Enhance doc for -fprofile-arcs
[official-gcc.git] / gcc / doc / invoke.texi
blobc205023d59cf9bb495c58a3a08461736cce1ad66
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  -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 -fno-show-column}
256 @item Warning Options
257 @xref{Warning Options,,Options to Request or Suppress Warnings}.
258 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
259 -pedantic-errors @gol
260 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
261 -Walloc-zero  -Walloc-size-larger-than=@var{n}
262 -Walloca  -Walloca-larger-than=@var{n} @gol
263 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
264 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
265 -Wno-builtin-declaration-mismatch @gol
266 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
267 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
268 -Wchar-subscripts  -Wclobbered  -Wcomment  -Wconditionally-supported  @gol
269 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
270 -Wdelete-incomplete @gol
271 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
272 -Wdisabled-optimization @gol
273 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
274 -Wno-div-by-zero  -Wdouble-promotion  -Wduplicated-cond @gol
275 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
276 -Werror  -Werror=*  -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
277 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
278 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
279 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
280 -Wformat-y2k  -Wframe-address @gol
281 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
282 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
283 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
284 -Wimplicit-function-declaration  -Wimplicit-int @gol
285 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
286 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
287 -Winvalid-pch  -Wlarger-than=@var{len} @gol
288 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
289 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
290 -Wmisleading-indentation  -Wmissing-braces @gol
291 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
292 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
293 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
294 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
295 -Woverride-init-side-effects  -Woverlength-strings @gol
296 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
297 -Wparentheses  -Wno-pedantic-ms-format @gol
298 -Wplacement-new  -Wplacement-new=@var{n} @gol
299 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
300 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
301 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
302 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
303 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
304 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
305 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
306 -Wno-scalar-storage-order @gol
307 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
308 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
309 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
310 -Wstringop-overflow=@var{n} @gol
311 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
312 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
313 -Wmissing-format-attribute  -Wsubobject-linkage @gol
314 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
315 -Wswitch-unreachable  -Wsync-nand @gol
316 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
317 -Wtype-limits  -Wundef @gol
318 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
319 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
320 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
321 -Wunused-parameter  -Wno-unused-result @gol
322 -Wunused-value  -Wunused-variable @gol
323 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
324 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
325 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
326 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
327 -Wzero-as-null-pointer-constant  -Whsa}
329 @item C and Objective-C-only Warning Options
330 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
331 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
332 -Wold-style-declaration  -Wold-style-definition @gol
333 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
334 -Wdeclaration-after-statement  -Wpointer-sign}
336 @item Debugging Options
337 @xref{Debugging Options,,Options for Debugging Your Program}.
338 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
339 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
340 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
341 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
342 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
343 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
344 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
345 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
346 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
347 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
348 -fvar-tracking  -fvar-tracking-assignments}
350 @item Optimization Options
351 @xref{Optimize Options,,Options that Control Optimization}.
352 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
353 -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
355 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
356 -fauto-inc-dec  -fbranch-probabilities @gol
357 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
358 -fbtr-bb-exclusive  -fcaller-saves @gol
359 -fcombine-stack-adjustments  -fconserve-stack @gol
360 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
361 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
362 -fcx-limited-range @gol
363 -fdata-sections  -fdce  -fdelayed-branch @gol
364 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
365 -fdevirtualize-at-ltrans  -fdse @gol
366 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
367 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
368 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
369 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
370 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
371 -fif-conversion2  -findirect-inlining @gol
372 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
373 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
374 -fipa-cp-alignment  -fipa-bit-cp @gol
375 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
376 -fira-algorithm=@var{algorithm} @gol
377 -fira-region=@var{region}  -fira-hoist-pressure @gol
378 -fira-loop-pressure  -fno-ira-share-save-slots @gol
379 -fno-ira-share-spill-slots @gol
380 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
381 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
382 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
383 -floop-block  -floop-interchange  -floop-strip-mine @gol
384 -floop-unroll-and-jam  -floop-nest-optimize @gol
385 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
386 -flto-partition=@var{alg}  -fmerge-all-constants @gol
387 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
388 -fmove-loop-invariants  -fno-branch-count-reg @gol
389 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
390 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
391 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
392 -fno-sched-spec  -fno-signed-zeros @gol
393 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
394 -fomit-frame-pointer  -foptimize-sibling-calls @gol
395 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
396 -fprefetch-loop-arrays @gol
397 -fprofile-correction @gol
398 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
399 -fprofile-reorder-functions @gol
400 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
401 -freorder-blocks-algorithm=@var{algorithm} @gol
402 -freorder-blocks-and-partition  -freorder-functions @gol
403 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
404 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
405 -fsched-spec-load  -fsched-spec-load-dangerous @gol
406 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
407 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
408 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
409 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
410 -fschedule-fusion @gol
411 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
412 -fselective-scheduling  -fselective-scheduling2 @gol
413 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
414 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
415 -fsignaling-nans @gol
416 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
417 -fsplit-paths @gol
418 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
419 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
420 -fstrict-overflow  -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
421 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
422 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
423 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
424 -ftree-loop-if-convert  -ftree-loop-im @gol
425 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
426 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
427 -ftree-loop-vectorize @gol
428 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
429 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
430 -ftree-switch-conversion  -ftree-tail-merge @gol
431 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
432 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
433 -funsafe-math-optimizations  -funswitch-loops @gol
434 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
435 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
436 --param @var{name}=@var{value}
437 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
439 @item Program Instrumentation Options
440 @xref{Instrumentation Options,,Program Instrumentation Options}.
441 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
442 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
443 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
444 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
445 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
446 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
447 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
448 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
449 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
450 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
451 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
452 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
453 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
454 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
455 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
456 -fstack-protector-explicit  -fstack-check @gol
457 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
458 -fno-stack-limit  -fsplit-stack @gol
459 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
460 -fvtv-counts  -fvtv-debug @gol
461 -finstrument-functions @gol
462 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
463 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
465 @item Preprocessor Options
466 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
467 @gccoptlist{-A@var{question}=@var{answer} @gol
468 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
469 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
470 -dD  -dI  -dM  -dN  -dU @gol
471 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
472 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
473 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
474 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
475 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
476 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
477 -H  -imacros @var{file}  -include @var{file} @gol
478 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
479 -no-integrated-cpp  -P  -pthread  -remap @gol
480 -traditional  -traditional-cpp  -trigraphs @gol
481 -U@var{macro}  -undef  @gol
482 -Wp,@var{option}  -Xpreprocessor @var{option}}
484 @item Assembler Options
485 @xref{Assembler Options,,Passing Options to the Assembler}.
486 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
488 @item Linker Options
489 @xref{Link Options,,Options for Linking}.
490 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
491 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
492 -s  -static  -static-libgcc  -static-libstdc++ @gol
493 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
494 -static-libmpx  -static-libmpxwrappers @gol
495 -shared  -shared-libgcc  -symbolic @gol
496 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
497 -u @var{symbol}  -z @var{keyword}}
499 @item Directory Options
500 @xref{Directory Options,,Options for Directory Search}.
501 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
502 -idirafter @var{dir} @gol
503 -imacros @var{file}  -imultilib @var{dir} @gol
504 -iplugindir=@var{dir}  -iprefix @var{file} @gol
505 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
506 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
507 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
508 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
510 @item Code Generation Options
511 @xref{Code Gen Options,,Options for Code Generation Conventions}.
512 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
513 -ffixed-@var{reg}  -fexceptions @gol
514 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
515 -fasynchronous-unwind-tables @gol
516 -fno-gnu-unique @gol
517 -finhibit-size-directive  -fno-common  -fno-ident @gol
518 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
519 -fno-jump-tables @gol
520 -frecord-gcc-switches @gol
521 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
522 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
523 -fleading-underscore  -ftls-model=@var{model} @gol
524 -fstack-reuse=@var{reuse_level} @gol
525 -ftrampolines  -ftrapv  -fwrapv @gol
526 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
527 -fstrict-volatile-bitfields  -fsync-libcalls}
529 @item Developer Options
530 @xref{Developer Options,,GCC Developer Options}.
531 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
532 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
533 -fdbg-cnt=@var{counter-value-list} @gol
534 -fdisable-ipa-@var{pass_name} @gol
535 -fdisable-rtl-@var{pass_name} @gol
536 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
537 -fdisable-tree-@var{pass_name} @gol
538 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
539 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
540 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
541 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
542 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
543 -fdump-passes @gol
544 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
545 -fdump-statistics @gol
546 -fdump-tree-all @gol
547 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
548 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
549 -fdump-tree-cfg  -fdump-tree-alias @gol
550 -fdump-tree-ch @gol
551 -fdump-tree-ssa@r{[}-@var{n}@r{]}  -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
552 -fdump-tree-ccp@r{[}-@var{n}@r{]}  -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
553 -fdump-tree-gimple@r{[}-raw@r{]} @gol
554 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
555 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
556 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
557 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
558 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
559 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
560 -fdump-tree-nrv  -fdump-tree-vect @gol
561 -fdump-tree-sink @gol
562 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
563 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
564 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
565 -fdump-tree-vtable-verify @gol
566 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
567 -fdump-tree-split-paths@r{[}-@var{n}@r{]} @gol
568 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
569 -fdump-final-insns=@var{file} @gol
570 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
571 -fenable-@var{kind}-@var{pass} @gol
572 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
573 -fira-verbose=@var{n} @gol
574 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
575 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
576 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
577 -fprofile-report @gol
578 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
579 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
580 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
581 -fvar-tracking-assignments-toggle  -gtoggle @gol
582 -print-file-name=@var{library}  -print-libgcc-file-name @gol
583 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
584 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
585 -print-sysroot  -print-sysroot-headers-suffix @gol
586 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
588 @item Machine-Dependent Options
589 @xref{Submodel Options,,Machine-Dependent Options}.
590 @c This list is ordered alphanumerically by subsection name.
591 @c Try and put the significant identifier (CPU or system) first,
592 @c so users have a clue at guessing where the ones they want will be.
594 @emph{AArch64 Options}
595 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
596 -mgeneral-regs-only @gol
597 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
598 -mstrict-align @gol
599 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
600 -mtls-dialect=desc  -mtls-dialect=traditional @gol
601 -mtls-size=@var{size} @gol
602 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
603 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
604 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
605 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
606 -mlow-precision-div  -mno-low-precision-div @gol
607 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
609 @emph{Adapteva Epiphany Options}
610 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
611 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
612 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
613 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
614 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
615 -msplit-vecmove-early  -m1reg-@var{reg}}
617 @emph{ARC Options}
618 @gccoptlist{-mbarrel-shifter @gol
619 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
620 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
621 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
622 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
623 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
624 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
625 -mlong-calls  -mmedium-calls  -msdata @gol
626 -mvolatile-cache  -mtp-regno=@var{regno} @gol
627 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
628 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
629 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
630 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
631 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
632 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
633 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
634 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
636 @emph{ARM Options}
637 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
638 -mabi=@var{name} @gol
639 -mapcs-stack-check  -mno-apcs-stack-check @gol
640 -mapcs-reentrant  -mno-apcs-reentrant @gol
641 -msched-prolog  -mno-sched-prolog @gol
642 -mlittle-endian  -mbig-endian @gol
643 -mfloat-abi=@var{name} @gol
644 -mfp16-format=@var{name}
645 -mthumb-interwork  -mno-thumb-interwork @gol
646 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
647 -mtune=@var{name}  -mprint-tune-info @gol
648 -mstructure-size-boundary=@var{n} @gol
649 -mabort-on-noreturn @gol
650 -mlong-calls  -mno-long-calls @gol
651 -msingle-pic-base  -mno-single-pic-base @gol
652 -mpic-register=@var{reg} @gol
653 -mnop-fun-dllimport @gol
654 -mpoke-function-name @gol
655 -mthumb  -marm @gol
656 -mtpcs-frame  -mtpcs-leaf-frame @gol
657 -mcaller-super-interworking  -mcallee-super-interworking @gol
658 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
659 -mword-relocations @gol
660 -mfix-cortex-m3-ldrd @gol
661 -munaligned-access @gol
662 -mneon-for-64bits @gol
663 -mslow-flash-data @gol
664 -masm-syntax-unified @gol
665 -mrestrict-it @gol
666 -mpure-code @gol
667 -mcmse}
669 @emph{AVR Options}
670 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
671 -mbranch-cost=@var{cost} @gol
672 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
673 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
674 -nodevicelib @gol
675 -Waddr-space-convert  -Wmisspelled-isr}
677 @emph{Blackfin Options}
678 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
679 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
680 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
681 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
682 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
683 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
684 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
685 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
686 -micplb}
688 @emph{C6X Options}
689 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
690 -msim  -msdata=@var{sdata-type}}
692 @emph{CRIS Options}
693 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
694 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
695 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
696 -mstack-align  -mdata-align  -mconst-align @gol
697 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
698 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
699 -mmul-bug-workaround  -mno-mul-bug-workaround}
701 @emph{CR16 Options}
702 @gccoptlist{-mmac @gol
703 -mcr16cplus  -mcr16c @gol
704 -msim  -mint32  -mbit-ops
705 -mdata-model=@var{model}}
707 @emph{Darwin Options}
708 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
709 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
710 -client_name  -compatibility_version  -current_version @gol
711 -dead_strip @gol
712 -dependency-file  -dylib_file  -dylinker_install_name @gol
713 -dynamic  -dynamiclib  -exported_symbols_list @gol
714 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
715 -force_flat_namespace  -headerpad_max_install_names @gol
716 -iframework @gol
717 -image_base  -init  -install_name  -keep_private_externs @gol
718 -multi_module  -multiply_defined  -multiply_defined_unused @gol
719 -noall_load   -no_dead_strip_inits_and_terms @gol
720 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
721 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
722 -private_bundle  -read_only_relocs  -sectalign @gol
723 -sectobjectsymbols  -whyload  -seg1addr @gol
724 -sectcreate  -sectobjectsymbols  -sectorder @gol
725 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
726 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
727 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
728 -single_module  -static  -sub_library  -sub_umbrella @gol
729 -twolevel_namespace  -umbrella  -undefined @gol
730 -unexported_symbols_list  -weak_reference_mismatches @gol
731 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
732 -mkernel  -mone-byte-bool}
734 @emph{DEC Alpha Options}
735 @gccoptlist{-mno-fp-regs  -msoft-float @gol
736 -mieee  -mieee-with-inexact  -mieee-conformant @gol
737 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
738 -mtrap-precision=@var{mode}  -mbuild-constants @gol
739 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
740 -mbwx  -mmax  -mfix  -mcix @gol
741 -mfloat-vax  -mfloat-ieee @gol
742 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
743 -msmall-text  -mlarge-text @gol
744 -mmemory-latency=@var{time}}
746 @emph{FR30 Options}
747 @gccoptlist{-msmall-model  -mno-lsim}
749 @emph{FT32 Options}
750 @gccoptlist{-msim  -mlra  -mnodiv}
752 @emph{FRV Options}
753 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
754 -mhard-float  -msoft-float @gol
755 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
756 -mdouble  -mno-double @gol
757 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
758 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
759 -mlinked-fp  -mlong-calls  -malign-labels @gol
760 -mlibrary-pic  -macc-4  -macc-8 @gol
761 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
762 -moptimize-membar  -mno-optimize-membar @gol
763 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
764 -mvliw-branch  -mno-vliw-branch @gol
765 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
766 -mno-nested-cond-exec  -mtomcat-stats @gol
767 -mTLS  -mtls @gol
768 -mcpu=@var{cpu}}
770 @emph{GNU/Linux Options}
771 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
772 -tno-android-cc  -tno-android-ld}
774 @emph{H8/300 Options}
775 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
777 @emph{HPPA Options}
778 @gccoptlist{-march=@var{architecture-type} @gol
779 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
780 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
781 -mfixed-range=@var{register-range} @gol
782 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
783 -mlong-load-store  -mno-disable-fpregs @gol
784 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
785 -mno-jump-in-delay  -mno-long-load-store @gol
786 -mno-portable-runtime  -mno-soft-float @gol
787 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
788 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
789 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
790 -munix=@var{unix-std}  -nolibdld  -static  -threads}
792 @emph{IA-64 Options}
793 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
794 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
795 -mconstant-gp  -mauto-pic  -mfused-madd @gol
796 -minline-float-divide-min-latency @gol
797 -minline-float-divide-max-throughput @gol
798 -mno-inline-float-divide @gol
799 -minline-int-divide-min-latency @gol
800 -minline-int-divide-max-throughput  @gol
801 -mno-inline-int-divide @gol
802 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
803 -mno-inline-sqrt @gol
804 -mdwarf2-asm  -mearly-stop-bits @gol
805 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
806 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
807 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
808 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
809 -msched-spec-ldc  -msched-spec-control-ldc @gol
810 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
811 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
812 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
813 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
815 @emph{LM32 Options}
816 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
817 -msign-extend-enabled  -muser-enabled}
819 @emph{M32R/D Options}
820 @gccoptlist{-m32r2  -m32rx  -m32r @gol
821 -mdebug @gol
822 -malign-loops  -mno-align-loops @gol
823 -missue-rate=@var{number} @gol
824 -mbranch-cost=@var{number} @gol
825 -mmodel=@var{code-size-model-type} @gol
826 -msdata=@var{sdata-type} @gol
827 -mno-flush-func  -mflush-func=@var{name} @gol
828 -mno-flush-trap  -mflush-trap=@var{number} @gol
829 -G @var{num}}
831 @emph{M32C Options}
832 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
834 @emph{M680x0 Options}
835 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
836 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
837 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
838 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
839 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
840 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
841 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
842 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
843 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
845 @emph{MCore Options}
846 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
847 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
848 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
849 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
850 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
852 @emph{MeP Options}
853 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
854 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
855 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
856 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
857 -mtiny=@var{n}}
859 @emph{MicroBlaze Options}
860 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
861 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
862 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
863 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
864 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
866 @emph{MIPS Options}
867 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
868 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
869 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
870 -mips16  -mno-mips16  -mflip-mips16 @gol
871 -minterlink-compressed  -mno-interlink-compressed @gol
872 -minterlink-mips16  -mno-interlink-mips16 @gol
873 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
874 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
875 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
876 -mno-float  -msingle-float  -mdouble-float @gol
877 -modd-spreg  -mno-odd-spreg @gol
878 -mabs=@var{mode}  -mnan=@var{encoding} @gol
879 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
880 -mmcu  -mmno-mcu @gol
881 -meva  -mno-eva @gol
882 -mvirt  -mno-virt @gol
883 -mxpa  -mno-xpa @gol
884 -mmicromips  -mno-micromips @gol
885 -mmsa  -mno-msa @gol
886 -mfpu=@var{fpu-type} @gol
887 -msmartmips  -mno-smartmips @gol
888 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
889 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
890 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
891 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
892 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
893 -membedded-data  -mno-embedded-data @gol
894 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
895 -mcode-readable=@var{setting} @gol
896 -msplit-addresses  -mno-split-addresses @gol
897 -mexplicit-relocs  -mno-explicit-relocs @gol
898 -mcheck-zero-division  -mno-check-zero-division @gol
899 -mdivide-traps  -mdivide-breaks @gol
900 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
901 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
902 -mfix-24k  -mno-fix-24k @gol
903 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
904 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
905 -mfix-vr4120  -mno-fix-vr4120 @gol
906 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
907 -mflush-func=@var{func}  -mno-flush-func @gol
908 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
909 -mcompact-branches=@var{policy} @gol
910 -mfp-exceptions  -mno-fp-exceptions @gol
911 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
912 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
913 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
914 -mframe-header-opt  -mno-frame-header-opt}
916 @emph{MMIX Options}
917 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
918 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
919 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
920 -mno-base-addresses  -msingle-exit  -mno-single-exit}
922 @emph{MN10300 Options}
923 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
924 -mno-am33  -mam33  -mam33-2  -mam34 @gol
925 -mtune=@var{cpu-type} @gol
926 -mreturn-pointer-on-d0 @gol
927 -mno-crt0  -mrelax  -mliw  -msetlb}
929 @emph{Moxie Options}
930 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
932 @emph{MSP430 Options}
933 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
934 -mwarn-mcu @gol
935 -mcode-region=  -mdata-region= @gol
936 -msilicon-errata=  -msilicon-errata-warn= @gol
937 -mhwmult=  -minrt}
939 @emph{NDS32 Options}
940 @gccoptlist{-mbig-endian  -mlittle-endian @gol
941 -mreduced-regs  -mfull-regs @gol
942 -mcmov  -mno-cmov @gol
943 -mperf-ext  -mno-perf-ext @gol
944 -mv3push  -mno-v3push @gol
945 -m16bit  -mno-16bit @gol
946 -misr-vector-size=@var{num} @gol
947 -mcache-block-size=@var{num} @gol
948 -march=@var{arch} @gol
949 -mcmodel=@var{code-model} @gol
950 -mctor-dtor  -mrelax}
952 @emph{Nios II Options}
953 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
954 -mel  -meb @gol
955 -mno-bypass-cache  -mbypass-cache @gol
956 -mno-cache-volatile  -mcache-volatile @gol
957 -mno-fast-sw-div  -mfast-sw-div @gol
958 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
959 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
960 -mcustom-fpu-cfg=@var{name} @gol
961 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
962 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
964 @emph{Nvidia PTX Options}
965 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
967 @emph{PDP-11 Options}
968 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
969 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
970 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
971 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
972 -mbranch-expensive  -mbranch-cheap @gol
973 -munix-asm  -mdec-asm}
975 @emph{picoChip Options}
976 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
977 -msymbol-as-address  -mno-inefficient-warnings}
979 @emph{PowerPC Options}
980 See RS/6000 and PowerPC Options.
982 @emph{RL78 Options}
983 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
984 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
985 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
987 @emph{RS/6000 and PowerPC Options}
988 @gccoptlist{-mcpu=@var{cpu-type} @gol
989 -mtune=@var{cpu-type} @gol
990 -mcmodel=@var{code-model} @gol
991 -mpowerpc64 @gol
992 -maltivec  -mno-altivec @gol
993 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
994 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
995 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
996 -mfprnd  -mno-fprnd @gol
997 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
998 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
999 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1000 -malign-power  -malign-natural @gol
1001 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1002 -msingle-float  -mdouble-float  -msimple-fpu @gol
1003 -mstring  -mno-string  -mupdate  -mno-update @gol
1004 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1005 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1006 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1007 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1008 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1009 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1010 -mprioritize-restricted-insns=@var{priority} @gol
1011 -msched-costly-dep=@var{dependence_type} @gol
1012 -minsert-sched-nops=@var{scheme} @gol
1013 -mcall-sysv  -mcall-netbsd @gol
1014 -maix-struct-return  -msvr4-struct-return @gol
1015 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1016 -mblock-move-inline-limit=@var{num} @gol
1017 -misel  -mno-isel @gol
1018 -misel=yes  -misel=no @gol
1019 -mspe  -mno-spe @gol
1020 -mspe=yes  -mspe=no @gol
1021 -mpaired @gol
1022 -mgen-cell-microcode  -mwarn-cell-microcode @gol
1023 -mvrsave  -mno-vrsave @gol
1024 -mmulhw  -mno-mulhw @gol
1025 -mdlmzb  -mno-dlmzb @gol
1026 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1027 -mprototype  -mno-prototype @gol
1028 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1029 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1030 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1031 -mno-recip-precision @gol
1032 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1033 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1034 -msave-toc-indirect  -mno-save-toc-indirect @gol
1035 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1036 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1037 -mquad-memory  -mno-quad-memory @gol
1038 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1039 -mcompat-align-parm  -mno-compat-align-parm @gol
1040 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1041 -mupper-regs-di  -mno-upper-regs-di @gol
1042 -mupper-regs  -mno-upper-regs @gol
1043 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1044 -mgnu-attribute  -mno-gnu-attribute @gol
1045 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1046 -mstack-protector-guard-offset=@var{offset} @gol
1047 -mlra  -mno-lra}
1049 @emph{RX Options}
1050 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1051 -mcpu=@gol
1052 -mbig-endian-data  -mlittle-endian-data @gol
1053 -msmall-data @gol
1054 -msim  -mno-sim@gol
1055 -mas100-syntax  -mno-as100-syntax@gol
1056 -mrelax@gol
1057 -mmax-constant-size=@gol
1058 -mint-register=@gol
1059 -mpid@gol
1060 -mallow-string-insns  -mno-allow-string-insns@gol
1061 -mjsr@gol
1062 -mno-warn-multiple-fast-interrupts@gol
1063 -msave-acc-in-interrupts}
1065 @emph{S/390 and zSeries Options}
1066 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1067 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1068 -mlong-double-64  -mlong-double-128 @gol
1069 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1070 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1071 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1072 -mhtm  -mvx  -mzvector @gol
1073 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1074 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1075 -mhotpatch=@var{halfwords},@var{halfwords}}
1077 @emph{Score Options}
1078 @gccoptlist{-meb  -mel @gol
1079 -mnhwloop @gol
1080 -muls @gol
1081 -mmac @gol
1082 -mscore5  -mscore5u  -mscore7  -mscore7d}
1084 @emph{SH Options}
1085 @gccoptlist{-m1  -m2  -m2e @gol
1086 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1087 -m3  -m3e @gol
1088 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1089 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1090 -mb  -ml  -mdalign  -mrelax @gol
1091 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1092 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1093 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1094 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1095 -maccumulate-outgoing-args @gol
1096 -matomic-model=@var{atomic-model} @gol
1097 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1098 -mcbranch-force-delay-slot @gol
1099 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1100 -mpretend-cmove  -mtas}
1102 @emph{Solaris 2 Options}
1103 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1104 -pthreads}
1106 @emph{SPARC Options}
1107 @gccoptlist{-mcpu=@var{cpu-type} @gol
1108 -mtune=@var{cpu-type} @gol
1109 -mcmodel=@var{code-model} @gol
1110 -mmemory-model=@var{mem-model} @gol
1111 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1112 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1113 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1114 -mhard-quad-float  -msoft-quad-float @gol
1115 -mstack-bias  -mno-stack-bias @gol
1116 -mstd-struct-return  -mno-std-struct-return @gol
1117 -munaligned-doubles  -mno-unaligned-doubles @gol
1118 -muser-mode  -mno-user-mode @gol
1119 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1120 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1121 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1122 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1123 -mfix-at697f  -mfix-ut699 @gol
1124 -mlra  -mno-lra}
1126 @emph{SPU Options}
1127 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1128 -msafe-dma  -munsafe-dma @gol
1129 -mbranch-hints @gol
1130 -msmall-mem  -mlarge-mem  -mstdmain @gol
1131 -mfixed-range=@var{register-range} @gol
1132 -mea32  -mea64 @gol
1133 -maddress-space-conversion  -mno-address-space-conversion @gol
1134 -mcache-size=@var{cache-size} @gol
1135 -matomic-updates  -mno-atomic-updates}
1137 @emph{System V Options}
1138 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1140 @emph{TILE-Gx Options}
1141 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1142 -mcmodel=@var{code-model}}
1144 @emph{TILEPro Options}
1145 @gccoptlist{-mcpu=@var{cpu}  -m32}
1147 @emph{V850 Options}
1148 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1149 -mprolog-function  -mno-prolog-function  -mspace @gol
1150 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1151 -mapp-regs  -mno-app-regs @gol
1152 -mdisable-callt  -mno-disable-callt @gol
1153 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1154 -mv850e  -mv850  -mv850e3v5 @gol
1155 -mloop @gol
1156 -mrelax @gol
1157 -mlong-jumps @gol
1158 -msoft-float @gol
1159 -mhard-float @gol
1160 -mgcc-abi @gol
1161 -mrh850-abi @gol
1162 -mbig-switch}
1164 @emph{VAX Options}
1165 @gccoptlist{-mg  -mgnu  -munix}
1167 @emph{Visium Options}
1168 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1169 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1171 @emph{VMS Options}
1172 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1173 -mpointer-size=@var{size}}
1175 @emph{VxWorks Options}
1176 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1177 -Xbind-lazy  -Xbind-now}
1179 @emph{x86 Options}
1180 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1181 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1182 -mfpmath=@var{unit} @gol
1183 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1184 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1185 -mno-wide-multiply  -mrtd  -malign-double @gol
1186 -mpreferred-stack-boundary=@var{num} @gol
1187 -mincoming-stack-boundary=@var{num} @gol
1188 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1189 -mrecip  -mrecip=@var{opt} @gol
1190 -mvzeroupper  -mprefer-avx128 @gol
1191 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1192 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1193 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1194 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1195 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1196 -msse4a  -m3dnow  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop  -mlzcnt @gol
1197 -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  -mmwaitx @gol
1198 -mclzero  -mpku  -mthreads @gol
1199 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1200 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1201 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1202 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1203 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1204 -mregparm=@var{num}  -msseregparm @gol
1205 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1206 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1207 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1208 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1209 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1210 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1211 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1212 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1213 -mmitigate-rop  -mgeneral-regs-only}
1215 @emph{x86 Windows Options}
1216 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1217 -mnop-fun-dllimport  -mthread @gol
1218 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1220 @emph{Xstormy16 Options}
1221 @gccoptlist{-msim}
1223 @emph{Xtensa Options}
1224 @gccoptlist{-mconst16  -mno-const16 @gol
1225 -mfused-madd  -mno-fused-madd @gol
1226 -mforce-no-pic @gol
1227 -mserialize-volatile  -mno-serialize-volatile @gol
1228 -mtext-section-literals  -mno-text-section-literals @gol
1229 -mauto-litpools  -mno-auto-litpools @gol
1230 -mtarget-align  -mno-target-align @gol
1231 -mlongcalls  -mno-longcalls}
1233 @emph{zSeries Options}
1234 See S/390 and zSeries Options.
1235 @end table
1238 @node Overall Options
1239 @section Options Controlling the Kind of Output
1241 Compilation can involve up to four stages: preprocessing, compilation
1242 proper, assembly and linking, always in that order.  GCC is capable of
1243 preprocessing and compiling several files either into several
1244 assembler input files, or into one assembler input file; then each
1245 assembler input file produces an object file, and linking combines all
1246 the object files (those newly compiled, and those specified as input)
1247 into an executable file.
1249 @cindex file name suffix
1250 For any given input file, the file name suffix determines what kind of
1251 compilation is done:
1253 @table @gcctabopt
1254 @item @var{file}.c
1255 C source code that must be preprocessed.
1257 @item @var{file}.i
1258 C source code that should not be preprocessed.
1260 @item @var{file}.ii
1261 C++ source code that should not be preprocessed.
1263 @item @var{file}.m
1264 Objective-C source code.  Note that you must link with the @file{libobjc}
1265 library to make an Objective-C program work.
1267 @item @var{file}.mi
1268 Objective-C source code that should not be preprocessed.
1270 @item @var{file}.mm
1271 @itemx @var{file}.M
1272 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1273 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1274 to a literal capital M@.
1276 @item @var{file}.mii
1277 Objective-C++ source code that should not be preprocessed.
1279 @item @var{file}.h
1280 C, C++, Objective-C or Objective-C++ header file to be turned into a
1281 precompiled header (default), or C, C++ header file to be turned into an
1282 Ada spec (via the @option{-fdump-ada-spec} switch).
1284 @item @var{file}.cc
1285 @itemx @var{file}.cp
1286 @itemx @var{file}.cxx
1287 @itemx @var{file}.cpp
1288 @itemx @var{file}.CPP
1289 @itemx @var{file}.c++
1290 @itemx @var{file}.C
1291 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1292 the last two letters must both be literally @samp{x}.  Likewise,
1293 @samp{.C} refers to a literal capital C@.
1295 @item @var{file}.mm
1296 @itemx @var{file}.M
1297 Objective-C++ source code that must be preprocessed.
1299 @item @var{file}.mii
1300 Objective-C++ source code that should not be preprocessed.
1302 @item @var{file}.hh
1303 @itemx @var{file}.H
1304 @itemx @var{file}.hp
1305 @itemx @var{file}.hxx
1306 @itemx @var{file}.hpp
1307 @itemx @var{file}.HPP
1308 @itemx @var{file}.h++
1309 @itemx @var{file}.tcc
1310 C++ header file to be turned into a precompiled header or Ada spec.
1312 @item @var{file}.f
1313 @itemx @var{file}.for
1314 @itemx @var{file}.ftn
1315 Fixed form Fortran source code that should not be preprocessed.
1317 @item @var{file}.F
1318 @itemx @var{file}.FOR
1319 @itemx @var{file}.fpp
1320 @itemx @var{file}.FPP
1321 @itemx @var{file}.FTN
1322 Fixed form Fortran source code that must be preprocessed (with the traditional
1323 preprocessor).
1325 @item @var{file}.f90
1326 @itemx @var{file}.f95
1327 @itemx @var{file}.f03
1328 @itemx @var{file}.f08
1329 Free form Fortran source code that should not be preprocessed.
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 must be preprocessed (with the
1336 traditional preprocessor).
1338 @item @var{file}.go
1339 Go source code.
1341 @item @var{file}.brig
1342 BRIG files (binary representation of HSAIL).
1344 @item @var{file}.ads
1345 Ada source code file that contains a library unit declaration (a
1346 declaration of a package, subprogram, or generic, or a generic
1347 instantiation), or a library unit renaming declaration (a package,
1348 generic, or subprogram renaming declaration).  Such files are also
1349 called @dfn{specs}.
1351 @item @var{file}.adb
1352 Ada source code file containing a library unit body (a subprogram or
1353 package body).  Such files are also called @dfn{bodies}.
1355 @c GCC also knows about some suffixes for languages not yet included:
1356 @c Pascal:
1357 @c @var{file}.p
1358 @c @var{file}.pas
1359 @c Ratfor:
1360 @c @var{file}.r
1362 @item @var{file}.s
1363 Assembler code.
1365 @item @var{file}.S
1366 @itemx @var{file}.sx
1367 Assembler code that must be preprocessed.
1369 @item @var{other}
1370 An object file to be fed straight into linking.
1371 Any file name with no recognized suffix is treated this way.
1372 @end table
1374 @opindex x
1375 You can specify the input language explicitly with the @option{-x} option:
1377 @table @gcctabopt
1378 @item -x @var{language}
1379 Specify explicitly the @var{language} for the following input files
1380 (rather than letting the compiler choose a default based on the file
1381 name suffix).  This option applies to all following input files until
1382 the next @option{-x} option.  Possible values for @var{language} are:
1383 @smallexample
1384 c  c-header  cpp-output
1385 c++  c++-header  c++-cpp-output
1386 objective-c  objective-c-header  objective-c-cpp-output
1387 objective-c++ objective-c++-header objective-c++-cpp-output
1388 assembler  assembler-with-cpp
1390 f77  f77-cpp-input f95  f95-cpp-input
1392 brig
1393 @end smallexample
1395 @item -x none
1396 Turn off any specification of a language, so that subsequent files are
1397 handled according to their file name suffixes (as they are if @option{-x}
1398 has not been used at all).
1399 @end table
1401 If you only want some of the stages of compilation, you can use
1402 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1403 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1404 @command{gcc} is to stop.  Note that some combinations (for example,
1405 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1407 @table @gcctabopt
1408 @item -c
1409 @opindex c
1410 Compile or assemble the source files, but do not link.  The linking
1411 stage simply is not done.  The ultimate output is in the form of an
1412 object file for each source file.
1414 By default, the object file name for a source file is made by replacing
1415 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1417 Unrecognized input files, not requiring compilation or assembly, are
1418 ignored.
1420 @item -S
1421 @opindex S
1422 Stop after the stage of compilation proper; do not assemble.  The output
1423 is in the form of an assembler code file for each non-assembler input
1424 file specified.
1426 By default, the assembler file name for a source file is made by
1427 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1429 Input files that don't require compilation are ignored.
1431 @item -E
1432 @opindex E
1433 Stop after the preprocessing stage; do not run the compiler proper.  The
1434 output is in the form of preprocessed source code, which is sent to the
1435 standard output.
1437 Input files that don't require preprocessing are ignored.
1439 @cindex output file option
1440 @item -o @var{file}
1441 @opindex o
1442 Place output in file @var{file}.  This applies to whatever
1443 sort of output is being produced, whether it be an executable file,
1444 an object file, an assembler file or preprocessed C code.
1446 If @option{-o} is not specified, the default is to put an executable
1447 file in @file{a.out}, the object file for
1448 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1449 assembler file in @file{@var{source}.s}, a precompiled header file in
1450 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1451 standard output.
1453 @item -v
1454 @opindex v
1455 Print (on standard error output) the commands executed to run the stages
1456 of compilation.  Also print the version number of the compiler driver
1457 program and of the preprocessor and the compiler proper.
1459 @item -###
1460 @opindex ###
1461 Like @option{-v} except the commands are not executed and arguments
1462 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1463 This is useful for shell scripts to capture the driver-generated command lines.
1465 @item --help
1466 @opindex help
1467 Print (on the standard output) a description of the command-line options
1468 understood by @command{gcc}.  If the @option{-v} option is also specified
1469 then @option{--help} is also passed on to the various processes
1470 invoked by @command{gcc}, so that they can display the command-line options
1471 they accept.  If the @option{-Wextra} option has also been specified
1472 (prior to the @option{--help} option), then command-line options that
1473 have no documentation associated with them are also displayed.
1475 @item --target-help
1476 @opindex target-help
1477 Print (on the standard output) a description of target-specific command-line
1478 options for each tool.  For some targets extra target-specific
1479 information may also be printed.
1481 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1482 Print (on the standard output) a description of the command-line
1483 options understood by the compiler that fit into all specified classes
1484 and qualifiers.  These are the supported classes:
1486 @table @asis
1487 @item @samp{optimizers}
1488 Display all of the optimization options supported by the
1489 compiler.
1491 @item @samp{warnings}
1492 Display all of the options controlling warning messages
1493 produced by the compiler.
1495 @item @samp{target}
1496 Display target-specific options.  Unlike the
1497 @option{--target-help} option however, target-specific options of the
1498 linker and assembler are not displayed.  This is because those
1499 tools do not currently support the extended @option{--help=} syntax.
1501 @item @samp{params}
1502 Display the values recognized by the @option{--param}
1503 option.
1505 @item @var{language}
1506 Display the options supported for @var{language}, where
1507 @var{language} is the name of one of the languages supported in this
1508 version of GCC@.
1510 @item @samp{common}
1511 Display the options that are common to all languages.
1512 @end table
1514 These are the supported qualifiers:
1516 @table @asis
1517 @item @samp{undocumented}
1518 Display only those options that are undocumented.
1520 @item @samp{joined}
1521 Display options taking an argument that appears after an equal
1522 sign in the same continuous piece of text, such as:
1523 @samp{--help=target}.
1525 @item @samp{separate}
1526 Display options taking an argument that appears as a separate word
1527 following the original option, such as: @samp{-o output-file}.
1528 @end table
1530 Thus for example to display all the undocumented target-specific
1531 switches supported by the compiler, use:
1533 @smallexample
1534 --help=target,undocumented
1535 @end smallexample
1537 The sense of a qualifier can be inverted by prefixing it with the
1538 @samp{^} character, so for example to display all binary warning
1539 options (i.e., ones that are either on or off and that do not take an
1540 argument) that have a description, use:
1542 @smallexample
1543 --help=warnings,^joined,^undocumented
1544 @end smallexample
1546 The argument to @option{--help=} should not consist solely of inverted
1547 qualifiers.
1549 Combining several classes is possible, although this usually
1550 restricts the output so much that there is nothing to display.  One
1551 case where it does work, however, is when one of the classes is
1552 @var{target}.  For example, to display all the target-specific
1553 optimization options, use:
1555 @smallexample
1556 --help=target,optimizers
1557 @end smallexample
1559 The @option{--help=} option can be repeated on the command line.  Each
1560 successive use displays its requested class of options, skipping
1561 those that have already been displayed.
1563 If the @option{-Q} option appears on the command line before the
1564 @option{--help=} option, then the descriptive text displayed by
1565 @option{--help=} is changed.  Instead of describing the displayed
1566 options, an indication is given as to whether the option is enabled,
1567 disabled or set to a specific value (assuming that the compiler
1568 knows this at the point where the @option{--help=} option is used).
1570 Here is a truncated example from the ARM port of @command{gcc}:
1572 @smallexample
1573   % gcc -Q -mabi=2 --help=target -c
1574   The following options are target specific:
1575   -mabi=                                2
1576   -mabort-on-noreturn                   [disabled]
1577   -mapcs                                [disabled]
1578 @end smallexample
1580 The output is sensitive to the effects of previous command-line
1581 options, so for example it is possible to find out which optimizations
1582 are enabled at @option{-O2} by using:
1584 @smallexample
1585 -Q -O2 --help=optimizers
1586 @end smallexample
1588 Alternatively you can discover which binary optimizations are enabled
1589 by @option{-O3} by using:
1591 @smallexample
1592 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1593 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1594 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1595 @end smallexample
1597 @item --version
1598 @opindex version
1599 Display the version number and copyrights of the invoked GCC@.
1601 @item -pass-exit-codes
1602 @opindex pass-exit-codes
1603 Normally the @command{gcc} program exits with the code of 1 if any
1604 phase of the compiler returns a non-success return code.  If you specify
1605 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1606 the numerically highest error produced by any phase returning an error
1607 indication.  The C, C++, and Fortran front ends return 4 if an internal
1608 compiler error is encountered.
1610 @item -pipe
1611 @opindex pipe
1612 Use pipes rather than temporary files for communication between the
1613 various stages of compilation.  This fails to work on some systems where
1614 the assembler is unable to read from a pipe; but the GNU assembler has
1615 no trouble.
1617 @item -specs=@var{file}
1618 @opindex specs
1619 Process @var{file} after the compiler reads in the standard @file{specs}
1620 file, in order to override the defaults which the @command{gcc} driver
1621 program uses when determining what switches to pass to @command{cc1},
1622 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1623 @option{-specs=@var{file}} can be specified on the command line, and they
1624 are processed in order, from left to right.  @xref{Spec Files}, for
1625 information about the format of the @var{file}.
1627 @item -wrapper
1628 @opindex wrapper
1629 Invoke all subcommands under a wrapper program.  The name of the
1630 wrapper program and its parameters are passed as a comma separated
1631 list.
1633 @smallexample
1634 gcc -c t.c -wrapper gdb,--args
1635 @end smallexample
1637 @noindent
1638 This invokes all subprograms of @command{gcc} under
1639 @samp{gdb --args}, thus the invocation of @command{cc1} is
1640 @samp{gdb --args cc1 @dots{}}.
1642 @item -fplugin=@var{name}.so
1643 @opindex fplugin
1644 Load the plugin code in file @var{name}.so, assumed to be a
1645 shared object to be dlopen'd by the compiler.  The base name of
1646 the shared object file is used to identify the plugin for the
1647 purposes of argument parsing (See
1648 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1649 Each plugin should define the callback functions specified in the
1650 Plugins API.
1652 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1653 @opindex fplugin-arg
1654 Define an argument called @var{key} with a value of @var{value}
1655 for the plugin called @var{name}.
1657 @item -fdump-ada-spec@r{[}-slim@r{]}
1658 @opindex fdump-ada-spec
1659 For C and C++ source and include files, generate corresponding Ada specs.
1660 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1661 GNAT User's Guide}, which provides detailed documentation on this feature.
1663 @item -fada-spec-parent=@var{unit}
1664 @opindex fada-spec-parent
1665 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1666 Ada specs as child units of parent @var{unit}.
1668 @item -fdump-go-spec=@var{file}
1669 @opindex fdump-go-spec
1670 For input files in any language, generate corresponding Go
1671 declarations in @var{file}.  This generates Go @code{const},
1672 @code{type}, @code{var}, and @code{func} declarations which may be a
1673 useful way to start writing a Go interface to code written in some
1674 other language.
1676 @include @value{srcdir}/../libiberty/at-file.texi
1677 @end table
1679 @node Invoking G++
1680 @section Compiling C++ Programs
1682 @cindex suffixes for C++ source
1683 @cindex C++ source file suffixes
1684 C++ source files conventionally use one of the suffixes @samp{.C},
1685 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1686 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1687 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1688 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1689 files with these names and compiles them as C++ programs even if you
1690 call the compiler the same way as for compiling C programs (usually
1691 with the name @command{gcc}).
1693 @findex g++
1694 @findex c++
1695 However, the use of @command{gcc} does not add the C++ library.
1696 @command{g++} is a program that calls GCC and automatically specifies linking
1697 against the C++ library.  It treats @samp{.c},
1698 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1699 files unless @option{-x} is used.  This program is also useful when
1700 precompiling a C header file with a @samp{.h} extension for use in C++
1701 compilations.  On many systems, @command{g++} is also installed with
1702 the name @command{c++}.
1704 @cindex invoking @command{g++}
1705 When you compile C++ programs, you may specify many of the same
1706 command-line options that you use for compiling programs in any
1707 language; or command-line options meaningful for C and related
1708 languages; or options that are meaningful only for C++ programs.
1709 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1710 explanations of options for languages related to C@.
1711 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1712 explanations of options that are meaningful only for C++ programs.
1714 @node C Dialect Options
1715 @section Options Controlling C Dialect
1716 @cindex dialect options
1717 @cindex language dialect options
1718 @cindex options, dialect
1720 The following options control the dialect of C (or languages derived
1721 from C, such as C++, Objective-C and Objective-C++) that the compiler
1722 accepts:
1724 @table @gcctabopt
1725 @cindex ANSI support
1726 @cindex ISO support
1727 @item -ansi
1728 @opindex ansi
1729 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1730 equivalent to @option{-std=c++98}.
1732 This turns off certain features of GCC that are incompatible with ISO
1733 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1734 such as the @code{asm} and @code{typeof} keywords, and
1735 predefined macros such as @code{unix} and @code{vax} that identify the
1736 type of system you are using.  It also enables the undesirable and
1737 rarely used ISO trigraph feature.  For the C compiler,
1738 it disables recognition of C++ style @samp{//} comments as well as
1739 the @code{inline} keyword.
1741 The alternate keywords @code{__asm__}, @code{__extension__},
1742 @code{__inline__} and @code{__typeof__} continue to work despite
1743 @option{-ansi}.  You would not want to use them in an ISO C program, of
1744 course, but it is useful to put them in header files that might be included
1745 in compilations done with @option{-ansi}.  Alternate predefined macros
1746 such as @code{__unix__} and @code{__vax__} are also available, with or
1747 without @option{-ansi}.
1749 The @option{-ansi} option does not cause non-ISO programs to be
1750 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1751 addition to @option{-ansi}.  @xref{Warning Options}.
1753 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1754 option is used.  Some header files may notice this macro and refrain
1755 from declaring certain functions or defining certain macros that the
1756 ISO standard doesn't call for; this is to avoid interfering with any
1757 programs that might use these names for other things.
1759 Functions that are normally built in but do not have semantics
1760 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1761 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1762 built-in functions provided by GCC}, for details of the functions
1763 affected.
1765 @item -std=
1766 @opindex std
1767 Determine the language standard. @xref{Standards,,Language Standards
1768 Supported by GCC}, for details of these standard versions.  This option
1769 is currently only supported when compiling C or C++.
1771 The compiler can accept several base standards, such as @samp{c90} or
1772 @samp{c++98}, and GNU dialects of those standards, such as
1773 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1774 compiler accepts all programs following that standard plus those
1775 using GNU extensions that do not contradict it.  For example,
1776 @option{-std=c90} turns off certain features of GCC that are
1777 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1778 keywords, but not other GNU extensions that do not have a meaning in
1779 ISO C90, such as omitting the middle term of a @code{?:}
1780 expression. On the other hand, when a GNU dialect of a standard is
1781 specified, all features supported by the compiler are enabled, even when
1782 those features change the meaning of the base standard.  As a result, some
1783 strict-conforming programs may be rejected.  The particular standard
1784 is used by @option{-Wpedantic} to identify which features are GNU
1785 extensions given that version of the standard. For example
1786 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1787 comments, while @option{-std=gnu99 -Wpedantic} does not.
1789 A value for this option must be provided; possible values are
1791 @table @samp
1792 @item c90
1793 @itemx c89
1794 @itemx iso9899:1990
1795 Support all ISO C90 programs (certain GNU extensions that conflict
1796 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1798 @item iso9899:199409
1799 ISO C90 as modified in amendment 1.
1801 @item c99
1802 @itemx c9x
1803 @itemx iso9899:1999
1804 @itemx iso9899:199x
1805 ISO C99.  This standard is substantially completely supported, modulo
1806 bugs and floating-point issues
1807 (mainly but not entirely relating to optional C99 features from
1808 Annexes F and G).  See
1809 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1810 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1812 @item c11
1813 @itemx c1x
1814 @itemx iso9899:2011
1815 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1816 substantially completely supported, modulo bugs, floating-point issues
1817 (mainly but not entirely relating to optional C11 features from
1818 Annexes F and G) and the optional Annexes K (Bounds-checking
1819 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1821 @item gnu90
1822 @itemx gnu89
1823 GNU dialect of ISO C90 (including some C99 features).
1825 @item gnu99
1826 @itemx gnu9x
1827 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1829 @item gnu11
1830 @itemx gnu1x
1831 GNU dialect of ISO C11.  This is the default for C code.
1832 The name @samp{gnu1x} is deprecated.
1834 @item c++98
1835 @itemx c++03
1836 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1837 additional defect reports. Same as @option{-ansi} for C++ code.
1839 @item gnu++98
1840 @itemx gnu++03
1841 GNU dialect of @option{-std=c++98}.
1843 @item c++11
1844 @itemx c++0x
1845 The 2011 ISO C++ standard plus amendments.
1846 The name @samp{c++0x} is deprecated.
1848 @item gnu++11
1849 @itemx gnu++0x
1850 GNU dialect of @option{-std=c++11}.
1851 The name @samp{gnu++0x} is deprecated.
1853 @item c++14
1854 @itemx c++1y
1855 The 2014 ISO C++ standard plus amendments.
1856 The name @samp{c++1y} is deprecated.
1858 @item gnu++14
1859 @itemx gnu++1y
1860 GNU dialect of @option{-std=c++14}.
1861 This is the default for C++ code.
1862 The name @samp{gnu++1y} is deprecated.
1864 @item c++1z
1865 The next revision of the ISO C++ standard, tentatively planned for
1866 2017.  Support is highly experimental, and will almost certainly
1867 change in incompatible ways in future releases.
1869 @item gnu++1z
1870 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1871 and will almost certainly change in incompatible ways in future
1872 releases.
1873 @end table
1875 @item -fgnu89-inline
1876 @opindex fgnu89-inline
1877 The option @option{-fgnu89-inline} tells GCC to use the traditional
1878 GNU semantics for @code{inline} functions when in C99 mode.
1879 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1880 Using this option is roughly equivalent to adding the
1881 @code{gnu_inline} function attribute to all inline functions
1882 (@pxref{Function Attributes}).
1884 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1885 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1886 specifies the default behavior).
1887 This option is not supported in @option{-std=c90} or
1888 @option{-std=gnu90} mode.
1890 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1891 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1892 in effect for @code{inline} functions.  @xref{Common Predefined
1893 Macros,,,cpp,The C Preprocessor}.
1895 @item -fpermitted-flt-eval-methods=@var{style}
1896 @opindex fpermitted-flt-eval-methods
1897 @opindex fpermitted-flt-eval-methods=c11
1898 @opindex fpermitted-flt-eval-methods=ts-18661-3
1899 ISO/IEC TS 18661-3 defines new permissible values for
1900 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1901 a semantic type that is an interchange or extended format should be
1902 evaluated to the precision and range of that type.  These new values are
1903 a superset of those permitted under C99/C11, which does not specify the
1904 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1905 conforming to C11 may not have been written expecting the possibility of
1906 the new values.
1908 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1909 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1910 or the extended set of values specified in ISO/IEC TS 18661-3.
1912 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1914 The default when in a standards compliant mode (@option{-std=c11} or similar)
1915 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1916 dialect (@option{-std=gnu11} or similar) is
1917 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1919 @item -aux-info @var{filename}
1920 @opindex aux-info
1921 Output to the given filename prototyped declarations for all functions
1922 declared and/or defined in a translation unit, including those in header
1923 files.  This option is silently ignored in any language other than C@.
1925 Besides declarations, the file indicates, in comments, the origin of
1926 each declaration (source file and line), whether the declaration was
1927 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1928 @samp{O} for old, respectively, in the first character after the line
1929 number and the colon), and whether it came from a declaration or a
1930 definition (@samp{C} or @samp{F}, respectively, in the following
1931 character).  In the case of function definitions, a K&R-style list of
1932 arguments followed by their declarations is also provided, inside
1933 comments, after the declaration.
1935 @item -fallow-parameterless-variadic-functions
1936 @opindex fallow-parameterless-variadic-functions
1937 Accept variadic functions without named parameters.
1939 Although it is possible to define such a function, this is not very
1940 useful as it is not possible to read the arguments.  This is only
1941 supported for C as this construct is allowed by C++.
1943 @item -fno-asm
1944 @opindex fno-asm
1945 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1946 keyword, so that code can use these words as identifiers.  You can use
1947 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1948 instead.  @option{-ansi} implies @option{-fno-asm}.
1950 In C++, this switch only affects the @code{typeof} keyword, since
1951 @code{asm} and @code{inline} are standard keywords.  You may want to
1952 use the @option{-fno-gnu-keywords} flag instead, which has the same
1953 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1954 switch only affects the @code{asm} and @code{typeof} keywords, since
1955 @code{inline} is a standard keyword in ISO C99.
1957 @item -fno-builtin
1958 @itemx -fno-builtin-@var{function}
1959 @opindex fno-builtin
1960 @cindex built-in functions
1961 Don't recognize built-in functions that do not begin with
1962 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1963 functions provided by GCC}, for details of the functions affected,
1964 including those which are not built-in functions when @option{-ansi} or
1965 @option{-std} options for strict ISO C conformance are used because they
1966 do not have an ISO standard meaning.
1968 GCC normally generates special code to handle certain built-in functions
1969 more efficiently; for instance, calls to @code{alloca} may become single
1970 instructions which adjust the stack directly, and calls to @code{memcpy}
1971 may become inline copy loops.  The resulting code is often both smaller
1972 and faster, but since the function calls no longer appear as such, you
1973 cannot set a breakpoint on those calls, nor can you change the behavior
1974 of the functions by linking with a different library.  In addition,
1975 when a function is recognized as a built-in function, GCC may use
1976 information about that function to warn about problems with calls to
1977 that function, or to generate more efficient code, even if the
1978 resulting code still contains calls to that function.  For example,
1979 warnings are given with @option{-Wformat} for bad calls to
1980 @code{printf} when @code{printf} is built in and @code{strlen} is
1981 known not to modify global memory.
1983 With the @option{-fno-builtin-@var{function}} option
1984 only the built-in function @var{function} is
1985 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1986 function is named that is not built-in in this version of GCC, this
1987 option is ignored.  There is no corresponding
1988 @option{-fbuiltin-@var{function}} option; if you wish to enable
1989 built-in functions selectively when using @option{-fno-builtin} or
1990 @option{-ffreestanding}, you may define macros such as:
1992 @smallexample
1993 #define abs(n)          __builtin_abs ((n))
1994 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1995 @end smallexample
1997 @item -fgimple
1998 @opindex fgimple
2000 Enable parsing of function definitions marked with @code{__GIMPLE}.
2001 This is an experimental feature that allows unit testing of GIMPLE
2002 passes.
2004 @item -fhosted
2005 @opindex fhosted
2006 @cindex hosted environment
2008 Assert that compilation targets a hosted environment.  This implies
2009 @option{-fbuiltin}.  A hosted environment is one in which the
2010 entire standard library is available, and in which @code{main} has a return
2011 type of @code{int}.  Examples are nearly everything except a kernel.
2012 This is equivalent to @option{-fno-freestanding}.
2014 @item -ffreestanding
2015 @opindex ffreestanding
2016 @cindex hosted environment
2018 Assert that compilation targets a freestanding environment.  This
2019 implies @option{-fno-builtin}.  A freestanding environment
2020 is one in which the standard library may not exist, and program startup may
2021 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2022 This is equivalent to @option{-fno-hosted}.
2024 @xref{Standards,,Language Standards Supported by GCC}, for details of
2025 freestanding and hosted environments.
2027 @item -fopenacc
2028 @opindex fopenacc
2029 @cindex OpenACC accelerator programming
2030 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2031 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2032 compiler generates accelerated code according to the OpenACC Application
2033 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2034 implies @option{-pthread}, and thus is only supported on targets that
2035 have support for @option{-pthread}.
2037 @item -fopenacc-dim=@var{geom}
2038 @opindex fopenacc-dim
2039 @cindex OpenACC accelerator programming
2040 Specify default compute dimensions for parallel offload regions that do
2041 not explicitly specify.  The @var{geom} value is a triple of
2042 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2043 can be omitted, to use a target-specific default value.
2045 @item -fopenmp
2046 @opindex fopenmp
2047 @cindex OpenMP parallel
2048 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2049 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2050 compiler generates parallel code according to the OpenMP Application
2051 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
2052 implies @option{-pthread}, and thus is only supported on targets that
2053 have support for @option{-pthread}. @option{-fopenmp} implies
2054 @option{-fopenmp-simd}.
2056 @item -fopenmp-simd
2057 @opindex fopenmp-simd
2058 @cindex OpenMP SIMD
2059 @cindex SIMD
2060 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2061 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2062 are ignored.
2064 @item -fcilkplus
2065 @opindex fcilkplus
2066 @cindex Enable Cilk Plus
2067 Enable the usage of Cilk Plus language extension features for C/C++.
2068 When the option @option{-fcilkplus} is specified, enable the usage of
2069 the Cilk Plus Language extension features for C/C++.  The present
2070 implementation follows ABI version 1.2.  This is an experimental
2071 feature that is only partially complete, and whose interface may
2072 change in future versions of GCC as the official specification
2073 changes.  Currently, all features but @code{_Cilk_for} have been
2074 implemented.
2076 @item -fgnu-tm
2077 @opindex fgnu-tm
2078 When the option @option{-fgnu-tm} is specified, the compiler
2079 generates code for the Linux variant of Intel's current Transactional
2080 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2081 an experimental feature whose interface may change in future versions
2082 of GCC, as the official specification changes.  Please note that not
2083 all architectures are supported for this feature.
2085 For more information on GCC's support for transactional memory,
2086 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2087 Transactional Memory Library}.
2089 Note that the transactional memory feature is not supported with
2090 non-call exceptions (@option{-fnon-call-exceptions}).
2092 @item -fms-extensions
2093 @opindex fms-extensions
2094 Accept some non-standard constructs used in Microsoft header files.
2096 In C++ code, this allows member names in structures to be similar
2097 to previous types declarations.
2099 @smallexample
2100 typedef int UOW;
2101 struct ABC @{
2102   UOW UOW;
2104 @end smallexample
2106 Some cases of unnamed fields in structures and unions are only
2107 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2108 fields within structs/unions}, for details.
2110 Note that this option is off for all targets but x86 
2111 targets using ms-abi.
2113 @item -fplan9-extensions
2114 @opindex fplan9-extensions
2115 Accept some non-standard constructs used in Plan 9 code.
2117 This enables @option{-fms-extensions}, permits passing pointers to
2118 structures with anonymous fields to functions that expect pointers to
2119 elements of the type of the field, and permits referring to anonymous
2120 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2121 struct/union fields within structs/unions}, for details.  This is only
2122 supported for C, not C++.
2124 @item -fcond-mismatch
2125 @opindex fcond-mismatch
2126 Allow conditional expressions with mismatched types in the second and
2127 third arguments.  The value of such an expression is void.  This option
2128 is not supported for C++.
2130 @item -flax-vector-conversions
2131 @opindex flax-vector-conversions
2132 Allow implicit conversions between vectors with differing numbers of
2133 elements and/or incompatible element types.  This option should not be
2134 used for new code.
2136 @item -funsigned-char
2137 @opindex funsigned-char
2138 Let the type @code{char} be unsigned, like @code{unsigned char}.
2140 Each kind of machine has a default for what @code{char} should
2141 be.  It is either like @code{unsigned char} by default or like
2142 @code{signed char} by default.
2144 Ideally, a portable program should always use @code{signed char} or
2145 @code{unsigned char} when it depends on the signedness of an object.
2146 But many programs have been written to use plain @code{char} and
2147 expect it to be signed, or expect it to be unsigned, depending on the
2148 machines they were written for.  This option, and its inverse, let you
2149 make such a program work with the opposite default.
2151 The type @code{char} is always a distinct type from each of
2152 @code{signed char} or @code{unsigned char}, even though its behavior
2153 is always just like one of those two.
2155 @item -fsigned-char
2156 @opindex fsigned-char
2157 Let the type @code{char} be signed, like @code{signed char}.
2159 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2160 the negative form of @option{-funsigned-char}.  Likewise, the option
2161 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2163 @item -fsigned-bitfields
2164 @itemx -funsigned-bitfields
2165 @itemx -fno-signed-bitfields
2166 @itemx -fno-unsigned-bitfields
2167 @opindex fsigned-bitfields
2168 @opindex funsigned-bitfields
2169 @opindex fno-signed-bitfields
2170 @opindex fno-unsigned-bitfields
2171 These options control whether a bit-field is signed or unsigned, when the
2172 declaration does not use either @code{signed} or @code{unsigned}.  By
2173 default, such a bit-field is signed, because this is consistent: the
2174 basic integer types such as @code{int} are signed types.
2176 @item -fsso-struct=@var{endianness}
2177 @opindex fsso-struct
2178 Set the default scalar storage order of structures and unions to the
2179 specified endianness.  The accepted values are @samp{big-endian},
2180 @samp{little-endian} and @samp{native} for the native endianness of
2181 the target (the default).  This option is not supported for C++.
2183 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2184 code that is not binary compatible with code generated without it if the
2185 specified endianness is not the native endianness of the target.
2186 @end table
2188 @node C++ Dialect Options
2189 @section Options Controlling C++ Dialect
2191 @cindex compiler options, C++
2192 @cindex C++ options, command-line
2193 @cindex options, C++
2194 This section describes the command-line options that are only meaningful
2195 for C++ programs.  You can also use most of the GNU compiler options
2196 regardless of what language your program is in.  For example, you
2197 might compile a file @file{firstClass.C} like this:
2199 @smallexample
2200 g++ -g -fstrict-enums -O -c firstClass.C
2201 @end smallexample
2203 @noindent
2204 In this example, only @option{-fstrict-enums} is an option meant
2205 only for C++ programs; you can use the other options with any
2206 language supported by GCC@.
2208 Some options for compiling C programs, such as @option{-std}, are also
2209 relevant for C++ programs.
2210 @xref{C Dialect Options,,Options Controlling C Dialect}.
2212 Here is a list of options that are @emph{only} for compiling C++ programs:
2214 @table @gcctabopt
2216 @item -fabi-version=@var{n}
2217 @opindex fabi-version
2218 Use version @var{n} of the C++ ABI@.  The default is version 0.
2220 Version 0 refers to the version conforming most closely to
2221 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2222 will change in different versions of G++ as ABI bugs are fixed.
2224 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2226 Version 2 is the version of the C++ ABI that first appeared in G++
2227 3.4, and was the default through G++ 4.9.
2229 Version 3 corrects an error in mangling a constant address as a
2230 template argument.
2232 Version 4, which first appeared in G++ 4.5, implements a standard
2233 mangling for vector types.
2235 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2236 attribute const/volatile on function pointer types, decltype of a
2237 plain decl, and use of a function parameter in the declaration of
2238 another parameter.
2240 Version 6, which first appeared in G++ 4.7, corrects the promotion
2241 behavior of C++11 scoped enums and the mangling of template argument
2242 packs, const/static_cast, prefix ++ and --, and a class scope function
2243 used as a template argument.
2245 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2246 builtin type and corrects the mangling of lambdas in default argument
2247 scope.
2249 Version 8, which first appeared in G++ 4.9, corrects the substitution
2250 behavior of function types with function-cv-qualifiers.
2252 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2253 @code{nullptr_t}.
2255 Version 10, which first appeared in G++ 6.1, adds mangling of
2256 attributes that affect type identity, such as ia32 calling convention
2257 attributes (e.g. @samp{stdcall}).
2259 Version 11, which first appeared in G++ 7, corrects the mangling of
2260 sizeof... expressions and operator names.  For multiple entities with
2261 the same name within a function, that are declared in different scopes,
2262 the mangling now changes starting with the twelfth occurrence.  It also
2263 implies @option{-fnew-inheriting-ctors}.
2265 See also @option{-Wabi}.
2267 @item -fabi-compat-version=@var{n}
2268 @opindex fabi-compat-version
2269 On targets that support strong aliases, G++
2270 works around mangling changes by creating an alias with the correct
2271 mangled name when defining a symbol with an incorrect mangled name.
2272 This switch specifies which ABI version to use for the alias.
2274 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2275 compatibility).  If another ABI version is explicitly selected, this
2276 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2277 use @option{-fabi-compat-version=2}.
2279 If this option is not provided but @option{-Wabi=@var{n}} is, that
2280 version is used for compatibility aliases.  If this option is provided
2281 along with @option{-Wabi} (without the version), the version from this
2282 option is used for the warning.
2284 @item -fno-access-control
2285 @opindex fno-access-control
2286 Turn off all access checking.  This switch is mainly useful for working
2287 around bugs in the access control code.
2289 @item -faligned-new
2290 @opindex faligned-new
2291 Enable support for C++17 @code{new} of types that require more
2292 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2293 numeric argument such as @code{-faligned-new=32} can be used to
2294 specify how much alignment (in bytes) is provided by that function,
2295 but few users will need to override the default of
2296 @code{alignof(std::max_align_t)}.
2298 @item -fcheck-new
2299 @opindex fcheck-new
2300 Check that the pointer returned by @code{operator new} is non-null
2301 before attempting to modify the storage allocated.  This check is
2302 normally unnecessary because the C++ standard specifies that
2303 @code{operator new} only returns @code{0} if it is declared
2304 @code{throw()}, in which case the compiler always checks the
2305 return value even without this option.  In all other cases, when
2306 @code{operator new} has a non-empty exception specification, memory
2307 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2308 @samp{new (nothrow)}.
2310 @item -fconcepts
2311 @opindex fconcepts
2312 Enable support for the C++ Extensions for Concepts Technical
2313 Specification, ISO 19217 (2015), which allows code like
2315 @smallexample
2316 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2317 template <Addable T> T add (T a, T b) @{ return a + b; @}
2318 @end smallexample
2320 @item -fconstexpr-depth=@var{n}
2321 @opindex fconstexpr-depth
2322 Set the maximum nested evaluation depth for C++11 constexpr functions
2323 to @var{n}.  A limit is needed to detect endless recursion during
2324 constant expression evaluation.  The minimum specified by the standard
2325 is 512.
2327 @item -fconstexpr-loop-limit=@var{n}
2328 @opindex fconstexpr-loop-limit
2329 Set the maximum number of iterations for a loop in C++14 constexpr functions
2330 to @var{n}.  A limit is needed to detect infinite loops during
2331 constant expression evaluation.  The default is 262144 (1<<18).
2333 @item -fdeduce-init-list
2334 @opindex fdeduce-init-list
2335 Enable deduction of a template type parameter as
2336 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2338 @smallexample
2339 template <class T> auto forward(T t) -> decltype (realfn (t))
2341   return realfn (t);
2344 void f()
2346   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2348 @end smallexample
2350 This deduction was implemented as a possible extension to the
2351 originally proposed semantics for the C++11 standard, but was not part
2352 of the final standard, so it is disabled by default.  This option is
2353 deprecated, and may be removed in a future version of G++.
2355 @item -ffriend-injection
2356 @opindex ffriend-injection
2357 Inject friend functions into the enclosing namespace, so that they are
2358 visible outside the scope of the class in which they are declared.
2359 Friend functions were documented to work this way in the old Annotated
2360 C++ Reference Manual.  
2361 However, in ISO C++ a friend function that is not declared
2362 in an enclosing scope can only be found using argument dependent
2363 lookup.  GCC defaults to the standard behavior.
2365 This option is for compatibility, and may be removed in a future
2366 release of G++.
2368 @item -fno-elide-constructors
2369 @opindex fno-elide-constructors
2370 The C++ standard allows an implementation to omit creating a temporary
2371 that is only used to initialize another object of the same type.
2372 Specifying this option disables that optimization, and forces G++ to
2373 call the copy constructor in all cases.  This option also causes G++
2374 to call trivial member functions which otherwise would be expanded inline.
2376 In C++17, the compiler is required to omit these temporaries, but this
2377 option still affects trivial member functions.
2379 @item -fno-enforce-eh-specs
2380 @opindex fno-enforce-eh-specs
2381 Don't generate code to check for violation of exception specifications
2382 at run time.  This option violates the C++ standard, but may be useful
2383 for reducing code size in production builds, much like defining
2384 @code{NDEBUG}.  This does not give user code permission to throw
2385 exceptions in violation of the exception specifications; the compiler
2386 still optimizes based on the specifications, so throwing an
2387 unexpected exception results in undefined behavior at run time.
2389 @item -fextern-tls-init
2390 @itemx -fno-extern-tls-init
2391 @opindex fextern-tls-init
2392 @opindex fno-extern-tls-init
2393 The C++11 and OpenMP standards allow @code{thread_local} and
2394 @code{threadprivate} variables to have dynamic (runtime)
2395 initialization.  To support this, any use of such a variable goes
2396 through a wrapper function that performs any necessary initialization.
2397 When the use and definition of the variable are in the same
2398 translation unit, this overhead can be optimized away, but when the
2399 use is in a different translation unit there is significant overhead
2400 even if the variable doesn't actually need dynamic initialization.  If
2401 the programmer can be sure that no use of the variable in a
2402 non-defining TU needs to trigger dynamic initialization (either
2403 because the variable is statically initialized, or a use of the
2404 variable in the defining TU will be executed before any uses in
2405 another TU), they can avoid this overhead with the
2406 @option{-fno-extern-tls-init} option.
2408 On targets that support symbol aliases, the default is
2409 @option{-fextern-tls-init}.  On targets that do not support symbol
2410 aliases, the default is @option{-fno-extern-tls-init}.
2412 @item -ffor-scope
2413 @itemx -fno-for-scope
2414 @opindex ffor-scope
2415 @opindex fno-for-scope
2416 If @option{-ffor-scope} is specified, the scope of variables declared in
2417 a @i{for-init-statement} is limited to the @code{for} loop itself,
2418 as specified by the C++ standard.
2419 If @option{-fno-for-scope} is specified, the scope of variables declared in
2420 a @i{for-init-statement} extends to the end of the enclosing scope,
2421 as was the case in old versions of G++, and other (traditional)
2422 implementations of C++.
2424 If neither flag is given, the default is to follow the standard,
2425 but to allow and give a warning for old-style code that would
2426 otherwise be invalid, or have different behavior.
2428 @item -fno-gnu-keywords
2429 @opindex fno-gnu-keywords
2430 Do not recognize @code{typeof} as a keyword, so that code can use this
2431 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2432 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2433 @option{-std=c++98}, @option{-std=c++11}, etc.
2435 @item -fno-implicit-templates
2436 @opindex fno-implicit-templates
2437 Never emit code for non-inline templates that are instantiated
2438 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2439 @xref{Template Instantiation}, for more information.
2441 @item -fno-implicit-inline-templates
2442 @opindex fno-implicit-inline-templates
2443 Don't emit code for implicit instantiations of inline templates, either.
2444 The default is to handle inlines differently so that compiles with and
2445 without optimization need the same set of explicit instantiations.
2447 @item -fno-implement-inlines
2448 @opindex fno-implement-inlines
2449 To save space, do not emit out-of-line copies of inline functions
2450 controlled by @code{#pragma implementation}.  This causes linker
2451 errors if these functions are not inlined everywhere they are called.
2453 @item -fms-extensions
2454 @opindex fms-extensions
2455 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2456 int and getting a pointer to member function via non-standard syntax.
2458 @item -fnew-inheriting-ctors
2459 @opindex fnew-inheriting-ctors
2460 Enable the P0136 adjustment to the semantics of C++11 constructor
2461 inheritance.  This is part of C++17 but also considered to be a Defect
2462 Report against C++11 and C++14.  This flag is enabled by default
2463 unless @option{-fabi-version=10} or lower is specified.
2465 @item -fnew-ttp-matching
2466 @opindex fnew-ttp-matching
2467 Enable the P0522 resolution to Core issue 150, template template
2468 parameters and default arguments: this allows a template with default
2469 template arguments as an argument for a template template parameter
2470 with fewer template parameters.  This flag is enabled by default for
2471 @option{-std=c++1z}.
2473 @item -fno-nonansi-builtins
2474 @opindex fno-nonansi-builtins
2475 Disable built-in declarations of functions that are not mandated by
2476 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2477 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2479 @item -fnothrow-opt
2480 @opindex fnothrow-opt
2481 Treat a @code{throw()} exception specification as if it were a
2482 @code{noexcept} specification to reduce or eliminate the text size
2483 overhead relative to a function with no exception specification.  If
2484 the function has local variables of types with non-trivial
2485 destructors, the exception specification actually makes the
2486 function smaller because the EH cleanups for those variables can be
2487 optimized away.  The semantic effect is that an exception thrown out of
2488 a function with such an exception specification results in a call
2489 to @code{terminate} rather than @code{unexpected}.
2491 @item -fno-operator-names
2492 @opindex fno-operator-names
2493 Do not treat the operator name keywords @code{and}, @code{bitand},
2494 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2495 synonyms as keywords.
2497 @item -fno-optional-diags
2498 @opindex fno-optional-diags
2499 Disable diagnostics that the standard says a compiler does not need to
2500 issue.  Currently, the only such diagnostic issued by G++ is the one for
2501 a name having multiple meanings within a class.
2503 @item -fpermissive
2504 @opindex fpermissive
2505 Downgrade some diagnostics about nonconformant code from errors to
2506 warnings.  Thus, using @option{-fpermissive} allows some
2507 nonconforming code to compile.
2509 @item -fno-pretty-templates
2510 @opindex fno-pretty-templates
2511 When an error message refers to a specialization of a function
2512 template, the compiler normally prints the signature of the
2513 template followed by the template arguments and any typedefs or
2514 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2515 rather than @code{void f(int)}) so that it's clear which template is
2516 involved.  When an error message refers to a specialization of a class
2517 template, the compiler omits any template arguments that match
2518 the default template arguments for that template.  If either of these
2519 behaviors make it harder to understand the error message rather than
2520 easier, you can use @option{-fno-pretty-templates} to disable them.
2522 @item -frepo
2523 @opindex frepo
2524 Enable automatic template instantiation at link time.  This option also
2525 implies @option{-fno-implicit-templates}.  @xref{Template
2526 Instantiation}, for more information.
2528 @item -fno-rtti
2529 @opindex fno-rtti
2530 Disable generation of information about every class with virtual
2531 functions for use by the C++ run-time type identification features
2532 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2533 of the language, you can save some space by using this flag.  Note that
2534 exception handling uses the same information, but G++ generates it as
2535 needed. The @code{dynamic_cast} operator can still be used for casts that
2536 do not require run-time type information, i.e.@: casts to @code{void *} or to
2537 unambiguous base classes.
2539 @item -fsized-deallocation
2540 @opindex fsized-deallocation
2541 Enable the built-in global declarations
2542 @smallexample
2543 void operator delete (void *, std::size_t) noexcept;
2544 void operator delete[] (void *, std::size_t) noexcept;
2545 @end smallexample
2546 as introduced in C++14.  This is useful for user-defined replacement
2547 deallocation functions that, for example, use the size of the object
2548 to make deallocation faster.  Enabled by default under
2549 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2550 warns about places that might want to add a definition.
2552 @item -fstrict-enums
2553 @opindex fstrict-enums
2554 Allow the compiler to optimize using the assumption that a value of
2555 enumerated type can only be one of the values of the enumeration (as
2556 defined in the C++ standard; basically, a value that can be
2557 represented in the minimum number of bits needed to represent all the
2558 enumerators).  This assumption may not be valid if the program uses a
2559 cast to convert an arbitrary integer value to the enumerated type.
2561 @item -fstrong-eval-order
2562 @opindex fstrong-eval-order
2563 Evaluate member access, array subscripting, and shift expressions in
2564 left-to-right order, and evaluate assignment in right-to-left order,
2565 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2566 @option{-fstrong-eval-order=some} enables just the ordering of member
2567 access and shift expressions, and is the default without
2568 @option{-std=c++1z}.
2570 @item -ftemplate-backtrace-limit=@var{n}
2571 @opindex ftemplate-backtrace-limit
2572 Set the maximum number of template instantiation notes for a single
2573 warning or error to @var{n}.  The default value is 10.
2575 @item -ftemplate-depth=@var{n}
2576 @opindex ftemplate-depth
2577 Set the maximum instantiation depth for template classes to @var{n}.
2578 A limit on the template instantiation depth is needed to detect
2579 endless recursions during template class instantiation.  ANSI/ISO C++
2580 conforming programs must not rely on a maximum depth greater than 17
2581 (changed to 1024 in C++11).  The default value is 900, as the compiler
2582 can run out of stack space before hitting 1024 in some situations.
2584 @item -fno-threadsafe-statics
2585 @opindex fno-threadsafe-statics
2586 Do not emit the extra code to use the routines specified in the C++
2587 ABI for thread-safe initialization of local statics.  You can use this
2588 option to reduce code size slightly in code that doesn't need to be
2589 thread-safe.
2591 @item -fuse-cxa-atexit
2592 @opindex fuse-cxa-atexit
2593 Register destructors for objects with static storage duration with the
2594 @code{__cxa_atexit} function rather than the @code{atexit} function.
2595 This option is required for fully standards-compliant handling of static
2596 destructors, but only works if your C library supports
2597 @code{__cxa_atexit}.
2599 @item -fno-use-cxa-get-exception-ptr
2600 @opindex fno-use-cxa-get-exception-ptr
2601 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2602 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2603 if the runtime routine is not available.
2605 @item -fvisibility-inlines-hidden
2606 @opindex fvisibility-inlines-hidden
2607 This switch declares that the user does not attempt to compare
2608 pointers to inline functions or methods where the addresses of the two functions
2609 are taken in different shared objects.
2611 The effect of this is that GCC may, effectively, mark inline methods with
2612 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2613 appear in the export table of a DSO and do not require a PLT indirection
2614 when used within the DSO@.  Enabling this option can have a dramatic effect
2615 on load and link times of a DSO as it massively reduces the size of the
2616 dynamic export table when the library makes heavy use of templates.
2618 The behavior of this switch is not quite the same as marking the
2619 methods as hidden directly, because it does not affect static variables
2620 local to the function or cause the compiler to deduce that
2621 the function is defined in only one shared object.
2623 You may mark a method as having a visibility explicitly to negate the
2624 effect of the switch for that method.  For example, if you do want to
2625 compare pointers to a particular inline method, you might mark it as
2626 having default visibility.  Marking the enclosing class with explicit
2627 visibility has no effect.
2629 Explicitly instantiated inline methods are unaffected by this option
2630 as their linkage might otherwise cross a shared library boundary.
2631 @xref{Template Instantiation}.
2633 @item -fvisibility-ms-compat
2634 @opindex fvisibility-ms-compat
2635 This flag attempts to use visibility settings to make GCC's C++
2636 linkage model compatible with that of Microsoft Visual Studio.
2638 The flag makes these changes to GCC's linkage model:
2640 @enumerate
2641 @item
2642 It sets the default visibility to @code{hidden}, like
2643 @option{-fvisibility=hidden}.
2645 @item
2646 Types, but not their members, are not hidden by default.
2648 @item
2649 The One Definition Rule is relaxed for types without explicit
2650 visibility specifications that are defined in more than one
2651 shared object: those declarations are permitted if they are
2652 permitted when this option is not used.
2653 @end enumerate
2655 In new code it is better to use @option{-fvisibility=hidden} and
2656 export those classes that are intended to be externally visible.
2657 Unfortunately it is possible for code to rely, perhaps accidentally,
2658 on the Visual Studio behavior.
2660 Among the consequences of these changes are that static data members
2661 of the same type with the same name but defined in different shared
2662 objects are different, so changing one does not change the other;
2663 and that pointers to function members defined in different shared
2664 objects may not compare equal.  When this flag is given, it is a
2665 violation of the ODR to define types with the same name differently.
2667 @item -fno-weak
2668 @opindex fno-weak
2669 Do not use weak symbol support, even if it is provided by the linker.
2670 By default, G++ uses weak symbols if they are available.  This
2671 option exists only for testing, and should not be used by end-users;
2672 it results in inferior code and has no benefits.  This option may
2673 be removed in a future release of G++.
2675 @item -nostdinc++
2676 @opindex nostdinc++
2677 Do not search for header files in the standard directories specific to
2678 C++, but do still search the other standard directories.  (This option
2679 is used when building the C++ library.)
2680 @end table
2682 In addition, these optimization, warning, and code generation options
2683 have meanings only for C++ programs:
2685 @table @gcctabopt
2686 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2687 @opindex Wabi
2688 @opindex Wno-abi
2689 Warn when G++ it generates code that is probably not compatible with
2690 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2691 ABI with each major release, normally @option{-Wabi} will warn only if
2692 there is a check added later in a release series for an ABI issue
2693 discovered since the initial release.  @option{-Wabi} will warn about
2694 more things if an older ABI version is selected (with
2695 @option{-fabi-version=@var{n}}).
2697 @option{-Wabi} can also be used with an explicit version number to
2698 warn about compatibility with a particular @option{-fabi-version}
2699 level, e.g. @option{-Wabi=2} to warn about changes relative to
2700 @option{-fabi-version=2}.
2702 If an explicit version number is provided and
2703 @option{-fabi-compat-version} is not specified, the version number
2704 from this option is used for compatibility aliases.  If no explicit
2705 version number is provided with this option, but
2706 @option{-fabi-compat-version} is specified, that version number is
2707 used for ABI warnings.
2709 Although an effort has been made to warn about
2710 all such cases, there are probably some cases that are not warned about,
2711 even though G++ is generating incompatible code.  There may also be
2712 cases where warnings are emitted even though the code that is generated
2713 is compatible.
2715 You should rewrite your code to avoid these warnings if you are
2716 concerned about the fact that code generated by G++ may not be binary
2717 compatible with code generated by other compilers.
2719 Known incompatibilities in @option{-fabi-version=2} (which was the
2720 default from GCC 3.4 to 4.9) include:
2722 @itemize @bullet
2724 @item
2725 A template with a non-type template parameter of reference type was
2726 mangled incorrectly:
2727 @smallexample
2728 extern int N;
2729 template <int &> struct S @{@};
2730 void n (S<N>) @{2@}
2731 @end smallexample
2733 This was fixed in @option{-fabi-version=3}.
2735 @item
2736 SIMD vector types declared using @code{__attribute ((vector_size))} were
2737 mangled in a non-standard way that does not allow for overloading of
2738 functions taking vectors of different sizes.
2740 The mangling was changed in @option{-fabi-version=4}.
2742 @item
2743 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2744 qualifiers, and @code{decltype} of a plain declaration was folded away.
2746 These mangling issues were fixed in @option{-fabi-version=5}.
2748 @item
2749 Scoped enumerators passed as arguments to a variadic function are
2750 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2751 On most targets this does not actually affect the parameter passing
2752 ABI, as there is no way to pass an argument smaller than @code{int}.
2754 Also, the ABI changed the mangling of template argument packs,
2755 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2756 a class scope function used as a template argument.
2758 These issues were corrected in @option{-fabi-version=6}.
2760 @item
2761 Lambdas in default argument scope were mangled incorrectly, and the
2762 ABI changed the mangling of @code{nullptr_t}.
2764 These issues were corrected in @option{-fabi-version=7}.
2766 @item
2767 When mangling a function type with function-cv-qualifiers, the
2768 un-qualified function type was incorrectly treated as a substitution
2769 candidate.
2771 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2773 @item
2774 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2775 unaligned accesses.  Note that this did not affect the ABI of a
2776 function with a @code{nullptr_t} parameter, as parameters have a
2777 minimum alignment.
2779 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2781 @item
2782 Target-specific attributes that affect the identity of a type, such as
2783 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2784 did not affect the mangled name, leading to name collisions when
2785 function pointers were used as template arguments.
2787 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2789 @end itemize
2791 It also warns about psABI-related changes.  The known psABI changes at this
2792 point include:
2794 @itemize @bullet
2796 @item
2797 For SysV/x86-64, unions with @code{long double} members are 
2798 passed in memory as specified in psABI.  For example:
2800 @smallexample
2801 union U @{
2802   long double ld;
2803   int i;
2805 @end smallexample
2807 @noindent
2808 @code{union U} is always passed in memory.
2810 @end itemize
2812 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2813 @opindex Wabi-tag
2814 @opindex -Wabi-tag
2815 Warn when a type with an ABI tag is used in a context that does not
2816 have that ABI tag.  See @ref{C++ Attributes} for more information
2817 about ABI tags.
2819 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2820 @opindex Wctor-dtor-privacy
2821 @opindex Wno-ctor-dtor-privacy
2822 Warn when a class seems unusable because all the constructors or
2823 destructors in that class are private, and it has neither friends nor
2824 public static member functions.  Also warn if there are no non-private
2825 methods, and there's at least one private member function that isn't
2826 a constructor or destructor.
2828 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2829 @opindex Wdelete-non-virtual-dtor
2830 @opindex Wno-delete-non-virtual-dtor
2831 Warn when @code{delete} is used to destroy an instance of a class that
2832 has virtual functions and non-virtual destructor. It is unsafe to delete
2833 an instance of a derived class through a pointer to a base class if the
2834 base class does not have a virtual destructor.  This warning is enabled
2835 by @option{-Wall}.
2837 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2838 @opindex Wliteral-suffix
2839 @opindex Wno-literal-suffix
2840 Warn when a string or character literal is followed by a ud-suffix which does
2841 not begin with an underscore.  As a conforming extension, GCC treats such
2842 suffixes as separate preprocessing tokens in order to maintain backwards
2843 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2844 For example:
2846 @smallexample
2847 #define __STDC_FORMAT_MACROS
2848 #include <inttypes.h>
2849 #include <stdio.h>
2851 int main() @{
2852   int64_t i64 = 123;
2853   printf("My int64: %" PRId64"\n", i64);
2855 @end smallexample
2857 In this case, @code{PRId64} is treated as a separate preprocessing token.
2859 This warning is enabled by default.
2861 @item -Wlto-type-mismatch
2862 @opindex Wlto-type-mismatch
2863 @opindex Wno-lto-type-mismatch
2865 During the link-time optimization warn about type mismatches in
2866 global declarations from different compilation units.
2867 Requires @option{-flto} to be enabled.  Enabled by default.
2869 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2870 @opindex Wnarrowing
2871 @opindex Wno-narrowing
2872 With @option{-std=gnu++98} or @option{-std=c++98}, warn when a narrowing
2873 conversion prohibited by C++11 occurs within
2874 @samp{@{ @}}, e.g.
2876 @smallexample
2877 int i = @{ 2.2 @}; // error: narrowing from double to int
2878 @end smallexample
2880 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2882 When a later standard is in effect, e.g. when using @option{-std=c++11},
2883 narrowing conversions are diagnosed by default, as required by the standard.
2884 A narrowing conversion from a constant produces an error,
2885 and a narrowing conversion from a non-constant produces a warning,
2886 but @option{-Wno-narrowing} suppresses the diagnostic.
2887 Note that this does not affect the meaning of well-formed code;
2888 narrowing conversions are still considered ill-formed in SFINAE contexts.
2890 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2891 @opindex Wnoexcept
2892 @opindex Wno-noexcept
2893 Warn when a noexcept-expression evaluates to false because of a call
2894 to a function that does not have a non-throwing exception
2895 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2896 the compiler to never throw an exception.
2898 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2899 @opindex Wnon-virtual-dtor
2900 @opindex Wno-non-virtual-dtor
2901 Warn when a class has virtual functions and an accessible non-virtual
2902 destructor itself or in an accessible polymorphic base class, in which
2903 case it is possible but unsafe to delete an instance of a derived
2904 class through a pointer to the class itself or base class.  This
2905 warning is automatically enabled if @option{-Weffc++} is specified.
2907 @item -Wregister @r{(C++ and Objective-C++ only)}
2908 @opindex Wregister
2909 @opindex Wno-register
2910 Warn on uses of the @code{register} storage class specifier, except
2911 when it is part of the GNU @ref{Explicit Register Variables} extension.
2912 The use of the @code{register} keyword as storage class specifier has
2913 been deprecated in C++11 and removed in C++17.
2914 Enabled by default with @option{-std=c++1z}.
2916 @item -Wreorder @r{(C++ and Objective-C++ only)}
2917 @opindex Wreorder
2918 @opindex Wno-reorder
2919 @cindex reordering, warning
2920 @cindex warning for reordering of member initializers
2921 Warn when the order of member initializers given in the code does not
2922 match the order in which they must be executed.  For instance:
2924 @smallexample
2925 struct A @{
2926   int i;
2927   int j;
2928   A(): j (0), i (1) @{ @}
2930 @end smallexample
2932 @noindent
2933 The compiler rearranges the member initializers for @code{i}
2934 and @code{j} to match the declaration order of the members, emitting
2935 a warning to that effect.  This warning is enabled by @option{-Wall}.
2937 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2938 @opindex fext-numeric-literals
2939 @opindex fno-ext-numeric-literals
2940 Accept imaginary, fixed-point, or machine-defined
2941 literal number suffixes as GNU extensions.
2942 When this option is turned off these suffixes are treated
2943 as C++11 user-defined literal numeric suffixes.
2944 This is on by default for all pre-C++11 dialects and all GNU dialects:
2945 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2946 @option{-std=gnu++14}.
2947 This option is off by default
2948 for ISO C++11 onwards (@option{-std=c++11}, ...).
2949 @end table
2951 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2953 @table @gcctabopt
2954 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2955 @opindex Weffc++
2956 @opindex Wno-effc++
2957 Warn about violations of the following style guidelines from Scott Meyers'
2958 @cite{Effective C++} series of books:
2960 @itemize @bullet
2961 @item
2962 Define a copy constructor and an assignment operator for classes
2963 with dynamically-allocated memory.
2965 @item
2966 Prefer initialization to assignment in constructors.
2968 @item
2969 Have @code{operator=} return a reference to @code{*this}.
2971 @item
2972 Don't try to return a reference when you must return an object.
2974 @item
2975 Distinguish between prefix and postfix forms of increment and
2976 decrement operators.
2978 @item
2979 Never overload @code{&&}, @code{||}, or @code{,}.
2981 @end itemize
2983 This option also enables @option{-Wnon-virtual-dtor}, which is also
2984 one of the effective C++ recommendations.  However, the check is
2985 extended to warn about the lack of virtual destructor in accessible
2986 non-polymorphic bases classes too.
2988 When selecting this option, be aware that the standard library
2989 headers do not obey all of these guidelines; use @samp{grep -v}
2990 to filter out those warnings.
2992 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2993 @opindex Wstrict-null-sentinel
2994 @opindex Wno-strict-null-sentinel
2995 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2996 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2997 to @code{__null}.  Although it is a null pointer constant rather than a
2998 null pointer, it is guaranteed to be of the same size as a pointer.
2999 But this use is not portable across different compilers.
3001 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3002 @opindex Wno-non-template-friend
3003 @opindex Wnon-template-friend
3004 Disable warnings when non-templatized friend functions are declared
3005 within a template.  Since the advent of explicit template specification
3006 support in G++, if the name of the friend is an unqualified-id (i.e.,
3007 @samp{friend foo(int)}), the C++ language specification demands that the
3008 friend declare or define an ordinary, nontemplate function.  (Section
3009 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
3010 could be interpreted as a particular specialization of a templatized
3011 function.  Because this non-conforming behavior is no longer the default
3012 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
3013 check existing code for potential trouble spots and is on by default.
3014 This new compiler behavior can be turned off with
3015 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
3016 but disables the helpful warning.
3018 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3019 @opindex Wold-style-cast
3020 @opindex Wno-old-style-cast
3021 Warn if an old-style (C-style) cast to a non-void type is used within
3022 a C++ program.  The new-style casts (@code{dynamic_cast},
3023 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3024 less vulnerable to unintended effects and much easier to search for.
3026 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3027 @opindex Woverloaded-virtual
3028 @opindex Wno-overloaded-virtual
3029 @cindex overloaded virtual function, warning
3030 @cindex warning for overloaded virtual function
3031 Warn when a function declaration hides virtual functions from a
3032 base class.  For example, in:
3034 @smallexample
3035 struct A @{
3036   virtual void f();
3039 struct B: public A @{
3040   void f(int);
3042 @end smallexample
3044 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3045 like:
3047 @smallexample
3048 B* b;
3049 b->f();
3050 @end smallexample
3052 @noindent
3053 fails to compile.
3055 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3056 @opindex Wno-pmf-conversions
3057 @opindex Wpmf-conversions
3058 Disable the diagnostic for converting a bound pointer to member function
3059 to a plain pointer.
3061 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3062 @opindex Wsign-promo
3063 @opindex Wno-sign-promo
3064 Warn when overload resolution chooses a promotion from unsigned or
3065 enumerated type to a signed type, over a conversion to an unsigned type of
3066 the same size.  Previous versions of G++ tried to preserve
3067 unsignedness, but the standard mandates the current behavior.
3069 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3070 @opindex Wtemplates
3071 Warn when a primary template declaration is encountered.  Some coding
3072 rules disallow templates, and this may be used to enforce that rule.
3073 The warning is inactive inside a system header file, such as the STL, so
3074 one can still use the STL.  One may also instantiate or specialize
3075 templates.
3077 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3078 @opindex Wmultiple-inheritance
3079 Warn when a class is defined with multiple direct base classes.  Some
3080 coding rules disallow multiple inheritance, and this may be used to
3081 enforce that rule.  The warning is inactive inside a system header file,
3082 such as the STL, so one can still use the STL.  One may also define
3083 classes that indirectly use multiple inheritance.
3085 @item -Wvirtual-inheritance
3086 @opindex Wvirtual-inheritance
3087 Warn when a class is defined with a virtual direct base class.  Some
3088 coding rules disallow multiple inheritance, and this may be used to
3089 enforce that rule.  The warning is inactive inside a system header file,
3090 such as the STL, so one can still use the STL.  One may also define
3091 classes that indirectly use virtual inheritance.
3093 @item -Wnamespaces
3094 @opindex Wnamespaces
3095 Warn when a namespace definition is opened.  Some coding rules disallow
3096 namespaces, and this may be used to enforce that rule.  The warning is
3097 inactive inside a system header file, such as the STL, so one can still
3098 use the STL.  One may also use using directives and qualified names.
3100 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3101 @opindex Wterminate
3102 @opindex Wno-terminate
3103 Disable the warning about a throw-expression that will immediately
3104 result in a call to @code{terminate}.
3105 @end table
3107 @node Objective-C and Objective-C++ Dialect Options
3108 @section Options Controlling Objective-C and Objective-C++ Dialects
3110 @cindex compiler options, Objective-C and Objective-C++
3111 @cindex Objective-C and Objective-C++ options, command-line
3112 @cindex options, Objective-C and Objective-C++
3113 (NOTE: This manual does not describe the Objective-C and Objective-C++
3114 languages themselves.  @xref{Standards,,Language Standards
3115 Supported by GCC}, for references.)
3117 This section describes the command-line options that are only meaningful
3118 for Objective-C and Objective-C++ programs.  You can also use most of
3119 the language-independent GNU compiler options.
3120 For example, you might compile a file @file{some_class.m} like this:
3122 @smallexample
3123 gcc -g -fgnu-runtime -O -c some_class.m
3124 @end smallexample
3126 @noindent
3127 In this example, @option{-fgnu-runtime} is an option meant only for
3128 Objective-C and Objective-C++ programs; you can use the other options with
3129 any language supported by GCC@.
3131 Note that since Objective-C is an extension of the C language, Objective-C
3132 compilations may also use options specific to the C front-end (e.g.,
3133 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3134 C++-specific options (e.g., @option{-Wabi}).
3136 Here is a list of options that are @emph{only} for compiling Objective-C
3137 and Objective-C++ programs:
3139 @table @gcctabopt
3140 @item -fconstant-string-class=@var{class-name}
3141 @opindex fconstant-string-class
3142 Use @var{class-name} as the name of the class to instantiate for each
3143 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3144 class name is @code{NXConstantString} if the GNU runtime is being used, and
3145 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3146 @option{-fconstant-cfstrings} option, if also present, overrides the
3147 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3148 to be laid out as constant CoreFoundation strings.
3150 @item -fgnu-runtime
3151 @opindex fgnu-runtime
3152 Generate object code compatible with the standard GNU Objective-C
3153 runtime.  This is the default for most types of systems.
3155 @item -fnext-runtime
3156 @opindex fnext-runtime
3157 Generate output compatible with the NeXT runtime.  This is the default
3158 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3159 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3160 used.
3162 @item -fno-nil-receivers
3163 @opindex fno-nil-receivers
3164 Assume that all Objective-C message dispatches (@code{[receiver
3165 message:arg]}) in this translation unit ensure that the receiver is
3166 not @code{nil}.  This allows for more efficient entry points in the
3167 runtime to be used.  This option is only available in conjunction with
3168 the NeXT runtime and ABI version 0 or 1.
3170 @item -fobjc-abi-version=@var{n}
3171 @opindex fobjc-abi-version
3172 Use version @var{n} of the Objective-C ABI for the selected runtime.
3173 This option is currently supported only for the NeXT runtime.  In that
3174 case, Version 0 is the traditional (32-bit) ABI without support for
3175 properties and other Objective-C 2.0 additions.  Version 1 is the
3176 traditional (32-bit) ABI with support for properties and other
3177 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3178 nothing is specified, the default is Version 0 on 32-bit target
3179 machines, and Version 2 on 64-bit target machines.
3181 @item -fobjc-call-cxx-cdtors
3182 @opindex fobjc-call-cxx-cdtors
3183 For each Objective-C class, check if any of its instance variables is a
3184 C++ object with a non-trivial default constructor.  If so, synthesize a
3185 special @code{- (id) .cxx_construct} instance method which runs
3186 non-trivial default constructors on any such instance variables, in order,
3187 and then return @code{self}.  Similarly, check if any instance variable
3188 is a C++ object with a non-trivial destructor, and if so, synthesize a
3189 special @code{- (void) .cxx_destruct} method which runs
3190 all such default destructors, in reverse order.
3192 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3193 methods thusly generated only operate on instance variables
3194 declared in the current Objective-C class, and not those inherited
3195 from superclasses.  It is the responsibility of the Objective-C
3196 runtime to invoke all such methods in an object's inheritance
3197 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3198 by the runtime immediately after a new object instance is allocated;
3199 the @code{- (void) .cxx_destruct} methods are invoked immediately
3200 before the runtime deallocates an object instance.
3202 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3203 support for invoking the @code{- (id) .cxx_construct} and
3204 @code{- (void) .cxx_destruct} methods.
3206 @item -fobjc-direct-dispatch
3207 @opindex fobjc-direct-dispatch
3208 Allow fast jumps to the message dispatcher.  On Darwin this is
3209 accomplished via the comm page.
3211 @item -fobjc-exceptions
3212 @opindex fobjc-exceptions
3213 Enable syntactic support for structured exception handling in
3214 Objective-C, similar to what is offered by C++.  This option
3215 is required to use the Objective-C keywords @code{@@try},
3216 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3217 @code{@@synchronized}.  This option is available with both the GNU
3218 runtime and the NeXT runtime (but not available in conjunction with
3219 the NeXT runtime on Mac OS X 10.2 and earlier).
3221 @item -fobjc-gc
3222 @opindex fobjc-gc
3223 Enable garbage collection (GC) in Objective-C and Objective-C++
3224 programs.  This option is only available with the NeXT runtime; the
3225 GNU runtime has a different garbage collection implementation that
3226 does not require special compiler flags.
3228 @item -fobjc-nilcheck
3229 @opindex fobjc-nilcheck
3230 For the NeXT runtime with version 2 of the ABI, check for a nil
3231 receiver in method invocations before doing the actual method call.
3232 This is the default and can be disabled using
3233 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3234 checked for nil in this way no matter what this flag is set to.
3235 Currently this flag does nothing when the GNU runtime, or an older
3236 version of the NeXT runtime ABI, is used.
3238 @item -fobjc-std=objc1
3239 @opindex fobjc-std
3240 Conform to the language syntax of Objective-C 1.0, the language
3241 recognized by GCC 4.0.  This only affects the Objective-C additions to
3242 the C/C++ language; it does not affect conformance to C/C++ standards,
3243 which is controlled by the separate C/C++ dialect option flags.  When
3244 this option is used with the Objective-C or Objective-C++ compiler,
3245 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3246 This is useful if you need to make sure that your Objective-C code can
3247 be compiled with older versions of GCC@.
3249 @item -freplace-objc-classes
3250 @opindex freplace-objc-classes
3251 Emit a special marker instructing @command{ld(1)} not to statically link in
3252 the resulting object file, and allow @command{dyld(1)} to load it in at
3253 run time instead.  This is used in conjunction with the Fix-and-Continue
3254 debugging mode, where the object file in question may be recompiled and
3255 dynamically reloaded in the course of program execution, without the need
3256 to restart the program itself.  Currently, Fix-and-Continue functionality
3257 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3258 and later.
3260 @item -fzero-link
3261 @opindex fzero-link
3262 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3263 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3264 compile time) with static class references that get initialized at load time,
3265 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3266 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3267 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3268 for individual class implementations to be modified during program execution.
3269 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3270 regardless of command-line options.
3272 @item -fno-local-ivars
3273 @opindex fno-local-ivars
3274 @opindex flocal-ivars
3275 By default instance variables in Objective-C can be accessed as if
3276 they were local variables from within the methods of the class they're
3277 declared in.  This can lead to shadowing between instance variables
3278 and other variables declared either locally inside a class method or
3279 globally with the same name.  Specifying the @option{-fno-local-ivars}
3280 flag disables this behavior thus avoiding variable shadowing issues.
3282 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3283 @opindex fivar-visibility
3284 Set the default instance variable visibility to the specified option
3285 so that instance variables declared outside the scope of any access
3286 modifier directives default to the specified visibility.
3288 @item -gen-decls
3289 @opindex gen-decls
3290 Dump interface declarations for all classes seen in the source file to a
3291 file named @file{@var{sourcename}.decl}.
3293 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3294 @opindex Wassign-intercept
3295 @opindex Wno-assign-intercept
3296 Warn whenever an Objective-C assignment is being intercepted by the
3297 garbage collector.
3299 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3300 @opindex Wno-protocol
3301 @opindex Wprotocol
3302 If a class is declared to implement a protocol, a warning is issued for
3303 every method in the protocol that is not implemented by the class.  The
3304 default behavior is to issue a warning for every method not explicitly
3305 implemented in the class, even if a method implementation is inherited
3306 from the superclass.  If you use the @option{-Wno-protocol} option, then
3307 methods inherited from the superclass are considered to be implemented,
3308 and no warning is issued for them.
3310 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3311 @opindex Wselector
3312 @opindex Wno-selector
3313 Warn if multiple methods of different types for the same selector are
3314 found during compilation.  The check is performed on the list of methods
3315 in the final stage of compilation.  Additionally, a check is performed
3316 for each selector appearing in a @code{@@selector(@dots{})}
3317 expression, and a corresponding method for that selector has been found
3318 during compilation.  Because these checks scan the method table only at
3319 the end of compilation, these warnings are not produced if the final
3320 stage of compilation is not reached, for example because an error is
3321 found during compilation, or because the @option{-fsyntax-only} option is
3322 being used.
3324 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3325 @opindex Wstrict-selector-match
3326 @opindex Wno-strict-selector-match
3327 Warn if multiple methods with differing argument and/or return types are
3328 found for a given selector when attempting to send a message using this
3329 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3330 is off (which is the default behavior), the compiler omits such warnings
3331 if any differences found are confined to types that share the same size
3332 and alignment.
3334 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3335 @opindex Wundeclared-selector
3336 @opindex Wno-undeclared-selector
3337 Warn if a @code{@@selector(@dots{})} expression referring to an
3338 undeclared selector is found.  A selector is considered undeclared if no
3339 method with that name has been declared before the
3340 @code{@@selector(@dots{})} expression, either explicitly in an
3341 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3342 an @code{@@implementation} section.  This option always performs its
3343 checks as soon as a @code{@@selector(@dots{})} expression is found,
3344 while @option{-Wselector} only performs its checks in the final stage of
3345 compilation.  This also enforces the coding style convention
3346 that methods and selectors must be declared before being used.
3348 @item -print-objc-runtime-info
3349 @opindex print-objc-runtime-info
3350 Generate C header describing the largest structure that is passed by
3351 value, if any.
3353 @end table
3355 @node Diagnostic Message Formatting Options
3356 @section Options to Control Diagnostic Messages Formatting
3357 @cindex options to control diagnostics formatting
3358 @cindex diagnostic messages
3359 @cindex message formatting
3361 Traditionally, diagnostic messages have been formatted irrespective of
3362 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3363 options described below
3364 to control the formatting algorithm for diagnostic messages, 
3365 e.g.@: how many characters per line, how often source location
3366 information should be reported.  Note that some language front ends may not
3367 honor these options.
3369 @table @gcctabopt
3370 @item -fmessage-length=@var{n}
3371 @opindex fmessage-length
3372 Try to format error messages so that they fit on lines of about
3373 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3374 done; each error message appears on a single line.  This is the
3375 default for all front ends.
3377 @item -fdiagnostics-show-location=once
3378 @opindex fdiagnostics-show-location
3379 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3380 reporter to emit source location information @emph{once}; that is, in
3381 case the message is too long to fit on a single physical line and has to
3382 be wrapped, the source location won't be emitted (as prefix) again,
3383 over and over, in subsequent continuation lines.  This is the default
3384 behavior.
3386 @item -fdiagnostics-show-location=every-line
3387 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3388 messages reporter to emit the same source location information (as
3389 prefix) for physical lines that result from the process of breaking
3390 a message which is too long to fit on a single line.
3392 @item -fdiagnostics-color[=@var{WHEN}]
3393 @itemx -fno-diagnostics-color
3394 @opindex fdiagnostics-color
3395 @cindex highlight, color
3396 @vindex GCC_COLORS @r{environment variable}
3397 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3398 or @samp{auto}.  The default depends on how the compiler has been configured,
3399 it can be any of the above @var{WHEN} options or also @samp{never}
3400 if @env{GCC_COLORS} environment variable isn't present in the environment,
3401 and @samp{auto} otherwise.
3402 @samp{auto} means to use color only when the standard error is a terminal.
3403 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3404 aliases for @option{-fdiagnostics-color=always} and
3405 @option{-fdiagnostics-color=never}, respectively.
3407 The colors are defined by the environment variable @env{GCC_COLORS}.
3408 Its value is a colon-separated list of capabilities and Select Graphic
3409 Rendition (SGR) substrings. SGR commands are interpreted by the
3410 terminal or terminal emulator.  (See the section in the documentation
3411 of your text terminal for permitted values and their meanings as
3412 character attributes.)  These substring values are integers in decimal
3413 representation and can be concatenated with semicolons.
3414 Common values to concatenate include
3415 @samp{1} for bold,
3416 @samp{4} for underline,
3417 @samp{5} for blink,
3418 @samp{7} for inverse,
3419 @samp{39} for default foreground color,
3420 @samp{30} to @samp{37} for foreground colors,
3421 @samp{90} to @samp{97} for 16-color mode foreground colors,
3422 @samp{38;5;0} to @samp{38;5;255}
3423 for 88-color and 256-color modes foreground colors,
3424 @samp{49} for default background color,
3425 @samp{40} to @samp{47} for background colors,
3426 @samp{100} to @samp{107} for 16-color mode background colors,
3427 and @samp{48;5;0} to @samp{48;5;255}
3428 for 88-color and 256-color modes background colors.
3430 The default @env{GCC_COLORS} is
3431 @smallexample
3432 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3433 quote=01:fixit-insert=32:fixit-delete=31:\
3434 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3435 @end smallexample
3436 @noindent
3437 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3438 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3439 @samp{01} is bold, and @samp{31} is red.
3440 Setting @env{GCC_COLORS} to the empty string disables colors.
3441 Supported capabilities are as follows.
3443 @table @code
3444 @item error=
3445 @vindex error GCC_COLORS @r{capability}
3446 SGR substring for error: markers.
3448 @item warning=
3449 @vindex warning GCC_COLORS @r{capability}
3450 SGR substring for warning: markers.
3452 @item note=
3453 @vindex note GCC_COLORS @r{capability}
3454 SGR substring for note: markers.
3456 @item range1=
3457 @vindex range1 GCC_COLORS @r{capability}
3458 SGR substring for first additional range.
3460 @item range2=
3461 @vindex range2 GCC_COLORS @r{capability}
3462 SGR substring for second additional range.
3464 @item locus=
3465 @vindex locus GCC_COLORS @r{capability}
3466 SGR substring for location information, @samp{file:line} or
3467 @samp{file:line:column} etc.
3469 @item quote=
3470 @vindex quote GCC_COLORS @r{capability}
3471 SGR substring for information printed within quotes.
3473 @item fixit-insert=
3474 @vindex fixit-insert GCC_COLORS @r{capability}
3475 SGR substring for fix-it hints suggesting text to
3476 be inserted or replaced.
3478 @item fixit-delete=
3479 @vindex fixit-delete GCC_COLORS @r{capability}
3480 SGR substring for fix-it hints suggesting text to
3481 be deleted.
3483 @item diff-filename=
3484 @vindex diff-filename GCC_COLORS @r{capability}
3485 SGR substring for filename headers within generated patches.
3487 @item diff-hunk=
3488 @vindex diff-hunk GCC_COLORS @r{capability}
3489 SGR substring for the starts of hunks within generated patches.
3491 @item diff-delete=
3492 @vindex diff-delete GCC_COLORS @r{capability}
3493 SGR substring for deleted lines within generated patches.
3495 @item diff-insert=
3496 @vindex diff-insert GCC_COLORS @r{capability}
3497 SGR substring for inserted lines within generated patches.
3498 @end table
3500 @item -fno-diagnostics-show-option
3501 @opindex fno-diagnostics-show-option
3502 @opindex fdiagnostics-show-option
3503 By default, each diagnostic emitted includes text indicating the
3504 command-line option that directly controls the diagnostic (if such an
3505 option is known to the diagnostic machinery).  Specifying the
3506 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3508 @item -fno-diagnostics-show-caret
3509 @opindex fno-diagnostics-show-caret
3510 @opindex fdiagnostics-show-caret
3511 By default, each diagnostic emitted includes the original source line
3512 and a caret @samp{^} indicating the column.  This option suppresses this
3513 information.  The source line is truncated to @var{n} characters, if
3514 the @option{-fmessage-length=n} option is given.  When the output is done
3515 to the terminal, the width is limited to the width given by the
3516 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3518 @item -fdiagnostics-parseable-fixits
3519 @opindex fdiagnostics-parseable-fixits
3520 Emit fix-it hints in a machine-parseable format, suitable for consumption
3521 by IDEs.  For each fix-it, a line will be printed after the relevant
3522 diagnostic, starting with the string ``fix-it:''.  For example:
3524 @smallexample
3525 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3526 @end smallexample
3528 The location is expressed as a half-open range, expressed as a count of
3529 bytes, starting at byte 1 for the initial column.  In the above example,
3530 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3531 given string:
3533 @smallexample
3534 00000000011111111112222222222
3535 12345678901234567890123456789
3536   gtk_widget_showall (dlg);
3537   ^^^^^^^^^^^^^^^^^^
3538   gtk_widget_show_all
3539 @end smallexample
3541 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3542 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3543 (e.g. vertical tab as ``\013'').
3545 An empty replacement string indicates that the given range is to be removed.
3546 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3547 be inserted at the given position.
3549 @item -fdiagnostics-generate-patch
3550 @opindex fdiagnostics-generate-patch
3551 Print fix-it hints to stderr in unified diff format, after any diagnostics
3552 are printed.  For example:
3554 @smallexample
3555 --- test.c
3556 +++ test.c
3557 @@ -42,5 +42,5 @@
3559  void show_cb(GtkDialog *dlg)
3560  @{
3561 -  gtk_widget_showall(dlg);
3562 +  gtk_widget_show_all(dlg);
3563  @}
3565 @end smallexample
3567 The diff may or may not be colorized, following the same rules
3568 as for diagnostics (see @option{-fdiagnostics-color}).
3570 @item -fno-show-column
3571 @opindex fno-show-column
3572 Do not print column numbers in diagnostics.  This may be necessary if
3573 diagnostics are being scanned by a program that does not understand the
3574 column numbers, such as @command{dejagnu}.
3576 @end table
3578 @node Warning Options
3579 @section Options to Request or Suppress Warnings
3580 @cindex options to control warnings
3581 @cindex warning messages
3582 @cindex messages, warning
3583 @cindex suppressing warnings
3585 Warnings are diagnostic messages that report constructions that
3586 are not inherently erroneous but that are risky or suggest there
3587 may have been an error.
3589 The following language-independent options do not enable specific
3590 warnings but control the kinds of diagnostics produced by GCC@.
3592 @table @gcctabopt
3593 @cindex syntax checking
3594 @item -fsyntax-only
3595 @opindex fsyntax-only
3596 Check the code for syntax errors, but don't do anything beyond that.
3598 @item -fmax-errors=@var{n}
3599 @opindex fmax-errors
3600 Limits the maximum number of error messages to @var{n}, at which point
3601 GCC bails out rather than attempting to continue processing the source
3602 code.  If @var{n} is 0 (the default), there is no limit on the number
3603 of error messages produced.  If @option{-Wfatal-errors} is also
3604 specified, then @option{-Wfatal-errors} takes precedence over this
3605 option.
3607 @item -w
3608 @opindex w
3609 Inhibit all warning messages.
3611 @item -Werror
3612 @opindex Werror
3613 @opindex Wno-error
3614 Make all warnings into errors.
3616 @item -Werror=
3617 @opindex Werror=
3618 @opindex Wno-error=
3619 Make the specified warning into an error.  The specifier for a warning
3620 is appended; for example @option{-Werror=switch} turns the warnings
3621 controlled by @option{-Wswitch} into errors.  This switch takes a
3622 negative form, to be used to negate @option{-Werror} for specific
3623 warnings; for example @option{-Wno-error=switch} makes
3624 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3625 is in effect.
3627 The warning message for each controllable warning includes the
3628 option that controls the warning.  That option can then be used with
3629 @option{-Werror=} and @option{-Wno-error=} as described above.
3630 (Printing of the option in the warning message can be disabled using the
3631 @option{-fno-diagnostics-show-option} flag.)
3633 Note that specifying @option{-Werror=}@var{foo} automatically implies
3634 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3635 imply anything.
3637 @item -Wfatal-errors
3638 @opindex Wfatal-errors
3639 @opindex Wno-fatal-errors
3640 This option causes the compiler to abort compilation on the first error
3641 occurred rather than trying to keep going and printing further error
3642 messages.
3644 @end table
3646 You can request many specific warnings with options beginning with
3647 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3648 implicit declarations.  Each of these specific warning options also
3649 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3650 example, @option{-Wno-implicit}.  This manual lists only one of the
3651 two forms, whichever is not the default.  For further
3652 language-specific options also refer to @ref{C++ Dialect Options} and
3653 @ref{Objective-C and Objective-C++ Dialect Options}.
3655 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3656 options, such as @option{-Wunused}, which may turn on further options,
3657 such as @option{-Wunused-value}. The combined effect of positive and
3658 negative forms is that more specific options have priority over less
3659 specific ones, independently of their position in the command-line. For
3660 options of the same specificity, the last one takes effect. Options
3661 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3662 as if they appeared at the end of the command-line.
3664 When an unrecognized warning option is requested (e.g.,
3665 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3666 that the option is not recognized.  However, if the @option{-Wno-} form
3667 is used, the behavior is slightly different: no diagnostic is
3668 produced for @option{-Wno-unknown-warning} unless other diagnostics
3669 are being produced.  This allows the use of new @option{-Wno-} options
3670 with old compilers, but if something goes wrong, the compiler
3671 warns that an unrecognized option is present.
3673 @table @gcctabopt
3674 @item -Wpedantic
3675 @itemx -pedantic
3676 @opindex pedantic
3677 @opindex Wpedantic
3678 Issue all the warnings demanded by strict ISO C and ISO C++;
3679 reject all programs that use forbidden extensions, and some other
3680 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3681 version of the ISO C standard specified by any @option{-std} option used.
3683 Valid ISO C and ISO C++ programs should compile properly with or without
3684 this option (though a rare few require @option{-ansi} or a
3685 @option{-std} option specifying the required version of ISO C)@.  However,
3686 without this option, certain GNU extensions and traditional C and C++
3687 features are supported as well.  With this option, they are rejected.
3689 @option{-Wpedantic} does not cause warning messages for use of the
3690 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3691 warnings are also disabled in the expression that follows
3692 @code{__extension__}.  However, only system header files should use
3693 these escape routes; application programs should avoid them.
3694 @xref{Alternate Keywords}.
3696 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3697 C conformance.  They soon find that it does not do quite what they want:
3698 it finds some non-ISO practices, but not all---only those for which
3699 ISO C @emph{requires} a diagnostic, and some others for which
3700 diagnostics have been added.
3702 A feature to report any failure to conform to ISO C might be useful in
3703 some instances, but would require considerable additional work and would
3704 be quite different from @option{-Wpedantic}.  We don't have plans to
3705 support such a feature in the near future.
3707 Where the standard specified with @option{-std} represents a GNU
3708 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3709 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3710 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3711 where they are required by the base standard.  (It does not make sense
3712 for such warnings to be given only for features not in the specified GNU
3713 C dialect, since by definition the GNU dialects of C include all
3714 features the compiler supports with the given option, and there would be
3715 nothing to warn about.)
3717 @item -pedantic-errors
3718 @opindex pedantic-errors
3719 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3720 requires a diagnostic, in some cases where there is undefined behavior
3721 at compile-time and in some other cases that do not prevent compilation
3722 of programs that are valid according to the standard. This is not
3723 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3724 by this option and not enabled by the latter and vice versa.
3726 @item -Wall
3727 @opindex Wall
3728 @opindex Wno-all
3729 This enables all the warnings about constructions that some users
3730 consider questionable, and that are easy to avoid (or modify to
3731 prevent the warning), even in conjunction with macros.  This also
3732 enables some language-specific warnings described in @ref{C++ Dialect
3733 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3735 @option{-Wall} turns on the following warning flags:
3737 @gccoptlist{-Waddress   @gol
3738 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3739 -Wbool-compare  @gol
3740 -Wbool-operation  @gol
3741 -Wc++11-compat  -Wc++14-compat  @gol
3742 -Wchar-subscripts  @gol
3743 -Wcomment  @gol
3744 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3745 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3746 -Wformat   @gol
3747 -Wint-in-bool-context  @gol
3748 -Wimplicit @r{(C and Objective-C only)} @gol
3749 -Wimplicit-int @r{(C and Objective-C only)} @gol
3750 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3751 -Winit-self @r{(only for C++)} @gol
3752 -Wlogical-not-parentheses @gol
3753 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3754 -Wmaybe-uninitialized @gol
3755 -Wmemset-elt-size @gol
3756 -Wmemset-transposed-args @gol
3757 -Wmisleading-indentation @r{(only for C/C++)} @gol
3758 -Wmissing-braces @r{(only for C/ObjC)} @gol
3759 -Wnarrowing @r{(only for C++)}  @gol
3760 -Wnonnull  @gol
3761 -Wnonnull-compare  @gol
3762 -Wopenmp-simd @gol
3763 -Wparentheses  @gol
3764 -Wpointer-sign  @gol
3765 -Wreorder   @gol
3766 -Wreturn-type  @gol
3767 -Wsequence-point  @gol
3768 -Wsign-compare @r{(only in C++)}  @gol
3769 -Wsizeof-pointer-memaccess @gol
3770 -Wstrict-aliasing  @gol
3771 -Wstrict-overflow=1  @gol
3772 -Wswitch  @gol
3773 -Wtautological-compare  @gol
3774 -Wtrigraphs  @gol
3775 -Wuninitialized  @gol
3776 -Wunknown-pragmas  @gol
3777 -Wunused-function  @gol
3778 -Wunused-label     @gol
3779 -Wunused-value     @gol
3780 -Wunused-variable  @gol
3781 -Wvolatile-register-var @gol
3784 Note that some warning flags are not implied by @option{-Wall}.  Some of
3785 them warn about constructions that users generally do not consider
3786 questionable, but which occasionally you might wish to check for;
3787 others warn about constructions that are necessary or hard to avoid in
3788 some cases, and there is no simple way to modify the code to suppress
3789 the warning. Some of them are enabled by @option{-Wextra} but many of
3790 them must be enabled individually.
3792 @item -Wextra
3793 @opindex W
3794 @opindex Wextra
3795 @opindex Wno-extra
3796 This enables some extra warning flags that are not enabled by
3797 @option{-Wall}. (This option used to be called @option{-W}.  The older
3798 name is still supported, but the newer name is more descriptive.)
3800 @gccoptlist{-Wclobbered  @gol
3801 -Wempty-body  @gol
3802 -Wignored-qualifiers @gol
3803 -Wimplicit-fallthrough=3 @gol
3804 -Wmissing-field-initializers  @gol
3805 -Wmissing-parameter-type @r{(C only)}  @gol
3806 -Wold-style-declaration @r{(C only)}  @gol
3807 -Woverride-init  @gol
3808 -Wsign-compare @r{(C only)} @gol
3809 -Wtype-limits  @gol
3810 -Wuninitialized  @gol
3811 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3812 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3813 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3816 The option @option{-Wextra} also prints warning messages for the
3817 following cases:
3819 @itemize @bullet
3821 @item
3822 A pointer is compared against integer zero with @code{<}, @code{<=},
3823 @code{>}, or @code{>=}.
3825 @item
3826 (C++ only) An enumerator and a non-enumerator both appear in a
3827 conditional expression.
3829 @item
3830 (C++ only) Ambiguous virtual bases.
3832 @item
3833 (C++ only) Subscripting an array that has been declared @code{register}.
3835 @item
3836 (C++ only) Taking the address of a variable that has been declared
3837 @code{register}.
3839 @item
3840 (C++ only) A base class is not initialized in the copy constructor
3841 of a derived class.
3843 @end itemize
3845 @item -Wchar-subscripts
3846 @opindex Wchar-subscripts
3847 @opindex Wno-char-subscripts
3848 Warn if an array subscript has type @code{char}.  This is a common cause
3849 of error, as programmers often forget that this type is signed on some
3850 machines.
3851 This warning is enabled by @option{-Wall}.
3853 @item -Wno-coverage-mismatch
3854 @opindex Wno-coverage-mismatch
3855 Warn if feedback profiles do not match when using the
3856 @option{-fprofile-use} option.
3857 If a source file is changed between compiling with @option{-fprofile-gen} and
3858 with @option{-fprofile-use}, the files with the profile feedback can fail
3859 to match the source file and GCC cannot use the profile feedback
3860 information.  By default, this warning is enabled and is treated as an
3861 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3862 warning or @option{-Wno-error=coverage-mismatch} can be used to
3863 disable the error.  Disabling the error for this warning can result in
3864 poorly optimized code and is useful only in the
3865 case of very minor changes such as bug fixes to an existing code-base.
3866 Completely disabling the warning is not recommended.
3868 @item -Wno-cpp
3869 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3871 Suppress warning messages emitted by @code{#warning} directives.
3873 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3874 @opindex Wdouble-promotion
3875 @opindex Wno-double-promotion
3876 Give a warning when a value of type @code{float} is implicitly
3877 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3878 floating-point unit implement @code{float} in hardware, but emulate
3879 @code{double} in software.  On such a machine, doing computations
3880 using @code{double} values is much more expensive because of the
3881 overhead required for software emulation.
3883 It is easy to accidentally do computations with @code{double} because
3884 floating-point literals are implicitly of type @code{double}.  For
3885 example, in:
3886 @smallexample
3887 @group
3888 float area(float radius)
3890    return 3.14159 * radius * radius;
3892 @end group
3893 @end smallexample
3894 the compiler performs the entire computation with @code{double}
3895 because the floating-point literal is a @code{double}.
3897 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3898 @opindex Wduplicate-decl-specifier
3899 @opindex Wno-duplicate-decl-specifier
3900 Warn if a declaration has duplicate @code{const}, @code{volatile},
3901 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3902 @option{-Wall}.
3904 @item -Wformat
3905 @itemx -Wformat=@var{n}
3906 @opindex Wformat
3907 @opindex Wno-format
3908 @opindex ffreestanding
3909 @opindex fno-builtin
3910 @opindex Wformat=
3911 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3912 the arguments supplied have types appropriate to the format string
3913 specified, and that the conversions specified in the format string make
3914 sense.  This includes standard functions, and others specified by format
3915 attributes (@pxref{Function Attributes}), in the @code{printf},
3916 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3917 not in the C standard) families (or other target-specific families).
3918 Which functions are checked without format attributes having been
3919 specified depends on the standard version selected, and such checks of
3920 functions without the attribute specified are disabled by
3921 @option{-ffreestanding} or @option{-fno-builtin}.
3923 The formats are checked against the format features supported by GNU
3924 libc version 2.2.  These include all ISO C90 and C99 features, as well
3925 as features from the Single Unix Specification and some BSD and GNU
3926 extensions.  Other library implementations may not support all these
3927 features; GCC does not support warning about features that go beyond a
3928 particular library's limitations.  However, if @option{-Wpedantic} is used
3929 with @option{-Wformat}, warnings are given about format features not
3930 in the selected standard version (but not for @code{strfmon} formats,
3931 since those are not in any version of the C standard).  @xref{C Dialect
3932 Options,,Options Controlling C Dialect}.
3934 @table @gcctabopt
3935 @item -Wformat=1
3936 @itemx -Wformat
3937 @opindex Wformat
3938 @opindex Wformat=1
3939 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3940 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3941 @option{-Wformat} also checks for null format arguments for several
3942 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3943 aspects of this level of format checking can be disabled by the
3944 options: @option{-Wno-format-contains-nul},
3945 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3946 @option{-Wformat} is enabled by @option{-Wall}.
3948 @item -Wno-format-contains-nul
3949 @opindex Wno-format-contains-nul
3950 @opindex Wformat-contains-nul
3951 If @option{-Wformat} is specified, do not warn about format strings that
3952 contain NUL bytes.
3954 @item -Wno-format-extra-args
3955 @opindex Wno-format-extra-args
3956 @opindex Wformat-extra-args
3957 If @option{-Wformat} is specified, do not warn about excess arguments to a
3958 @code{printf} or @code{scanf} format function.  The C standard specifies
3959 that such arguments are ignored.
3961 Where the unused arguments lie between used arguments that are
3962 specified with @samp{$} operand number specifications, normally
3963 warnings are still given, since the implementation could not know what
3964 type to pass to @code{va_arg} to skip the unused arguments.  However,
3965 in the case of @code{scanf} formats, this option suppresses the
3966 warning if the unused arguments are all pointers, since the Single
3967 Unix Specification says that such unused arguments are allowed.
3969 @item -Wformat-overflow
3970 @itemx -Wformat-overflow=@var{level}
3971 @opindex Wformat-overflow
3972 @opindex Wno-format-overflow
3973 Warn about calls to formatted input/output functions such as @code{sprintf}
3974 and @code{vsprintf} that might overflow the destination buffer.  When the
3975 exact number of bytes written by a format directive cannot be determined
3976 at compile-time it is estimated based on heuristics that depend on the
3977 @var{level} argument and on optimization.  While enabling optimization
3978 will in most cases improve the accuracy of the warning, it may also
3979 result in false positives.
3981 @table @gcctabopt
3982 @item -Wformat-overflow
3983 @item -Wformat-overflow=1
3984 @opindex Wformat-overflow
3985 @opindex Wno-format-overflow
3986 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
3987 employs a conservative approach that warns only about calls that most
3988 likely overflow the buffer.  At this level, numeric arguments to format
3989 directives with unknown values are assumed to have the value of one, and
3990 strings of unknown length to be empty.  Numeric arguments that are known
3991 to be bounded to a subrange of their type, or string arguments whose output
3992 is bounded either by their directive's precision or by a finite set of
3993 string literals, are assumed to take on the value within the range that
3994 results in the most bytes on output.  For example, the call to @code{sprintf}
3995 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
3996 the terminating NUL character (@code{'\0'}) appended by the function
3997 to the destination buffer will be written past its end.  Increasing
3998 the size of the buffer by a single byte is sufficient to avoid the
3999 warning, though it may not be sufficient to avoid the overflow.
4001 @smallexample
4002 void f (int a, int b)
4004   char buf [12];
4005   sprintf (buf, "a = %i, b = %i\n", a, b);
4007 @end smallexample
4009 @item -Wformat-overflow=2
4010 Level @var{2} warns also about calls that might overflow the destination
4011 buffer given an argument of sufficient length or magnitude.  At level
4012 @var{2}, unknown numeric arguments are assumed to have the minimum
4013 representable value for signed types with a precision greater than 1, and
4014 the maximum representable value otherwise.  Unknown string arguments whose
4015 length cannot be assumed to be bounded either by the directive's precision,
4016 or by a finite set of string literals they may evaluate to, or the character
4017 array they may point to, are assumed to be 1 character long.
4019 At level @var{2}, the call in the example above is again diagnosed, but
4020 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4021 @code{%i} directive will write some of its digits beyond the end of
4022 the destination buffer.  To make the call safe regardless of the values
4023 of the two variables, the size of the destination buffer must be increased
4024 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4025 an informational note following the warning.
4027 An alternative to increasing the size of the destination buffer is to
4028 constrain the range of formatted values.  The maximum length of string
4029 arguments can be bounded by specifying the precision in the format
4030 directive.  When numeric arguments of format directives can be assumed
4031 to be bounded by less than the precision of their type, choosing
4032 an appropriate length modifier to the format specifier will reduce
4033 the required buffer size.  For example, if @var{a} and @var{b} in the
4034 example above can be assumed to be within the precision of
4035 the @code{short int} type then using either the @code{%hi} format
4036 directive or casting the argument to @code{short} reduces the maximum
4037 required size of the buffer to 24 bytes.
4039 @smallexample
4040 void f (int a, int b)
4042   char buf [23];
4043   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4045 @end smallexample
4046 @end table
4048 @item -Wno-format-zero-length
4049 @opindex Wno-format-zero-length
4050 @opindex Wformat-zero-length
4051 If @option{-Wformat} is specified, do not warn about zero-length formats.
4052 The C standard specifies that zero-length formats are allowed.
4055 @item -Wformat=2
4056 @opindex Wformat=2
4057 Enable @option{-Wformat} plus additional format checks.  Currently
4058 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4059 -Wformat-y2k}.
4061 @item -Wformat-nonliteral
4062 @opindex Wformat-nonliteral
4063 @opindex Wno-format-nonliteral
4064 If @option{-Wformat} is specified, also warn if the format string is not a
4065 string literal and so cannot be checked, unless the format function
4066 takes its format arguments as a @code{va_list}.
4068 @item -Wformat-security
4069 @opindex Wformat-security
4070 @opindex Wno-format-security
4071 If @option{-Wformat} is specified, also warn about uses of format
4072 functions that represent possible security problems.  At present, this
4073 warns about calls to @code{printf} and @code{scanf} functions where the
4074 format string is not a string literal and there are no format arguments,
4075 as in @code{printf (foo);}.  This may be a security hole if the format
4076 string came from untrusted input and contains @samp{%n}.  (This is
4077 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4078 in future warnings may be added to @option{-Wformat-security} that are not
4079 included in @option{-Wformat-nonliteral}.)
4081 @item -Wformat-signedness
4082 @opindex Wformat-signedness
4083 @opindex Wno-format-signedness
4084 If @option{-Wformat} is specified, also warn if the format string
4085 requires an unsigned argument and the argument is signed and vice versa.
4087 @item -Wformat-truncation
4088 @itemx -Wformat-truncation=@var{level}
4089 @opindex Wformat-truncation
4090 @opindex Wno-format-truncation
4091 Warn about calls to formatted input/output functions such as @code{snprintf}
4092 and @code{vsnprintf} that might result in output truncation.  When the exact
4093 number of bytes written by a format directive cannot be determined at
4094 compile-time it is estimated based on heuristics that depend on
4095 the @var{level} argument and on optimization.  While enabling optimization
4096 will in most cases improve the accuracy of the warning, it may also result
4097 in false positives.  Except as noted otherwise, the option uses the same
4098 logic @option{-Wformat-overflow}.
4100 @table @gcctabopt
4101 @item -Wformat-truncation
4102 @item -Wformat-truncation=1
4103 @opindex Wformat-truncation
4104 @opindex Wno-format-overflow
4105 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4106 employs a conservative approach that warns only about calls to bounded
4107 functions whose return value is unused and that will most likely result
4108 in output truncatation.
4110 @item -Wformat-truncation=2
4111 Level @var{2} warns also about calls to bounded functions whose return
4112 value is used and that might result in truncation given an argument of
4113 sufficient length or magnitude.
4114 @end table
4116 @item -Wformat-y2k
4117 @opindex Wformat-y2k
4118 @opindex Wno-format-y2k
4119 If @option{-Wformat} is specified, also warn about @code{strftime}
4120 formats that may yield only a two-digit year.
4121 @end table
4123 @item -Wnonnull
4124 @opindex Wnonnull
4125 @opindex Wno-nonnull
4126 Warn about passing a null pointer for arguments marked as
4127 requiring a non-null value by the @code{nonnull} function attribute.
4129 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4130 can be disabled with the @option{-Wno-nonnull} option.
4132 @item -Wnonnull-compare
4133 @opindex Wnonnull-compare
4134 @opindex Wno-nonnull-compare
4135 Warn when comparing an argument marked with the @code{nonnull}
4136 function attribute against null inside the function.
4138 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4139 can be disabled with the @option{-Wno-nonnull-compare} option.
4141 @item -Wnull-dereference
4142 @opindex Wnull-dereference
4143 @opindex Wno-null-dereference
4144 Warn if the compiler detects paths that trigger erroneous or
4145 undefined behavior due to dereferencing a null pointer.  This option
4146 is only active when @option{-fdelete-null-pointer-checks} is active,
4147 which is enabled by optimizations in most targets.  The precision of
4148 the warnings depends on the optimization options used.
4150 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4151 @opindex Winit-self
4152 @opindex Wno-init-self
4153 Warn about uninitialized variables that are initialized with themselves.
4154 Note this option can only be used with the @option{-Wuninitialized} option.
4156 For example, GCC warns about @code{i} being uninitialized in the
4157 following snippet only when @option{-Winit-self} has been specified:
4158 @smallexample
4159 @group
4160 int f()
4162   int i = i;
4163   return i;
4165 @end group
4166 @end smallexample
4168 This warning is enabled by @option{-Wall} in C++.
4170 @item -Wimplicit-int @r{(C and Objective-C only)}
4171 @opindex Wimplicit-int
4172 @opindex Wno-implicit-int
4173 Warn when a declaration does not specify a type.
4174 This warning is enabled by @option{-Wall}.
4176 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4177 @opindex Wimplicit-function-declaration
4178 @opindex Wno-implicit-function-declaration
4179 Give a warning whenever a function is used before being declared. In
4180 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4181 enabled by default and it is made into an error by
4182 @option{-pedantic-errors}. This warning is also enabled by
4183 @option{-Wall}.
4185 @item -Wimplicit @r{(C and Objective-C only)}
4186 @opindex Wimplicit
4187 @opindex Wno-implicit
4188 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4189 This warning is enabled by @option{-Wall}.
4191 @item -Wimplicit-fallthrough
4192 @opindex Wimplicit-fallthrough
4193 @opindex Wno-implicit-fallthrough
4194 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4195 and @option{-Wno-implicit-fallthrough} is the same as
4196 @option{-Wimplicit-fallthrough=0}.
4198 @item -Wimplicit-fallthrough=@var{n}
4199 @opindex Wimplicit-fallthrough=
4200 Warn when a switch case falls through.  For example:
4202 @smallexample
4203 @group
4204 switch (cond)
4205   @{
4206   case 1:
4207     a = 1;
4208     break;
4209   case 2:
4210     a = 2;
4211   case 3:
4212     a = 3;
4213     break;
4214   @}
4215 @end group
4216 @end smallexample
4218 This warning does not warn when the last statement of a case cannot
4219 fall through, e.g. when there is a return statement or a call to function
4220 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4221 also takes into account control flow statements, such as ifs, and only
4222 warns when appropriate.  E.g.@:
4224 @smallexample
4225 @group
4226 switch (cond)
4227   @{
4228   case 1:
4229     if (i > 3) @{
4230       bar (5);
4231       break;
4232     @} else if (i < 1) @{
4233       bar (0);
4234     @} else
4235       return;
4236   default:
4237     @dots{}
4238   @}
4239 @end group
4240 @end smallexample
4242 Since there are occasions where a switch case fall through is desirable,
4243 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4244 to be used along with a null statement to suppress this warning that
4245 would normally occur:
4247 @smallexample
4248 @group
4249 switch (cond)
4250   @{
4251   case 1:
4252     bar (0);
4253     __attribute__ ((fallthrough));
4254   default:
4255     @dots{}
4256   @}
4257 @end group
4258 @end smallexample
4260 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4261 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4262 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4263 Instead of the these attributes, it is also possible to add a fallthrough
4264 comment to silence the warning.  The whole body of the C or C++ style comment
4265 should match the given regular expressions listed below.  The option argument
4266 @var{n} specifies what kind of comments are accepted:
4268 @itemize @bullet
4270 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4272 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4273 expression, any comment is used as fallthrough comment.
4275 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4276 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4278 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4279 following regular expressions:
4281 @itemize @bullet
4283 @item @code{-fallthrough}
4285 @item @code{@@fallthrough@@}
4287 @item @code{lint -fallthrough[ \t]*}
4289 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4291 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4293 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4295 @end itemize
4297 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4298 following regular expressions:
4300 @itemize @bullet
4302 @item @code{-fallthrough}
4304 @item @code{@@fallthrough@@}
4306 @item @code{lint -fallthrough[ \t]*}
4308 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4310 @end itemize
4312 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4313 fallthrough comments, only attributes disable the warning.
4315 @end itemize
4317 The comment needs to be followed after optional whitespace and other comments
4318 by @code{case} or @code{default} keywords or by a user label that preceeds some
4319 @code{case} or @code{default} label.
4321 @smallexample
4322 @group
4323 switch (cond)
4324   @{
4325   case 1:
4326     bar (0);
4327     /* FALLTHRU */
4328   default:
4329     @dots{}
4330   @}
4331 @end group
4332 @end smallexample
4334 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4336 @item -Wignored-qualifiers @r{(C and C++ only)}
4337 @opindex Wignored-qualifiers
4338 @opindex Wno-ignored-qualifiers
4339 Warn if the return type of a function has a type qualifier
4340 such as @code{const}.  For ISO C such a type qualifier has no effect,
4341 since the value returned by a function is not an lvalue.
4342 For C++, the warning is only emitted for scalar types or @code{void}.
4343 ISO C prohibits qualified @code{void} return types on function
4344 definitions, so such return types always receive a warning
4345 even without this option.
4347 This warning is also enabled by @option{-Wextra}.
4349 @item -Wignored-attributes @r{(C and C++ only)}
4350 @opindex Wignored-attributes
4351 @opindex Wno-ignored-attributes
4352 Warn when an attribute is ignored.  This is different from the
4353 @option{-Wattributes} option in that it warns whenever the compiler decides
4354 to drop an attribute, not that the attribute is either unknown, used in a
4355 wrong place, etc.  This warning is enabled by default.
4357 @item -Wmain
4358 @opindex Wmain
4359 @opindex Wno-main
4360 Warn if the type of @code{main} is suspicious.  @code{main} should be
4361 a function with external linkage, returning int, taking either zero
4362 arguments, two, or three arguments of appropriate types.  This warning
4363 is enabled by default in C++ and is enabled by either @option{-Wall}
4364 or @option{-Wpedantic}.
4366 @item -Wmisleading-indentation @r{(C and C++ only)}
4367 @opindex Wmisleading-indentation
4368 @opindex Wno-misleading-indentation
4369 Warn when the indentation of the code does not reflect the block structure.
4370 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4371 @code{for} clauses with a guarded statement that does not use braces,
4372 followed by an unguarded statement with the same indentation.
4374 In the following example, the call to ``bar'' is misleadingly indented as
4375 if it were guarded by the ``if'' conditional.
4377 @smallexample
4378   if (some_condition ())
4379     foo ();
4380     bar ();  /* Gotcha: this is not guarded by the "if".  */
4381 @end smallexample
4383 In the case of mixed tabs and spaces, the warning uses the
4384 @option{-ftabstop=} option to determine if the statements line up
4385 (defaulting to 8).
4387 The warning is not issued for code involving multiline preprocessor logic
4388 such as the following example.
4390 @smallexample
4391   if (flagA)
4392     foo (0);
4393 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4394   if (flagB)
4395 #endif
4396     foo (1);
4397 @end smallexample
4399 The warning is not issued after a @code{#line} directive, since this
4400 typically indicates autogenerated code, and no assumptions can be made
4401 about the layout of the file that the directive references.
4403 This warning is enabled by @option{-Wall} in C and C++.
4405 @item -Wmissing-braces
4406 @opindex Wmissing-braces
4407 @opindex Wno-missing-braces
4408 Warn if an aggregate or union initializer is not fully bracketed.  In
4409 the following example, the initializer for @code{a} is not fully
4410 bracketed, but that for @code{b} is fully bracketed.  This warning is
4411 enabled by @option{-Wall} in C.
4413 @smallexample
4414 int a[2][2] = @{ 0, 1, 2, 3 @};
4415 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4416 @end smallexample
4418 This warning is enabled by @option{-Wall}.
4420 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4421 @opindex Wmissing-include-dirs
4422 @opindex Wno-missing-include-dirs
4423 Warn if a user-supplied include directory does not exist.
4425 @item -Wparentheses
4426 @opindex Wparentheses
4427 @opindex Wno-parentheses
4428 Warn if parentheses are omitted in certain contexts, such
4429 as when there is an assignment in a context where a truth value
4430 is expected, or when operators are nested whose precedence people
4431 often get confused about.
4433 Also warn if a comparison like @code{x<=y<=z} appears; this is
4434 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4435 interpretation from that of ordinary mathematical notation.
4437 Also warn for dangerous uses of the GNU extension to
4438 @code{?:} with omitted middle operand. When the condition
4439 in the @code{?}: operator is a boolean expression, the omitted value is
4440 always 1.  Often programmers expect it to be a value computed
4441 inside the conditional expression instead.
4443 This warning is enabled by @option{-Wall}.
4445 @item -Wsequence-point
4446 @opindex Wsequence-point
4447 @opindex Wno-sequence-point
4448 Warn about code that may have undefined semantics because of violations
4449 of sequence point rules in the C and C++ standards.
4451 The C and C++ standards define the order in which expressions in a C/C++
4452 program are evaluated in terms of @dfn{sequence points}, which represent
4453 a partial ordering between the execution of parts of the program: those
4454 executed before the sequence point, and those executed after it.  These
4455 occur after the evaluation of a full expression (one which is not part
4456 of a larger expression), after the evaluation of the first operand of a
4457 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4458 function is called (but after the evaluation of its arguments and the
4459 expression denoting the called function), and in certain other places.
4460 Other than as expressed by the sequence point rules, the order of
4461 evaluation of subexpressions of an expression is not specified.  All
4462 these rules describe only a partial order rather than a total order,
4463 since, for example, if two functions are called within one expression
4464 with no sequence point between them, the order in which the functions
4465 are called is not specified.  However, the standards committee have
4466 ruled that function calls do not overlap.
4468 It is not specified when between sequence points modifications to the
4469 values of objects take effect.  Programs whose behavior depends on this
4470 have undefined behavior; the C and C++ standards specify that ``Between
4471 the previous and next sequence point an object shall have its stored
4472 value modified at most once by the evaluation of an expression.
4473 Furthermore, the prior value shall be read only to determine the value
4474 to be stored.''.  If a program breaks these rules, the results on any
4475 particular implementation are entirely unpredictable.
4477 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4478 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4479 diagnosed by this option, and it may give an occasional false positive
4480 result, but in general it has been found fairly effective at detecting
4481 this sort of problem in programs.
4483 The C++17 standard will define the order of evaluation of operands in
4484 more cases: in particular it requires that the right-hand side of an
4485 assignment be evaluated before the left-hand side, so the above
4486 examples are no longer undefined.  But this warning will still warn
4487 about them, to help people avoid writing code that is undefined in C
4488 and earlier revisions of C++.
4490 The standard is worded confusingly, therefore there is some debate
4491 over the precise meaning of the sequence point rules in subtle cases.
4492 Links to discussions of the problem, including proposed formal
4493 definitions, may be found on the GCC readings page, at
4494 @uref{http://gcc.gnu.org/@/readings.html}.
4496 This warning is enabled by @option{-Wall} for C and C++.
4498 @item -Wno-return-local-addr
4499 @opindex Wno-return-local-addr
4500 @opindex Wreturn-local-addr
4501 Do not warn about returning a pointer (or in C++, a reference) to a
4502 variable that goes out of scope after the function returns.
4504 @item -Wreturn-type
4505 @opindex Wreturn-type
4506 @opindex Wno-return-type
4507 Warn whenever a function is defined with a return type that defaults
4508 to @code{int}.  Also warn about any @code{return} statement with no
4509 return value in a function whose return type is not @code{void}
4510 (falling off the end of the function body is considered returning
4511 without a value).
4513 For C only, warn about a @code{return} statement with an expression in a
4514 function whose return type is @code{void}, unless the expression type is
4515 also @code{void}.  As a GNU extension, the latter case is accepted
4516 without a warning unless @option{-Wpedantic} is used.
4518 For C++, a function without return type always produces a diagnostic
4519 message, even when @option{-Wno-return-type} is specified.  The only
4520 exceptions are @code{main} and functions defined in system headers.
4522 This warning is enabled by @option{-Wall}.
4524 @item -Wshift-count-negative
4525 @opindex Wshift-count-negative
4526 @opindex Wno-shift-count-negative
4527 Warn if shift count is negative. This warning is enabled by default.
4529 @item -Wshift-count-overflow
4530 @opindex Wshift-count-overflow
4531 @opindex Wno-shift-count-overflow
4532 Warn if shift count >= width of type. This warning is enabled by default.
4534 @item -Wshift-negative-value
4535 @opindex Wshift-negative-value
4536 @opindex Wno-shift-negative-value
4537 Warn if left shifting a negative value.  This warning is enabled by
4538 @option{-Wextra} in C99 and C++11 modes (and newer).
4540 @item -Wshift-overflow
4541 @itemx -Wshift-overflow=@var{n}
4542 @opindex Wshift-overflow
4543 @opindex Wno-shift-overflow
4544 Warn about left shift overflows.  This warning is enabled by
4545 default in C99 and C++11 modes (and newer).
4547 @table @gcctabopt
4548 @item -Wshift-overflow=1
4549 This is the warning level of @option{-Wshift-overflow} and is enabled
4550 by default in C99 and C++11 modes (and newer).  This warning level does
4551 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4552 an overflow is still rejected in contexts where an integer constant expression
4553 is required.)
4555 @item -Wshift-overflow=2
4556 This warning level also warns about left-shifting 1 into the sign bit,
4557 unless C++14 mode is active.
4558 @end table
4560 @item -Wswitch
4561 @opindex Wswitch
4562 @opindex Wno-switch
4563 Warn whenever a @code{switch} statement has an index of enumerated type
4564 and lacks a @code{case} for one or more of the named codes of that
4565 enumeration.  (The presence of a @code{default} label prevents this
4566 warning.)  @code{case} labels outside the enumeration range also
4567 provoke warnings when this option is used (even if there is a
4568 @code{default} label).
4569 This warning is enabled by @option{-Wall}.
4571 @item -Wswitch-default
4572 @opindex Wswitch-default
4573 @opindex Wno-switch-default
4574 Warn whenever a @code{switch} statement does not have a @code{default}
4575 case.
4577 @item -Wswitch-enum
4578 @opindex Wswitch-enum
4579 @opindex Wno-switch-enum
4580 Warn whenever a @code{switch} statement has an index of enumerated type
4581 and lacks a @code{case} for one or more of the named codes of that
4582 enumeration.  @code{case} labels outside the enumeration range also
4583 provoke warnings when this option is used.  The only difference
4584 between @option{-Wswitch} and this option is that this option gives a
4585 warning about an omitted enumeration code even if there is a
4586 @code{default} label.
4588 @item -Wswitch-bool
4589 @opindex Wswitch-bool
4590 @opindex Wno-switch-bool
4591 Warn whenever a @code{switch} statement has an index of boolean type
4592 and the case values are outside the range of a boolean type.
4593 It is possible to suppress this warning by casting the controlling
4594 expression to a type other than @code{bool}.  For example:
4595 @smallexample
4596 @group
4597 switch ((int) (a == 4))
4598   @{
4599   @dots{}
4600   @}
4601 @end group
4602 @end smallexample
4603 This warning is enabled by default for C and C++ programs.
4605 @item -Wswitch-unreachable
4606 @opindex Wswitch-unreachable
4607 @opindex Wno-switch-unreachable
4608 Warn whenever a @code{switch} statement contains statements between the
4609 controlling expression and the first case label, which will never be
4610 executed.  For example:
4611 @smallexample
4612 @group
4613 switch (cond)
4614   @{
4615    i = 15;
4616   @dots{}
4617    case 5:
4618   @dots{}
4619   @}
4620 @end group
4621 @end smallexample
4622 @option{-Wswitch-unreachable} does not warn if the statement between the
4623 controlling expression and the first case label is just a declaration:
4624 @smallexample
4625 @group
4626 switch (cond)
4627   @{
4628    int i;
4629   @dots{}
4630    case 5:
4631    i = 5;
4632   @dots{}
4633   @}
4634 @end group
4635 @end smallexample
4636 This warning is enabled by default for C and C++ programs.
4638 @item -Wsync-nand @r{(C and C++ only)}
4639 @opindex Wsync-nand
4640 @opindex Wno-sync-nand
4641 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4642 built-in functions are used.  These functions changed semantics in GCC 4.4.
4644 @item -Wunused-but-set-parameter
4645 @opindex Wunused-but-set-parameter
4646 @opindex Wno-unused-but-set-parameter
4647 Warn whenever a function parameter is assigned to, but otherwise unused
4648 (aside from its declaration).
4650 To suppress this warning use the @code{unused} attribute
4651 (@pxref{Variable Attributes}).
4653 This warning is also enabled by @option{-Wunused} together with
4654 @option{-Wextra}.
4656 @item -Wunused-but-set-variable
4657 @opindex Wunused-but-set-variable
4658 @opindex Wno-unused-but-set-variable
4659 Warn whenever a local variable is assigned to, but otherwise unused
4660 (aside from its declaration).
4661 This warning is enabled by @option{-Wall}.
4663 To suppress this warning use the @code{unused} attribute
4664 (@pxref{Variable Attributes}).
4666 This warning is also enabled by @option{-Wunused}, which is enabled
4667 by @option{-Wall}.
4669 @item -Wunused-function
4670 @opindex Wunused-function
4671 @opindex Wno-unused-function
4672 Warn whenever a static function is declared but not defined or a
4673 non-inline static function is unused.
4674 This warning is enabled by @option{-Wall}.
4676 @item -Wunused-label
4677 @opindex Wunused-label
4678 @opindex Wno-unused-label
4679 Warn whenever a label is declared but not used.
4680 This warning is enabled by @option{-Wall}.
4682 To suppress this warning use the @code{unused} attribute
4683 (@pxref{Variable Attributes}).
4685 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4686 @opindex Wunused-local-typedefs
4687 Warn when a typedef locally defined in a function is not used.
4688 This warning is enabled by @option{-Wall}.
4690 @item -Wunused-parameter
4691 @opindex Wunused-parameter
4692 @opindex Wno-unused-parameter
4693 Warn whenever a function parameter is unused aside from its declaration.
4695 To suppress this warning use the @code{unused} attribute
4696 (@pxref{Variable Attributes}).
4698 @item -Wno-unused-result
4699 @opindex Wunused-result
4700 @opindex Wno-unused-result
4701 Do not warn if a caller of a function marked with attribute
4702 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4703 its return value. The default is @option{-Wunused-result}.
4705 @item -Wunused-variable
4706 @opindex Wunused-variable
4707 @opindex Wno-unused-variable
4708 Warn whenever a local or static variable is unused aside from its
4709 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4710 but not for C++. This warning is enabled by @option{-Wall}.
4712 To suppress this warning use the @code{unused} attribute
4713 (@pxref{Variable Attributes}).
4715 @item -Wunused-const-variable
4716 @itemx -Wunused-const-variable=@var{n}
4717 @opindex Wunused-const-variable
4718 @opindex Wno-unused-const-variable
4719 Warn whenever a constant static variable is unused aside from its declaration.
4720 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4721 for C, but not for C++. In C this declares variable storage, but in C++ this
4722 is not an error since const variables take the place of @code{#define}s.
4724 To suppress this warning use the @code{unused} attribute
4725 (@pxref{Variable Attributes}).
4727 @table @gcctabopt
4728 @item -Wunused-const-variable=1
4729 This is the warning level that is enabled by @option{-Wunused-variable} for
4730 C.  It warns only about unused static const variables defined in the main
4731 compilation unit, but not about static const variables declared in any
4732 header included.
4734 @item -Wunused-const-variable=2
4735 This warning level also warns for unused constant static variables in
4736 headers (excluding system headers).  This is the warning level of
4737 @option{-Wunused-const-variable} and must be explicitly requested since
4738 in C++ this isn't an error and in C it might be harder to clean up all
4739 headers included.
4740 @end table
4742 @item -Wunused-value
4743 @opindex Wunused-value
4744 @opindex Wno-unused-value
4745 Warn whenever a statement computes a result that is explicitly not
4746 used. To suppress this warning cast the unused expression to
4747 @code{void}. This includes an expression-statement or the left-hand
4748 side of a comma expression that contains no side effects. For example,
4749 an expression such as @code{x[i,j]} causes a warning, while
4750 @code{x[(void)i,j]} does not.
4752 This warning is enabled by @option{-Wall}.
4754 @item -Wunused
4755 @opindex Wunused
4756 @opindex Wno-unused
4757 All the above @option{-Wunused} options combined.
4759 In order to get a warning about an unused function parameter, you must
4760 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4761 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4763 @item -Wuninitialized
4764 @opindex Wuninitialized
4765 @opindex Wno-uninitialized
4766 Warn if an automatic variable is used without first being initialized
4767 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4768 warn if a non-static reference or non-static @code{const} member
4769 appears in a class without constructors.
4771 If you want to warn about code that uses the uninitialized value of the
4772 variable in its own initializer, use the @option{-Winit-self} option.
4774 These warnings occur for individual uninitialized or clobbered
4775 elements of structure, union or array variables as well as for
4776 variables that are uninitialized or clobbered as a whole.  They do
4777 not occur for variables or elements declared @code{volatile}.  Because
4778 these warnings depend on optimization, the exact variables or elements
4779 for which there are warnings depends on the precise optimization
4780 options and version of GCC used.
4782 Note that there may be no warning about a variable that is used only
4783 to compute a value that itself is never used, because such
4784 computations may be deleted by data flow analysis before the warnings
4785 are printed.
4787 @item -Winvalid-memory-model
4788 @opindex Winvalid-memory-model
4789 @opindex Wno-invalid-memory-model
4790 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4791 and the C11 atomic generic functions with a memory consistency argument
4792 that is either invalid for the operation or outside the range of values
4793 of the @code{memory_order} enumeration.  For example, since the
4794 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4795 defined for the relaxed, release, and sequentially consistent memory
4796 orders the following code is diagnosed:
4798 @smallexample
4799 void store (int *i)
4801   __atomic_store_n (i, 0, memory_order_consume);
4803 @end smallexample
4805 @option{-Winvalid-memory-model} is enabled by default.
4807 @item -Wmaybe-uninitialized
4808 @opindex Wmaybe-uninitialized
4809 @opindex Wno-maybe-uninitialized
4810 For an automatic variable, if there exists a path from the function
4811 entry to a use of the variable that is initialized, but there exist
4812 some other paths for which the variable is not initialized, the compiler
4813 emits a warning if it cannot prove the uninitialized paths are not
4814 executed at run time. These warnings are made optional because GCC is
4815 not smart enough to see all the reasons why the code might be correct
4816 in spite of appearing to have an error.  Here is one example of how
4817 this can happen:
4819 @smallexample
4820 @group
4822   int x;
4823   switch (y)
4824     @{
4825     case 1: x = 1;
4826       break;
4827     case 2: x = 4;
4828       break;
4829     case 3: x = 5;
4830     @}
4831   foo (x);
4833 @end group
4834 @end smallexample
4836 @noindent
4837 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4838 always initialized, but GCC doesn't know this. To suppress the
4839 warning, you need to provide a default case with assert(0) or
4840 similar code.
4842 @cindex @code{longjmp} warnings
4843 This option also warns when a non-volatile automatic variable might be
4844 changed by a call to @code{longjmp}.  These warnings as well are possible
4845 only in optimizing compilation.
4847 The compiler sees only the calls to @code{setjmp}.  It cannot know
4848 where @code{longjmp} will be called; in fact, a signal handler could
4849 call it at any point in the code.  As a result, you may get a warning
4850 even when there is in fact no problem because @code{longjmp} cannot
4851 in fact be called at the place that would cause a problem.
4853 Some spurious warnings can be avoided if you declare all the functions
4854 you use that never return as @code{noreturn}.  @xref{Function
4855 Attributes}.
4857 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4859 @item -Wunknown-pragmas
4860 @opindex Wunknown-pragmas
4861 @opindex Wno-unknown-pragmas
4862 @cindex warning for unknown pragmas
4863 @cindex unknown pragmas, warning
4864 @cindex pragmas, warning of unknown
4865 Warn when a @code{#pragma} directive is encountered that is not understood by 
4866 GCC@.  If this command-line option is used, warnings are even issued
4867 for unknown pragmas in system header files.  This is not the case if
4868 the warnings are only enabled by the @option{-Wall} command-line option.
4870 @item -Wno-pragmas
4871 @opindex Wno-pragmas
4872 @opindex Wpragmas
4873 Do not warn about misuses of pragmas, such as incorrect parameters,
4874 invalid syntax, or conflicts between pragmas.  See also
4875 @option{-Wunknown-pragmas}.
4877 @item -Wstrict-aliasing
4878 @opindex Wstrict-aliasing
4879 @opindex Wno-strict-aliasing
4880 This option is only active when @option{-fstrict-aliasing} is active.
4881 It warns about code that might break the strict aliasing rules that the
4882 compiler is using for optimization.  The warning does not catch all
4883 cases, but does attempt to catch the more common pitfalls.  It is
4884 included in @option{-Wall}.
4885 It is equivalent to @option{-Wstrict-aliasing=3}
4887 @item -Wstrict-aliasing=n
4888 @opindex Wstrict-aliasing=n
4889 This option is only active when @option{-fstrict-aliasing} is active.
4890 It warns about code that might break the strict aliasing rules that the
4891 compiler is using for optimization.
4892 Higher levels correspond to higher accuracy (fewer false positives).
4893 Higher levels also correspond to more effort, similar to the way @option{-O} 
4894 works.
4895 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4897 Level 1: Most aggressive, quick, least accurate.
4898 Possibly useful when higher levels
4899 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4900 false negatives.  However, it has many false positives.
4901 Warns for all pointer conversions between possibly incompatible types,
4902 even if never dereferenced.  Runs in the front end only.
4904 Level 2: Aggressive, quick, not too precise.
4905 May still have many false positives (not as many as level 1 though),
4906 and few false negatives (but possibly more than level 1).
4907 Unlike level 1, it only warns when an address is taken.  Warns about
4908 incomplete types.  Runs in the front end only.
4910 Level 3 (default for @option{-Wstrict-aliasing}):
4911 Should have very few false positives and few false
4912 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4913 Takes care of the common pun+dereference pattern in the front end:
4914 @code{*(int*)&some_float}.
4915 If optimization is enabled, it also runs in the back end, where it deals
4916 with multiple statement cases using flow-sensitive points-to information.
4917 Only warns when the converted pointer is dereferenced.
4918 Does not warn about incomplete types.
4920 @item -Wstrict-overflow
4921 @itemx -Wstrict-overflow=@var{n}
4922 @opindex Wstrict-overflow
4923 @opindex Wno-strict-overflow
4924 This option is only active when @option{-fstrict-overflow} is active.
4925 It warns about cases where the compiler optimizes based on the
4926 assumption that signed overflow does not occur.  Note that it does not
4927 warn about all cases where the code might overflow: it only warns
4928 about cases where the compiler implements some optimization.  Thus
4929 this warning depends on the optimization level.
4931 An optimization that assumes that signed overflow does not occur is
4932 perfectly safe if the values of the variables involved are such that
4933 overflow never does, in fact, occur.  Therefore this warning can
4934 easily give a false positive: a warning about code that is not
4935 actually a problem.  To help focus on important issues, several
4936 warning levels are defined.  No warnings are issued for the use of
4937 undefined signed overflow when estimating how many iterations a loop
4938 requires, in particular when determining whether a loop will be
4939 executed at all.
4941 @table @gcctabopt
4942 @item -Wstrict-overflow=1
4943 Warn about cases that are both questionable and easy to avoid.  For
4944 example,  with @option{-fstrict-overflow}, the compiler simplifies
4945 @code{x + 1 > x} to @code{1}.  This level of
4946 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4947 are not, and must be explicitly requested.
4949 @item -Wstrict-overflow=2
4950 Also warn about other cases where a comparison is simplified to a
4951 constant.  For example: @code{abs (x) >= 0}.  This can only be
4952 simplified when @option{-fstrict-overflow} is in effect, because
4953 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4954 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4955 @option{-Wstrict-overflow=2}.
4957 @item -Wstrict-overflow=3
4958 Also warn about other cases where a comparison is simplified.  For
4959 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4961 @item -Wstrict-overflow=4
4962 Also warn about other simplifications not covered by the above cases.
4963 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4965 @item -Wstrict-overflow=5
4966 Also warn about cases where the compiler reduces the magnitude of a
4967 constant involved in a comparison.  For example: @code{x + 2 > y} is
4968 simplified to @code{x + 1 >= y}.  This is reported only at the
4969 highest warning level because this simplification applies to many
4970 comparisons, so this warning level gives a very large number of
4971 false positives.
4972 @end table
4974 @item -Wstringop-overflow
4975 @itemx -Wstringop-overflow=@var{type}
4976 @opindex Wstringop-overflow
4977 @opindex Wno-stringop-overflow
4978 Warn for calls to string manipulation functions such as @code{memcpy} and
4979 @code{strcpy} that are determined to overflow the destination buffer.  The
4980 optional argument is one greater than the type of Object Size Checking to
4981 perform to determine the size of the destination.  @xref{Object Size Checking}.
4982 The argument is meaningful only for functions that operate on character arrays
4983 but not for raw memory functions like @code{memcpy} which always make use
4984 of Object Size type-0.  The option also warns for calls that specify a size
4985 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
4986 The option produces the best results with optimization enabled but can detect
4987 a small subset of simple buffer overflows even without optimization in
4988 calls to the GCC built-in functions like @code{__builtin_memcpy} that
4989 correspond to the standard functions.  In any case, the option warns about
4990 just a subset of buffer overflows detected by the corresponding overflow
4991 checking built-ins.  For example, the option will issue a warning for
4992 the @code{strcpy} call below because it copies at least 5 characters
4993 (the string @code{"blue"} including the terminating NUL) into the buffer
4994 of size 4.
4996 @smallexample
4997 enum Color @{ blue, purple, yellow @};
4998 const char* f (enum Color clr)
5000   static char buf [4];
5001   const char *str;
5002   switch (clr)
5003     @{
5004       case blue: str = "blue"; break;
5005       case purple: str = "purple"; break;
5006       case yellow: str = "yellow"; break;
5007     @}
5009   return strcpy (buf, str);   // warning here
5011 @end smallexample
5013 Option @option{-Wstringop-overflow=2} is enabled by default.
5015 @table @gcctabopt
5016 @item -Wstringop-overflow
5017 @item -Wstringop-overflow=1
5018 @opindex Wstringop-overflow
5019 @opindex Wno-stringop-overflow
5020 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5021 to determine the sizes of destination objects.  This is the default setting
5022 of the option.  At this setting the option will not warn for writes past
5023 the end of subobjects of larger objects accessed by pointers unless the
5024 size of the largest surrounding object is known.  When the destination may
5025 be one of several objects it is assumed to be the largest one of them.  On
5026 Linux systems, when optimization is enabled at this setting the option warns
5027 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5028 a non-zero value.
5030 @item -Wstringop-overflow=2
5031 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5032 to determine the sizes of destination objects.  At this setting the option
5033 will warn about overflows when writing to members of the largest complete
5034 objects whose exact size is known.  It will, however, not warn for excessive
5035 writes to the same members of unknown objects referenced by pointers since
5036 they may point to arrays containing unknown numbers of elements.
5038 @item -Wstringop-overflow=3
5039 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5040 to determine the sizes of destination objects.  At this setting the option
5041 warns about overflowing the smallest object or data member.  This is the
5042 most restrictive setting of the option that may result in warnings for safe
5043 code.
5045 @item -Wstringop-overflow=4
5046 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5047 to determine the sizes of destination objects.  At this setting the option
5048 will warn about overflowing any data members, and when the destination is
5049 one of several objects it uses the size of the largest of them to decide
5050 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5051 setting of the option may result in warnings for benign code.
5052 @end table
5054 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5055 @opindex Wsuggest-attribute=
5056 @opindex Wno-suggest-attribute=
5057 Warn for cases where adding an attribute may be beneficial. The
5058 attributes currently supported are listed below.
5060 @table @gcctabopt
5061 @item -Wsuggest-attribute=pure
5062 @itemx -Wsuggest-attribute=const
5063 @itemx -Wsuggest-attribute=noreturn
5064 @opindex Wsuggest-attribute=pure
5065 @opindex Wno-suggest-attribute=pure
5066 @opindex Wsuggest-attribute=const
5067 @opindex Wno-suggest-attribute=const
5068 @opindex Wsuggest-attribute=noreturn
5069 @opindex Wno-suggest-attribute=noreturn
5071 Warn about functions that might be candidates for attributes
5072 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5073 functions visible in other compilation units or (in the case of @code{pure} and
5074 @code{const}) if it cannot prove that the function returns normally. A function
5075 returns normally if it doesn't contain an infinite loop or return abnormally
5076 by throwing, calling @code{abort} or trapping.  This analysis requires option
5077 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5078 higher.  Higher optimization levels improve the accuracy of the analysis.
5080 @item -Wsuggest-attribute=format
5081 @itemx -Wmissing-format-attribute
5082 @opindex Wsuggest-attribute=format
5083 @opindex Wmissing-format-attribute
5084 @opindex Wno-suggest-attribute=format
5085 @opindex Wno-missing-format-attribute
5086 @opindex Wformat
5087 @opindex Wno-format
5089 Warn about function pointers that might be candidates for @code{format}
5090 attributes.  Note these are only possible candidates, not absolute ones.
5091 GCC guesses that function pointers with @code{format} attributes that
5092 are used in assignment, initialization, parameter passing or return
5093 statements should have a corresponding @code{format} attribute in the
5094 resulting type.  I.e.@: the left-hand side of the assignment or
5095 initialization, the type of the parameter variable, or the return type
5096 of the containing function respectively should also have a @code{format}
5097 attribute to avoid the warning.
5099 GCC also warns about function definitions that might be
5100 candidates for @code{format} attributes.  Again, these are only
5101 possible candidates.  GCC guesses that @code{format} attributes
5102 might be appropriate for any function that calls a function like
5103 @code{vprintf} or @code{vscanf}, but this might not always be the
5104 case, and some functions for which @code{format} attributes are
5105 appropriate may not be detected.
5106 @end table
5108 @item -Wsuggest-final-types
5109 @opindex Wno-suggest-final-types
5110 @opindex Wsuggest-final-types
5111 Warn about types with virtual methods where code quality would be improved
5112 if the type were declared with the C++11 @code{final} specifier, 
5113 or, if possible,
5114 declared in an anonymous namespace. This allows GCC to more aggressively
5115 devirtualize the polymorphic calls. This warning is more effective with link
5116 time optimization, where the information about the class hierarchy graph is
5117 more complete.
5119 @item -Wsuggest-final-methods
5120 @opindex Wno-suggest-final-methods
5121 @opindex Wsuggest-final-methods
5122 Warn about virtual methods where code quality would be improved if the method
5123 were declared with the C++11 @code{final} specifier, 
5124 or, if possible, its type were
5125 declared in an anonymous namespace or with the @code{final} specifier.
5126 This warning is
5127 more effective with link time optimization, where the information about the
5128 class hierarchy graph is more complete. It is recommended to first consider
5129 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5130 annotations.
5132 @item -Wsuggest-override
5133 Warn about overriding virtual functions that are not marked with the override
5134 keyword.
5136 @item -Walloc-zero
5137 @opindex Wno-alloc-zero
5138 @opindex Walloc-zero
5139 Warn about calls to allocation functions decorated with attribute
5140 @code{alloc_size} that specify zero bytes, including those to the built-in
5141 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5142 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5143 when called with a zero size differs among implementations (and in the case
5144 of @code{realloc} has been deprecated) relying on it may result in subtle
5145 portability bugs and should be avoided.
5147 @item -Walloc-size-larger-than=@var{n}
5148 Warn about calls to functions decorated with attribute @code{alloc_size}
5149 that attempt to allocate objects larger than the specified number of bytes,
5150 or where the result of the size computation in an integer type with infinite
5151 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5152 may end in one of the standard suffixes designating a multiple of bytes
5153 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5154 @code{MB} and @code{MiB} for magabyte and mebibyte, and so on.
5155 @xref{Function Attributes}.
5157 @item -Walloca
5158 @opindex Wno-alloca
5159 @opindex Walloca
5160 This option warns on all uses of @code{alloca} in the source.
5162 @item -Walloca-larger-than=@var{n}
5163 This option warns on calls to @code{alloca} that are not bounded by a
5164 controlling predicate limiting its argument of integer type to at most
5165 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5166 Arguments of non-integer types are considered unbounded even if they
5167 appear to be constrained to the expected range.
5169 For example, a bounded case of @code{alloca} could be:
5171 @smallexample
5172 void func (size_t n)
5174   void *p;
5175   if (n <= 1000)
5176     p = alloca (n);
5177   else
5178     p = malloc (n);
5179   f (p);
5181 @end smallexample
5183 In the above example, passing @code{-Walloca-larger-than=1000} would not
5184 issue a warning because the call to @code{alloca} is known to be at most
5185 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5186 the compiler would emit a warning.
5188 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5189 controlling predicate constraining its integer argument.  For example:
5191 @smallexample
5192 void func ()
5194   void *p = alloca (n);
5195   f (p);
5197 @end smallexample
5199 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5200 a warning, but this time because of the lack of bounds checking.
5202 Note, that even seemingly correct code involving signed integers could
5203 cause a warning:
5205 @smallexample
5206 void func (signed int n)
5208   if (n < 500)
5209     @{
5210       p = alloca (n);
5211       f (p);
5212     @}
5214 @end smallexample
5216 In the above example, @var{n} could be negative, causing a larger than
5217 expected argument to be implicitly cast into the @code{alloca} call.
5219 This option also warns when @code{alloca} is used in a loop.
5221 This warning is not enabled by @option{-Wall}, and is only active when
5222 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5224 See also @option{-Wvla-larger-than=@var{n}}.
5226 @item -Warray-bounds
5227 @itemx -Warray-bounds=@var{n}
5228 @opindex Wno-array-bounds
5229 @opindex Warray-bounds
5230 This option is only active when @option{-ftree-vrp} is active
5231 (default for @option{-O2} and above). It warns about subscripts to arrays
5232 that are always out of bounds. This warning is enabled by @option{-Wall}.
5234 @table @gcctabopt
5235 @item -Warray-bounds=1
5236 This is the warning level of @option{-Warray-bounds} and is enabled
5237 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5239 @item -Warray-bounds=2
5240 This warning level also warns about out of bounds access for
5241 arrays at the end of a struct and for arrays accessed through
5242 pointers. This warning level may give a larger number of
5243 false positives and is deactivated by default.
5244 @end table
5246 @item -Wbool-compare
5247 @opindex Wno-bool-compare
5248 @opindex Wbool-compare
5249 Warn about boolean expression compared with an integer value different from
5250 @code{true}/@code{false}.  For instance, the following comparison is
5251 always false:
5252 @smallexample
5253 int n = 5;
5254 @dots{}
5255 if ((n > 1) == 2) @{ @dots{} @}
5256 @end smallexample
5257 This warning is enabled by @option{-Wall}.
5259 @item -Wbool-operation
5260 @opindex Wno-bool-operation
5261 @opindex Wbool-operation
5262 Warn about suspicious operations on expressions of a boolean type.  For
5263 instance, bitwise negation of a boolean is very likely a bug in the program.
5264 For C, this warning also warns about incrementing or decrementing a boolean,
5265 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5266 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5268 This warning is enabled by @option{-Wall}.
5270 @item -Wduplicated-branches
5271 @opindex Wno-duplicated-branches
5272 @opindex Wduplicated-branches
5273 Warn when an if-else has identical branches.  This warning detects cases like
5274 @smallexample
5275 if (p != NULL)
5276   return 0;
5277 else
5278   return 0;
5279 @end smallexample
5280 It doesn't warn when both branches contain just a null statement.  This warning
5281 also warn for conditional operators:
5282 @smallexample
5283   int i = x ? *p : *p;
5284 @end smallexample
5286 @item -Wduplicated-cond
5287 @opindex Wno-duplicated-cond
5288 @opindex Wduplicated-cond
5289 Warn about duplicated conditions in an if-else-if chain.  For instance,
5290 warn for the following code:
5291 @smallexample
5292 if (p->q != NULL) @{ @dots{} @}
5293 else if (p->q != NULL) @{ @dots{} @}
5294 @end smallexample
5296 @item -Wframe-address
5297 @opindex Wno-frame-address
5298 @opindex Wframe-address
5299 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5300 is called with an argument greater than 0.  Such calls may return indeterminate
5301 values or crash the program.  The warning is included in @option{-Wall}.
5303 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5304 @opindex Wno-discarded-qualifiers
5305 @opindex Wdiscarded-qualifiers
5306 Do not warn if type qualifiers on pointers are being discarded.
5307 Typically, the compiler warns if a @code{const char *} variable is
5308 passed to a function that takes a @code{char *} parameter.  This option
5309 can be used to suppress such a warning.
5311 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5312 @opindex Wno-discarded-array-qualifiers
5313 @opindex Wdiscarded-array-qualifiers
5314 Do not warn if type qualifiers on arrays which are pointer targets
5315 are being discarded. Typically, the compiler warns if a
5316 @code{const int (*)[]} variable is passed to a function that
5317 takes a @code{int (*)[]} parameter.  This option can be used to
5318 suppress such a warning.
5320 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5321 @opindex Wno-incompatible-pointer-types
5322 @opindex Wincompatible-pointer-types
5323 Do not warn when there is a conversion between pointers that have incompatible
5324 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5325 which warns for pointer argument passing or assignment with different
5326 signedness.
5328 @item -Wno-int-conversion @r{(C and Objective-C only)}
5329 @opindex Wno-int-conversion
5330 @opindex Wint-conversion
5331 Do not warn about incompatible integer to pointer and pointer to integer
5332 conversions.  This warning is about implicit conversions; for explicit
5333 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5334 @option{-Wno-pointer-to-int-cast} may be used.
5336 @item -Wno-div-by-zero
5337 @opindex Wno-div-by-zero
5338 @opindex Wdiv-by-zero
5339 Do not warn about compile-time integer division by zero.  Floating-point
5340 division by zero is not warned about, as it can be a legitimate way of
5341 obtaining infinities and NaNs.
5343 @item -Wsystem-headers
5344 @opindex Wsystem-headers
5345 @opindex Wno-system-headers
5346 @cindex warnings from system headers
5347 @cindex system headers, warnings from
5348 Print warning messages for constructs found in system header files.
5349 Warnings from system headers are normally suppressed, on the assumption
5350 that they usually do not indicate real problems and would only make the
5351 compiler output harder to read.  Using this command-line option tells
5352 GCC to emit warnings from system headers as if they occurred in user
5353 code.  However, note that using @option{-Wall} in conjunction with this
5354 option does @emph{not} warn about unknown pragmas in system
5355 headers---for that, @option{-Wunknown-pragmas} must also be used.
5357 @item -Wtautological-compare
5358 @opindex Wtautological-compare
5359 @opindex Wno-tautological-compare
5360 Warn if a self-comparison always evaluates to true or false.  This
5361 warning detects various mistakes such as:
5362 @smallexample
5363 int i = 1;
5364 @dots{}
5365 if (i > i) @{ @dots{} @}
5366 @end smallexample
5367 This warning is enabled by @option{-Wall}.
5369 @item -Wtrampolines
5370 @opindex Wtrampolines
5371 @opindex Wno-trampolines
5372 Warn about trampolines generated for pointers to nested functions.
5373 A trampoline is a small piece of data or code that is created at run
5374 time on the stack when the address of a nested function is taken, and is
5375 used to call the nested function indirectly.  For some targets, it is
5376 made up of data only and thus requires no special treatment.  But, for
5377 most targets, it is made up of code and thus requires the stack to be
5378 made executable in order for the program to work properly.
5380 @item -Wfloat-equal
5381 @opindex Wfloat-equal
5382 @opindex Wno-float-equal
5383 Warn if floating-point values are used in equality comparisons.
5385 The idea behind this is that sometimes it is convenient (for the
5386 programmer) to consider floating-point values as approximations to
5387 infinitely precise real numbers.  If you are doing this, then you need
5388 to compute (by analyzing the code, or in some other way) the maximum or
5389 likely maximum error that the computation introduces, and allow for it
5390 when performing comparisons (and when producing output, but that's a
5391 different problem).  In particular, instead of testing for equality, you
5392 should check to see whether the two values have ranges that overlap; and
5393 this is done with the relational operators, so equality comparisons are
5394 probably mistaken.
5396 @item -Wtraditional @r{(C and Objective-C only)}
5397 @opindex Wtraditional
5398 @opindex Wno-traditional
5399 Warn about certain constructs that behave differently in traditional and
5400 ISO C@.  Also warn about ISO C constructs that have no traditional C
5401 equivalent, and/or problematic constructs that should be avoided.
5403 @itemize @bullet
5404 @item
5405 Macro parameters that appear within string literals in the macro body.
5406 In traditional C macro replacement takes place within string literals,
5407 but in ISO C it does not.
5409 @item
5410 In traditional C, some preprocessor directives did not exist.
5411 Traditional preprocessors only considered a line to be a directive
5412 if the @samp{#} appeared in column 1 on the line.  Therefore
5413 @option{-Wtraditional} warns about directives that traditional C
5414 understands but ignores because the @samp{#} does not appear as the
5415 first character on the line.  It also suggests you hide directives like
5416 @code{#pragma} not understood by traditional C by indenting them.  Some
5417 traditional implementations do not recognize @code{#elif}, so this option
5418 suggests avoiding it altogether.
5420 @item
5421 A function-like macro that appears without arguments.
5423 @item
5424 The unary plus operator.
5426 @item
5427 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5428 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5429 constants.)  Note, these suffixes appear in macros defined in the system
5430 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5431 Use of these macros in user code might normally lead to spurious
5432 warnings, however GCC's integrated preprocessor has enough context to
5433 avoid warning in these cases.
5435 @item
5436 A function declared external in one block and then used after the end of
5437 the block.
5439 @item
5440 A @code{switch} statement has an operand of type @code{long}.
5442 @item
5443 A non-@code{static} function declaration follows a @code{static} one.
5444 This construct is not accepted by some traditional C compilers.
5446 @item
5447 The ISO type of an integer constant has a different width or
5448 signedness from its traditional type.  This warning is only issued if
5449 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5450 typically represent bit patterns, are not warned about.
5452 @item
5453 Usage of ISO string concatenation is detected.
5455 @item
5456 Initialization of automatic aggregates.
5458 @item
5459 Identifier conflicts with labels.  Traditional C lacks a separate
5460 namespace for labels.
5462 @item
5463 Initialization of unions.  If the initializer is zero, the warning is
5464 omitted.  This is done under the assumption that the zero initializer in
5465 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5466 initializer warnings and relies on default initialization to zero in the
5467 traditional C case.
5469 @item
5470 Conversions by prototypes between fixed/floating-point values and vice
5471 versa.  The absence of these prototypes when compiling with traditional
5472 C causes serious problems.  This is a subset of the possible
5473 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5475 @item
5476 Use of ISO C style function definitions.  This warning intentionally is
5477 @emph{not} issued for prototype declarations or variadic functions
5478 because these ISO C features appear in your code when using
5479 libiberty's traditional C compatibility macros, @code{PARAMS} and
5480 @code{VPARAMS}.  This warning is also bypassed for nested functions
5481 because that feature is already a GCC extension and thus not relevant to
5482 traditional C compatibility.
5483 @end itemize
5485 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5486 @opindex Wtraditional-conversion
5487 @opindex Wno-traditional-conversion
5488 Warn if a prototype causes a type conversion that is different from what
5489 would happen to the same argument in the absence of a prototype.  This
5490 includes conversions of fixed point to floating and vice versa, and
5491 conversions changing the width or signedness of a fixed-point argument
5492 except when the same as the default promotion.
5494 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5495 @opindex Wdeclaration-after-statement
5496 @opindex Wno-declaration-after-statement
5497 Warn when a declaration is found after a statement in a block.  This
5498 construct, known from C++, was introduced with ISO C99 and is by default
5499 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5501 @item -Wshadow
5502 @opindex Wshadow
5503 @opindex Wno-shadow
5504 Warn whenever a local variable or type declaration shadows another
5505 variable, parameter, type, class member (in C++), or instance variable
5506 (in Objective-C) or whenever a built-in function is shadowed. Note
5507 that in C++, the compiler warns if a local variable shadows an
5508 explicit typedef, but not if it shadows a struct/class/enum.
5509 Same as @option{-Wshadow=global}.
5511 @item -Wno-shadow-ivar @r{(Objective-C only)}
5512 @opindex Wno-shadow-ivar
5513 @opindex Wshadow-ivar
5514 Do not warn whenever a local variable shadows an instance variable in an
5515 Objective-C method.
5517 @item -Wshadow=global
5518 @opindex Wshadow=local
5519 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5521 @item -Wshadow=local
5522 @opindex Wshadow=local
5523 Warn when a local variable shadows another local variable or parameter.
5524 This warning is enabled by @option{-Wshadow=global}.
5526 @item -Wshadow=compatible-local
5527 @opindex Wshadow=compatible-local
5528 Warn when a local variable shadows another local variable or parameter
5529 whose type is compatible with that of the shadowing variable. In C++,
5530 type compatibility here means the type of the shadowing variable can be
5531 converted to that of the shadowed variable. The creation of this flag
5532 (in addition to @option{-Wshadow=local}) is based on the idea that when
5533 a local variable shadows another one of incompatible type, it is most
5534 likely intentional, not a bug or typo, as shown in the following example:
5536 @smallexample
5537 @group
5538 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5540   for (int i = 0; i < N; ++i)
5541   @{
5542     ...
5543   @}
5544   ...
5546 @end group
5547 @end smallexample
5549 Since the two variable @code{i} in the example above have incompatible types,
5550 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5551 Because their types are incompatible, if a programmer accidentally uses one
5552 in place of the other, type checking will catch that and emit an error or
5553 warning. So not warning (about shadowing) in this case will not lead to
5554 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5555 possibly reduce the number of warnings triggered by intentional shadowing.
5557 This warning is enabled by @option{-Wshadow=local}.
5559 @item -Wlarger-than=@var{len}
5560 @opindex Wlarger-than=@var{len}
5561 @opindex Wlarger-than-@var{len}
5562 Warn whenever an object of larger than @var{len} bytes is defined.
5564 @item -Wframe-larger-than=@var{len}
5565 @opindex Wframe-larger-than
5566 Warn if the size of a function frame is larger than @var{len} bytes.
5567 The computation done to determine the stack frame size is approximate
5568 and not conservative.
5569 The actual requirements may be somewhat greater than @var{len}
5570 even if you do not get a warning.  In addition, any space allocated
5571 via @code{alloca}, variable-length arrays, or related constructs
5572 is not included by the compiler when determining
5573 whether or not to issue a warning.
5575 @item -Wno-free-nonheap-object
5576 @opindex Wno-free-nonheap-object
5577 @opindex Wfree-nonheap-object
5578 Do not warn when attempting to free an object that was not allocated
5579 on the heap.
5581 @item -Wstack-usage=@var{len}
5582 @opindex Wstack-usage
5583 Warn if the stack usage of a function might be larger than @var{len} bytes.
5584 The computation done to determine the stack usage is conservative.
5585 Any space allocated via @code{alloca}, variable-length arrays, or related
5586 constructs is included by the compiler when determining whether or not to
5587 issue a warning.
5589 The message is in keeping with the output of @option{-fstack-usage}.
5591 @itemize
5592 @item
5593 If the stack usage is fully static but exceeds the specified amount, it's:
5595 @smallexample
5596   warning: stack usage is 1120 bytes
5597 @end smallexample
5598 @item
5599 If the stack usage is (partly) dynamic but bounded, it's:
5601 @smallexample
5602   warning: stack usage might be 1648 bytes
5603 @end smallexample
5604 @item
5605 If the stack usage is (partly) dynamic and not bounded, it's:
5607 @smallexample
5608   warning: stack usage might be unbounded
5609 @end smallexample
5610 @end itemize
5612 @item -Wunsafe-loop-optimizations
5613 @opindex Wunsafe-loop-optimizations
5614 @opindex Wno-unsafe-loop-optimizations
5615 Warn if the loop cannot be optimized because the compiler cannot
5616 assume anything on the bounds of the loop indices.  With
5617 @option{-funsafe-loop-optimizations} warn if the compiler makes
5618 such assumptions.
5620 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5621 @opindex Wno-pedantic-ms-format
5622 @opindex Wpedantic-ms-format
5623 When used in combination with @option{-Wformat}
5624 and @option{-pedantic} without GNU extensions, this option
5625 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5626 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5627 which depend on the MS runtime.
5629 @item -Waligned-new
5630 @opindex Waligned-new
5631 @opindex Wno-aligned-new
5632 Warn about a new-expression of a type that requires greater alignment
5633 than the @code{alignof(std::max_align_t)} but uses an allocation
5634 function without an explicit alignment parameter. This option is
5635 enabled by @option{-Wall}.
5637 Normally this only warns about global allocation functions, but
5638 @option{-Waligned-new=all} also warns about class member allocation
5639 functions.
5641 @item -Wplacement-new
5642 @itemx -Wplacement-new=@var{n}
5643 @opindex Wplacement-new
5644 @opindex Wno-placement-new
5645 Warn about placement new expressions with undefined behavior, such as
5646 constructing an object in a buffer that is smaller than the type of
5647 the object.  For example, the placement new expression below is diagnosed
5648 because it attempts to construct an array of 64 integers in a buffer only
5649 64 bytes large.
5650 @smallexample
5651 char buf [64];
5652 new (buf) int[64];
5653 @end smallexample
5654 This warning is enabled by default.
5656 @table @gcctabopt
5657 @item -Wplacement-new=1
5658 This is the default warning level of @option{-Wplacement-new}.  At this
5659 level the warning is not issued for some strictly undefined constructs that
5660 GCC allows as extensions for compatibility with legacy code.  For example,
5661 the following @code{new} expression is not diagnosed at this level even
5662 though it has undefined behavior according to the C++ standard because
5663 it writes past the end of the one-element array.
5664 @smallexample
5665 struct S @{ int n, a[1]; @};
5666 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5667 new (s->a)int [32]();
5668 @end smallexample
5670 @item -Wplacement-new=2
5671 At this level, in addition to diagnosing all the same constructs as at level
5672 1, a diagnostic is also issued for placement new expressions that construct
5673 an object in the last member of structure whose type is an array of a single
5674 element and whose size is less than the size of the object being constructed.
5675 While the previous example would be diagnosed, the following construct makes
5676 use of the flexible member array extension to avoid the warning at level 2.
5677 @smallexample
5678 struct S @{ int n, a[]; @};
5679 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5680 new (s->a)int [32]();
5681 @end smallexample
5683 @end table
5685 @item -Wpointer-arith
5686 @opindex Wpointer-arith
5687 @opindex Wno-pointer-arith
5688 Warn about anything that depends on the ``size of'' a function type or
5689 of @code{void}.  GNU C assigns these types a size of 1, for
5690 convenience in calculations with @code{void *} pointers and pointers
5691 to functions.  In C++, warn also when an arithmetic operation involves
5692 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5694 @item -Wpointer-compare
5695 @opindex Wpointer-compare
5696 @opindex Wno-pointer-compare
5697 Warn if a pointer is compared with a zero character constant.  This usually
5698 means that the pointer was meant to be dereferenced.  For example:
5700 @smallexample
5701 const char *p = foo ();
5702 if (p == '\0')
5703   return 42;
5704 @end smallexample
5706 Note that the code above is invalid in C++11.
5708 This warning is enabled by default.
5710 @item -Wtype-limits
5711 @opindex Wtype-limits
5712 @opindex Wno-type-limits
5713 Warn if a comparison is always true or always false due to the limited
5714 range of the data type, but do not warn for constant expressions.  For
5715 example, warn if an unsigned variable is compared against zero with
5716 @code{<} or @code{>=}.  This warning is also enabled by
5717 @option{-Wextra}.
5719 @include cppwarnopts.texi
5721 @item -Wbad-function-cast @r{(C and Objective-C only)}
5722 @opindex Wbad-function-cast
5723 @opindex Wno-bad-function-cast
5724 Warn when a function call is cast to a non-matching type.
5725 For example, warn if a call to a function returning an integer type 
5726 is cast to a pointer type.
5728 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5729 @opindex Wc90-c99-compat
5730 @opindex Wno-c90-c99-compat
5731 Warn about features not present in ISO C90, but present in ISO C99.
5732 For instance, warn about use of variable length arrays, @code{long long}
5733 type, @code{bool} type, compound literals, designated initializers, and so
5734 on.  This option is independent of the standards mode.  Warnings are disabled
5735 in the expression that follows @code{__extension__}.
5737 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5738 @opindex Wc99-c11-compat
5739 @opindex Wno-c99-c11-compat
5740 Warn about features not present in ISO C99, but present in ISO C11.
5741 For instance, warn about use of anonymous structures and unions,
5742 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5743 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5744 and so on.  This option is independent of the standards mode.  Warnings are
5745 disabled in the expression that follows @code{__extension__}.
5747 @item -Wc++-compat @r{(C and Objective-C only)}
5748 @opindex Wc++-compat
5749 Warn about ISO C constructs that are outside of the common subset of
5750 ISO C and ISO C++, e.g.@: request for implicit conversion from
5751 @code{void *} to a pointer to non-@code{void} type.
5753 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5754 @opindex Wc++11-compat
5755 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5756 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5757 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5758 enabled by @option{-Wall}.
5760 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5761 @opindex Wc++14-compat
5762 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5763 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5765 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5766 @opindex Wc++1z-compat
5767 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5768 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5770 @item -Wcast-qual
5771 @opindex Wcast-qual
5772 @opindex Wno-cast-qual
5773 Warn whenever a pointer is cast so as to remove a type qualifier from
5774 the target type.  For example, warn if a @code{const char *} is cast
5775 to an ordinary @code{char *}.
5777 Also warn when making a cast that introduces a type qualifier in an
5778 unsafe way.  For example, casting @code{char **} to @code{const char **}
5779 is unsafe, as in this example:
5781 @smallexample
5782   /* p is char ** value.  */
5783   const char **q = (const char **) p;
5784   /* Assignment of readonly string to const char * is OK.  */
5785   *q = "string";
5786   /* Now char** pointer points to read-only memory.  */
5787   **p = 'b';
5788 @end smallexample
5790 @item -Wcast-align
5791 @opindex Wcast-align
5792 @opindex Wno-cast-align
5793 Warn whenever a pointer is cast such that the required alignment of the
5794 target is increased.  For example, warn if a @code{char *} is cast to
5795 an @code{int *} on machines where integers can only be accessed at
5796 two- or four-byte boundaries.
5798 @item -Wwrite-strings
5799 @opindex Wwrite-strings
5800 @opindex Wno-write-strings
5801 When compiling C, give string constants the type @code{const
5802 char[@var{length}]} so that copying the address of one into a
5803 non-@code{const} @code{char *} pointer produces a warning.  These
5804 warnings help you find at compile time code that can try to write
5805 into a string constant, but only if you have been very careful about
5806 using @code{const} in declarations and prototypes.  Otherwise, it is
5807 just a nuisance. This is why we did not make @option{-Wall} request
5808 these warnings.
5810 When compiling C++, warn about the deprecated conversion from string
5811 literals to @code{char *}.  This warning is enabled by default for C++
5812 programs.
5814 @item -Wclobbered
5815 @opindex Wclobbered
5816 @opindex Wno-clobbered
5817 Warn for variables that might be changed by @code{longjmp} or
5818 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5820 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5821 @opindex Wconditionally-supported
5822 @opindex Wno-conditionally-supported
5823 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5825 @item -Wconversion
5826 @opindex Wconversion
5827 @opindex Wno-conversion
5828 Warn for implicit conversions that may alter a value. This includes
5829 conversions between real and integer, like @code{abs (x)} when
5830 @code{x} is @code{double}; conversions between signed and unsigned,
5831 like @code{unsigned ui = -1}; and conversions to smaller types, like
5832 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5833 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5834 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5835 conversions between signed and unsigned integers can be disabled by
5836 using @option{-Wno-sign-conversion}.
5838 For C++, also warn for confusing overload resolution for user-defined
5839 conversions; and conversions that never use a type conversion
5840 operator: conversions to @code{void}, the same type, a base class or a
5841 reference to them. Warnings about conversions between signed and
5842 unsigned integers are disabled by default in C++ unless
5843 @option{-Wsign-conversion} is explicitly enabled.
5845 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5846 @opindex Wconversion-null
5847 @opindex Wno-conversion-null
5848 Do not warn for conversions between @code{NULL} and non-pointer
5849 types. @option{-Wconversion-null} is enabled by default.
5851 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5852 @opindex Wzero-as-null-pointer-constant
5853 @opindex Wno-zero-as-null-pointer-constant
5854 Warn when a literal @samp{0} is used as null pointer constant.  This can
5855 be useful to facilitate the conversion to @code{nullptr} in C++11.
5857 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5858 @opindex Wsubobject-linkage
5859 @opindex Wno-subobject-linkage
5860 Warn if a class type has a base or a field whose type uses the anonymous
5861 namespace or depends on a type with no linkage.  If a type A depends on
5862 a type B with no or internal linkage, defining it in multiple
5863 translation units would be an ODR violation because the meaning of B
5864 is different in each translation unit.  If A only appears in a single
5865 translation unit, the best way to silence the warning is to give it
5866 internal linkage by putting it in an anonymous namespace as well.  The
5867 compiler doesn't give this warning for types defined in the main .C
5868 file, as those are unlikely to have multiple definitions.
5869 @option{-Wsubobject-linkage} is enabled by default.
5871 @item -Wdangling-else
5872 @opindex Wdangling-else
5873 @opindex Wno-dangling-else
5874 Warn about constructions where there may be confusion to which
5875 @code{if} statement an @code{else} branch belongs.  Here is an example of
5876 such a case:
5878 @smallexample
5879 @group
5881   if (a)
5882     if (b)
5883       foo ();
5884   else
5885     bar ();
5887 @end group
5888 @end smallexample
5890 In C/C++, every @code{else} branch belongs to the innermost possible
5891 @code{if} statement, which in this example is @code{if (b)}.  This is
5892 often not what the programmer expected, as illustrated in the above
5893 example by indentation the programmer chose.  When there is the
5894 potential for this confusion, GCC issues a warning when this flag
5895 is specified.  To eliminate the warning, add explicit braces around
5896 the innermost @code{if} statement so there is no way the @code{else}
5897 can belong to the enclosing @code{if}.  The resulting code
5898 looks like this:
5900 @smallexample
5901 @group
5903   if (a)
5904     @{
5905       if (b)
5906         foo ();
5907       else
5908         bar ();
5909     @}
5911 @end group
5912 @end smallexample
5914 This warning is enabled by @option{-Wparentheses}.
5916 @item -Wdate-time
5917 @opindex Wdate-time
5918 @opindex Wno-date-time
5919 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5920 are encountered as they might prevent bit-wise-identical reproducible
5921 compilations.
5923 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5924 @opindex Wdelete-incomplete
5925 @opindex Wno-delete-incomplete
5926 Warn when deleting a pointer to incomplete type, which may cause
5927 undefined behavior at runtime.  This warning is enabled by default.
5929 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5930 @opindex Wuseless-cast
5931 @opindex Wno-useless-cast
5932 Warn when an expression is casted to its own type.
5934 @item -Wempty-body
5935 @opindex Wempty-body
5936 @opindex Wno-empty-body
5937 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5938 while} statement.  This warning is also enabled by @option{-Wextra}.
5940 @item -Wenum-compare
5941 @opindex Wenum-compare
5942 @opindex Wno-enum-compare
5943 Warn about a comparison between values of different enumerated types.
5944 In C++ enumeral mismatches in conditional expressions are also
5945 diagnosed and the warning is enabled by default.  In C this warning is 
5946 enabled by @option{-Wall}.
5948 @item -Wjump-misses-init @r{(C, Objective-C only)}
5949 @opindex Wjump-misses-init
5950 @opindex Wno-jump-misses-init
5951 Warn if a @code{goto} statement or a @code{switch} statement jumps
5952 forward across the initialization of a variable, or jumps backward to a
5953 label after the variable has been initialized.  This only warns about
5954 variables that are initialized when they are declared.  This warning is
5955 only supported for C and Objective-C; in C++ this sort of branch is an
5956 error in any case.
5958 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5959 can be disabled with the @option{-Wno-jump-misses-init} option.
5961 @item -Wsign-compare
5962 @opindex Wsign-compare
5963 @opindex Wno-sign-compare
5964 @cindex warning for comparison of signed and unsigned values
5965 @cindex comparison of signed and unsigned values, warning
5966 @cindex signed and unsigned values, comparison warning
5967 Warn when a comparison between signed and unsigned values could produce
5968 an incorrect result when the signed value is converted to unsigned.
5969 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5970 also enabled by @option{-Wextra}.
5972 @item -Wsign-conversion
5973 @opindex Wsign-conversion
5974 @opindex Wno-sign-conversion
5975 Warn for implicit conversions that may change the sign of an integer
5976 value, like assigning a signed integer expression to an unsigned
5977 integer variable. An explicit cast silences the warning. In C, this
5978 option is enabled also by @option{-Wconversion}.
5980 @item -Wfloat-conversion
5981 @opindex Wfloat-conversion
5982 @opindex Wno-float-conversion
5983 Warn for implicit conversions that reduce the precision of a real value.
5984 This includes conversions from real to integer, and from higher precision
5985 real to lower precision real values.  This option is also enabled by
5986 @option{-Wconversion}.
5988 @item -Wno-scalar-storage-order
5989 @opindex -Wno-scalar-storage-order
5990 @opindex -Wscalar-storage-order
5991 Do not warn on suspicious constructs involving reverse scalar storage order.
5993 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5994 @opindex Wsized-deallocation
5995 @opindex Wno-sized-deallocation
5996 Warn about a definition of an unsized deallocation function
5997 @smallexample
5998 void operator delete (void *) noexcept;
5999 void operator delete[] (void *) noexcept;
6000 @end smallexample
6001 without a definition of the corresponding sized deallocation function
6002 @smallexample
6003 void operator delete (void *, std::size_t) noexcept;
6004 void operator delete[] (void *, std::size_t) noexcept;
6005 @end smallexample
6006 or vice versa.  Enabled by @option{-Wextra} along with
6007 @option{-fsized-deallocation}.
6009 @item -Wsizeof-pointer-memaccess
6010 @opindex Wsizeof-pointer-memaccess
6011 @opindex Wno-sizeof-pointer-memaccess
6012 Warn for suspicious length parameters to certain string and memory built-in
6013 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6014 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6015 but a pointer, and suggests a possible fix, or about
6016 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6017 @option{-Wall}.
6019 @item -Wsizeof-array-argument
6020 @opindex Wsizeof-array-argument
6021 @opindex Wno-sizeof-array-argument
6022 Warn when the @code{sizeof} operator is applied to a parameter that is
6023 declared as an array in a function definition.  This warning is enabled by
6024 default for C and C++ programs.
6026 @item -Wmemset-elt-size
6027 @opindex Wmemset-elt-size
6028 @opindex Wno-memset-elt-size
6029 Warn for suspicious calls to the @code{memset} built-in function, if the
6030 first argument references an array, and the third argument is a number
6031 equal to the number of elements, but not equal to the size of the array
6032 in memory.  This indicates that the user has omitted a multiplication by
6033 the element size.  This warning is enabled by @option{-Wall}.
6035 @item -Wmemset-transposed-args
6036 @opindex Wmemset-transposed-args
6037 @opindex Wno-memset-transposed-args
6038 Warn for suspicious calls to the @code{memset} built-in function, if the
6039 second argument is not zero and the third argument is zero.  This warns e.g.@
6040 about @code{memset (buf, sizeof buf, 0)} where most probably
6041 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6042 is only emitted if the third argument is literal zero.  If it is some
6043 expression that is folded to zero, a cast of zero to some type, etc., 
6044 it is far less likely that the user has mistakenly exchanged the arguments 
6045 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6047 @item -Waddress
6048 @opindex Waddress
6049 @opindex Wno-address
6050 Warn about suspicious uses of memory addresses. These include using
6051 the address of a function in a conditional expression, such as
6052 @code{void func(void); if (func)}, and comparisons against the memory
6053 address of a string literal, such as @code{if (x == "abc")}.  Such
6054 uses typically indicate a programmer error: the address of a function
6055 always evaluates to true, so their use in a conditional usually
6056 indicate that the programmer forgot the parentheses in a function
6057 call; and comparisons against string literals result in unspecified
6058 behavior and are not portable in C, so they usually indicate that the
6059 programmer intended to use @code{strcmp}.  This warning is enabled by
6060 @option{-Wall}.
6062 @item -Wlogical-op
6063 @opindex Wlogical-op
6064 @opindex Wno-logical-op
6065 Warn about suspicious uses of logical operators in expressions.
6066 This includes using logical operators in contexts where a
6067 bit-wise operator is likely to be expected.  Also warns when
6068 the operands of a logical operator are the same:
6069 @smallexample
6070 extern int a;
6071 if (a < 0 && a < 0) @{ @dots{} @}
6072 @end smallexample
6074 @item -Wlogical-not-parentheses
6075 @opindex Wlogical-not-parentheses
6076 @opindex Wno-logical-not-parentheses
6077 Warn about logical not used on the left hand side operand of a comparison.
6078 This option does not warn if the right operand is considered to be a boolean
6079 expression.  Its purpose is to detect suspicious code like the following:
6080 @smallexample
6081 int a;
6082 @dots{}
6083 if (!a > 1) @{ @dots{} @}
6084 @end smallexample
6086 It is possible to suppress the warning by wrapping the LHS into
6087 parentheses:
6088 @smallexample
6089 if ((!a) > 1) @{ @dots{} @}
6090 @end smallexample
6092 This warning is enabled by @option{-Wall}.
6094 @item -Waggregate-return
6095 @opindex Waggregate-return
6096 @opindex Wno-aggregate-return
6097 Warn if any functions that return structures or unions are defined or
6098 called.  (In languages where you can return an array, this also elicits
6099 a warning.)
6101 @item -Wno-aggressive-loop-optimizations
6102 @opindex Wno-aggressive-loop-optimizations
6103 @opindex Waggressive-loop-optimizations
6104 Warn if in a loop with constant number of iterations the compiler detects
6105 undefined behavior in some statement during one or more of the iterations.
6107 @item -Wno-attributes
6108 @opindex Wno-attributes
6109 @opindex Wattributes
6110 Do not warn if an unexpected @code{__attribute__} is used, such as
6111 unrecognized attributes, function attributes applied to variables,
6112 etc.  This does not stop errors for incorrect use of supported
6113 attributes.
6115 @item -Wno-builtin-declaration-mismatch
6116 @opindex Wno-builtin-declaration-mismatch
6117 @opindex Wbuiltin-declaration-mismatch
6118 Warn if a built-in function is declared with the wrong signature.
6119 This warning is enabled by default.
6121 @item -Wno-builtin-macro-redefined
6122 @opindex Wno-builtin-macro-redefined
6123 @opindex Wbuiltin-macro-redefined
6124 Do not warn if certain built-in macros are redefined.  This suppresses
6125 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6126 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6128 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6129 @opindex Wstrict-prototypes
6130 @opindex Wno-strict-prototypes
6131 Warn if a function is declared or defined without specifying the
6132 argument types.  (An old-style function definition is permitted without
6133 a warning if preceded by a declaration that specifies the argument
6134 types.)
6136 @item -Wold-style-declaration @r{(C and Objective-C only)}
6137 @opindex Wold-style-declaration
6138 @opindex Wno-old-style-declaration
6139 Warn for obsolescent usages, according to the C Standard, in a
6140 declaration. For example, warn if storage-class specifiers like
6141 @code{static} are not the first things in a declaration.  This warning
6142 is also enabled by @option{-Wextra}.
6144 @item -Wold-style-definition @r{(C and Objective-C only)}
6145 @opindex Wold-style-definition
6146 @opindex Wno-old-style-definition
6147 Warn if an old-style function definition is used.  A warning is given
6148 even if there is a previous prototype.
6150 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6151 @opindex Wmissing-parameter-type
6152 @opindex Wno-missing-parameter-type
6153 A function parameter is declared without a type specifier in K&R-style
6154 functions:
6156 @smallexample
6157 void foo(bar) @{ @}
6158 @end smallexample
6160 This warning is also enabled by @option{-Wextra}.
6162 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6163 @opindex Wmissing-prototypes
6164 @opindex Wno-missing-prototypes
6165 Warn if a global function is defined without a previous prototype
6166 declaration.  This warning is issued even if the definition itself
6167 provides a prototype.  Use this option to detect global functions
6168 that do not have a matching prototype declaration in a header file.
6169 This option is not valid for C++ because all function declarations
6170 provide prototypes and a non-matching declaration declares an
6171 overload rather than conflict with an earlier declaration.
6172 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6174 @item -Wmissing-declarations
6175 @opindex Wmissing-declarations
6176 @opindex Wno-missing-declarations
6177 Warn if a global function is defined without a previous declaration.
6178 Do so even if the definition itself provides a prototype.
6179 Use this option to detect global functions that are not declared in
6180 header files.  In C, no warnings are issued for functions with previous
6181 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6182 missing prototypes.  In C++, no warnings are issued for function templates,
6183 or for inline functions, or for functions in anonymous namespaces.
6185 @item -Wmissing-field-initializers
6186 @opindex Wmissing-field-initializers
6187 @opindex Wno-missing-field-initializers
6188 @opindex W
6189 @opindex Wextra
6190 @opindex Wno-extra
6191 Warn if a structure's initializer has some fields missing.  For
6192 example, the following code causes such a warning, because
6193 @code{x.h} is implicitly zero:
6195 @smallexample
6196 struct s @{ int f, g, h; @};
6197 struct s x = @{ 3, 4 @};
6198 @end smallexample
6200 This option does not warn about designated initializers, so the following
6201 modification does not trigger a warning:
6203 @smallexample
6204 struct s @{ int f, g, h; @};
6205 struct s x = @{ .f = 3, .g = 4 @};
6206 @end smallexample
6208 In C++ this option does not warn either about the empty @{ @}
6209 initializer, for example:
6211 @smallexample
6212 struct s @{ int f, g, h; @};
6213 s x = @{ @};
6214 @end smallexample
6216 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6217 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6219 @item -Wno-multichar
6220 @opindex Wno-multichar
6221 @opindex Wmultichar
6222 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6223 Usually they indicate a typo in the user's code, as they have
6224 implementation-defined values, and should not be used in portable code.
6226 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
6227 @opindex Wnormalized=
6228 @opindex Wnormalized
6229 @opindex Wno-normalized
6230 @cindex NFC
6231 @cindex NFKC
6232 @cindex character set, input normalization
6233 In ISO C and ISO C++, two identifiers are different if they are
6234 different sequences of characters.  However, sometimes when characters
6235 outside the basic ASCII character set are used, you can have two
6236 different character sequences that look the same.  To avoid confusion,
6237 the ISO 10646 standard sets out some @dfn{normalization rules} which
6238 when applied ensure that two sequences that look the same are turned into
6239 the same sequence.  GCC can warn you if you are using identifiers that
6240 have not been normalized; this option controls that warning.
6242 There are four levels of warning supported by GCC@.  The default is
6243 @option{-Wnormalized=nfc}, which warns about any identifier that is
6244 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6245 recommended form for most uses.  It is equivalent to
6246 @option{-Wnormalized}.
6248 Unfortunately, there are some characters allowed in identifiers by
6249 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6250 identifiers.  That is, there's no way to use these symbols in portable
6251 ISO C or C++ and have all your identifiers in NFC@.
6252 @option{-Wnormalized=id} suppresses the warning for these characters.
6253 It is hoped that future versions of the standards involved will correct
6254 this, which is why this option is not the default.
6256 You can switch the warning off for all characters by writing
6257 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6258 only do this if you are using some other normalization scheme (like
6259 ``D''), because otherwise you can easily create bugs that are
6260 literally impossible to see.
6262 Some characters in ISO 10646 have distinct meanings but look identical
6263 in some fonts or display methodologies, especially once formatting has
6264 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6265 LETTER N'', displays just like a regular @code{n} that has been
6266 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6267 normalization scheme to convert all these into a standard form as
6268 well, and GCC warns if your code is not in NFKC if you use
6269 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6270 about every identifier that contains the letter O because it might be
6271 confused with the digit 0, and so is not the default, but may be
6272 useful as a local coding convention if the programming environment 
6273 cannot be fixed to display these characters distinctly.
6275 @item -Wno-deprecated
6276 @opindex Wno-deprecated
6277 @opindex Wdeprecated
6278 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6280 @item -Wno-deprecated-declarations
6281 @opindex Wno-deprecated-declarations
6282 @opindex Wdeprecated-declarations
6283 Do not warn about uses of functions (@pxref{Function Attributes}),
6284 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6285 Attributes}) marked as deprecated by using the @code{deprecated}
6286 attribute.
6288 @item -Wno-overflow
6289 @opindex Wno-overflow
6290 @opindex Woverflow
6291 Do not warn about compile-time overflow in constant expressions.
6293 @item -Wno-odr
6294 @opindex Wno-odr
6295 @opindex Wodr
6296 Warn about One Definition Rule violations during link-time optimization.
6297 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6299 @item -Wopenmp-simd
6300 @opindex Wopenm-simd
6301 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6302 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6303 option can be used to relax the cost model.
6305 @item -Woverride-init @r{(C and Objective-C only)}
6306 @opindex Woverride-init
6307 @opindex Wno-override-init
6308 @opindex W
6309 @opindex Wextra
6310 @opindex Wno-extra
6311 Warn if an initialized field without side effects is overridden when
6312 using designated initializers (@pxref{Designated Inits, , Designated
6313 Initializers}).
6315 This warning is included in @option{-Wextra}.  To get other
6316 @option{-Wextra} warnings without this one, use @option{-Wextra
6317 -Wno-override-init}.
6319 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6320 @opindex Woverride-init-side-effects
6321 @opindex Wno-override-init-side-effects
6322 Warn if an initialized field with side effects is overridden when
6323 using designated initializers (@pxref{Designated Inits, , Designated
6324 Initializers}).  This warning is enabled by default.
6326 @item -Wpacked
6327 @opindex Wpacked
6328 @opindex Wno-packed
6329 Warn if a structure is given the packed attribute, but the packed
6330 attribute has no effect on the layout or size of the structure.
6331 Such structures may be mis-aligned for little benefit.  For
6332 instance, in this code, the variable @code{f.x} in @code{struct bar}
6333 is misaligned even though @code{struct bar} does not itself
6334 have the packed attribute:
6336 @smallexample
6337 @group
6338 struct foo @{
6339   int x;
6340   char a, b, c, d;
6341 @} __attribute__((packed));
6342 struct bar @{
6343   char z;
6344   struct foo f;
6346 @end group
6347 @end smallexample
6349 @item -Wpacked-bitfield-compat
6350 @opindex Wpacked-bitfield-compat
6351 @opindex Wno-packed-bitfield-compat
6352 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6353 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6354 the change can lead to differences in the structure layout.  GCC
6355 informs you when the offset of such a field has changed in GCC 4.4.
6356 For example there is no longer a 4-bit padding between field @code{a}
6357 and @code{b} in this structure:
6359 @smallexample
6360 struct foo
6362   char a:4;
6363   char b:8;
6364 @} __attribute__ ((packed));
6365 @end smallexample
6367 This warning is enabled by default.  Use
6368 @option{-Wno-packed-bitfield-compat} to disable this warning.
6370 @item -Wpadded
6371 @opindex Wpadded
6372 @opindex Wno-padded
6373 Warn if padding is included in a structure, either to align an element
6374 of the structure or to align the whole structure.  Sometimes when this
6375 happens it is possible to rearrange the fields of the structure to
6376 reduce the padding and so make the structure smaller.
6378 @item -Wredundant-decls
6379 @opindex Wredundant-decls
6380 @opindex Wno-redundant-decls
6381 Warn if anything is declared more than once in the same scope, even in
6382 cases where multiple declaration is valid and changes nothing.
6384 @item -Wrestrict
6385 @opindex Wrestrict
6386 @opindex Wno-restrict
6387 Warn when an argument passed to a restrict-qualified parameter
6388 aliases with another argument.
6390 @item -Wnested-externs @r{(C and Objective-C only)}
6391 @opindex Wnested-externs
6392 @opindex Wno-nested-externs
6393 Warn if an @code{extern} declaration is encountered within a function.
6395 @item -Wno-inherited-variadic-ctor
6396 @opindex Winherited-variadic-ctor
6397 @opindex Wno-inherited-variadic-ctor
6398 Suppress warnings about use of C++11 inheriting constructors when the
6399 base class inherited from has a C variadic constructor; the warning is
6400 on by default because the ellipsis is not inherited.
6402 @item -Winline
6403 @opindex Winline
6404 @opindex Wno-inline
6405 Warn if a function that is declared as inline cannot be inlined.
6406 Even with this option, the compiler does not warn about failures to
6407 inline functions declared in system headers.
6409 The compiler uses a variety of heuristics to determine whether or not
6410 to inline a function.  For example, the compiler takes into account
6411 the size of the function being inlined and the amount of inlining
6412 that has already been done in the current function.  Therefore,
6413 seemingly insignificant changes in the source program can cause the
6414 warnings produced by @option{-Winline} to appear or disappear.
6416 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6417 @opindex Wno-invalid-offsetof
6418 @opindex Winvalid-offsetof
6419 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6420 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6421 to a non-standard-layout type is undefined.  In existing C++ implementations,
6422 however, @code{offsetof} typically gives meaningful results.
6423 This flag is for users who are aware that they are
6424 writing nonportable code and who have deliberately chosen to ignore the
6425 warning about it.
6427 The restrictions on @code{offsetof} may be relaxed in a future version
6428 of the C++ standard.
6430 @item -Wint-in-bool-context
6431 @opindex Wint-in-bool-context
6432 @opindex Wno-int-in-bool-context
6433 Warn for suspicious use of integer values where boolean values are expected,
6434 such as conditional expressions (?:) using non-boolean integer constants in
6435 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6436 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6437 for all kinds of multiplications regardless of the data type.
6438 This warning is enabled by @option{-Wall}.
6440 @item -Wno-int-to-pointer-cast
6441 @opindex Wno-int-to-pointer-cast
6442 @opindex Wint-to-pointer-cast
6443 Suppress warnings from casts to pointer type of an integer of a
6444 different size. In C++, casting to a pointer type of smaller size is
6445 an error. @option{Wint-to-pointer-cast} is enabled by default.
6448 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6449 @opindex Wno-pointer-to-int-cast
6450 @opindex Wpointer-to-int-cast
6451 Suppress warnings from casts from a pointer to an integer type of a
6452 different size.
6454 @item -Winvalid-pch
6455 @opindex Winvalid-pch
6456 @opindex Wno-invalid-pch
6457 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6458 the search path but can't be used.
6460 @item -Wlong-long
6461 @opindex Wlong-long
6462 @opindex Wno-long-long
6463 Warn if @code{long long} type is used.  This is enabled by either
6464 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6465 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6467 @item -Wvariadic-macros
6468 @opindex Wvariadic-macros
6469 @opindex Wno-variadic-macros
6470 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6471 alternate syntax is used in ISO C99 mode.  This is enabled by either
6472 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6473 messages, use @option{-Wno-variadic-macros}.
6475 @item -Wvarargs
6476 @opindex Wvarargs
6477 @opindex Wno-varargs
6478 Warn upon questionable usage of the macros used to handle variable
6479 arguments like @code{va_start}.  This is default.  To inhibit the
6480 warning messages, use @option{-Wno-varargs}.
6482 @item -Wvector-operation-performance
6483 @opindex Wvector-operation-performance
6484 @opindex Wno-vector-operation-performance
6485 Warn if vector operation is not implemented via SIMD capabilities of the
6486 architecture.  Mainly useful for the performance tuning.
6487 Vector operation can be implemented @code{piecewise}, which means that the
6488 scalar operation is performed on every vector element; 
6489 @code{in parallel}, which means that the vector operation is implemented
6490 using scalars of wider type, which normally is more performance efficient;
6491 and @code{as a single scalar}, which means that vector fits into a
6492 scalar type.
6494 @item -Wno-virtual-move-assign
6495 @opindex Wvirtual-move-assign
6496 @opindex Wno-virtual-move-assign
6497 Suppress warnings about inheriting from a virtual base with a
6498 non-trivial C++11 move assignment operator.  This is dangerous because
6499 if the virtual base is reachable along more than one path, it is
6500 moved multiple times, which can mean both objects end up in the
6501 moved-from state.  If the move assignment operator is written to avoid
6502 moving from a moved-from object, this warning can be disabled.
6504 @item -Wvla
6505 @opindex Wvla
6506 @opindex Wno-vla
6507 Warn if a variable-length array is used in the code.
6508 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6509 the variable-length array.
6511 @item -Wvla-larger-than=@var{n}
6512 If this option is used, the compiler will warn on uses of
6513 variable-length arrays where the size is either unbounded, or bounded
6514 by an argument that can be larger than @var{n} bytes.  This is similar
6515 to how @option{-Walloca-larger-than=@var{n}} works, but with
6516 variable-length arrays.
6518 Note that GCC may optimize small variable-length arrays of a known
6519 value into plain arrays, so this warning may not get triggered for
6520 such arrays.
6522 This warning is not enabled by @option{-Wall}, and is only active when
6523 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6525 See also @option{-Walloca-larger-than=@var{n}}.
6527 @item -Wvolatile-register-var
6528 @opindex Wvolatile-register-var
6529 @opindex Wno-volatile-register-var
6530 Warn if a register variable is declared volatile.  The volatile
6531 modifier does not inhibit all optimizations that may eliminate reads
6532 and/or writes to register variables.  This warning is enabled by
6533 @option{-Wall}.
6535 @item -Wdisabled-optimization
6536 @opindex Wdisabled-optimization
6537 @opindex Wno-disabled-optimization
6538 Warn if a requested optimization pass is disabled.  This warning does
6539 not generally indicate that there is anything wrong with your code; it
6540 merely indicates that GCC's optimizers are unable to handle the code
6541 effectively.  Often, the problem is that your code is too big or too
6542 complex; GCC refuses to optimize programs when the optimization
6543 itself is likely to take inordinate amounts of time.
6545 @item -Wpointer-sign @r{(C and Objective-C only)}
6546 @opindex Wpointer-sign
6547 @opindex Wno-pointer-sign
6548 Warn for pointer argument passing or assignment with different signedness.
6549 This option is only supported for C and Objective-C@.  It is implied by
6550 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6551 @option{-Wno-pointer-sign}.
6553 @item -Wstack-protector
6554 @opindex Wstack-protector
6555 @opindex Wno-stack-protector
6556 This option is only active when @option{-fstack-protector} is active.  It
6557 warns about functions that are not protected against stack smashing.
6559 @item -Woverlength-strings
6560 @opindex Woverlength-strings
6561 @opindex Wno-overlength-strings
6562 Warn about string constants that are longer than the ``minimum
6563 maximum'' length specified in the C standard.  Modern compilers
6564 generally allow string constants that are much longer than the
6565 standard's minimum limit, but very portable programs should avoid
6566 using longer strings.
6568 The limit applies @emph{after} string constant concatenation, and does
6569 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6570 C99, it was raised to 4095.  C++98 does not specify a normative
6571 minimum maximum, so we do not diagnose overlength strings in C++@.
6573 This option is implied by @option{-Wpedantic}, and can be disabled with
6574 @option{-Wno-overlength-strings}.
6576 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6577 @opindex Wunsuffixed-float-constants
6579 Issue a warning for any floating constant that does not have
6580 a suffix.  When used together with @option{-Wsystem-headers} it
6581 warns about such constants in system header files.  This can be useful
6582 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6583 from the decimal floating-point extension to C99.
6585 @item -Wno-designated-init @r{(C and Objective-C only)}
6586 Suppress warnings when a positional initializer is used to initialize
6587 a structure that has been marked with the @code{designated_init}
6588 attribute.
6590 @item -Whsa
6591 Issue a warning when HSAIL cannot be emitted for the compiled function or
6592 OpenMP construct.
6594 @end table
6596 @node Debugging Options
6597 @section Options for Debugging Your Program
6598 @cindex options, debugging
6599 @cindex debugging information options
6601 To tell GCC to emit extra information for use by a debugger, in almost 
6602 all cases you need only to add @option{-g} to your other options.
6604 GCC allows you to use @option{-g} with
6605 @option{-O}.  The shortcuts taken by optimized code may occasionally
6606 be surprising: some variables you declared may not exist
6607 at all; flow of control may briefly move where you did not expect it;
6608 some statements may not be executed because they compute constant
6609 results or their values are already at hand; some statements may
6610 execute in different places because they have been moved out of loops.
6611 Nevertheless it is possible to debug optimized output.  This makes
6612 it reasonable to use the optimizer for programs that might have bugs.
6614 If you are not using some other optimization option, consider
6615 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6616 With no @option{-O} option at all, some compiler passes that collect
6617 information useful for debugging do not run at all, so that
6618 @option{-Og} may result in a better debugging experience.
6620 @table @gcctabopt
6621 @item -g
6622 @opindex g
6623 Produce debugging information in the operating system's native format
6624 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6625 information.
6627 On most systems that use stabs format, @option{-g} enables use of extra
6628 debugging information that only GDB can use; this extra information
6629 makes debugging work better in GDB but probably makes other debuggers
6630 crash or
6631 refuse to read the program.  If you want to control for certain whether
6632 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6633 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6635 @item -ggdb
6636 @opindex ggdb
6637 Produce debugging information for use by GDB@.  This means to use the
6638 most expressive format available (DWARF, stabs, or the native format
6639 if neither of those are supported), including GDB extensions if at all
6640 possible.
6642 @item -gdwarf
6643 @itemx -gdwarf-@var{version}
6644 @opindex gdwarf
6645 Produce debugging information in DWARF format (if that is supported).
6646 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6647 for most targets is 4.  DWARF Version 5 is only experimental.
6649 Note that with DWARF Version 2, some ports require and always
6650 use some non-conflicting DWARF 3 extensions in the unwind tables.
6652 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6653 for maximum benefit.
6655 GCC no longer supports DWARF Version 1, which is substantially
6656 different than Version 2 and later.  For historical reasons, some
6657 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6658 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6659 in their names, but apply to all currently-supported versions of DWARF.
6661 @item -gstabs
6662 @opindex gstabs
6663 Produce debugging information in stabs format (if that is supported),
6664 without GDB extensions.  This is the format used by DBX on most BSD
6665 systems.  On MIPS, Alpha and System V Release 4 systems this option
6666 produces stabs debugging output that is not understood by DBX or SDB@.
6667 On System V Release 4 systems this option requires the GNU assembler.
6669 @item -gstabs+
6670 @opindex gstabs+
6671 Produce debugging information in stabs format (if that is supported),
6672 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6673 use of these extensions is likely to make other debuggers crash or
6674 refuse to read the program.
6676 @item -gcoff
6677 @opindex gcoff
6678 Produce debugging information in COFF format (if that is supported).
6679 This is the format used by SDB on most System V systems prior to
6680 System V Release 4.
6682 @item -gxcoff
6683 @opindex gxcoff
6684 Produce debugging information in XCOFF format (if that is supported).
6685 This is the format used by the DBX debugger on IBM RS/6000 systems.
6687 @item -gxcoff+
6688 @opindex gxcoff+
6689 Produce debugging information in XCOFF format (if that is supported),
6690 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6691 use of these extensions is likely to make other debuggers crash or
6692 refuse to read the program, and may cause assemblers other than the GNU
6693 assembler (GAS) to fail with an error.
6695 @item -gvms
6696 @opindex gvms
6697 Produce debugging information in Alpha/VMS debug format (if that is
6698 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6700 @item -g@var{level}
6701 @itemx -ggdb@var{level}
6702 @itemx -gstabs@var{level}
6703 @itemx -gcoff@var{level}
6704 @itemx -gxcoff@var{level}
6705 @itemx -gvms@var{level}
6706 Request debugging information and also use @var{level} to specify how
6707 much information.  The default level is 2.
6709 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6710 @option{-g}.
6712 Level 1 produces minimal information, enough for making backtraces in
6713 parts of the program that you don't plan to debug.  This includes
6714 descriptions of functions and external variables, and line number
6715 tables, but no information about local variables.
6717 Level 3 includes extra information, such as all the macro definitions
6718 present in the program.  Some debuggers support macro expansion when
6719 you use @option{-g3}.
6721 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6722 confusion with @option{-gdwarf-@var{level}}.
6723 Instead use an additional @option{-g@var{level}} option to change the
6724 debug level for DWARF.
6726 @item -feliminate-unused-debug-symbols
6727 @opindex feliminate-unused-debug-symbols
6728 Produce debugging information in stabs format (if that is supported),
6729 for only symbols that are actually used.
6731 @item -femit-class-debug-always
6732 @opindex femit-class-debug-always
6733 Instead of emitting debugging information for a C++ class in only one
6734 object file, emit it in all object files using the class.  This option
6735 should be used only with debuggers that are unable to handle the way GCC
6736 normally emits debugging information for classes because using this
6737 option increases the size of debugging information by as much as a
6738 factor of two.
6740 @item -fno-merge-debug-strings
6741 @opindex fmerge-debug-strings
6742 @opindex fno-merge-debug-strings
6743 Direct the linker to not merge together strings in the debugging
6744 information that are identical in different object files.  Merging is
6745 not supported by all assemblers or linkers.  Merging decreases the size
6746 of the debug information in the output file at the cost of increasing
6747 link processing time.  Merging is enabled by default.
6749 @item -fdebug-prefix-map=@var{old}=@var{new}
6750 @opindex fdebug-prefix-map
6751 When compiling files in directory @file{@var{old}}, record debugging
6752 information describing them as in @file{@var{new}} instead.
6754 @item -fvar-tracking
6755 @opindex fvar-tracking
6756 Run variable tracking pass.  It computes where variables are stored at each
6757 position in code.  Better debugging information is then generated
6758 (if the debugging information format supports this information).
6760 It is enabled by default when compiling with optimization (@option{-Os},
6761 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6762 the debug info format supports it.
6764 @item -fvar-tracking-assignments
6765 @opindex fvar-tracking-assignments
6766 @opindex fno-var-tracking-assignments
6767 Annotate assignments to user variables early in the compilation and
6768 attempt to carry the annotations over throughout the compilation all the
6769 way to the end, in an attempt to improve debug information while
6770 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6772 It can be enabled even if var-tracking is disabled, in which case
6773 annotations are created and maintained, but discarded at the end.
6774 By default, this flag is enabled together with @option{-fvar-tracking},
6775 except when selective scheduling is enabled.
6777 @item -gsplit-dwarf
6778 @opindex gsplit-dwarf
6779 Separate as much DWARF debugging information as possible into a
6780 separate output file with the extension @file{.dwo}.  This option allows
6781 the build system to avoid linking files with debug information.  To
6782 be useful, this option requires a debugger capable of reading @file{.dwo}
6783 files.
6785 @item -gpubnames
6786 @opindex gpubnames
6787 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6789 @item -ggnu-pubnames
6790 @opindex ggnu-pubnames
6791 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6792 suitable for conversion into a GDB@ index.  This option is only useful
6793 with a linker that can produce GDB@ index version 7.
6795 @item -fdebug-types-section
6796 @opindex fdebug-types-section
6797 @opindex fno-debug-types-section
6798 When using DWARF Version 4 or higher, type DIEs can be put into
6799 their own @code{.debug_types} section instead of making them part of the
6800 @code{.debug_info} section.  It is more efficient to put them in a separate
6801 comdat sections since the linker can then remove duplicates.
6802 But not all DWARF consumers support @code{.debug_types} sections yet
6803 and on some objects @code{.debug_types} produces larger instead of smaller
6804 debugging information.
6806 @item -grecord-gcc-switches
6807 @item -gno-record-gcc-switches
6808 @opindex grecord-gcc-switches
6809 @opindex gno-record-gcc-switches
6810 This switch causes the command-line options used to invoke the
6811 compiler that may affect code generation to be appended to the
6812 DW_AT_producer attribute in DWARF debugging information.  The options
6813 are concatenated with spaces separating them from each other and from
6814 the compiler version.  
6815 It is enabled by default.
6816 See also @option{-frecord-gcc-switches} for another
6817 way of storing compiler options into the object file.  
6819 @item -gstrict-dwarf
6820 @opindex gstrict-dwarf
6821 Disallow using extensions of later DWARF standard version than selected
6822 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6823 DWARF extensions from later standard versions is allowed.
6825 @item -gno-strict-dwarf
6826 @opindex gno-strict-dwarf
6827 Allow using extensions of later DWARF standard version than selected with
6828 @option{-gdwarf-@var{version}}.
6830 @item -gz@r{[}=@var{type}@r{]}
6831 @opindex gz
6832 Produce compressed debug sections in DWARF format, if that is supported.
6833 If @var{type} is not given, the default type depends on the capabilities
6834 of the assembler and linker used.  @var{type} may be one of
6835 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6836 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6837 compression in traditional GNU format).  If the linker doesn't support
6838 writing compressed debug sections, the option is rejected.  Otherwise,
6839 if the assembler does not support them, @option{-gz} is silently ignored
6840 when producing object files.
6842 @item -feliminate-dwarf2-dups
6843 @opindex feliminate-dwarf2-dups
6844 Compress DWARF debugging information by eliminating duplicated
6845 information about each symbol.  This option only makes sense when
6846 generating DWARF debugging information.
6848 @item -femit-struct-debug-baseonly
6849 @opindex femit-struct-debug-baseonly
6850 Emit debug information for struct-like types
6851 only when the base name of the compilation source file
6852 matches the base name of file in which the struct is defined.
6854 This option substantially reduces the size of debugging information,
6855 but at significant potential loss in type information to the debugger.
6856 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6857 See @option{-femit-struct-debug-detailed} for more detailed control.
6859 This option works only with DWARF debug output.
6861 @item -femit-struct-debug-reduced
6862 @opindex femit-struct-debug-reduced
6863 Emit debug information for struct-like types
6864 only when the base name of the compilation source file
6865 matches the base name of file in which the type is defined,
6866 unless the struct is a template or defined in a system header.
6868 This option significantly reduces the size of debugging information,
6869 with some potential loss in type information to the debugger.
6870 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6871 See @option{-femit-struct-debug-detailed} for more detailed control.
6873 This option works only with DWARF debug output.
6875 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6876 @opindex femit-struct-debug-detailed
6877 Specify the struct-like types
6878 for which the compiler generates debug information.
6879 The intent is to reduce duplicate struct debug information
6880 between different object files within the same program.
6882 This option is a detailed version of
6883 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6884 which serves for most needs.
6886 A specification has the syntax@*
6887 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6889 The optional first word limits the specification to
6890 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6891 A struct type is used directly when it is the type of a variable, member.
6892 Indirect uses arise through pointers to structs.
6893 That is, when use of an incomplete struct is valid, the use is indirect.
6894 An example is
6895 @samp{struct one direct; struct two * indirect;}.
6897 The optional second word limits the specification to
6898 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6899 Generic structs are a bit complicated to explain.
6900 For C++, these are non-explicit specializations of template classes,
6901 or non-template classes within the above.
6902 Other programming languages have generics,
6903 but @option{-femit-struct-debug-detailed} does not yet implement them.
6905 The third word specifies the source files for those
6906 structs for which the compiler should emit debug information.
6907 The values @samp{none} and @samp{any} have the normal meaning.
6908 The value @samp{base} means that
6909 the base of name of the file in which the type declaration appears
6910 must match the base of the name of the main compilation file.
6911 In practice, this means that when compiling @file{foo.c}, debug information
6912 is generated for types declared in that file and @file{foo.h},
6913 but not other header files.
6914 The value @samp{sys} means those types satisfying @samp{base}
6915 or declared in system or compiler headers.
6917 You may need to experiment to determine the best settings for your application.
6919 The default is @option{-femit-struct-debug-detailed=all}.
6921 This option works only with DWARF debug output.
6923 @item -fno-dwarf2-cfi-asm
6924 @opindex fdwarf2-cfi-asm
6925 @opindex fno-dwarf2-cfi-asm
6926 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6927 instead of using GAS @code{.cfi_*} directives.
6929 @item -fno-eliminate-unused-debug-types
6930 @opindex feliminate-unused-debug-types
6931 @opindex fno-eliminate-unused-debug-types
6932 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6933 output for types that are nowhere used in the source file being compiled.
6934 Sometimes it is useful to have GCC emit debugging
6935 information for all types declared in a compilation
6936 unit, regardless of whether or not they are actually used
6937 in that compilation unit, for example 
6938 if, in the debugger, you want to cast a value to a type that is
6939 not actually used in your program (but is declared).  More often,
6940 however, this results in a significant amount of wasted space.
6941 @end table
6943 @node Optimize Options
6944 @section Options That Control Optimization
6945 @cindex optimize options
6946 @cindex options, optimization
6948 These options control various sorts of optimizations.
6950 Without any optimization option, the compiler's goal is to reduce the
6951 cost of compilation and to make debugging produce the expected
6952 results.  Statements are independent: if you stop the program with a
6953 breakpoint between statements, you can then assign a new value to any
6954 variable or change the program counter to any other statement in the
6955 function and get exactly the results you expect from the source
6956 code.
6958 Turning on optimization flags makes the compiler attempt to improve
6959 the performance and/or code size at the expense of compilation time
6960 and possibly the ability to debug the program.
6962 The compiler performs optimization based on the knowledge it has of the
6963 program.  Compiling multiple files at once to a single output file mode allows
6964 the compiler to use information gained from all of the files when compiling
6965 each of them.
6967 Not all optimizations are controlled directly by a flag.  Only
6968 optimizations that have a flag are listed in this section.
6970 Most optimizations are only enabled if an @option{-O} level is set on
6971 the command line.  Otherwise they are disabled, even if individual
6972 optimization flags are specified.
6974 Depending on the target and how GCC was configured, a slightly different
6975 set of optimizations may be enabled at each @option{-O} level than
6976 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6977 to find out the exact set of optimizations that are enabled at each level.
6978 @xref{Overall Options}, for examples.
6980 @table @gcctabopt
6981 @item -O
6982 @itemx -O1
6983 @opindex O
6984 @opindex O1
6985 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6986 more memory for a large function.
6988 With @option{-O}, the compiler tries to reduce code size and execution
6989 time, without performing any optimizations that take a great deal of
6990 compilation time.
6992 @option{-O} turns on the following optimization flags:
6993 @gccoptlist{
6994 -fauto-inc-dec @gol
6995 -fbranch-count-reg @gol
6996 -fcombine-stack-adjustments @gol
6997 -fcompare-elim @gol
6998 -fcprop-registers @gol
6999 -fdce @gol
7000 -fdefer-pop @gol
7001 -fdelayed-branch @gol
7002 -fdse @gol
7003 -fforward-propagate @gol
7004 -fguess-branch-probability @gol
7005 -fif-conversion2 @gol
7006 -fif-conversion @gol
7007 -finline-functions-called-once @gol
7008 -fipa-pure-const @gol
7009 -fipa-profile @gol
7010 -fipa-reference @gol
7011 -fmerge-constants @gol
7012 -fmove-loop-invariants @gol
7013 -freorder-blocks @gol
7014 -fshrink-wrap @gol
7015 -fshrink-wrap-separate @gol
7016 -fsplit-wide-types @gol
7017 -fssa-backprop @gol
7018 -fssa-phiopt @gol
7019 -ftree-bit-ccp @gol
7020 -ftree-ccp @gol
7021 -ftree-ch @gol
7022 -ftree-coalesce-vars @gol
7023 -ftree-copy-prop @gol
7024 -ftree-dce @gol
7025 -ftree-dominator-opts @gol
7026 -ftree-dse @gol
7027 -ftree-forwprop @gol
7028 -ftree-fre @gol
7029 -ftree-phiprop @gol
7030 -ftree-sink @gol
7031 -ftree-slsr @gol
7032 -ftree-sra @gol
7033 -ftree-pta @gol
7034 -ftree-ter @gol
7035 -funit-at-a-time}
7037 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7038 where doing so does not interfere with debugging.
7040 @item -O2
7041 @opindex O2
7042 Optimize even more.  GCC performs nearly all supported optimizations
7043 that do not involve a space-speed tradeoff.
7044 As compared to @option{-O}, this option increases both compilation time
7045 and the performance of the generated code.
7047 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7048 also turns on the following optimization flags:
7049 @gccoptlist{-fthread-jumps @gol
7050 -falign-functions  -falign-jumps @gol
7051 -falign-loops  -falign-labels @gol
7052 -fcaller-saves @gol
7053 -fcrossjumping @gol
7054 -fcse-follow-jumps  -fcse-skip-blocks @gol
7055 -fdelete-null-pointer-checks @gol
7056 -fdevirtualize -fdevirtualize-speculatively @gol
7057 -fexpensive-optimizations @gol
7058 -fgcse  -fgcse-lm  @gol
7059 -fhoist-adjacent-loads @gol
7060 -finline-small-functions @gol
7061 -findirect-inlining @gol
7062 -fipa-cp @gol
7063 -fipa-cp-alignment @gol
7064 -fipa-bit-cp @gol
7065 -fipa-sra @gol
7066 -fipa-icf @gol
7067 -fisolate-erroneous-paths-dereference @gol
7068 -flra-remat @gol
7069 -foptimize-sibling-calls @gol
7070 -foptimize-strlen @gol
7071 -fpartial-inlining @gol
7072 -fpeephole2 @gol
7073 -freorder-blocks-algorithm=stc @gol
7074 -freorder-blocks-and-partition -freorder-functions @gol
7075 -frerun-cse-after-loop  @gol
7076 -fsched-interblock  -fsched-spec @gol
7077 -fschedule-insns  -fschedule-insns2 @gol
7078 -fstore-merging @gol
7079 -fstrict-aliasing -fstrict-overflow @gol
7080 -ftree-builtin-call-dce @gol
7081 -ftree-switch-conversion -ftree-tail-merge @gol
7082 -fcode-hoisting @gol
7083 -ftree-pre @gol
7084 -ftree-vrp @gol
7085 -fipa-ra}
7087 Please note the warning under @option{-fgcse} about
7088 invoking @option{-O2} on programs that use computed gotos.
7090 @item -O3
7091 @opindex O3
7092 Optimize yet more.  @option{-O3} turns on all optimizations specified
7093 by @option{-O2} and also turns on the @option{-finline-functions},
7094 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7095 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7096 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7097 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7098 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7099 and @option{-fipa-cp-clone} options.
7101 @item -O0
7102 @opindex O0
7103 Reduce compilation time and make debugging produce the expected
7104 results.  This is the default.
7106 @item -Os
7107 @opindex Os
7108 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7109 do not typically increase code size.  It also performs further
7110 optimizations designed to reduce code size.
7112 @option{-Os} disables the following optimization flags:
7113 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7114 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7115 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7117 @item -Ofast
7118 @opindex Ofast
7119 Disregard strict standards compliance.  @option{-Ofast} enables all
7120 @option{-O3} optimizations.  It also enables optimizations that are not
7121 valid for all standard-compliant programs.
7122 It turns on @option{-ffast-math} and the Fortran-specific
7123 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7125 @item -Og
7126 @opindex Og
7127 Optimize debugging experience.  @option{-Og} enables optimizations
7128 that do not interfere with debugging. It should be the optimization
7129 level of choice for the standard edit-compile-debug cycle, offering
7130 a reasonable level of optimization while maintaining fast compilation
7131 and a good debugging experience.
7132 @end table
7134 If you use multiple @option{-O} options, with or without level numbers,
7135 the last such option is the one that is effective.
7137 Options of the form @option{-f@var{flag}} specify machine-independent
7138 flags.  Most flags have both positive and negative forms; the negative
7139 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7140 below, only one of the forms is listed---the one you typically 
7141 use.  You can figure out the other form by either removing @samp{no-}
7142 or adding it.
7144 The following options control specific optimizations.  They are either
7145 activated by @option{-O} options or are related to ones that are.  You
7146 can use the following flags in the rare cases when ``fine-tuning'' of
7147 optimizations to be performed is desired.
7149 @table @gcctabopt
7150 @item -fno-defer-pop
7151 @opindex fno-defer-pop
7152 Always pop the arguments to each function call as soon as that function
7153 returns.  For machines that must pop arguments after a function call,
7154 the compiler normally lets arguments accumulate on the stack for several
7155 function calls and pops them all at once.
7157 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7159 @item -fforward-propagate
7160 @opindex fforward-propagate
7161 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7162 instructions and checks if the result can be simplified.  If loop unrolling
7163 is active, two passes are performed and the second is scheduled after
7164 loop unrolling.
7166 This option is enabled by default at optimization levels @option{-O},
7167 @option{-O2}, @option{-O3}, @option{-Os}.
7169 @item -ffp-contract=@var{style}
7170 @opindex ffp-contract
7171 @option{-ffp-contract=off} disables floating-point expression contraction.
7172 @option{-ffp-contract=fast} enables floating-point expression contraction
7173 such as forming of fused multiply-add operations if the target has
7174 native support for them.
7175 @option{-ffp-contract=on} enables floating-point expression contraction
7176 if allowed by the language standard.  This is currently not implemented
7177 and treated equal to @option{-ffp-contract=off}.
7179 The default is @option{-ffp-contract=fast}.
7181 @item -fomit-frame-pointer
7182 @opindex fomit-frame-pointer
7183 Don't keep the frame pointer in a register for functions that
7184 don't need one.  This avoids the instructions to save, set up and
7185 restore frame pointers; it also makes an extra register available
7186 in many functions.  @strong{It also makes debugging impossible on
7187 some machines.}
7189 On some machines, such as the VAX, this flag has no effect, because
7190 the standard calling sequence automatically handles the frame pointer
7191 and nothing is saved by pretending it doesn't exist.  The
7192 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7193 whether a target machine supports this flag.  @xref{Registers,,Register
7194 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7196 The default setting (when not optimizing for
7197 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7198 @option{-fomit-frame-pointer}.  You can configure GCC with the
7199 @option{--enable-frame-pointer} configure option to change the default.
7201 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7203 @item -foptimize-sibling-calls
7204 @opindex foptimize-sibling-calls
7205 Optimize sibling and tail recursive calls.
7207 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7209 @item -foptimize-strlen
7210 @opindex foptimize-strlen
7211 Optimize various standard C string functions (e.g. @code{strlen},
7212 @code{strchr} or @code{strcpy}) and
7213 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7215 Enabled at levels @option{-O2}, @option{-O3}.
7217 @item -fno-inline
7218 @opindex fno-inline
7219 Do not expand any functions inline apart from those marked with
7220 the @code{always_inline} attribute.  This is the default when not
7221 optimizing.
7223 Single functions can be exempted from inlining by marking them
7224 with the @code{noinline} attribute.
7226 @item -finline-small-functions
7227 @opindex finline-small-functions
7228 Integrate functions into their callers when their body is smaller than expected
7229 function call code (so overall size of program gets smaller).  The compiler
7230 heuristically decides which functions are simple enough to be worth integrating
7231 in this way.  This inlining applies to all functions, even those not declared
7232 inline.
7234 Enabled at level @option{-O2}.
7236 @item -findirect-inlining
7237 @opindex findirect-inlining
7238 Inline also indirect calls that are discovered to be known at compile
7239 time thanks to previous inlining.  This option has any effect only
7240 when inlining itself is turned on by the @option{-finline-functions}
7241 or @option{-finline-small-functions} options.
7243 Enabled at level @option{-O2}.
7245 @item -finline-functions
7246 @opindex finline-functions
7247 Consider all functions for inlining, even if they are not declared inline.
7248 The compiler heuristically decides which functions are worth integrating
7249 in this way.
7251 If all calls to a given function are integrated, and the function is
7252 declared @code{static}, then the function is normally not output as
7253 assembler code in its own right.
7255 Enabled at level @option{-O3}.
7257 @item -finline-functions-called-once
7258 @opindex finline-functions-called-once
7259 Consider all @code{static} functions called once for inlining into their
7260 caller even if they are not marked @code{inline}.  If a call to a given
7261 function is integrated, then the function is not output as assembler code
7262 in its own right.
7264 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7266 @item -fearly-inlining
7267 @opindex fearly-inlining
7268 Inline functions marked by @code{always_inline} and functions whose body seems
7269 smaller than the function call overhead early before doing
7270 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7271 makes profiling significantly cheaper and usually inlining faster on programs
7272 having large chains of nested wrapper functions.
7274 Enabled by default.
7276 @item -fipa-sra
7277 @opindex fipa-sra
7278 Perform interprocedural scalar replacement of aggregates, removal of
7279 unused parameters and replacement of parameters passed by reference
7280 by parameters passed by value.
7282 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7284 @item -finline-limit=@var{n}
7285 @opindex finline-limit
7286 By default, GCC limits the size of functions that can be inlined.  This flag
7287 allows coarse control of this limit.  @var{n} is the size of functions that
7288 can be inlined in number of pseudo instructions.
7290 Inlining is actually controlled by a number of parameters, which may be
7291 specified individually by using @option{--param @var{name}=@var{value}}.
7292 The @option{-finline-limit=@var{n}} option sets some of these parameters
7293 as follows:
7295 @table @gcctabopt
7296 @item max-inline-insns-single
7297 is set to @var{n}/2.
7298 @item max-inline-insns-auto
7299 is set to @var{n}/2.
7300 @end table
7302 See below for a documentation of the individual
7303 parameters controlling inlining and for the defaults of these parameters.
7305 @emph{Note:} there may be no value to @option{-finline-limit} that results
7306 in default behavior.
7308 @emph{Note:} pseudo instruction represents, in this particular context, an
7309 abstract measurement of function's size.  In no way does it represent a count
7310 of assembly instructions and as such its exact meaning might change from one
7311 release to an another.
7313 @item -fno-keep-inline-dllexport
7314 @opindex fno-keep-inline-dllexport
7315 This is a more fine-grained version of @option{-fkeep-inline-functions},
7316 which applies only to functions that are declared using the @code{dllexport}
7317 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7318 Functions}.
7320 @item -fkeep-inline-functions
7321 @opindex fkeep-inline-functions
7322 In C, emit @code{static} functions that are declared @code{inline}
7323 into the object file, even if the function has been inlined into all
7324 of its callers.  This switch does not affect functions using the
7325 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7326 inline functions into the object file.
7328 @item -fkeep-static-functions
7329 @opindex fkeep-static-functions
7330 Emit @code{static} functions into the object file, even if the function
7331 is never used.
7333 @item -fkeep-static-consts
7334 @opindex fkeep-static-consts
7335 Emit variables declared @code{static const} when optimization isn't turned
7336 on, even if the variables aren't referenced.
7338 GCC enables this option by default.  If you want to force the compiler to
7339 check if a variable is referenced, regardless of whether or not
7340 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7342 @item -fmerge-constants
7343 @opindex fmerge-constants
7344 Attempt to merge identical constants (string constants and floating-point
7345 constants) across compilation units.
7347 This option is the default for optimized compilation if the assembler and
7348 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7349 behavior.
7351 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7353 @item -fmerge-all-constants
7354 @opindex fmerge-all-constants
7355 Attempt to merge identical constants and identical variables.
7357 This option implies @option{-fmerge-constants}.  In addition to
7358 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7359 arrays or initialized constant variables with integral or floating-point
7360 types.  Languages like C or C++ require each variable, including multiple
7361 instances of the same variable in recursive calls, to have distinct locations,
7362 so using this option results in non-conforming
7363 behavior.
7365 @item -fmodulo-sched
7366 @opindex fmodulo-sched
7367 Perform swing modulo scheduling immediately before the first scheduling
7368 pass.  This pass looks at innermost loops and reorders their
7369 instructions by overlapping different iterations.
7371 @item -fmodulo-sched-allow-regmoves
7372 @opindex fmodulo-sched-allow-regmoves
7373 Perform more aggressive SMS-based modulo scheduling with register moves
7374 allowed.  By setting this flag certain anti-dependences edges are
7375 deleted, which triggers the generation of reg-moves based on the
7376 life-range analysis.  This option is effective only with
7377 @option{-fmodulo-sched} enabled.
7379 @item -fno-branch-count-reg
7380 @opindex fno-branch-count-reg
7381 Avoid running a pass scanning for opportunities to use ``decrement and
7382 branch'' instructions on a count register instead of generating sequences
7383 of instructions that decrement a register, compare it against zero, and
7384 then branch based upon the result.  This option is only meaningful on
7385 architectures that support such instructions, which include x86, PowerPC,
7386 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7387 doesn't remove the decrement and branch instructions from the generated
7388 instruction stream introduced by other optimization passes.
7390 Enabled by default at @option{-O1} and higher.
7392 The default is @option{-fbranch-count-reg}.
7394 @item -fno-function-cse
7395 @opindex fno-function-cse
7396 Do not put function addresses in registers; make each instruction that
7397 calls a constant function contain the function's address explicitly.
7399 This option results in less efficient code, but some strange hacks
7400 that alter the assembler output may be confused by the optimizations
7401 performed when this option is not used.
7403 The default is @option{-ffunction-cse}
7405 @item -fno-zero-initialized-in-bss
7406 @opindex fno-zero-initialized-in-bss
7407 If the target supports a BSS section, GCC by default puts variables that
7408 are initialized to zero into BSS@.  This can save space in the resulting
7409 code.
7411 This option turns off this behavior because some programs explicitly
7412 rely on variables going to the data section---e.g., so that the
7413 resulting executable can find the beginning of that section and/or make
7414 assumptions based on that.
7416 The default is @option{-fzero-initialized-in-bss}.
7418 @item -fthread-jumps
7419 @opindex fthread-jumps
7420 Perform optimizations that check to see if a jump branches to a
7421 location where another comparison subsumed by the first is found.  If
7422 so, the first branch is redirected to either the destination of the
7423 second branch or a point immediately following it, depending on whether
7424 the condition is known to be true or false.
7426 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7428 @item -fsplit-wide-types
7429 @opindex fsplit-wide-types
7430 When using a type that occupies multiple registers, such as @code{long
7431 long} on a 32-bit system, split the registers apart and allocate them
7432 independently.  This normally generates better code for those types,
7433 but may make debugging more difficult.
7435 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7436 @option{-Os}.
7438 @item -fcse-follow-jumps
7439 @opindex fcse-follow-jumps
7440 In common subexpression elimination (CSE), scan through jump instructions
7441 when the target of the jump is not reached by any other path.  For
7442 example, when CSE encounters an @code{if} statement with an
7443 @code{else} clause, CSE follows the jump when the condition
7444 tested is false.
7446 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7448 @item -fcse-skip-blocks
7449 @opindex fcse-skip-blocks
7450 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7451 follow jumps that conditionally skip over blocks.  When CSE
7452 encounters a simple @code{if} statement with no else clause,
7453 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7454 body of the @code{if}.
7456 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7458 @item -frerun-cse-after-loop
7459 @opindex frerun-cse-after-loop
7460 Re-run common subexpression elimination after loop optimizations are
7461 performed.
7463 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7465 @item -fgcse
7466 @opindex fgcse
7467 Perform a global common subexpression elimination pass.
7468 This pass also performs global constant and copy propagation.
7470 @emph{Note:} When compiling a program using computed gotos, a GCC
7471 extension, you may get better run-time performance if you disable
7472 the global common subexpression elimination pass by adding
7473 @option{-fno-gcse} to the command line.
7475 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7477 @item -fgcse-lm
7478 @opindex fgcse-lm
7479 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7480 attempts to move loads that are only killed by stores into themselves.  This
7481 allows a loop containing a load/store sequence to be changed to a load outside
7482 the loop, and a copy/store within the loop.
7484 Enabled by default when @option{-fgcse} is enabled.
7486 @item -fgcse-sm
7487 @opindex fgcse-sm
7488 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7489 global common subexpression elimination.  This pass attempts to move
7490 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7491 loops containing a load/store sequence can be changed to a load before
7492 the loop and a store after the loop.
7494 Not enabled at any optimization level.
7496 @item -fgcse-las
7497 @opindex fgcse-las
7498 When @option{-fgcse-las} is enabled, the global common subexpression
7499 elimination pass eliminates redundant loads that come after stores to the
7500 same memory location (both partial and full redundancies).
7502 Not enabled at any optimization level.
7504 @item -fgcse-after-reload
7505 @opindex fgcse-after-reload
7506 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7507 pass is performed after reload.  The purpose of this pass is to clean up
7508 redundant spilling.
7510 @item -faggressive-loop-optimizations
7511 @opindex faggressive-loop-optimizations
7512 This option tells the loop optimizer to use language constraints to
7513 derive bounds for the number of iterations of a loop.  This assumes that
7514 loop code does not invoke undefined behavior by for example causing signed
7515 integer overflows or out-of-bound array accesses.  The bounds for the
7516 number of iterations of a loop are used to guide loop unrolling and peeling
7517 and loop exit test optimizations.
7518 This option is enabled by default.
7520 @item -funconstrained-commons
7521 @opindex funconstrained-commons
7522 This option tells the compiler that variables declared in common blocks
7523 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7524 prevents certain optimizations that depend on knowing the array bounds.
7526 @item -fcrossjumping
7527 @opindex fcrossjumping
7528 Perform cross-jumping transformation.
7529 This transformation unifies equivalent code and saves code size.  The
7530 resulting code may or may not perform better than without cross-jumping.
7532 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7534 @item -fauto-inc-dec
7535 @opindex fauto-inc-dec
7536 Combine increments or decrements of addresses with memory accesses.
7537 This pass is always skipped on architectures that do not have
7538 instructions to support this.  Enabled by default at @option{-O} and
7539 higher on architectures that support this.
7541 @item -fdce
7542 @opindex fdce
7543 Perform dead code elimination (DCE) on RTL@.
7544 Enabled by default at @option{-O} and higher.
7546 @item -fdse
7547 @opindex fdse
7548 Perform dead store elimination (DSE) on RTL@.
7549 Enabled by default at @option{-O} and higher.
7551 @item -fif-conversion
7552 @opindex fif-conversion
7553 Attempt to transform conditional jumps into branch-less equivalents.  This
7554 includes use of conditional moves, min, max, set flags and abs instructions, and
7555 some tricks doable by standard arithmetics.  The use of conditional execution
7556 on chips where it is available is controlled by @option{-fif-conversion2}.
7558 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7560 @item -fif-conversion2
7561 @opindex fif-conversion2
7562 Use conditional execution (where available) to transform conditional jumps into
7563 branch-less equivalents.
7565 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7567 @item -fdeclone-ctor-dtor
7568 @opindex fdeclone-ctor-dtor
7569 The C++ ABI requires multiple entry points for constructors and
7570 destructors: one for a base subobject, one for a complete object, and
7571 one for a virtual destructor that calls operator delete afterwards.
7572 For a hierarchy with virtual bases, the base and complete variants are
7573 clones, which means two copies of the function.  With this option, the
7574 base and complete variants are changed to be thunks that call a common
7575 implementation.
7577 Enabled by @option{-Os}.
7579 @item -fdelete-null-pointer-checks
7580 @opindex fdelete-null-pointer-checks
7581 Assume that programs cannot safely dereference null pointers, and that
7582 no code or data element resides at address zero.
7583 This option enables simple constant
7584 folding optimizations at all optimization levels.  In addition, other
7585 optimization passes in GCC use this flag to control global dataflow
7586 analyses that eliminate useless checks for null pointers; these assume
7587 that a memory access to address zero always results in a trap, so
7588 that if a pointer is checked after it has already been dereferenced,
7589 it cannot be null.
7591 Note however that in some environments this assumption is not true.
7592 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7593 for programs that depend on that behavior.
7595 This option is enabled by default on most targets.  On Nios II ELF, it
7596 defaults to off.  On AVR and CR16, this option is completely disabled.  
7598 Passes that use the dataflow information
7599 are enabled independently at different optimization levels.
7601 @item -fdevirtualize
7602 @opindex fdevirtualize
7603 Attempt to convert calls to virtual functions to direct calls.  This
7604 is done both within a procedure and interprocedurally as part of
7605 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7606 propagation (@option{-fipa-cp}).
7607 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7609 @item -fdevirtualize-speculatively
7610 @opindex fdevirtualize-speculatively
7611 Attempt to convert calls to virtual functions to speculative direct calls.
7612 Based on the analysis of the type inheritance graph, determine for a given call
7613 the set of likely targets. If the set is small, preferably of size 1, change
7614 the call into a conditional deciding between direct and indirect calls.  The
7615 speculative calls enable more optimizations, such as inlining.  When they seem
7616 useless after further optimization, they are converted back into original form.
7618 @item -fdevirtualize-at-ltrans
7619 @opindex fdevirtualize-at-ltrans
7620 Stream extra information needed for aggressive devirtualization when running
7621 the link-time optimizer in local transformation mode.  
7622 This option enables more devirtualization but
7623 significantly increases the size of streamed data. For this reason it is
7624 disabled by default.
7626 @item -fexpensive-optimizations
7627 @opindex fexpensive-optimizations
7628 Perform a number of minor optimizations that are relatively expensive.
7630 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7632 @item -free
7633 @opindex free
7634 Attempt to remove redundant extension instructions.  This is especially
7635 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7636 registers after writing to their lower 32-bit half.
7638 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7639 @option{-O3}, @option{-Os}.
7641 @item -fno-lifetime-dse
7642 @opindex fno-lifetime-dse
7643 In C++ the value of an object is only affected by changes within its
7644 lifetime: when the constructor begins, the object has an indeterminate
7645 value, and any changes during the lifetime of the object are dead when
7646 the object is destroyed.  Normally dead store elimination will take
7647 advantage of this; if your code relies on the value of the object
7648 storage persisting beyond the lifetime of the object, you can use this
7649 flag to disable this optimization.  To preserve stores before the
7650 constructor starts (e.g. because your operator new clears the object
7651 storage) but still treat the object as dead after the destructor you,
7652 can use @option{-flifetime-dse=1}.  The default behavior can be
7653 explicitly selected with @option{-flifetime-dse=2}.
7654 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7656 @item -flive-range-shrinkage
7657 @opindex flive-range-shrinkage
7658 Attempt to decrease register pressure through register live range
7659 shrinkage.  This is helpful for fast processors with small or moderate
7660 size register sets.
7662 @item -fira-algorithm=@var{algorithm}
7663 @opindex fira-algorithm
7664 Use the specified coloring algorithm for the integrated register
7665 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7666 specifies Chow's priority coloring, or @samp{CB}, which specifies
7667 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7668 for all architectures, but for those targets that do support it, it is
7669 the default because it generates better code.
7671 @item -fira-region=@var{region}
7672 @opindex fira-region
7673 Use specified regions for the integrated register allocator.  The
7674 @var{region} argument should be one of the following:
7676 @table @samp
7678 @item all
7679 Use all loops as register allocation regions.
7680 This can give the best results for machines with a small and/or
7681 irregular register set.
7683 @item mixed
7684 Use all loops except for loops with small register pressure 
7685 as the regions.  This value usually gives
7686 the best results in most cases and for most architectures,
7687 and is enabled by default when compiling with optimization for speed
7688 (@option{-O}, @option{-O2}, @dots{}).
7690 @item one
7691 Use all functions as a single region.  
7692 This typically results in the smallest code size, and is enabled by default for
7693 @option{-Os} or @option{-O0}.
7695 @end table
7697 @item -fira-hoist-pressure
7698 @opindex fira-hoist-pressure
7699 Use IRA to evaluate register pressure in the code hoisting pass for
7700 decisions to hoist expressions.  This option usually results in smaller
7701 code, but it can slow the compiler down.
7703 This option is enabled at level @option{-Os} for all targets.
7705 @item -fira-loop-pressure
7706 @opindex fira-loop-pressure
7707 Use IRA to evaluate register pressure in loops for decisions to move
7708 loop invariants.  This option usually results in generation
7709 of faster and smaller code on machines with large register files (>= 32
7710 registers), but it can slow the compiler down.
7712 This option is enabled at level @option{-O3} for some targets.
7714 @item -fno-ira-share-save-slots
7715 @opindex fno-ira-share-save-slots
7716 Disable sharing of stack slots used for saving call-used hard
7717 registers living through a call.  Each hard register gets a
7718 separate stack slot, and as a result function stack frames are
7719 larger.
7721 @item -fno-ira-share-spill-slots
7722 @opindex fno-ira-share-spill-slots
7723 Disable sharing of stack slots allocated for pseudo-registers.  Each
7724 pseudo-register that does not get a hard register gets a separate
7725 stack slot, and as a result function stack frames are larger.
7727 @item -flra-remat
7728 @opindex flra-remat
7729 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7730 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7731 values if it is profitable.
7733 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7735 @item -fdelayed-branch
7736 @opindex fdelayed-branch
7737 If supported for the target machine, attempt to reorder instructions
7738 to exploit instruction slots available after delayed branch
7739 instructions.
7741 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7743 @item -fschedule-insns
7744 @opindex fschedule-insns
7745 If supported for the target machine, attempt to reorder instructions to
7746 eliminate execution stalls due to required data being unavailable.  This
7747 helps machines that have slow floating point or memory load instructions
7748 by allowing other instructions to be issued until the result of the load
7749 or floating-point instruction is required.
7751 Enabled at levels @option{-O2}, @option{-O3}.
7753 @item -fschedule-insns2
7754 @opindex fschedule-insns2
7755 Similar to @option{-fschedule-insns}, but requests an additional pass of
7756 instruction scheduling after register allocation has been done.  This is
7757 especially useful on machines with a relatively small number of
7758 registers and where memory load instructions take more than one cycle.
7760 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7762 @item -fno-sched-interblock
7763 @opindex fno-sched-interblock
7764 Don't schedule instructions across basic blocks.  This is normally
7765 enabled by default when scheduling before register allocation, i.e.@:
7766 with @option{-fschedule-insns} or at @option{-O2} or higher.
7768 @item -fno-sched-spec
7769 @opindex fno-sched-spec
7770 Don't allow speculative motion of non-load instructions.  This is normally
7771 enabled by default when scheduling before register allocation, i.e.@:
7772 with @option{-fschedule-insns} or at @option{-O2} or higher.
7774 @item -fsched-pressure
7775 @opindex fsched-pressure
7776 Enable register pressure sensitive insn scheduling before register
7777 allocation.  This only makes sense when scheduling before register
7778 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7779 @option{-O2} or higher.  Usage of this option can improve the
7780 generated code and decrease its size by preventing register pressure
7781 increase above the number of available hard registers and subsequent
7782 spills in register allocation.
7784 @item -fsched-spec-load
7785 @opindex fsched-spec-load
7786 Allow speculative motion of some load instructions.  This only makes
7787 sense when scheduling before register allocation, i.e.@: with
7788 @option{-fschedule-insns} or at @option{-O2} or higher.
7790 @item -fsched-spec-load-dangerous
7791 @opindex fsched-spec-load-dangerous
7792 Allow speculative motion of more load instructions.  This only makes
7793 sense when scheduling before register allocation, i.e.@: with
7794 @option{-fschedule-insns} or at @option{-O2} or higher.
7796 @item -fsched-stalled-insns
7797 @itemx -fsched-stalled-insns=@var{n}
7798 @opindex fsched-stalled-insns
7799 Define how many insns (if any) can be moved prematurely from the queue
7800 of stalled insns into the ready list during the second scheduling pass.
7801 @option{-fno-sched-stalled-insns} means that no insns are moved
7802 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7803 on how many queued insns can be moved prematurely.
7804 @option{-fsched-stalled-insns} without a value is equivalent to
7805 @option{-fsched-stalled-insns=1}.
7807 @item -fsched-stalled-insns-dep
7808 @itemx -fsched-stalled-insns-dep=@var{n}
7809 @opindex fsched-stalled-insns-dep
7810 Define how many insn groups (cycles) are examined for a dependency
7811 on a stalled insn that is a candidate for premature removal from the queue
7812 of stalled insns.  This has an effect only during the second scheduling pass,
7813 and only if @option{-fsched-stalled-insns} is used.
7814 @option{-fno-sched-stalled-insns-dep} is equivalent to
7815 @option{-fsched-stalled-insns-dep=0}.
7816 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7817 @option{-fsched-stalled-insns-dep=1}.
7819 @item -fsched2-use-superblocks
7820 @opindex fsched2-use-superblocks
7821 When scheduling after register allocation, use superblock scheduling.
7822 This allows motion across basic block boundaries,
7823 resulting in faster schedules.  This option is experimental, as not all machine
7824 descriptions used by GCC model the CPU closely enough to avoid unreliable
7825 results from the algorithm.
7827 This only makes sense when scheduling after register allocation, i.e.@: with
7828 @option{-fschedule-insns2} or at @option{-O2} or higher.
7830 @item -fsched-group-heuristic
7831 @opindex fsched-group-heuristic
7832 Enable the group heuristic in the scheduler.  This heuristic favors
7833 the instruction that belongs to a schedule group.  This is enabled
7834 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7835 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7837 @item -fsched-critical-path-heuristic
7838 @opindex fsched-critical-path-heuristic
7839 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7840 instructions on the critical path.  This is enabled by default when
7841 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7842 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7844 @item -fsched-spec-insn-heuristic
7845 @opindex fsched-spec-insn-heuristic
7846 Enable the speculative instruction heuristic in the scheduler.  This
7847 heuristic favors speculative instructions with greater dependency weakness.
7848 This is enabled by default when scheduling is enabled, i.e.@:
7849 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7850 or at @option{-O2} or higher.
7852 @item -fsched-rank-heuristic
7853 @opindex fsched-rank-heuristic
7854 Enable the rank heuristic in the scheduler.  This heuristic favors
7855 the instruction belonging to a basic block with greater size or frequency.
7856 This is enabled by default when scheduling is enabled, i.e.@:
7857 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7858 at @option{-O2} or higher.
7860 @item -fsched-last-insn-heuristic
7861 @opindex fsched-last-insn-heuristic
7862 Enable the last-instruction heuristic in the scheduler.  This heuristic
7863 favors the instruction that is less dependent on the last instruction
7864 scheduled.  This is enabled by default when scheduling is enabled,
7865 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7866 at @option{-O2} or higher.
7868 @item -fsched-dep-count-heuristic
7869 @opindex fsched-dep-count-heuristic
7870 Enable the dependent-count heuristic in the scheduler.  This heuristic
7871 favors the instruction that has more instructions depending on it.
7872 This is enabled by default when scheduling is enabled, i.e.@:
7873 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7874 at @option{-O2} or higher.
7876 @item -freschedule-modulo-scheduled-loops
7877 @opindex freschedule-modulo-scheduled-loops
7878 Modulo scheduling is performed before traditional scheduling.  If a loop
7879 is modulo scheduled, later scheduling passes may change its schedule.  
7880 Use this option to control that behavior.
7882 @item -fselective-scheduling
7883 @opindex fselective-scheduling
7884 Schedule instructions using selective scheduling algorithm.  Selective
7885 scheduling runs instead of the first scheduler pass.
7887 @item -fselective-scheduling2
7888 @opindex fselective-scheduling2
7889 Schedule instructions using selective scheduling algorithm.  Selective
7890 scheduling runs instead of the second scheduler pass.
7892 @item -fsel-sched-pipelining
7893 @opindex fsel-sched-pipelining
7894 Enable software pipelining of innermost loops during selective scheduling.
7895 This option has no effect unless one of @option{-fselective-scheduling} or
7896 @option{-fselective-scheduling2} is turned on.
7898 @item -fsel-sched-pipelining-outer-loops
7899 @opindex fsel-sched-pipelining-outer-loops
7900 When pipelining loops during selective scheduling, also pipeline outer loops.
7901 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7903 @item -fsemantic-interposition
7904 @opindex fsemantic-interposition
7905 Some object formats, like ELF, allow interposing of symbols by the 
7906 dynamic linker.
7907 This means that for symbols exported from the DSO, the compiler cannot perform
7908 interprocedural propagation, inlining and other optimizations in anticipation
7909 that the function or variable in question may change. While this feature is
7910 useful, for example, to rewrite memory allocation functions by a debugging
7911 implementation, it is expensive in the terms of code quality.
7912 With @option{-fno-semantic-interposition} the compiler assumes that 
7913 if interposition happens for functions the overwriting function will have 
7914 precisely the same semantics (and side effects). 
7915 Similarly if interposition happens
7916 for variables, the constructor of the variable will be the same. The flag
7917 has no effect for functions explicitly declared inline 
7918 (where it is never allowed for interposition to change semantics) 
7919 and for symbols explicitly declared weak.
7921 @item -fshrink-wrap
7922 @opindex fshrink-wrap
7923 Emit function prologues only before parts of the function that need it,
7924 rather than at the top of the function.  This flag is enabled by default at
7925 @option{-O} and higher.
7927 @item -fshrink-wrap-separate
7928 @opindex fshrink-wrap-separate
7929 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7930 those parts are only executed when needed.
7931 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7932 is also turned on and the target supports this.
7934 @item -fcaller-saves
7935 @opindex fcaller-saves
7936 Enable allocation of values to registers that are clobbered by
7937 function calls, by emitting extra instructions to save and restore the
7938 registers around such calls.  Such allocation is done only when it
7939 seems to result in better code.
7941 This option is always enabled by default on certain machines, usually
7942 those which have no call-preserved registers to use instead.
7944 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7946 @item -fcombine-stack-adjustments
7947 @opindex fcombine-stack-adjustments
7948 Tracks stack adjustments (pushes and pops) and stack memory references
7949 and then tries to find ways to combine them.
7951 Enabled by default at @option{-O1} and higher.
7953 @item -fipa-ra
7954 @opindex fipa-ra
7955 Use caller save registers for allocation if those registers are not used by
7956 any called function.  In that case it is not necessary to save and restore
7957 them around calls.  This is only possible if called functions are part of
7958 same compilation unit as current function and they are compiled before it.
7960 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7961 is disabled if generated code will be instrumented for profiling
7962 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
7963 exactly (this happens on targets that do not expose prologues
7964 and epilogues in RTL).
7966 @item -fconserve-stack
7967 @opindex fconserve-stack
7968 Attempt to minimize stack usage.  The compiler attempts to use less
7969 stack space, even if that makes the program slower.  This option
7970 implies setting the @option{large-stack-frame} parameter to 100
7971 and the @option{large-stack-frame-growth} parameter to 400.
7973 @item -ftree-reassoc
7974 @opindex ftree-reassoc
7975 Perform reassociation on trees.  This flag is enabled by default
7976 at @option{-O} and higher.
7978 @item -fcode-hoisting
7979 @opindex fcode-hoisting
7980 Perform code hoisting.  Code hoisting tries to move the
7981 evaluation of expressions executed on all paths to the function exit
7982 as early as possible.  This is especially useful as a code size
7983 optimization, but it often helps for code speed as well.
7984 This flag is enabled by default at @option{-O2} and higher.
7986 @item -ftree-pre
7987 @opindex ftree-pre
7988 Perform partial redundancy elimination (PRE) on trees.  This flag is
7989 enabled by default at @option{-O2} and @option{-O3}.
7991 @item -ftree-partial-pre
7992 @opindex ftree-partial-pre
7993 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7994 enabled by default at @option{-O3}.
7996 @item -ftree-forwprop
7997 @opindex ftree-forwprop
7998 Perform forward propagation on trees.  This flag is enabled by default
7999 at @option{-O} and higher.
8001 @item -ftree-fre
8002 @opindex ftree-fre
8003 Perform full redundancy elimination (FRE) on trees.  The difference
8004 between FRE and PRE is that FRE only considers expressions
8005 that are computed on all paths leading to the redundant computation.
8006 This analysis is faster than PRE, though it exposes fewer redundancies.
8007 This flag is enabled by default at @option{-O} and higher.
8009 @item -ftree-phiprop
8010 @opindex ftree-phiprop
8011 Perform hoisting of loads from conditional pointers on trees.  This
8012 pass is enabled by default at @option{-O} and higher.
8014 @item -fhoist-adjacent-loads
8015 @opindex fhoist-adjacent-loads
8016 Speculatively hoist loads from both branches of an if-then-else if the
8017 loads are from adjacent locations in the same structure and the target
8018 architecture has a conditional move instruction.  This flag is enabled
8019 by default at @option{-O2} and higher.
8021 @item -ftree-copy-prop
8022 @opindex ftree-copy-prop
8023 Perform copy propagation on trees.  This pass eliminates unnecessary
8024 copy operations.  This flag is enabled by default at @option{-O} and
8025 higher.
8027 @item -fipa-pure-const
8028 @opindex fipa-pure-const
8029 Discover which functions are pure or constant.
8030 Enabled by default at @option{-O} and higher.
8032 @item -fipa-reference
8033 @opindex fipa-reference
8034 Discover which static variables do not escape the
8035 compilation unit.
8036 Enabled by default at @option{-O} and higher.
8038 @item -fipa-pta
8039 @opindex fipa-pta
8040 Perform interprocedural pointer analysis and interprocedural modification
8041 and reference analysis.  This option can cause excessive memory and
8042 compile-time usage on large compilation units.  It is not enabled by
8043 default at any optimization level.
8045 @item -fipa-profile
8046 @opindex fipa-profile
8047 Perform interprocedural profile propagation.  The functions called only from
8048 cold functions are marked as cold. Also functions executed once (such as
8049 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8050 functions and loop less parts of functions executed once are then optimized for
8051 size.
8052 Enabled by default at @option{-O} and higher.
8054 @item -fipa-cp
8055 @opindex fipa-cp
8056 Perform interprocedural constant propagation.
8057 This optimization analyzes the program to determine when values passed
8058 to functions are constants and then optimizes accordingly.
8059 This optimization can substantially increase performance
8060 if the application has constants passed to functions.
8061 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8063 @item -fipa-cp-clone
8064 @opindex fipa-cp-clone
8065 Perform function cloning to make interprocedural constant propagation stronger.
8066 When enabled, interprocedural constant propagation performs function cloning
8067 when externally visible function can be called with constant arguments.
8068 Because this optimization can create multiple copies of functions,
8069 it may significantly increase code size
8070 (see @option{--param ipcp-unit-growth=@var{value}}).
8071 This flag is enabled by default at @option{-O3}.
8073 @item -fipa-cp-alignment
8074 @opindex -fipa-cp-alignment
8075 When enabled, this optimization propagates alignment of function
8076 parameters to support better vectorization and string operations.
8078 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8079 requires that @option{-fipa-cp} is enabled.
8080 @option{-fipa-cp-alignment} is obsolete, use @option{-fipa-bit-cp} instead.
8082 @item -fipa-bit-cp
8083 @opindex -fipa-bit-cp
8084 When enabled, perform ipa bitwise constant propagation. This flag is
8085 enabled by default at @option{-O2}. It requires that @option{-fipa-cp}
8086 is enabled.
8088 @item -fipa-icf
8089 @opindex fipa-icf
8090 Perform Identical Code Folding for functions and read-only variables.
8091 The optimization reduces code size and may disturb unwind stacks by replacing
8092 a function by equivalent one with a different name. The optimization works
8093 more effectively with link time optimization enabled.
8095 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8096 works on different levels and thus the optimizations are not same - there are
8097 equivalences that are found only by GCC and equivalences found only by Gold.
8099 This flag is enabled by default at @option{-O2} and @option{-Os}.
8101 @item -fisolate-erroneous-paths-dereference
8102 @opindex fisolate-erroneous-paths-dereference
8103 Detect paths that trigger erroneous or undefined behavior due to
8104 dereferencing a null pointer.  Isolate those paths from the main control
8105 flow and turn the statement with erroneous or undefined behavior into a trap.
8106 This flag is enabled by default at @option{-O2} and higher and depends on
8107 @option{-fdelete-null-pointer-checks} also being enabled.
8109 @item -fisolate-erroneous-paths-attribute
8110 @opindex fisolate-erroneous-paths-attribute
8111 Detect paths that trigger erroneous or undefined behavior due a null value
8112 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8113 attribute.  Isolate those paths from the main control flow and turn the
8114 statement with erroneous or undefined behavior into a trap.  This is not
8115 currently enabled, but may be enabled by @option{-O2} in the future.
8117 @item -ftree-sink
8118 @opindex ftree-sink
8119 Perform forward store motion on trees.  This flag is
8120 enabled by default at @option{-O} and higher.
8122 @item -ftree-bit-ccp
8123 @opindex ftree-bit-ccp
8124 Perform sparse conditional bit constant propagation on trees and propagate
8125 pointer alignment information.
8126 This pass only operates on local scalar variables and is enabled by default
8127 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8129 @item -ftree-ccp
8130 @opindex ftree-ccp
8131 Perform sparse conditional constant propagation (CCP) on trees.  This
8132 pass only operates on local scalar variables and is enabled by default
8133 at @option{-O} and higher.
8135 @item -fssa-backprop
8136 @opindex fssa-backprop
8137 Propagate information about uses of a value up the definition chain
8138 in order to simplify the definitions.  For example, this pass strips
8139 sign operations if the sign of a value never matters.  The flag is
8140 enabled by default at @option{-O} and higher.
8142 @item -fssa-phiopt
8143 @opindex fssa-phiopt
8144 Perform pattern matching on SSA PHI nodes to optimize conditional
8145 code.  This pass is enabled by default at @option{-O} and higher.
8147 @item -ftree-switch-conversion
8148 @opindex ftree-switch-conversion
8149 Perform conversion of simple initializations in a switch to
8150 initializations from a scalar array.  This flag is enabled by default
8151 at @option{-O2} and higher.
8153 @item -ftree-tail-merge
8154 @opindex ftree-tail-merge
8155 Look for identical code sequences.  When found, replace one with a jump to the
8156 other.  This optimization is known as tail merging or cross jumping.  This flag
8157 is enabled by default at @option{-O2} and higher.  The compilation time
8158 in this pass can
8159 be limited using @option{max-tail-merge-comparisons} parameter and
8160 @option{max-tail-merge-iterations} parameter.
8162 @item -ftree-dce
8163 @opindex ftree-dce
8164 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8165 default at @option{-O} and higher.
8167 @item -ftree-builtin-call-dce
8168 @opindex ftree-builtin-call-dce
8169 Perform conditional dead code elimination (DCE) for calls to built-in functions
8170 that may set @code{errno} but are otherwise side-effect free.  This flag is
8171 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8172 specified.
8174 @item -ftree-dominator-opts
8175 @opindex ftree-dominator-opts
8176 Perform a variety of simple scalar cleanups (constant/copy
8177 propagation, redundancy elimination, range propagation and expression
8178 simplification) based on a dominator tree traversal.  This also
8179 performs jump threading (to reduce jumps to jumps). This flag is
8180 enabled by default at @option{-O} and higher.
8182 @item -ftree-dse
8183 @opindex ftree-dse
8184 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8185 a memory location that is later overwritten by another store without
8186 any intervening loads.  In this case the earlier store can be deleted.  This
8187 flag is enabled by default at @option{-O} and higher.
8189 @item -ftree-ch
8190 @opindex ftree-ch
8191 Perform loop header copying on trees.  This is beneficial since it increases
8192 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8193 is enabled by default at @option{-O} and higher.  It is not enabled
8194 for @option{-Os}, since it usually increases code size.
8196 @item -ftree-loop-optimize
8197 @opindex ftree-loop-optimize
8198 Perform loop optimizations on trees.  This flag is enabled by default
8199 at @option{-O} and higher.
8201 @item -ftree-loop-linear
8202 @itemx -floop-interchange
8203 @itemx -floop-strip-mine
8204 @itemx -floop-block
8205 @itemx -floop-unroll-and-jam
8206 @opindex ftree-loop-linear
8207 @opindex floop-interchange
8208 @opindex floop-strip-mine
8209 @opindex floop-block
8210 @opindex floop-unroll-and-jam
8211 Perform loop nest optimizations.  Same as
8212 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8213 to be configured with @option{--with-isl} to enable the Graphite loop
8214 transformation infrastructure.
8216 @item -fgraphite-identity
8217 @opindex fgraphite-identity
8218 Enable the identity transformation for graphite.  For every SCoP we generate
8219 the polyhedral representation and transform it back to gimple.  Using
8220 @option{-fgraphite-identity} we can check the costs or benefits of the
8221 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8222 are also performed by the code generator isl, like index splitting and
8223 dead code elimination in loops.
8225 @item -floop-nest-optimize
8226 @opindex floop-nest-optimize
8227 Enable the isl based loop nest optimizer.  This is a generic loop nest
8228 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8229 structure optimized for data-locality and parallelism.  This option
8230 is experimental.
8232 @item -floop-parallelize-all
8233 @opindex floop-parallelize-all
8234 Use the Graphite data dependence analysis to identify loops that can
8235 be parallelized.  Parallelize all the loops that can be analyzed to
8236 not contain loop carried dependences without checking that it is
8237 profitable to parallelize the loops.
8239 @item -ftree-coalesce-vars
8240 @opindex ftree-coalesce-vars
8241 While transforming the program out of the SSA representation, attempt to
8242 reduce copying by coalescing versions of different user-defined
8243 variables, instead of just compiler temporaries.  This may severely
8244 limit the ability to debug an optimized program compiled with
8245 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8246 prevents SSA coalescing of user variables.  This option is enabled by
8247 default if optimization is enabled, and it does very little otherwise.
8249 @item -ftree-loop-if-convert
8250 @opindex ftree-loop-if-convert
8251 Attempt to transform conditional jumps in the innermost loops to
8252 branch-less equivalents.  The intent is to remove control-flow from
8253 the innermost loops in order to improve the ability of the
8254 vectorization pass to handle these loops.  This is enabled by default
8255 if vectorization is enabled.
8257 @item -ftree-loop-distribution
8258 @opindex ftree-loop-distribution
8259 Perform loop distribution.  This flag can improve cache performance on
8260 big loop bodies and allow further loop optimizations, like
8261 parallelization or vectorization, to take place.  For example, the loop
8262 @smallexample
8263 DO I = 1, N
8264   A(I) = B(I) + C
8265   D(I) = E(I) * F
8266 ENDDO
8267 @end smallexample
8268 is transformed to
8269 @smallexample
8270 DO I = 1, N
8271    A(I) = B(I) + C
8272 ENDDO
8273 DO I = 1, N
8274    D(I) = E(I) * F
8275 ENDDO
8276 @end smallexample
8278 @item -ftree-loop-distribute-patterns
8279 @opindex ftree-loop-distribute-patterns
8280 Perform loop distribution of patterns that can be code generated with
8281 calls to a library.  This flag is enabled by default at @option{-O3}.
8283 This pass distributes the initialization loops and generates a call to
8284 memset zero.  For example, the loop
8285 @smallexample
8286 DO I = 1, N
8287   A(I) = 0
8288   B(I) = A(I) + I
8289 ENDDO
8290 @end smallexample
8291 is transformed to
8292 @smallexample
8293 DO I = 1, N
8294    A(I) = 0
8295 ENDDO
8296 DO I = 1, N
8297    B(I) = A(I) + I
8298 ENDDO
8299 @end smallexample
8300 and the initialization loop is transformed into a call to memset zero.
8302 @item -ftree-loop-im
8303 @opindex ftree-loop-im
8304 Perform loop invariant motion on trees.  This pass moves only invariants that
8305 are hard to handle at RTL level (function calls, operations that expand to
8306 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8307 operands of conditions that are invariant out of the loop, so that we can use
8308 just trivial invariantness analysis in loop unswitching.  The pass also includes
8309 store motion.
8311 @item -ftree-loop-ivcanon
8312 @opindex ftree-loop-ivcanon
8313 Create a canonical counter for number of iterations in loops for which
8314 determining number of iterations requires complicated analysis.  Later
8315 optimizations then may determine the number easily.  Useful especially
8316 in connection with unrolling.
8318 @item -fivopts
8319 @opindex fivopts
8320 Perform induction variable optimizations (strength reduction, induction
8321 variable merging and induction variable elimination) on trees.
8323 @item -ftree-parallelize-loops=n
8324 @opindex ftree-parallelize-loops
8325 Parallelize loops, i.e., split their iteration space to run in n threads.
8326 This is only possible for loops whose iterations are independent
8327 and can be arbitrarily reordered.  The optimization is only
8328 profitable on multiprocessor machines, for loops that are CPU-intensive,
8329 rather than constrained e.g.@: by memory bandwidth.  This option
8330 implies @option{-pthread}, and thus is only supported on targets
8331 that have support for @option{-pthread}.
8333 @item -ftree-pta
8334 @opindex ftree-pta
8335 Perform function-local points-to analysis on trees.  This flag is
8336 enabled by default at @option{-O} and higher.
8338 @item -ftree-sra
8339 @opindex ftree-sra
8340 Perform scalar replacement of aggregates.  This pass replaces structure
8341 references with scalars to prevent committing structures to memory too
8342 early.  This flag is enabled by default at @option{-O} and higher.
8344 @item -fstore-merging
8345 @opindex fstore-merging
8346 Perform merging of narrow stores to consecutive memory addresses.  This pass
8347 merges contiguous stores of immediate values narrower than a word into fewer
8348 wider stores to reduce the number of instructions.  This is enabled by default
8349 at @option{-O2} and higher as well as @option{-Os}.
8351 @item -ftree-ter
8352 @opindex ftree-ter
8353 Perform temporary expression replacement during the SSA->normal phase.  Single
8354 use/single def temporaries are replaced at their use location with their
8355 defining expression.  This results in non-GIMPLE code, but gives the expanders
8356 much more complex trees to work on resulting in better RTL generation.  This is
8357 enabled by default at @option{-O} and higher.
8359 @item -ftree-slsr
8360 @opindex ftree-slsr
8361 Perform straight-line strength reduction on trees.  This recognizes related
8362 expressions involving multiplications and replaces them by less expensive
8363 calculations when possible.  This is enabled by default at @option{-O} and
8364 higher.
8366 @item -ftree-vectorize
8367 @opindex ftree-vectorize
8368 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8369 and @option{-ftree-slp-vectorize} if not explicitly specified.
8371 @item -ftree-loop-vectorize
8372 @opindex ftree-loop-vectorize
8373 Perform loop vectorization on trees. This flag is enabled by default at
8374 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8376 @item -ftree-slp-vectorize
8377 @opindex ftree-slp-vectorize
8378 Perform basic block vectorization on trees. This flag is enabled by default at
8379 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8381 @item -fvect-cost-model=@var{model}
8382 @opindex fvect-cost-model
8383 Alter the cost model used for vectorization.  The @var{model} argument
8384 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8385 With the @samp{unlimited} model the vectorized code-path is assumed
8386 to be profitable while with the @samp{dynamic} model a runtime check
8387 guards the vectorized code-path to enable it only for iteration
8388 counts that will likely execute faster than when executing the original
8389 scalar loop.  The @samp{cheap} model disables vectorization of
8390 loops where doing so would be cost prohibitive for example due to
8391 required runtime checks for data dependence or alignment but otherwise
8392 is equal to the @samp{dynamic} model.
8393 The default cost model depends on other optimization flags and is
8394 either @samp{dynamic} or @samp{cheap}.
8396 @item -fsimd-cost-model=@var{model}
8397 @opindex fsimd-cost-model
8398 Alter the cost model used for vectorization of loops marked with the OpenMP
8399 or Cilk Plus simd directive.  The @var{model} argument should be one of
8400 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8401 have the same meaning as described in @option{-fvect-cost-model} and by
8402 default a cost model defined with @option{-fvect-cost-model} is used.
8404 @item -ftree-vrp
8405 @opindex ftree-vrp
8406 Perform Value Range Propagation on trees.  This is similar to the
8407 constant propagation pass, but instead of values, ranges of values are
8408 propagated.  This allows the optimizers to remove unnecessary range
8409 checks like array bound checks and null pointer checks.  This is
8410 enabled by default at @option{-O2} and higher.  Null pointer check
8411 elimination is only done if @option{-fdelete-null-pointer-checks} is
8412 enabled.
8414 @item -fsplit-paths
8415 @opindex fsplit-paths
8416 Split paths leading to loop backedges.  This can improve dead code
8417 elimination and common subexpression elimination.  This is enabled by
8418 default at @option{-O2} and above.
8420 @item -fsplit-ivs-in-unroller
8421 @opindex fsplit-ivs-in-unroller
8422 Enables expression of values of induction variables in later iterations
8423 of the unrolled loop using the value in the first iteration.  This breaks
8424 long dependency chains, thus improving efficiency of the scheduling passes.
8426 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8427 same effect.  However, that is not reliable in cases where the loop body
8428 is more complicated than a single basic block.  It also does not work at all
8429 on some architectures due to restrictions in the CSE pass.
8431 This optimization is enabled by default.
8433 @item -fvariable-expansion-in-unroller
8434 @opindex fvariable-expansion-in-unroller
8435 With this option, the compiler creates multiple copies of some
8436 local variables when unrolling a loop, which can result in superior code.
8438 @item -fpartial-inlining
8439 @opindex fpartial-inlining
8440 Inline parts of functions.  This option has any effect only
8441 when inlining itself is turned on by the @option{-finline-functions}
8442 or @option{-finline-small-functions} options.
8444 Enabled at level @option{-O2}.
8446 @item -fpredictive-commoning
8447 @opindex fpredictive-commoning
8448 Perform predictive commoning optimization, i.e., reusing computations
8449 (especially memory loads and stores) performed in previous
8450 iterations of loops.
8452 This option is enabled at level @option{-O3}.
8454 @item -fprefetch-loop-arrays
8455 @opindex fprefetch-loop-arrays
8456 If supported by the target machine, generate instructions to prefetch
8457 memory to improve the performance of loops that access large arrays.
8459 This option may generate better or worse code; results are highly
8460 dependent on the structure of loops within the source code.
8462 Disabled at level @option{-Os}.
8464 @item -fno-printf-return-value
8465 @opindex fno-printf-return-value
8466 Do not substitute constants for known return value of formatted output
8467 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8468 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8469 transformation allows GCC to optimize or even eliminate branches based
8470 on the known return value of these functions called with arguments that
8471 are either constant, or whose values are known to be in a range that
8472 makes determining the exact return value possible.  For example, when
8473 @option{-fprintf-return-value} is in effect, both the branch and the
8474 body of the @code{if} statement (but not the call to @code{snprint})
8475 can be optimized away when @code{i} is a 32-bit or smaller integer
8476 because the return value is guaranteed to be at most 8.
8478 @smallexample
8479 char buf[9];
8480 if (snprintf (buf, "%08x", i) >= sizeof buf)
8481   @dots{}
8482 @end smallexample
8484 The @option{-fprintf-return-value} option relies on other optimizations
8485 and yields best results with @option{-O2}.  It works in tandem with the
8486 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8487 The @option{-fprintf-return-value} option is enabled by default.
8489 @item -fno-peephole
8490 @itemx -fno-peephole2
8491 @opindex fno-peephole
8492 @opindex fno-peephole2
8493 Disable any machine-specific peephole optimizations.  The difference
8494 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8495 are implemented in the compiler; some targets use one, some use the
8496 other, a few use both.
8498 @option{-fpeephole} is enabled by default.
8499 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8501 @item -fno-guess-branch-probability
8502 @opindex fno-guess-branch-probability
8503 Do not guess branch probabilities using heuristics.
8505 GCC uses heuristics to guess branch probabilities if they are
8506 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8507 heuristics are based on the control flow graph.  If some branch probabilities
8508 are specified by @code{__builtin_expect}, then the heuristics are
8509 used to guess branch probabilities for the rest of the control flow graph,
8510 taking the @code{__builtin_expect} info into account.  The interactions
8511 between the heuristics and @code{__builtin_expect} can be complex, and in
8512 some cases, it may be useful to disable the heuristics so that the effects
8513 of @code{__builtin_expect} are easier to understand.
8515 The default is @option{-fguess-branch-probability} at levels
8516 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8518 @item -freorder-blocks
8519 @opindex freorder-blocks
8520 Reorder basic blocks in the compiled function in order to reduce number of
8521 taken branches and improve code locality.
8523 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8525 @item -freorder-blocks-algorithm=@var{algorithm}
8526 @opindex freorder-blocks-algorithm
8527 Use the specified algorithm for basic block reordering.  The
8528 @var{algorithm} argument can be @samp{simple}, which does not increase
8529 code size (except sometimes due to secondary effects like alignment),
8530 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8531 put all often executed code together, minimizing the number of branches
8532 executed by making extra copies of code.
8534 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8535 @samp{stc} at levels @option{-O2}, @option{-O3}.
8537 @item -freorder-blocks-and-partition
8538 @opindex freorder-blocks-and-partition
8539 In addition to reordering basic blocks in the compiled function, in order
8540 to reduce number of taken branches, partitions hot and cold basic blocks
8541 into separate sections of the assembly and @file{.o} files, to improve
8542 paging and cache locality performance.
8544 This optimization is automatically turned off in the presence of
8545 exception handling, for linkonce sections, for functions with a user-defined
8546 section attribute and on any architecture that does not support named
8547 sections.
8549 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8551 @item -freorder-functions
8552 @opindex freorder-functions
8553 Reorder functions in the object file in order to
8554 improve code locality.  This is implemented by using special
8555 subsections @code{.text.hot} for most frequently executed functions and
8556 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8557 the linker so object file format must support named sections and linker must
8558 place them in a reasonable way.
8560 Also profile feedback must be available to make this option effective.  See
8561 @option{-fprofile-arcs} for details.
8563 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8565 @item -fstrict-aliasing
8566 @opindex fstrict-aliasing
8567 Allow the compiler to assume the strictest aliasing rules applicable to
8568 the language being compiled.  For C (and C++), this activates
8569 optimizations based on the type of expressions.  In particular, an
8570 object of one type is assumed never to reside at the same address as an
8571 object of a different type, unless the types are almost the same.  For
8572 example, an @code{unsigned int} can alias an @code{int}, but not a
8573 @code{void*} or a @code{double}.  A character type may alias any other
8574 type.
8576 @anchor{Type-punning}Pay special attention to code like this:
8577 @smallexample
8578 union a_union @{
8579   int i;
8580   double d;
8583 int f() @{
8584   union a_union t;
8585   t.d = 3.0;
8586   return t.i;
8588 @end smallexample
8589 The practice of reading from a different union member than the one most
8590 recently written to (called ``type-punning'') is common.  Even with
8591 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8592 is accessed through the union type.  So, the code above works as
8593 expected.  @xref{Structures unions enumerations and bit-fields
8594 implementation}.  However, this code might not:
8595 @smallexample
8596 int f() @{
8597   union a_union t;
8598   int* ip;
8599   t.d = 3.0;
8600   ip = &t.i;
8601   return *ip;
8603 @end smallexample
8605 Similarly, access by taking the address, casting the resulting pointer
8606 and dereferencing the result has undefined behavior, even if the cast
8607 uses a union type, e.g.:
8608 @smallexample
8609 int f() @{
8610   double d = 3.0;
8611   return ((union a_union *) &d)->i;
8613 @end smallexample
8615 The @option{-fstrict-aliasing} option is enabled at levels
8616 @option{-O2}, @option{-O3}, @option{-Os}.
8618 @item -fstrict-overflow
8619 @opindex fstrict-overflow
8620 Allow the compiler to assume strict signed overflow rules, depending
8621 on the language being compiled.  For C (and C++) this means that
8622 overflow when doing arithmetic with signed numbers is undefined, which
8623 means that the compiler may assume that it does not happen.  This
8624 permits various optimizations.  For example, the compiler assumes
8625 that an expression like @code{i + 10 > i} is always true for
8626 signed @code{i}.  This assumption is only valid if signed overflow is
8627 undefined, as the expression is false if @code{i + 10} overflows when
8628 using twos complement arithmetic.  When this option is in effect any
8629 attempt to determine whether an operation on signed numbers 
8630 overflows must be written carefully to not actually involve overflow.
8632 This option also allows the compiler to assume strict pointer
8633 semantics: given a pointer to an object, if adding an offset to that
8634 pointer does not produce a pointer to the same object, the addition is
8635 undefined.  This permits the compiler to conclude that @code{p + u >
8636 p} is always true for a pointer @code{p} and unsigned integer
8637 @code{u}.  This assumption is only valid because pointer wraparound is
8638 undefined, as the expression is false if @code{p + u} overflows using
8639 twos complement arithmetic.
8641 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8642 that integer signed overflow is fully defined: it wraps.  When
8643 @option{-fwrapv} is used, there is no difference between
8644 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8645 integers.  With @option{-fwrapv} certain types of overflow are
8646 permitted.  For example, if the compiler gets an overflow when doing
8647 arithmetic on constants, the overflowed value can still be used with
8648 @option{-fwrapv}, but not otherwise.
8650 The @option{-fstrict-overflow} option is enabled at levels
8651 @option{-O2}, @option{-O3}, @option{-Os}.
8653 @item -falign-functions
8654 @itemx -falign-functions=@var{n}
8655 @opindex falign-functions
8656 Align the start of functions to the next power-of-two greater than
8657 @var{n}, skipping up to @var{n} bytes.  For instance,
8658 @option{-falign-functions=32} aligns functions to the next 32-byte
8659 boundary, but @option{-falign-functions=24} aligns to the next
8660 32-byte boundary only if this can be done by skipping 23 bytes or less.
8662 @option{-fno-align-functions} and @option{-falign-functions=1} are
8663 equivalent and mean that functions are not aligned.
8665 Some assemblers only support this flag when @var{n} is a power of two;
8666 in that case, it is rounded up.
8668 If @var{n} is not specified or is zero, use a machine-dependent default.
8670 Enabled at levels @option{-O2}, @option{-O3}.
8672 @item -flimit-function-alignment
8673 If this option is enabled, the compiler tries to avoid unnecessarily
8674 overaligning functions. It attempts to instruct the assembler to align
8675 by the amount specified by @option{-falign-functions}, but not to
8676 skip more bytes than the size of the function.
8678 @item -falign-labels
8679 @itemx -falign-labels=@var{n}
8680 @opindex falign-labels
8681 Align all branch targets to a power-of-two boundary, skipping up to
8682 @var{n} bytes like @option{-falign-functions}.  This option can easily
8683 make code slower, because it must insert dummy operations for when the
8684 branch target is reached in the usual flow of the code.
8686 @option{-fno-align-labels} and @option{-falign-labels=1} are
8687 equivalent and mean that labels are not aligned.
8689 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8690 are greater than this value, then their values are used instead.
8692 If @var{n} is not specified or is zero, use a machine-dependent default
8693 which is very likely to be @samp{1}, meaning no alignment.
8695 Enabled at levels @option{-O2}, @option{-O3}.
8697 @item -falign-loops
8698 @itemx -falign-loops=@var{n}
8699 @opindex falign-loops
8700 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8701 like @option{-falign-functions}.  If the loops are
8702 executed many times, this makes up for any execution of the dummy
8703 operations.
8705 @option{-fno-align-loops} and @option{-falign-loops=1} are
8706 equivalent and mean that loops are not aligned.
8708 If @var{n} is not specified or is zero, use a machine-dependent default.
8710 Enabled at levels @option{-O2}, @option{-O3}.
8712 @item -falign-jumps
8713 @itemx -falign-jumps=@var{n}
8714 @opindex falign-jumps
8715 Align branch targets to a power-of-two boundary, for branch targets
8716 where the targets can only be reached by jumping, skipping up to @var{n}
8717 bytes like @option{-falign-functions}.  In this case, no dummy operations
8718 need be executed.
8720 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8721 equivalent and mean that loops are not aligned.
8723 If @var{n} is not specified or is zero, use a machine-dependent default.
8725 Enabled at levels @option{-O2}, @option{-O3}.
8727 @item -funit-at-a-time
8728 @opindex funit-at-a-time
8729 This option is left for compatibility reasons. @option{-funit-at-a-time}
8730 has no effect, while @option{-fno-unit-at-a-time} implies
8731 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8733 Enabled by default.
8735 @item -fno-toplevel-reorder
8736 @opindex fno-toplevel-reorder
8737 Do not reorder top-level functions, variables, and @code{asm}
8738 statements.  Output them in the same order that they appear in the
8739 input file.  When this option is used, unreferenced static variables
8740 are not removed.  This option is intended to support existing code
8741 that relies on a particular ordering.  For new code, it is better to
8742 use attributes when possible.
8744 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8745 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8746 targets.
8748 @item -fweb
8749 @opindex fweb
8750 Constructs webs as commonly used for register allocation purposes and assign
8751 each web individual pseudo register.  This allows the register allocation pass
8752 to operate on pseudos directly, but also strengthens several other optimization
8753 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8754 however, make debugging impossible, since variables no longer stay in a
8755 ``home register''.
8757 Enabled by default with @option{-funroll-loops}.
8759 @item -fwhole-program
8760 @opindex fwhole-program
8761 Assume that the current compilation unit represents the whole program being
8762 compiled.  All public functions and variables with the exception of @code{main}
8763 and those merged by attribute @code{externally_visible} become static functions
8764 and in effect are optimized more aggressively by interprocedural optimizers.
8766 This option should not be used in combination with @option{-flto}.
8767 Instead relying on a linker plugin should provide safer and more precise
8768 information.
8770 @item -flto[=@var{n}]
8771 @opindex flto
8772 This option runs the standard link-time optimizer.  When invoked
8773 with source code, it generates GIMPLE (one of GCC's internal
8774 representations) and writes it to special ELF sections in the object
8775 file.  When the object files are linked together, all the function
8776 bodies are read from these ELF sections and instantiated as if they
8777 had been part of the same translation unit.
8779 To use the link-time optimizer, @option{-flto} and optimization
8780 options should be specified at compile time and during the final link.
8781 It is recommended that you compile all the files participating in the
8782 same link with the same options and also specify those options at
8783 link time.  
8784 For example:
8786 @smallexample
8787 gcc -c -O2 -flto foo.c
8788 gcc -c -O2 -flto bar.c
8789 gcc -o myprog -flto -O2 foo.o bar.o
8790 @end smallexample
8792 The first two invocations to GCC save a bytecode representation
8793 of GIMPLE into special ELF sections inside @file{foo.o} and
8794 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8795 @file{foo.o} and @file{bar.o}, merges the two files into a single
8796 internal image, and compiles the result as usual.  Since both
8797 @file{foo.o} and @file{bar.o} are merged into a single image, this
8798 causes all the interprocedural analyses and optimizations in GCC to
8799 work across the two files as if they were a single one.  This means,
8800 for example, that the inliner is able to inline functions in
8801 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8803 Another (simpler) way to enable link-time optimization is:
8805 @smallexample
8806 gcc -o myprog -flto -O2 foo.c bar.c
8807 @end smallexample
8809 The above generates bytecode for @file{foo.c} and @file{bar.c},
8810 merges them together into a single GIMPLE representation and optimizes
8811 them as usual to produce @file{myprog}.
8813 The only important thing to keep in mind is that to enable link-time
8814 optimizations you need to use the GCC driver to perform the link step.
8815 GCC then automatically performs link-time optimization if any of the
8816 objects involved were compiled with the @option{-flto} command-line option.  
8817 You generally
8818 should specify the optimization options to be used for link-time
8819 optimization though GCC tries to be clever at guessing an
8820 optimization level to use from the options used at compile time
8821 if you fail to specify one at link time.  You can always override
8822 the automatic decision to do link-time optimization at link time
8823 by passing @option{-fno-lto} to the link command.
8825 To make whole program optimization effective, it is necessary to make
8826 certain whole program assumptions.  The compiler needs to know
8827 what functions and variables can be accessed by libraries and runtime
8828 outside of the link-time optimized unit.  When supported by the linker,
8829 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8830 to the compiler about used and externally visible symbols.  When
8831 the linker plugin is not available, @option{-fwhole-program} should be
8832 used to allow the compiler to make these assumptions, which leads
8833 to more aggressive optimization decisions.
8835 When @option{-fuse-linker-plugin} is not enabled, when a file is
8836 compiled with @option{-flto}, the generated object file is larger than
8837 a regular object file because it contains GIMPLE bytecodes and the usual
8838 final code (see @option{-ffat-lto-objects}.  This means that
8839 object files with LTO information can be linked as normal object
8840 files; if @option{-fno-lto} is passed to the linker, no
8841 interprocedural optimizations are applied.  Note that when
8842 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8843 but you cannot perform a regular, non-LTO link on them.
8845 Additionally, the optimization flags used to compile individual files
8846 are not necessarily related to those used at link time.  For instance,
8848 @smallexample
8849 gcc -c -O0 -ffat-lto-objects -flto foo.c
8850 gcc -c -O0 -ffat-lto-objects -flto bar.c
8851 gcc -o myprog -O3 foo.o bar.o
8852 @end smallexample
8854 This produces individual object files with unoptimized assembler
8855 code, but the resulting binary @file{myprog} is optimized at
8856 @option{-O3}.  If, instead, the final binary is generated with
8857 @option{-fno-lto}, then @file{myprog} is not optimized.
8859 When producing the final binary, GCC only
8860 applies link-time optimizations to those files that contain bytecode.
8861 Therefore, you can mix and match object files and libraries with
8862 GIMPLE bytecodes and final object code.  GCC automatically selects
8863 which files to optimize in LTO mode and which files to link without
8864 further processing.
8866 There are some code generation flags preserved by GCC when
8867 generating bytecodes, as they need to be used during the final link
8868 stage.  Generally options specified at link time override those
8869 specified at compile time.
8871 If you do not specify an optimization level option @option{-O} at
8872 link time, then GCC uses the highest optimization level 
8873 used when compiling the object files.
8875 Currently, the following options and their settings are taken from
8876 the first object file that explicitly specifies them: 
8877 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8878 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8879 and all the @option{-m} target flags.
8881 Certain ABI-changing flags are required to match in all compilation units,
8882 and trying to override this at link time with a conflicting value
8883 is ignored.  This includes options such as @option{-freg-struct-return}
8884 and @option{-fpcc-struct-return}. 
8886 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8887 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8888 are passed through to the link stage and merged conservatively for
8889 conflicting translation units.  Specifically
8890 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8891 precedence; and for example @option{-ffp-contract=off} takes precedence
8892 over @option{-ffp-contract=fast}.  You can override them at link time.
8894 If LTO encounters objects with C linkage declared with incompatible
8895 types in separate translation units to be linked together (undefined
8896 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8897 issued.  The behavior is still undefined at run time.  Similar
8898 diagnostics may be raised for other languages.
8900 Another feature of LTO is that it is possible to apply interprocedural
8901 optimizations on files written in different languages:
8903 @smallexample
8904 gcc -c -flto foo.c
8905 g++ -c -flto bar.cc
8906 gfortran -c -flto baz.f90
8907 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8908 @end smallexample
8910 Notice that the final link is done with @command{g++} to get the C++
8911 runtime libraries and @option{-lgfortran} is added to get the Fortran
8912 runtime libraries.  In general, when mixing languages in LTO mode, you
8913 should use the same link command options as when mixing languages in a
8914 regular (non-LTO) compilation.
8916 If object files containing GIMPLE bytecode are stored in a library archive, say
8917 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8918 are using a linker with plugin support.  To create static libraries suitable
8919 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8920 and @command{ranlib}; 
8921 to show the symbols of object files with GIMPLE bytecode, use
8922 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8923 and @command{nm} have been compiled with plugin support.  At link time, use the the
8924 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8925 the LTO optimization process:
8927 @smallexample
8928 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8929 @end smallexample
8931 With the linker plugin enabled, the linker extracts the needed
8932 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8933 to make them part of the aggregated GIMPLE image to be optimized.
8935 If you are not using a linker with plugin support and/or do not
8936 enable the linker plugin, then the objects inside @file{libfoo.a}
8937 are extracted and linked as usual, but they do not participate
8938 in the LTO optimization process.  In order to make a static library suitable
8939 for both LTO optimization and usual linkage, compile its object files with
8940 @option{-flto} @option{-ffat-lto-objects}.
8942 Link-time optimizations do not require the presence of the whole program to
8943 operate.  If the program does not require any symbols to be exported, it is
8944 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8945 the interprocedural optimizers to use more aggressive assumptions which may
8946 lead to improved optimization opportunities.
8947 Use of @option{-fwhole-program} is not needed when linker plugin is
8948 active (see @option{-fuse-linker-plugin}).
8950 The current implementation of LTO makes no
8951 attempt to generate bytecode that is portable between different
8952 types of hosts.  The bytecode files are versioned and there is a
8953 strict version check, so bytecode files generated in one version of
8954 GCC do not work with an older or newer version of GCC.
8956 Link-time optimization does not work well with generation of debugging
8957 information.  Combining @option{-flto} with
8958 @option{-g} is currently experimental and expected to produce unexpected
8959 results.
8961 If you specify the optional @var{n}, the optimization and code
8962 generation done at link time is executed in parallel using @var{n}
8963 parallel jobs by utilizing an installed @command{make} program.  The
8964 environment variable @env{MAKE} may be used to override the program
8965 used.  The default value for @var{n} is 1.
8967 You can also specify @option{-flto=jobserver} to use GNU make's
8968 job server mode to determine the number of parallel jobs. This
8969 is useful when the Makefile calling GCC is already executing in parallel.
8970 You must prepend a @samp{+} to the command recipe in the parent Makefile
8971 for this to work.  This option likely only works if @env{MAKE} is
8972 GNU make.
8974 @item -flto-partition=@var{alg}
8975 @opindex flto-partition
8976 Specify the partitioning algorithm used by the link-time optimizer.
8977 The value is either @samp{1to1} to specify a partitioning mirroring
8978 the original source files or @samp{balanced} to specify partitioning
8979 into equally sized chunks (whenever possible) or @samp{max} to create
8980 new partition for every symbol where possible.  Specifying @samp{none}
8981 as an algorithm disables partitioning and streaming completely. 
8982 The default value is @samp{balanced}. While @samp{1to1} can be used
8983 as an workaround for various code ordering issues, the @samp{max}
8984 partitioning is intended for internal testing only.
8985 The value @samp{one} specifies that exactly one partition should be
8986 used while the value @samp{none} bypasses partitioning and executes
8987 the link-time optimization step directly from the WPA phase.
8989 @item -flto-odr-type-merging
8990 @opindex flto-odr-type-merging
8991 Enable streaming of mangled types names of C++ types and their unification
8992 at link time.  This increases size of LTO object files, but enables
8993 diagnostics about One Definition Rule violations.
8995 @item -flto-compression-level=@var{n}
8996 @opindex flto-compression-level
8997 This option specifies the level of compression used for intermediate
8998 language written to LTO object files, and is only meaningful in
8999 conjunction with LTO mode (@option{-flto}).  Valid
9000 values are 0 (no compression) to 9 (maximum compression).  Values
9001 outside this range are clamped to either 0 or 9.  If the option is not
9002 given, a default balanced compression setting is used.
9004 @item -fuse-linker-plugin
9005 @opindex fuse-linker-plugin
9006 Enables the use of a linker plugin during link-time optimization.  This
9007 option relies on plugin support in the linker, which is available in gold
9008 or in GNU ld 2.21 or newer.
9010 This option enables the extraction of object files with GIMPLE bytecode out
9011 of library archives. This improves the quality of optimization by exposing
9012 more code to the link-time optimizer.  This information specifies what
9013 symbols can be accessed externally (by non-LTO object or during dynamic
9014 linking).  Resulting code quality improvements on binaries (and shared
9015 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9016 See @option{-flto} for a description of the effect of this flag and how to
9017 use it.
9019 This option is enabled by default when LTO support in GCC is enabled
9020 and GCC was configured for use with
9021 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9023 @item -ffat-lto-objects
9024 @opindex ffat-lto-objects
9025 Fat LTO objects are object files that contain both the intermediate language
9026 and the object code. This makes them usable for both LTO linking and normal
9027 linking. This option is effective only when compiling with @option{-flto}
9028 and is ignored at link time.
9030 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9031 requires the complete toolchain to be aware of LTO. It requires a linker with
9032 linker plugin support for basic functionality.  Additionally,
9033 @command{nm}, @command{ar} and @command{ranlib}
9034 need to support linker plugins to allow a full-featured build environment
9035 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9036 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9037 to these tools. With non fat LTO makefiles need to be modified to use them.
9039 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9040 support.
9042 @item -fcompare-elim
9043 @opindex fcompare-elim
9044 After register allocation and post-register allocation instruction splitting,
9045 identify arithmetic instructions that compute processor flags similar to a
9046 comparison operation based on that arithmetic.  If possible, eliminate the
9047 explicit comparison operation.
9049 This pass only applies to certain targets that cannot explicitly represent
9050 the comparison operation before register allocation is complete.
9052 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9054 @item -fcprop-registers
9055 @opindex fcprop-registers
9056 After register allocation and post-register allocation instruction splitting,
9057 perform a copy-propagation pass to try to reduce scheduling dependencies
9058 and occasionally eliminate the copy.
9060 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9062 @item -fprofile-correction
9063 @opindex fprofile-correction
9064 Profiles collected using an instrumented binary for multi-threaded programs may
9065 be inconsistent due to missed counter updates. When this option is specified,
9066 GCC uses heuristics to correct or smooth out such inconsistencies. By
9067 default, GCC emits an error message when an inconsistent profile is detected.
9069 @item -fprofile-use
9070 @itemx -fprofile-use=@var{path}
9071 @opindex fprofile-use
9072 Enable profile feedback-directed optimizations, 
9073 and the following optimizations
9074 which are generally profitable only with profile feedback available:
9075 @option{-fbranch-probabilities}, @option{-fvpt},
9076 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9077 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9079 Before you can use this option, you must first generate profiling information.
9080 @xref{Instrumentation Options}, for information about the
9081 @option{-fprofile-generate} option.
9083 By default, GCC emits an error message if the feedback profiles do not
9084 match the source code.  This error can be turned into a warning by using
9085 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9086 code.
9088 If @var{path} is specified, GCC looks at the @var{path} to find
9089 the profile feedback data files. See @option{-fprofile-dir}.
9091 @item -fauto-profile
9092 @itemx -fauto-profile=@var{path}
9093 @opindex fauto-profile
9094 Enable sampling-based feedback-directed optimizations, 
9095 and the following optimizations
9096 which are generally profitable only with profile feedback available:
9097 @option{-fbranch-probabilities}, @option{-fvpt},
9098 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9099 @option{-ftree-vectorize},
9100 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9101 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9102 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9104 @var{path} is the name of a file containing AutoFDO profile information.
9105 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9107 Producing an AutoFDO profile data file requires running your program
9108 with the @command{perf} utility on a supported GNU/Linux target system.
9109 For more information, see @uref{https://perf.wiki.kernel.org/}.
9111 E.g.
9112 @smallexample
9113 perf record -e br_inst_retired:near_taken -b -o perf.data \
9114     -- your_program
9115 @end smallexample
9117 Then use the @command{create_gcov} tool to convert the raw profile data
9118 to a format that can be used by GCC.@  You must also supply the 
9119 unstripped binary for your program to this tool.  
9120 See @uref{https://github.com/google/autofdo}.
9122 E.g.
9123 @smallexample
9124 create_gcov --binary=your_program.unstripped --profile=perf.data \
9125     --gcov=profile.afdo
9126 @end smallexample
9127 @end table
9129 The following options control compiler behavior regarding floating-point 
9130 arithmetic.  These options trade off between speed and
9131 correctness.  All must be specifically enabled.
9133 @table @gcctabopt
9134 @item -ffloat-store
9135 @opindex ffloat-store
9136 Do not store floating-point variables in registers, and inhibit other
9137 options that might change whether a floating-point value is taken from a
9138 register or memory.
9140 @cindex floating-point precision
9141 This option prevents undesirable excess precision on machines such as
9142 the 68000 where the floating registers (of the 68881) keep more
9143 precision than a @code{double} is supposed to have.  Similarly for the
9144 x86 architecture.  For most programs, the excess precision does only
9145 good, but a few programs rely on the precise definition of IEEE floating
9146 point.  Use @option{-ffloat-store} for such programs, after modifying
9147 them to store all pertinent intermediate computations into variables.
9149 @item -fexcess-precision=@var{style}
9150 @opindex fexcess-precision
9151 This option allows further control over excess precision on machines
9152 where floating-point operations occur in a format with more precision or
9153 range than the IEEE standard and interchange floating-point types.  By
9154 default, @option{-fexcess-precision=fast} is in effect; this means that
9155 operations may be carried out in a wider precision than the types specified
9156 in the source if that would result in faster code, and it is unpredictable
9157 when rounding to the types specified in the source code takes place.
9158 When compiling C, if @option{-fexcess-precision=standard} is specified then
9159 excess precision follows the rules specified in ISO C99; in particular,
9160 both casts and assignments cause values to be rounded to their
9161 semantic types (whereas @option{-ffloat-store} only affects
9162 assignments).  This option is enabled by default for C if a strict
9163 conformance option such as @option{-std=c99} is used.
9164 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9165 regardless of whether a strict conformance option is used.
9167 @opindex mfpmath
9168 @option{-fexcess-precision=standard} is not implemented for languages
9169 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9170 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9171 semantics apply without excess precision, and in the latter, rounding
9172 is unpredictable.
9174 @item -ffast-math
9175 @opindex ffast-math
9176 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9177 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9178 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9179 @option{-fexcess-precision=fast}.
9181 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9183 This option is not turned on by any @option{-O} option besides
9184 @option{-Ofast} since it can result in incorrect output for programs
9185 that depend on an exact implementation of IEEE or ISO rules/specifications
9186 for math functions. It may, however, yield faster code for programs
9187 that do not require the guarantees of these specifications.
9189 @item -fno-math-errno
9190 @opindex fno-math-errno
9191 Do not set @code{errno} after calling math functions that are executed
9192 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9193 IEEE exceptions for math error handling may want to use this flag
9194 for speed while maintaining IEEE arithmetic compatibility.
9196 This option is not turned on by any @option{-O} option since
9197 it can result in incorrect output for programs that depend on
9198 an exact implementation of IEEE or ISO rules/specifications for
9199 math functions. It may, however, yield faster code for programs
9200 that do not require the guarantees of these specifications.
9202 The default is @option{-fmath-errno}.
9204 On Darwin systems, the math library never sets @code{errno}.  There is
9205 therefore no reason for the compiler to consider the possibility that
9206 it might, and @option{-fno-math-errno} is the default.
9208 @item -funsafe-math-optimizations
9209 @opindex funsafe-math-optimizations
9211 Allow optimizations for floating-point arithmetic that (a) assume
9212 that arguments and results are valid and (b) may violate IEEE or
9213 ANSI standards.  When used at link time, it may include libraries
9214 or startup files that change the default FPU control word or other
9215 similar optimizations.
9217 This option is not turned on by any @option{-O} option since
9218 it can result in incorrect output for programs that depend on
9219 an exact implementation of IEEE or ISO rules/specifications for
9220 math functions. It may, however, yield faster code for programs
9221 that do not require the guarantees of these specifications.
9222 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9223 @option{-fassociative-math} and @option{-freciprocal-math}.
9225 The default is @option{-fno-unsafe-math-optimizations}.
9227 @item -fassociative-math
9228 @opindex fassociative-math
9230 Allow re-association of operands in series of floating-point operations.
9231 This violates the ISO C and C++ language standard by possibly changing
9232 computation result.  NOTE: re-ordering may change the sign of zero as
9233 well as ignore NaNs and inhibit or create underflow or overflow (and
9234 thus cannot be used on code that relies on rounding behavior like
9235 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9236 and thus may not be used when ordered comparisons are required.
9237 This option requires that both @option{-fno-signed-zeros} and
9238 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9239 much sense with @option{-frounding-math}. For Fortran the option
9240 is automatically enabled when both @option{-fno-signed-zeros} and
9241 @option{-fno-trapping-math} are in effect.
9243 The default is @option{-fno-associative-math}.
9245 @item -freciprocal-math
9246 @opindex freciprocal-math
9248 Allow the reciprocal of a value to be used instead of dividing by
9249 the value if this enables optimizations.  For example @code{x / y}
9250 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9251 is subject to common subexpression elimination.  Note that this loses
9252 precision and increases the number of flops operating on the value.
9254 The default is @option{-fno-reciprocal-math}.
9256 @item -ffinite-math-only
9257 @opindex ffinite-math-only
9258 Allow optimizations for floating-point arithmetic that assume
9259 that arguments and results are not NaNs or +-Infs.
9261 This option is not turned on by any @option{-O} option since
9262 it can result in incorrect output for programs that depend on
9263 an exact implementation of IEEE or ISO rules/specifications for
9264 math functions. It may, however, yield faster code for programs
9265 that do not require the guarantees of these specifications.
9267 The default is @option{-fno-finite-math-only}.
9269 @item -fno-signed-zeros
9270 @opindex fno-signed-zeros
9271 Allow optimizations for floating-point arithmetic that ignore the
9272 signedness of zero.  IEEE arithmetic specifies the behavior of
9273 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9274 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9275 This option implies that the sign of a zero result isn't significant.
9277 The default is @option{-fsigned-zeros}.
9279 @item -fno-trapping-math
9280 @opindex fno-trapping-math
9281 Compile code assuming that floating-point operations cannot generate
9282 user-visible traps.  These traps include division by zero, overflow,
9283 underflow, inexact result and invalid operation.  This option requires
9284 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9285 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9287 This option should never be turned on by any @option{-O} option since
9288 it can result in incorrect output for programs that depend on
9289 an exact implementation of IEEE or ISO rules/specifications for
9290 math functions.
9292 The default is @option{-ftrapping-math}.
9294 @item -frounding-math
9295 @opindex frounding-math
9296 Disable transformations and optimizations that assume default floating-point
9297 rounding behavior.  This is round-to-zero for all floating point
9298 to integer conversions, and round-to-nearest for all other arithmetic
9299 truncations.  This option should be specified for programs that change
9300 the FP rounding mode dynamically, or that may be executed with a
9301 non-default rounding mode.  This option disables constant folding of
9302 floating-point expressions at compile time (which may be affected by
9303 rounding mode) and arithmetic transformations that are unsafe in the
9304 presence of sign-dependent rounding modes.
9306 The default is @option{-fno-rounding-math}.
9308 This option is experimental and does not currently guarantee to
9309 disable all GCC optimizations that are affected by rounding mode.
9310 Future versions of GCC may provide finer control of this setting
9311 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9312 will be used to specify the default state for @code{FENV_ACCESS}.
9314 @item -fsignaling-nans
9315 @opindex fsignaling-nans
9316 Compile code assuming that IEEE signaling NaNs may generate user-visible
9317 traps during floating-point operations.  Setting this option disables
9318 optimizations that may change the number of exceptions visible with
9319 signaling NaNs.  This option implies @option{-ftrapping-math}.
9321 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9322 be defined.
9324 The default is @option{-fno-signaling-nans}.
9326 This option is experimental and does not currently guarantee to
9327 disable all GCC optimizations that affect signaling NaN behavior.
9329 @item -fno-fp-int-builtin-inexact
9330 @opindex fno-fp-int-builtin-inexact
9331 Do not allow the built-in functions @code{ceil}, @code{floor},
9332 @code{round} and @code{trunc}, and their @code{float} and @code{long
9333 double} variants, to generate code that raises the ``inexact''
9334 floating-point exception for noninteger arguments.  ISO C99 and C11
9335 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9336 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9337 functions to do so.
9339 The default is @option{-ffp-int-builtin-inexact}, allowing the
9340 exception to be raised.  This option does nothing unless
9341 @option{-ftrapping-math} is in effect.
9343 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9344 generate a call to a library function then the ``inexact'' exception
9345 may be raised if the library implementation does not follow TS 18661.
9347 @item -fsingle-precision-constant
9348 @opindex fsingle-precision-constant
9349 Treat floating-point constants as single precision instead of
9350 implicitly converting them to double-precision constants.
9352 @item -fcx-limited-range
9353 @opindex fcx-limited-range
9354 When enabled, this option states that a range reduction step is not
9355 needed when performing complex division.  Also, there is no checking
9356 whether the result of a complex multiplication or division is @code{NaN
9357 + I*NaN}, with an attempt to rescue the situation in that case.  The
9358 default is @option{-fno-cx-limited-range}, but is enabled by
9359 @option{-ffast-math}.
9361 This option controls the default setting of the ISO C99
9362 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9363 all languages.
9365 @item -fcx-fortran-rules
9366 @opindex fcx-fortran-rules
9367 Complex multiplication and division follow Fortran rules.  Range
9368 reduction is done as part of complex division, but there is no checking
9369 whether the result of a complex multiplication or division is @code{NaN
9370 + I*NaN}, with an attempt to rescue the situation in that case.
9372 The default is @option{-fno-cx-fortran-rules}.
9374 @end table
9376 The following options control optimizations that may improve
9377 performance, but are not enabled by any @option{-O} options.  This
9378 section includes experimental options that may produce broken code.
9380 @table @gcctabopt
9381 @item -fbranch-probabilities
9382 @opindex fbranch-probabilities
9383 After running a program compiled with @option{-fprofile-arcs}
9384 (@pxref{Instrumentation Options}),
9385 you can compile it a second time using
9386 @option{-fbranch-probabilities}, to improve optimizations based on
9387 the number of times each branch was taken.  When a program
9388 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9389 counts to a file called @file{@var{sourcename}.gcda} for each source
9390 file.  The information in this data file is very dependent on the
9391 structure of the generated code, so you must use the same source code
9392 and the same optimization options for both compilations.
9394 With @option{-fbranch-probabilities}, GCC puts a
9395 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9396 These can be used to improve optimization.  Currently, they are only
9397 used in one place: in @file{reorg.c}, instead of guessing which path a
9398 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9399 exactly determine which path is taken more often.
9401 @item -fprofile-values
9402 @opindex fprofile-values
9403 If combined with @option{-fprofile-arcs}, it adds code so that some
9404 data about values of expressions in the program is gathered.
9406 With @option{-fbranch-probabilities}, it reads back the data gathered
9407 from profiling values of expressions for usage in optimizations.
9409 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9411 @item -fprofile-reorder-functions
9412 @opindex fprofile-reorder-functions
9413 Function reordering based on profile instrumentation collects
9414 first time of execution of a function and orders these functions
9415 in ascending order.
9417 Enabled with @option{-fprofile-use}.
9419 @item -fvpt
9420 @opindex fvpt
9421 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9422 to add code to gather information about values of expressions.
9424 With @option{-fbranch-probabilities}, it reads back the data gathered
9425 and actually performs the optimizations based on them.
9426 Currently the optimizations include specialization of division operations
9427 using the knowledge about the value of the denominator.
9429 @item -frename-registers
9430 @opindex frename-registers
9431 Attempt to avoid false dependencies in scheduled code by making use
9432 of registers left over after register allocation.  This optimization
9433 most benefits processors with lots of registers.  Depending on the
9434 debug information format adopted by the target, however, it can
9435 make debugging impossible, since variables no longer stay in
9436 a ``home register''.
9438 Enabled by default with @option{-funroll-loops}.
9440 @item -fschedule-fusion
9441 @opindex fschedule-fusion
9442 Performs a target dependent pass over the instruction stream to schedule
9443 instructions of same type together because target machine can execute them
9444 more efficiently if they are adjacent to each other in the instruction flow.
9446 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9448 @item -ftracer
9449 @opindex ftracer
9450 Perform tail duplication to enlarge superblock size.  This transformation
9451 simplifies the control flow of the function allowing other optimizations to do
9452 a better job.
9454 Enabled with @option{-fprofile-use}.
9456 @item -funroll-loops
9457 @opindex funroll-loops
9458 Unroll loops whose number of iterations can be determined at compile time or
9459 upon entry to the loop.  @option{-funroll-loops} implies
9460 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9461 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9462 a small constant number of iterations).  This option makes code larger, and may
9463 or may not make it run faster.
9465 Enabled with @option{-fprofile-use}.
9467 @item -funroll-all-loops
9468 @opindex funroll-all-loops
9469 Unroll all loops, even if their number of iterations is uncertain when
9470 the loop is entered.  This usually makes programs run more slowly.
9471 @option{-funroll-all-loops} implies the same options as
9472 @option{-funroll-loops}.
9474 @item -fpeel-loops
9475 @opindex fpeel-loops
9476 Peels loops for which there is enough information that they do not
9477 roll much (from profile feedback or static analysis).  It also turns on
9478 complete loop peeling (i.e.@: complete removal of loops with small constant
9479 number of iterations).
9481 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9483 @item -fmove-loop-invariants
9484 @opindex fmove-loop-invariants
9485 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9486 at level @option{-O1}
9488 @item -fsplit-loops
9489 @opindex fsplit-loops
9490 Split a loop into two if it contains a condition that's always true
9491 for one side of the iteration space and false for the other.
9493 @item -funswitch-loops
9494 @opindex funswitch-loops
9495 Move branches with loop invariant conditions out of the loop, with duplicates
9496 of the loop on both branches (modified according to result of the condition).
9498 @item -ffunction-sections
9499 @itemx -fdata-sections
9500 @opindex ffunction-sections
9501 @opindex fdata-sections
9502 Place each function or data item into its own section in the output
9503 file if the target supports arbitrary sections.  The name of the
9504 function or the name of the data item determines the section's name
9505 in the output file.
9507 Use these options on systems where the linker can perform optimizations
9508 to improve locality of reference in the instruction space.  Most systems
9509 using the ELF object format and SPARC processors running Solaris 2 have
9510 linkers with such optimizations.  AIX may have these optimizations in
9511 the future.
9513 Only use these options when there are significant benefits from doing
9514 so.  When you specify these options, the assembler and linker
9515 create larger object and executable files and are also slower.
9516 You cannot use @command{gprof} on all systems if you
9517 specify this option, and you may have problems with debugging if
9518 you specify both this option and @option{-g}.
9520 @item -fbranch-target-load-optimize
9521 @opindex fbranch-target-load-optimize
9522 Perform branch target register load optimization before prologue / epilogue
9523 threading.
9524 The use of target registers can typically be exposed only during reload,
9525 thus hoisting loads out of loops and doing inter-block scheduling needs
9526 a separate optimization pass.
9528 @item -fbranch-target-load-optimize2
9529 @opindex fbranch-target-load-optimize2
9530 Perform branch target register load optimization after prologue / epilogue
9531 threading.
9533 @item -fbtr-bb-exclusive
9534 @opindex fbtr-bb-exclusive
9535 When performing branch target register load optimization, don't reuse
9536 branch target registers within any basic block.
9538 @item -fstdarg-opt
9539 @opindex fstdarg-opt
9540 Optimize the prologue of variadic argument functions with respect to usage of
9541 those arguments.
9543 @item -fsection-anchors
9544 @opindex fsection-anchors
9545 Try to reduce the number of symbolic address calculations by using
9546 shared ``anchor'' symbols to address nearby objects.  This transformation
9547 can help to reduce the number of GOT entries and GOT accesses on some
9548 targets.
9550 For example, the implementation of the following function @code{foo}:
9552 @smallexample
9553 static int a, b, c;
9554 int foo (void) @{ return a + b + c; @}
9555 @end smallexample
9557 @noindent
9558 usually calculates the addresses of all three variables, but if you
9559 compile it with @option{-fsection-anchors}, it accesses the variables
9560 from a common anchor point instead.  The effect is similar to the
9561 following pseudocode (which isn't valid C):
9563 @smallexample
9564 int foo (void)
9566   register int *xr = &x;
9567   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9569 @end smallexample
9571 Not all targets support this option.
9573 @item --param @var{name}=@var{value}
9574 @opindex param
9575 In some places, GCC uses various constants to control the amount of
9576 optimization that is done.  For example, GCC does not inline functions
9577 that contain more than a certain number of instructions.  You can
9578 control some of these constants on the command line using the
9579 @option{--param} option.
9581 The names of specific parameters, and the meaning of the values, are
9582 tied to the internals of the compiler, and are subject to change
9583 without notice in future releases.
9585 In each case, the @var{value} is an integer.  The allowable choices for
9586 @var{name} are:
9588 @table @gcctabopt
9589 @item predictable-branch-outcome
9590 When branch is predicted to be taken with probability lower than this threshold
9591 (in percent), then it is considered well predictable. The default is 10.
9593 @item max-rtl-if-conversion-insns
9594 RTL if-conversion tries to remove conditional branches around a block and
9595 replace them with conditionally executed instructions.  This parameter
9596 gives the maximum number of instructions in a block which should be
9597 considered for if-conversion.  The default is 10, though the compiler will
9598 also use other heuristics to decide whether if-conversion is likely to be
9599 profitable.
9601 @item max-rtl-if-conversion-predictable-cost
9602 @item max-rtl-if-conversion-unpredictable-cost
9603 RTL if-conversion will try to remove conditional branches around a block
9604 and replace them with conditionally executed instructions.  These parameters
9605 give the maximum permissible cost for the sequence that would be generated
9606 by if-conversion depending on whether the branch is statically determined
9607 to be predictable or not.  The units for this parameter are the same as
9608 those for the GCC internal seq_cost metric.  The compiler will try to
9609 provide a reasonable default for this parameter using the BRANCH_COST
9610 target macro.
9612 @item max-crossjump-edges
9613 The maximum number of incoming edges to consider for cross-jumping.
9614 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9615 the number of edges incoming to each block.  Increasing values mean
9616 more aggressive optimization, making the compilation time increase with
9617 probably small improvement in executable size.
9619 @item min-crossjump-insns
9620 The minimum number of instructions that must be matched at the end
9621 of two blocks before cross-jumping is performed on them.  This
9622 value is ignored in the case where all instructions in the block being
9623 cross-jumped from are matched.  The default value is 5.
9625 @item max-grow-copy-bb-insns
9626 The maximum code size expansion factor when copying basic blocks
9627 instead of jumping.  The expansion is relative to a jump instruction.
9628 The default value is 8.
9630 @item max-goto-duplication-insns
9631 The maximum number of instructions to duplicate to a block that jumps
9632 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9633 passes, GCC factors computed gotos early in the compilation process,
9634 and unfactors them as late as possible.  Only computed jumps at the
9635 end of a basic blocks with no more than max-goto-duplication-insns are
9636 unfactored.  The default value is 8.
9638 @item max-delay-slot-insn-search
9639 The maximum number of instructions to consider when looking for an
9640 instruction to fill a delay slot.  If more than this arbitrary number of
9641 instructions are searched, the time savings from filling the delay slot
9642 are minimal, so stop searching.  Increasing values mean more
9643 aggressive optimization, making the compilation time increase with probably
9644 small improvement in execution time.
9646 @item max-delay-slot-live-search
9647 When trying to fill delay slots, the maximum number of instructions to
9648 consider when searching for a block with valid live register
9649 information.  Increasing this arbitrarily chosen value means more
9650 aggressive optimization, increasing the compilation time.  This parameter
9651 should be removed when the delay slot code is rewritten to maintain the
9652 control-flow graph.
9654 @item max-gcse-memory
9655 The approximate maximum amount of memory that can be allocated in
9656 order to perform the global common subexpression elimination
9657 optimization.  If more memory than specified is required, the
9658 optimization is not done.
9660 @item max-gcse-insertion-ratio
9661 If the ratio of expression insertions to deletions is larger than this value
9662 for any expression, then RTL PRE inserts or removes the expression and thus
9663 leaves partially redundant computations in the instruction stream.  The default value is 20.
9665 @item max-pending-list-length
9666 The maximum number of pending dependencies scheduling allows
9667 before flushing the current state and starting over.  Large functions
9668 with few branches or calls can create excessively large lists which
9669 needlessly consume memory and resources.
9671 @item max-modulo-backtrack-attempts
9672 The maximum number of backtrack attempts the scheduler should make
9673 when modulo scheduling a loop.  Larger values can exponentially increase
9674 compilation time.
9676 @item max-inline-insns-single
9677 Several parameters control the tree inliner used in GCC@.
9678 This number sets the maximum number of instructions (counted in GCC's
9679 internal representation) in a single function that the tree inliner
9680 considers for inlining.  This only affects functions declared
9681 inline and methods implemented in a class declaration (C++).
9682 The default value is 400.
9684 @item max-inline-insns-auto
9685 When you use @option{-finline-functions} (included in @option{-O3}),
9686 a lot of functions that would otherwise not be considered for inlining
9687 by the compiler are investigated.  To those functions, a different
9688 (more restrictive) limit compared to functions declared inline can
9689 be applied.
9690 The default value is 40.
9692 @item inline-min-speedup
9693 When estimated performance improvement of caller + callee runtime exceeds this
9694 threshold (in precent), the function can be inlined regardless the limit on
9695 @option{--param max-inline-insns-single} and @option{--param
9696 max-inline-insns-auto}.
9698 @item large-function-insns
9699 The limit specifying really large functions.  For functions larger than this
9700 limit after inlining, inlining is constrained by
9701 @option{--param large-function-growth}.  This parameter is useful primarily
9702 to avoid extreme compilation time caused by non-linear algorithms used by the
9703 back end.
9704 The default value is 2700.
9706 @item large-function-growth
9707 Specifies maximal growth of large function caused by inlining in percents.
9708 The default value is 100 which limits large function growth to 2.0 times
9709 the original size.
9711 @item large-unit-insns
9712 The limit specifying large translation unit.  Growth caused by inlining of
9713 units larger than this limit is limited by @option{--param inline-unit-growth}.
9714 For small units this might be too tight.
9715 For example, consider a unit consisting of function A
9716 that is inline and B that just calls A three times.  If B is small relative to
9717 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9718 large units consisting of small inlineable functions, however, the overall unit
9719 growth limit is needed to avoid exponential explosion of code size.  Thus for
9720 smaller units, the size is increased to @option{--param large-unit-insns}
9721 before applying @option{--param inline-unit-growth}.  The default is 10000.
9723 @item inline-unit-growth
9724 Specifies maximal overall growth of the compilation unit caused by inlining.
9725 The default value is 20 which limits unit growth to 1.2 times the original
9726 size. Cold functions (either marked cold via an attribute or by profile
9727 feedback) are not accounted into the unit size.
9729 @item ipcp-unit-growth
9730 Specifies maximal overall growth of the compilation unit caused by
9731 interprocedural constant propagation.  The default value is 10 which limits
9732 unit growth to 1.1 times the original size.
9734 @item large-stack-frame
9735 The limit specifying large stack frames.  While inlining the algorithm is trying
9736 to not grow past this limit too much.  The default value is 256 bytes.
9738 @item large-stack-frame-growth
9739 Specifies maximal growth of large stack frames caused by inlining in percents.
9740 The default value is 1000 which limits large stack frame growth to 11 times
9741 the original size.
9743 @item max-inline-insns-recursive
9744 @itemx max-inline-insns-recursive-auto
9745 Specifies the maximum number of instructions an out-of-line copy of a
9746 self-recursive inline
9747 function can grow into by performing recursive inlining.
9749 @option{--param max-inline-insns-recursive} applies to functions
9750 declared inline.
9751 For functions not declared inline, recursive inlining
9752 happens only when @option{-finline-functions} (included in @option{-O3}) is
9753 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9754 default value is 450.
9756 @item max-inline-recursive-depth
9757 @itemx max-inline-recursive-depth-auto
9758 Specifies the maximum recursion depth used for recursive inlining.
9760 @option{--param max-inline-recursive-depth} applies to functions
9761 declared inline.  For functions not declared inline, recursive inlining
9762 happens only when @option{-finline-functions} (included in @option{-O3}) is
9763 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9764 default value is 8.
9766 @item min-inline-recursive-probability
9767 Recursive inlining is profitable only for function having deep recursion
9768 in average and can hurt for function having little recursion depth by
9769 increasing the prologue size or complexity of function body to other
9770 optimizers.
9772 When profile feedback is available (see @option{-fprofile-generate}) the actual
9773 recursion depth can be guessed from the probability that function recurses
9774 via a given call expression.  This parameter limits inlining only to call
9775 expressions whose probability exceeds the given threshold (in percents).
9776 The default value is 10.
9778 @item early-inlining-insns
9779 Specify growth that the early inliner can make.  In effect it increases
9780 the amount of inlining for code having a large abstraction penalty.
9781 The default value is 14.
9783 @item max-early-inliner-iterations
9784 Limit of iterations of the early inliner.  This basically bounds
9785 the number of nested indirect calls the early inliner can resolve.
9786 Deeper chains are still handled by late inlining.
9788 @item comdat-sharing-probability
9789 Probability (in percent) that C++ inline function with comdat visibility
9790 are shared across multiple compilation units.  The default value is 20.
9792 @item profile-func-internal-id
9793 A parameter to control whether to use function internal id in profile
9794 database lookup. If the value is 0, the compiler uses an id that
9795 is based on function assembler name and filename, which makes old profile
9796 data more tolerant to source changes such as function reordering etc.
9797 The default value is 0.
9799 @item min-vect-loop-bound
9800 The minimum number of iterations under which loops are not vectorized
9801 when @option{-ftree-vectorize} is used.  The number of iterations after
9802 vectorization needs to be greater than the value specified by this option
9803 to allow vectorization.  The default value is 0.
9805 @item gcse-cost-distance-ratio
9806 Scaling factor in calculation of maximum distance an expression
9807 can be moved by GCSE optimizations.  This is currently supported only in the
9808 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9809 is with simple expressions, i.e., the expressions that have cost
9810 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9811 hoisting of simple expressions.  The default value is 10.
9813 @item gcse-unrestricted-cost
9814 Cost, roughly measured as the cost of a single typical machine
9815 instruction, at which GCSE optimizations do not constrain
9816 the distance an expression can travel.  This is currently
9817 supported only in the code hoisting pass.  The lesser the cost,
9818 the more aggressive code hoisting is.  Specifying 0 
9819 allows all expressions to travel unrestricted distances.
9820 The default value is 3.
9822 @item max-hoist-depth
9823 The depth of search in the dominator tree for expressions to hoist.
9824 This is used to avoid quadratic behavior in hoisting algorithm.
9825 The value of 0 does not limit on the search, but may slow down compilation
9826 of huge functions.  The default value is 30.
9828 @item max-tail-merge-comparisons
9829 The maximum amount of similar bbs to compare a bb with.  This is used to
9830 avoid quadratic behavior in tree tail merging.  The default value is 10.
9832 @item max-tail-merge-iterations
9833 The maximum amount of iterations of the pass over the function.  This is used to
9834 limit compilation time in tree tail merging.  The default value is 2.
9836 @item store-merging-allow-unaligned
9837 Allow the store merging pass to introduce unaligned stores if it is legal to
9838 do so.  The default value is 1.
9840 @item max-stores-to-merge
9841 The maximum number of stores to attempt to merge into wider stores in the store
9842 merging pass.  The minimum value is 2 and the default is 64.
9844 @item max-unrolled-insns
9845 The maximum number of instructions that a loop may have to be unrolled.
9846 If a loop is unrolled, this parameter also determines how many times
9847 the loop code is unrolled.
9849 @item max-average-unrolled-insns
9850 The maximum number of instructions biased by probabilities of their execution
9851 that a loop may have to be unrolled.  If a loop is unrolled,
9852 this parameter also determines how many times the loop code is unrolled.
9854 @item max-unroll-times
9855 The maximum number of unrollings of a single loop.
9857 @item max-peeled-insns
9858 The maximum number of instructions that a loop may have to be peeled.
9859 If a loop is peeled, this parameter also determines how many times
9860 the loop code is peeled.
9862 @item max-peel-times
9863 The maximum number of peelings of a single loop.
9865 @item max-peel-branches
9866 The maximum number of branches on the hot path through the peeled sequence.
9868 @item max-completely-peeled-insns
9869 The maximum number of insns of a completely peeled loop.
9871 @item max-completely-peel-times
9872 The maximum number of iterations of a loop to be suitable for complete peeling.
9874 @item max-completely-peel-loop-nest-depth
9875 The maximum depth of a loop nest suitable for complete peeling.
9877 @item max-unswitch-insns
9878 The maximum number of insns of an unswitched loop.
9880 @item max-unswitch-level
9881 The maximum number of branches unswitched in a single loop.
9883 @item max-loop-headers-insns
9884 The maximum number of insns in loop header duplicated by he copy loop headers
9885 pass.
9887 @item lim-expensive
9888 The minimum cost of an expensive expression in the loop invariant motion.
9890 @item iv-consider-all-candidates-bound
9891 Bound on number of candidates for induction variables, below which
9892 all candidates are considered for each use in induction variable
9893 optimizations.  If there are more candidates than this,
9894 only the most relevant ones are considered to avoid quadratic time complexity.
9896 @item iv-max-considered-uses
9897 The induction variable optimizations give up on loops that contain more
9898 induction variable uses.
9900 @item iv-always-prune-cand-set-bound
9901 If the number of candidates in the set is smaller than this value,
9902 always try to remove unnecessary ivs from the set
9903 when adding a new one.
9905 @item avg-loop-niter
9906 Average number of iterations of a loop.
9908 @item dse-max-object-size
9909 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
9910 Larger values may result in larger compilation times.
9912 @item scev-max-expr-size
9913 Bound on size of expressions used in the scalar evolutions analyzer.
9914 Large expressions slow the analyzer.
9916 @item scev-max-expr-complexity
9917 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9918 Complex expressions slow the analyzer.
9920 @item max-tree-if-conversion-phi-args
9921 Maximum number of arguments in a PHI supported by TREE if conversion
9922 unless the loop is marked with simd pragma.
9924 @item vect-max-version-for-alignment-checks
9925 The maximum number of run-time checks that can be performed when
9926 doing loop versioning for alignment in the vectorizer.
9928 @item vect-max-version-for-alias-checks
9929 The maximum number of run-time checks that can be performed when
9930 doing loop versioning for alias in the vectorizer.
9932 @item vect-max-peeling-for-alignment
9933 The maximum number of loop peels to enhance access alignment
9934 for vectorizer. Value -1 means no limit.
9936 @item max-iterations-to-track
9937 The maximum number of iterations of a loop the brute-force algorithm
9938 for analysis of the number of iterations of the loop tries to evaluate.
9940 @item hot-bb-count-ws-permille
9941 A basic block profile count is considered hot if it contributes to 
9942 the given permillage (i.e. 0...1000) of the entire profiled execution.
9944 @item hot-bb-frequency-fraction
9945 Select fraction of the entry block frequency of executions of basic block in
9946 function given basic block needs to have to be considered hot.
9948 @item max-predicted-iterations
9949 The maximum number of loop iterations we predict statically.  This is useful
9950 in cases where a function contains a single loop with known bound and
9951 another loop with unknown bound.
9952 The known number of iterations is predicted correctly, while
9953 the unknown number of iterations average to roughly 10.  This means that the
9954 loop without bounds appears artificially cold relative to the other one.
9956 @item builtin-expect-probability
9957 Control the probability of the expression having the specified value. This
9958 parameter takes a percentage (i.e. 0 ... 100) as input.
9959 The default probability of 90 is obtained empirically.
9961 @item align-threshold
9963 Select fraction of the maximal frequency of executions of a basic block in
9964 a function to align the basic block.
9966 @item align-loop-iterations
9968 A loop expected to iterate at least the selected number of iterations is
9969 aligned.
9971 @item tracer-dynamic-coverage
9972 @itemx tracer-dynamic-coverage-feedback
9974 This value is used to limit superblock formation once the given percentage of
9975 executed instructions is covered.  This limits unnecessary code size
9976 expansion.
9978 The @option{tracer-dynamic-coverage-feedback} parameter
9979 is used only when profile
9980 feedback is available.  The real profiles (as opposed to statically estimated
9981 ones) are much less balanced allowing the threshold to be larger value.
9983 @item tracer-max-code-growth
9984 Stop tail duplication once code growth has reached given percentage.  This is
9985 a rather artificial limit, as most of the duplicates are eliminated later in
9986 cross jumping, so it may be set to much higher values than is the desired code
9987 growth.
9989 @item tracer-min-branch-ratio
9991 Stop reverse growth when the reverse probability of best edge is less than this
9992 threshold (in percent).
9994 @item tracer-min-branch-probability
9995 @itemx tracer-min-branch-probability-feedback
9997 Stop forward growth if the best edge has probability lower than this
9998 threshold.
10000 Similarly to @option{tracer-dynamic-coverage} two parameters are
10001 provided.  @option{tracer-min-branch-probability-feedback} is used for
10002 compilation with profile feedback and @option{tracer-min-branch-probability}
10003 compilation without.  The value for compilation with profile feedback
10004 needs to be more conservative (higher) in order to make tracer
10005 effective.
10007 @item max-cse-path-length
10009 The maximum number of basic blocks on path that CSE considers.
10010 The default is 10.
10012 @item max-cse-insns
10013 The maximum number of instructions CSE processes before flushing.
10014 The default is 1000.
10016 @item ggc-min-expand
10018 GCC uses a garbage collector to manage its own memory allocation.  This
10019 parameter specifies the minimum percentage by which the garbage
10020 collector's heap should be allowed to expand between collections.
10021 Tuning this may improve compilation speed; it has no effect on code
10022 generation.
10024 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10025 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10026 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10027 GCC is not able to calculate RAM on a particular platform, the lower
10028 bound of 30% is used.  Setting this parameter and
10029 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10030 every opportunity.  This is extremely slow, but can be useful for
10031 debugging.
10033 @item ggc-min-heapsize
10035 Minimum size of the garbage collector's heap before it begins bothering
10036 to collect garbage.  The first collection occurs after the heap expands
10037 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10038 tuning this may improve compilation speed, and has no effect on code
10039 generation.
10041 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10042 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10043 with a lower bound of 4096 (four megabytes) and an upper bound of
10044 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10045 particular platform, the lower bound is used.  Setting this parameter
10046 very large effectively disables garbage collection.  Setting this
10047 parameter and @option{ggc-min-expand} to zero causes a full collection
10048 to occur at every opportunity.
10050 @item max-reload-search-insns
10051 The maximum number of instruction reload should look backward for equivalent
10052 register.  Increasing values mean more aggressive optimization, making the
10053 compilation time increase with probably slightly better performance.
10054 The default value is 100.
10056 @item max-cselib-memory-locations
10057 The maximum number of memory locations cselib should take into account.
10058 Increasing values mean more aggressive optimization, making the compilation time
10059 increase with probably slightly better performance.  The default value is 500.
10061 @item max-sched-ready-insns
10062 The maximum number of instructions ready to be issued the scheduler should
10063 consider at any given time during the first scheduling pass.  Increasing
10064 values mean more thorough searches, making the compilation time increase
10065 with probably little benefit.  The default value is 100.
10067 @item max-sched-region-blocks
10068 The maximum number of blocks in a region to be considered for
10069 interblock scheduling.  The default value is 10.
10071 @item max-pipeline-region-blocks
10072 The maximum number of blocks in a region to be considered for
10073 pipelining in the selective scheduler.  The default value is 15.
10075 @item max-sched-region-insns
10076 The maximum number of insns in a region to be considered for
10077 interblock scheduling.  The default value is 100.
10079 @item max-pipeline-region-insns
10080 The maximum number of insns in a region to be considered for
10081 pipelining in the selective scheduler.  The default value is 200.
10083 @item min-spec-prob
10084 The minimum probability (in percents) of reaching a source block
10085 for interblock speculative scheduling.  The default value is 40.
10087 @item max-sched-extend-regions-iters
10088 The maximum number of iterations through CFG to extend regions.
10089 A value of 0 (the default) disables region extensions.
10091 @item max-sched-insn-conflict-delay
10092 The maximum conflict delay for an insn to be considered for speculative motion.
10093 The default value is 3.
10095 @item sched-spec-prob-cutoff
10096 The minimal probability of speculation success (in percents), so that
10097 speculative insns are scheduled.
10098 The default value is 40.
10100 @item sched-state-edge-prob-cutoff
10101 The minimum probability an edge must have for the scheduler to save its
10102 state across it.
10103 The default value is 10.
10105 @item sched-mem-true-dep-cost
10106 Minimal distance (in CPU cycles) between store and load targeting same
10107 memory locations.  The default value is 1.
10109 @item selsched-max-lookahead
10110 The maximum size of the lookahead window of selective scheduling.  It is a
10111 depth of search for available instructions.
10112 The default value is 50.
10114 @item selsched-max-sched-times
10115 The maximum number of times that an instruction is scheduled during
10116 selective scheduling.  This is the limit on the number of iterations
10117 through which the instruction may be pipelined.  The default value is 2.
10119 @item selsched-insns-to-rename
10120 The maximum number of best instructions in the ready list that are considered
10121 for renaming in the selective scheduler.  The default value is 2.
10123 @item sms-min-sc
10124 The minimum value of stage count that swing modulo scheduler
10125 generates.  The default value is 2.
10127 @item max-last-value-rtl
10128 The maximum size measured as number of RTLs that can be recorded in an expression
10129 in combiner for a pseudo register as last known value of that register.  The default
10130 is 10000.
10132 @item max-combine-insns
10133 The maximum number of instructions the RTL combiner tries to combine.
10134 The default value is 2 at @option{-Og} and 4 otherwise.
10136 @item integer-share-limit
10137 Small integer constants can use a shared data structure, reducing the
10138 compiler's memory usage and increasing its speed.  This sets the maximum
10139 value of a shared integer constant.  The default value is 256.
10141 @item ssp-buffer-size
10142 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10143 protection when @option{-fstack-protection} is used.
10145 @item min-size-for-stack-sharing
10146 The minimum size of variables taking part in stack slot sharing when not
10147 optimizing. The default value is 32.
10149 @item max-jump-thread-duplication-stmts
10150 Maximum number of statements allowed in a block that needs to be
10151 duplicated when threading jumps.
10153 @item max-fields-for-field-sensitive
10154 Maximum number of fields in a structure treated in
10155 a field sensitive manner during pointer analysis.  The default is zero
10156 for @option{-O0} and @option{-O1},
10157 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10159 @item prefetch-latency
10160 Estimate on average number of instructions that are executed before
10161 prefetch finishes.  The distance prefetched ahead is proportional
10162 to this constant.  Increasing this number may also lead to less
10163 streams being prefetched (see @option{simultaneous-prefetches}).
10165 @item simultaneous-prefetches
10166 Maximum number of prefetches that can run at the same time.
10168 @item l1-cache-line-size
10169 The size of cache line in L1 cache, in bytes.
10171 @item l1-cache-size
10172 The size of L1 cache, in kilobytes.
10174 @item l2-cache-size
10175 The size of L2 cache, in kilobytes.
10177 @item min-insn-to-prefetch-ratio
10178 The minimum ratio between the number of instructions and the
10179 number of prefetches to enable prefetching in a loop.
10181 @item prefetch-min-insn-to-mem-ratio
10182 The minimum ratio between the number of instructions and the
10183 number of memory references to enable prefetching in a loop.
10185 @item use-canonical-types
10186 Whether the compiler should use the ``canonical'' type system.  By
10187 default, this should always be 1, which uses a more efficient internal
10188 mechanism for comparing types in C++ and Objective-C++.  However, if
10189 bugs in the canonical type system are causing compilation failures,
10190 set this value to 0 to disable canonical types.
10192 @item switch-conversion-max-branch-ratio
10193 Switch initialization conversion refuses to create arrays that are
10194 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10195 branches in the switch.
10197 @item max-partial-antic-length
10198 Maximum length of the partial antic set computed during the tree
10199 partial redundancy elimination optimization (@option{-ftree-pre}) when
10200 optimizing at @option{-O3} and above.  For some sorts of source code
10201 the enhanced partial redundancy elimination optimization can run away,
10202 consuming all of the memory available on the host machine.  This
10203 parameter sets a limit on the length of the sets that are computed,
10204 which prevents the runaway behavior.  Setting a value of 0 for
10205 this parameter allows an unlimited set length.
10207 @item sccvn-max-scc-size
10208 Maximum size of a strongly connected component (SCC) during SCCVN
10209 processing.  If this limit is hit, SCCVN processing for the whole
10210 function is not done and optimizations depending on it are
10211 disabled.  The default maximum SCC size is 10000.
10213 @item sccvn-max-alias-queries-per-access
10214 Maximum number of alias-oracle queries we perform when looking for
10215 redundancies for loads and stores.  If this limit is hit the search
10216 is aborted and the load or store is not considered redundant.  The
10217 number of queries is algorithmically limited to the number of
10218 stores on all paths from the load to the function entry.
10219 The default maximum number of queries is 1000.
10221 @item ira-max-loops-num
10222 IRA uses regional register allocation by default.  If a function
10223 contains more loops than the number given by this parameter, only at most
10224 the given number of the most frequently-executed loops form regions
10225 for regional register allocation.  The default value of the
10226 parameter is 100.
10228 @item ira-max-conflict-table-size 
10229 Although IRA uses a sophisticated algorithm to compress the conflict
10230 table, the table can still require excessive amounts of memory for
10231 huge functions.  If the conflict table for a function could be more
10232 than the size in MB given by this parameter, the register allocator
10233 instead uses a faster, simpler, and lower-quality
10234 algorithm that does not require building a pseudo-register conflict table.  
10235 The default value of the parameter is 2000.
10237 @item ira-loop-reserved-regs
10238 IRA can be used to evaluate more accurate register pressure in loops
10239 for decisions to move loop invariants (see @option{-O3}).  The number
10240 of available registers reserved for some other purposes is given
10241 by this parameter.  The default value of the parameter is 2, which is
10242 the minimal number of registers needed by typical instructions.
10243 This value is the best found from numerous experiments.
10245 @item lra-inheritance-ebb-probability-cutoff
10246 LRA tries to reuse values reloaded in registers in subsequent insns.
10247 This optimization is called inheritance.  EBB is used as a region to
10248 do this optimization.  The parameter defines a minimal fall-through
10249 edge probability in percentage used to add BB to inheritance EBB in
10250 LRA.  The default value of the parameter is 40.  The value was chosen
10251 from numerous runs of SPEC2000 on x86-64.
10253 @item loop-invariant-max-bbs-in-loop
10254 Loop invariant motion can be very expensive, both in compilation time and
10255 in amount of needed compile-time memory, with very large loops.  Loops
10256 with more basic blocks than this parameter won't have loop invariant
10257 motion optimization performed on them.  The default value of the
10258 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10260 @item loop-max-datarefs-for-datadeps
10261 Building data dependencies is expensive for very large loops.  This
10262 parameter limits the number of data references in loops that are
10263 considered for data dependence analysis.  These large loops are no
10264 handled by the optimizations using loop data dependencies.
10265 The default value is 1000.
10267 @item max-vartrack-size
10268 Sets a maximum number of hash table slots to use during variable
10269 tracking dataflow analysis of any function.  If this limit is exceeded
10270 with variable tracking at assignments enabled, analysis for that
10271 function is retried without it, after removing all debug insns from
10272 the function.  If the limit is exceeded even without debug insns, var
10273 tracking analysis is completely disabled for the function.  Setting
10274 the parameter to zero makes it unlimited.
10276 @item max-vartrack-expr-depth
10277 Sets a maximum number of recursion levels when attempting to map
10278 variable names or debug temporaries to value expressions.  This trades
10279 compilation time for more complete debug information.  If this is set too
10280 low, value expressions that are available and could be represented in
10281 debug information may end up not being used; setting this higher may
10282 enable the compiler to find more complex debug expressions, but compile
10283 time and memory use may grow.  The default is 12.
10285 @item min-nondebug-insn-uid
10286 Use uids starting at this parameter for nondebug insns.  The range below
10287 the parameter is reserved exclusively for debug insns created by
10288 @option{-fvar-tracking-assignments}, but debug insns may get
10289 (non-overlapping) uids above it if the reserved range is exhausted.
10291 @item ipa-sra-ptr-growth-factor
10292 IPA-SRA replaces a pointer to an aggregate with one or more new
10293 parameters only when their cumulative size is less or equal to
10294 @option{ipa-sra-ptr-growth-factor} times the size of the original
10295 pointer parameter.
10297 @item sra-max-scalarization-size-Ospeed
10298 @item sra-max-scalarization-size-Osize
10299 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10300 replace scalar parts of aggregates with uses of independent scalar
10301 variables.  These parameters control the maximum size, in storage units,
10302 of aggregate which is considered for replacement when compiling for
10303 speed
10304 (@option{sra-max-scalarization-size-Ospeed}) or size
10305 (@option{sra-max-scalarization-size-Osize}) respectively.
10307 @item tm-max-aggregate-size
10308 When making copies of thread-local variables in a transaction, this
10309 parameter specifies the size in bytes after which variables are
10310 saved with the logging functions as opposed to save/restore code
10311 sequence pairs.  This option only applies when using
10312 @option{-fgnu-tm}.
10314 @item graphite-max-nb-scop-params
10315 To avoid exponential effects in the Graphite loop transforms, the
10316 number of parameters in a Static Control Part (SCoP) is bounded.  The
10317 default value is 10 parameters.  A variable whose value is unknown at
10318 compilation time and defined outside a SCoP is a parameter of the SCoP.
10320 @item graphite-max-bbs-per-function
10321 To avoid exponential effects in the detection of SCoPs, the size of
10322 the functions analyzed by Graphite is bounded.  The default value is
10323 100 basic blocks.
10325 @item loop-block-tile-size
10326 Loop blocking or strip mining transforms, enabled with
10327 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10328 loop in the loop nest by a given number of iterations.  The strip
10329 length can be changed using the @option{loop-block-tile-size}
10330 parameter.  The default value is 51 iterations.
10332 @item loop-unroll-jam-size
10333 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10334 default value is 4.
10336 @item loop-unroll-jam-depth
10337 Specify the dimension to be unrolled (counting from the most inner loop)
10338 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10340 @item ipa-cp-value-list-size
10341 IPA-CP attempts to track all possible values and types passed to a function's
10342 parameter in order to propagate them and perform devirtualization.
10343 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10344 stores per one formal parameter of a function.
10346 @item ipa-cp-eval-threshold
10347 IPA-CP calculates its own score of cloning profitability heuristics
10348 and performs those cloning opportunities with scores that exceed
10349 @option{ipa-cp-eval-threshold}.
10351 @item ipa-cp-recursion-penalty
10352 Percentage penalty the recursive functions will receive when they
10353 are evaluated for cloning.
10355 @item ipa-cp-single-call-penalty
10356 Percentage penalty functions containing a single call to another
10357 function will receive when they are evaluated for cloning.
10360 @item ipa-max-agg-items
10361 IPA-CP is also capable to propagate a number of scalar values passed
10362 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10363 number of such values per one parameter.
10365 @item ipa-cp-loop-hint-bonus
10366 When IPA-CP determines that a cloning candidate would make the number
10367 of iterations of a loop known, it adds a bonus of
10368 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10369 the candidate.
10371 @item ipa-cp-array-index-hint-bonus
10372 When IPA-CP determines that a cloning candidate would make the index of
10373 an array access known, it adds a bonus of
10374 @option{ipa-cp-array-index-hint-bonus} to the profitability
10375 score of the candidate.
10377 @item ipa-max-aa-steps
10378 During its analysis of function bodies, IPA-CP employs alias analysis
10379 in order to track values pointed to by function parameters.  In order
10380 not spend too much time analyzing huge functions, it gives up and
10381 consider all memory clobbered after examining
10382 @option{ipa-max-aa-steps} statements modifying memory.
10384 @item lto-partitions
10385 Specify desired number of partitions produced during WHOPR compilation.
10386 The number of partitions should exceed the number of CPUs used for compilation.
10387 The default value is 32.
10389 @item lto-min-partition
10390 Size of minimal partition for WHOPR (in estimated instructions).
10391 This prevents expenses of splitting very small programs into too many
10392 partitions.
10394 @item lto-max-partition
10395 Size of max partition for WHOPR (in estimated instructions).
10396 to provide an upper bound for individual size of partition.
10397 Meant to be used only with balanced partitioning.
10399 @item cxx-max-namespaces-for-diagnostic-help
10400 The maximum number of namespaces to consult for suggestions when C++
10401 name lookup fails for an identifier.  The default is 1000.
10403 @item sink-frequency-threshold
10404 The maximum relative execution frequency (in percents) of the target block
10405 relative to a statement's original block to allow statement sinking of a
10406 statement.  Larger numbers result in more aggressive statement sinking.
10407 The default value is 75.  A small positive adjustment is applied for
10408 statements with memory operands as those are even more profitable so sink.
10410 @item max-stores-to-sink
10411 The maximum number of conditional store pairs that can be sunk.  Set to 0
10412 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10413 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10415 @item allow-store-data-races
10416 Allow optimizers to introduce new data races on stores.
10417 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10418 at optimization level @option{-Ofast}.
10420 @item case-values-threshold
10421 The smallest number of different values for which it is best to use a
10422 jump-table instead of a tree of conditional branches.  If the value is
10423 0, use the default for the machine.  The default is 0.
10425 @item tree-reassoc-width
10426 Set the maximum number of instructions executed in parallel in
10427 reassociated tree. This parameter overrides target dependent
10428 heuristics used by default if has non zero value.
10430 @item sched-pressure-algorithm
10431 Choose between the two available implementations of
10432 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10433 and is the more likely to prevent instructions from being reordered.
10434 Algorithm 2 was designed to be a compromise between the relatively
10435 conservative approach taken by algorithm 1 and the rather aggressive
10436 approach taken by the default scheduler.  It relies more heavily on
10437 having a regular register file and accurate register pressure classes.
10438 See @file{haifa-sched.c} in the GCC sources for more details.
10440 The default choice depends on the target.
10442 @item max-slsr-cand-scan
10443 Set the maximum number of existing candidates that are considered when
10444 seeking a basis for a new straight-line strength reduction candidate.
10446 @item asan-globals
10447 Enable buffer overflow detection for global objects.  This kind
10448 of protection is enabled by default if you are using
10449 @option{-fsanitize=address} option.
10450 To disable global objects protection use @option{--param asan-globals=0}.
10452 @item asan-stack
10453 Enable buffer overflow detection for stack objects.  This kind of
10454 protection is enabled by default when using @option{-fsanitize=address}.
10455 To disable stack protection use @option{--param asan-stack=0} option.
10457 @item asan-instrument-reads
10458 Enable buffer overflow detection for memory reads.  This kind of
10459 protection is enabled by default when using @option{-fsanitize=address}.
10460 To disable memory reads protection use
10461 @option{--param asan-instrument-reads=0}.
10463 @item asan-instrument-writes
10464 Enable buffer overflow detection for memory writes.  This kind of
10465 protection is enabled by default when using @option{-fsanitize=address}.
10466 To disable memory writes protection use
10467 @option{--param asan-instrument-writes=0} option.
10469 @item asan-memintrin
10470 Enable detection for built-in functions.  This kind of protection
10471 is enabled by default when using @option{-fsanitize=address}.
10472 To disable built-in functions protection use
10473 @option{--param asan-memintrin=0}.
10475 @item asan-use-after-return
10476 Enable detection of use-after-return.  This kind of protection
10477 is enabled by default when using @option{-fsanitize=address} option.
10478 To disable use-after-return detection use 
10479 @option{--param asan-use-after-return=0}.
10481 Note: The check is disabled by default at runtime.  To enable the check,
10482 you should set environment variable @env{ASAN_OPTIONS} to
10483 @code{detect_stack_use_after_return=1}.
10485 @item asan-instrumentation-with-call-threshold
10486 If number of memory accesses in function being instrumented
10487 is greater or equal to this number, use callbacks instead of inline checks.
10488 E.g. to disable inline code use
10489 @option{--param asan-instrumentation-with-call-threshold=0}.
10491 @item use-after-scope-direct-emission-threshold
10492 If size of a local variables in bytes is smaller of equal to this number,
10493 direct instruction emission is utilized to poison and unpoison local variables.
10495 @item chkp-max-ctor-size
10496 Static constructors generated by Pointer Bounds Checker may become very
10497 large and significantly increase compile time at optimization level
10498 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10499 in a single generated constructor.  Default value is 5000.
10501 @item max-fsm-thread-path-insns
10502 Maximum number of instructions to copy when duplicating blocks on a
10503 finite state automaton jump thread path.  The default is 100.
10505 @item max-fsm-thread-length
10506 Maximum number of basic blocks on a finite state automaton jump thread
10507 path.  The default is 10.
10509 @item max-fsm-thread-paths
10510 Maximum number of new jump thread paths to create for a finite state
10511 automaton.  The default is 50.
10513 @item parloops-chunk-size
10514 Chunk size of omp schedule for loops parallelized by parloops.  The default
10515 is 0.
10517 @item parloops-schedule
10518 Schedule type of omp schedule for loops parallelized by parloops (static,
10519 dynamic, guided, auto, runtime).  The default is static.
10521 @item max-ssa-name-query-depth
10522 Maximum depth of recursion when querying properties of SSA names in things
10523 like fold routines.  One level of recursion corresponds to following a
10524 use-def chain.
10526 @item hsa-gen-debug-stores
10527 Enable emission of special debug stores within HSA kernels which are
10528 then read and reported by libgomp plugin.  Generation of these stores
10529 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10530 enable it.
10532 @item max-speculative-devirt-maydefs
10533 The maximum number of may-defs we analyze when looking for a must-def
10534 specifying the dynamic type of an object that invokes a virtual call
10535 we may be able to devirtualize speculatively.
10537 @item max-vrp-switch-assertions
10538 The maximum number of assertions to add along the default edge of a switch
10539 statement during VRP.  The default is 10.
10540 @end table
10541 @end table
10543 @node Instrumentation Options
10544 @section Program Instrumentation Options
10545 @cindex instrumentation options
10546 @cindex program instrumentation options
10547 @cindex run-time error checking options
10548 @cindex profiling options
10549 @cindex options, program instrumentation
10550 @cindex options, run-time error checking
10551 @cindex options, profiling
10553 GCC supports a number of command-line options that control adding
10554 run-time instrumentation to the code it normally generates.  
10555 For example, one purpose of instrumentation is collect profiling
10556 statistics for use in finding program hot spots, code coverage
10557 analysis, or profile-guided optimizations.
10558 Another class of program instrumentation is adding run-time checking 
10559 to detect programming errors like invalid pointer
10560 dereferences or out-of-bounds array accesses, as well as deliberately
10561 hostile attacks such as stack smashing or C++ vtable hijacking.
10562 There is also a general hook which can be used to implement other
10563 forms of tracing or function-level instrumentation for debug or
10564 program analysis purposes.
10566 @table @gcctabopt
10567 @cindex @command{prof}
10568 @item -p
10569 @opindex p
10570 Generate extra code to write profile information suitable for the
10571 analysis program @command{prof}.  You must use this option when compiling
10572 the source files you want data about, and you must also use it when
10573 linking.
10575 @cindex @command{gprof}
10576 @item -pg
10577 @opindex pg
10578 Generate extra code to write profile information suitable for the
10579 analysis program @command{gprof}.  You must use this option when compiling
10580 the source files you want data about, and you must also use it when
10581 linking.
10583 @item -fprofile-arcs
10584 @opindex fprofile-arcs
10585 Add code so that program flow @dfn{arcs} are instrumented.  During
10586 execution the program records how many times each branch and call is
10587 executed and how many times it is taken or returns.  On targets that support
10588 constructors with priority support, profiling properly handles constructors,
10589 destructors and C++ constructors (and destructors) of classes which are used
10590 as a type of a global variable.
10592 When the compiled
10593 program exits it saves this data to a file called
10594 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10595 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10596 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10597 @var{auxname} is generated from the name of the output file, if
10598 explicitly specified and it is not the final executable, otherwise it is
10599 the basename of the source file.  In both cases any suffix is removed
10600 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10601 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10602 @xref{Cross-profiling}.
10604 @cindex @command{gcov}
10605 @item --coverage
10606 @opindex coverage
10608 This option is used to compile and link code instrumented for coverage
10609 analysis.  The option is a synonym for @option{-fprofile-arcs}
10610 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10611 linking).  See the documentation for those options for more details.
10613 @itemize
10615 @item
10616 Compile the source files with @option{-fprofile-arcs} plus optimization
10617 and code generation options.  For test coverage analysis, use the
10618 additional @option{-ftest-coverage} option.  You do not need to profile
10619 every source file in a program.
10621 @item
10622 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10623 (the latter implies the former).
10625 @item
10626 Run the program on a representative workload to generate the arc profile
10627 information.  This may be repeated any number of times.  You can run
10628 concurrent instances of your program, and provided that the file system
10629 supports locking, the data files will be correctly updated.  Also
10630 @code{fork} calls are detected and correctly handled (double counting
10631 will not happen).
10633 @item
10634 For profile-directed optimizations, compile the source files again with
10635 the same optimization and code generation options plus
10636 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10637 Control Optimization}).
10639 @item
10640 For test coverage analysis, use @command{gcov} to produce human readable
10641 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10642 @command{gcov} documentation for further information.
10644 @end itemize
10646 With @option{-fprofile-arcs}, for each function of your program GCC
10647 creates a program flow graph, then finds a spanning tree for the graph.
10648 Only arcs that are not on the spanning tree have to be instrumented: the
10649 compiler adds code to count the number of times that these arcs are
10650 executed.  When an arc is the only exit or only entrance to a block, the
10651 instrumentation code can be added to the block; otherwise, a new basic
10652 block must be created to hold the instrumentation code.
10654 @need 2000
10655 @item -ftest-coverage
10656 @opindex ftest-coverage
10657 Produce a notes file that the @command{gcov} code-coverage utility
10658 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10659 show program coverage.  Each source file's note file is called
10660 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10661 above for a description of @var{auxname} and instructions on how to
10662 generate test coverage data.  Coverage data matches the source files
10663 more closely if you do not optimize.
10665 @item -fprofile-dir=@var{path}
10666 @opindex fprofile-dir
10668 Set the directory to search for the profile data files in to @var{path}.
10669 This option affects only the profile data generated by
10670 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10671 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10672 and its related options.  Both absolute and relative paths can be used.
10673 By default, GCC uses the current directory as @var{path}, thus the
10674 profile data file appears in the same directory as the object file.
10676 @item -fprofile-generate
10677 @itemx -fprofile-generate=@var{path}
10678 @opindex fprofile-generate
10680 Enable options usually used for instrumenting application to produce
10681 profile useful for later recompilation with profile feedback based
10682 optimization.  You must use @option{-fprofile-generate} both when
10683 compiling and when linking your program.
10685 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10687 If @var{path} is specified, GCC looks at the @var{path} to find
10688 the profile feedback data files. See @option{-fprofile-dir}.
10690 To optimize the program based on the collected profile information, use
10691 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10693 @item -fprofile-update=@var{method}
10694 @opindex fprofile-update
10696 Alter the update method for an application instrumented for profile
10697 feedback based optimization.  The @var{method} argument should be one of
10698 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10699 The first one is useful for single-threaded applications,
10700 while the second one prevents profile corruption by emitting thread-safe code.
10702 @strong{Warning:} When an application does not properly join all threads
10703 (or creates an detached thread), a profile file can be still corrupted.
10705 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10706 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10707 automatically selects @samp{prefer-atomic} when @option{-pthread}
10708 is present in the command line.
10710 @item -fsanitize=address
10711 @opindex fsanitize=address
10712 Enable AddressSanitizer, a fast memory error detector.
10713 Memory access instructions are instrumented to detect
10714 out-of-bounds and use-after-free bugs.
10715 The option enables @option{-fsanitize-address-use-after-scope}.
10716 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10717 more details.  The run-time behavior can be influenced using the
10718 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10719 the available options are shown at startup of the instrumented program.  See
10720 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10721 for a list of supported options.
10722 The option can't be combined with @option{-fsanitize=thread}.
10724 @item -fsanitize=kernel-address
10725 @opindex fsanitize=kernel-address
10726 Enable AddressSanitizer for Linux kernel.
10727 See @uref{https://github.com/google/kasan/wiki} for more details.
10729 @item -fsanitize=thread
10730 @opindex fsanitize=thread
10731 Enable ThreadSanitizer, a fast data race detector.
10732 Memory access instructions are instrumented to detect
10733 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10734 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10735 environment variable; see
10736 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10737 supported options.
10738 The option can't be combined with @option{-fsanitize=address}
10739 and/or @option{-fsanitize=leak}.
10741 @item -fsanitize=leak
10742 @opindex fsanitize=leak
10743 Enable LeakSanitizer, a memory leak detector.
10744 This option only matters for linking of executables and
10745 the executable is linked against a library that overrides @code{malloc}
10746 and other allocator functions.  See
10747 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10748 details.  The run-time behavior can be influenced using the
10749 @env{LSAN_OPTIONS} environment variable.
10750 The option can't be combined with @option{-fsanitize=thread}.
10752 @item -fsanitize=undefined
10753 @opindex fsanitize=undefined
10754 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10755 Various computations are instrumented to detect undefined behavior
10756 at runtime.  Current suboptions are:
10758 @table @gcctabopt
10760 @item -fsanitize=shift
10761 @opindex fsanitize=shift
10762 This option enables checking that the result of a shift operation is
10763 not undefined.  Note that what exactly is considered undefined differs
10764 slightly between C and C++, as well as between ISO C90 and C99, etc.
10765 This option has two suboptions, @option{-fsanitize=shift-base} and
10766 @option{-fsanitize=shift-exponent}.
10768 @item -fsanitize=shift-exponent
10769 @opindex fsanitize=shift-exponent
10770 This option enables checking that the second argument of a shift operation
10771 is not negative and is smaller than the precision of the promoted first
10772 argument.
10774 @item -fsanitize=shift-base
10775 @opindex fsanitize=shift-base
10776 If the second argument of a shift operation is within range, check that the
10777 result of a shift operation is not undefined.  Note that what exactly is
10778 considered undefined differs slightly between C and C++, as well as between
10779 ISO C90 and C99, etc.
10781 @item -fsanitize=integer-divide-by-zero
10782 @opindex fsanitize=integer-divide-by-zero
10783 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10785 @item -fsanitize=unreachable
10786 @opindex fsanitize=unreachable
10787 With this option, the compiler turns the @code{__builtin_unreachable}
10788 call into a diagnostics message call instead.  When reaching the
10789 @code{__builtin_unreachable} call, the behavior is undefined.
10791 @item -fsanitize=vla-bound
10792 @opindex fsanitize=vla-bound
10793 This option instructs the compiler to check that the size of a variable
10794 length array is positive.
10796 @item -fsanitize=null
10797 @opindex fsanitize=null
10798 This option enables pointer checking.  Particularly, the application
10799 built with this option turned on will issue an error message when it
10800 tries to dereference a NULL pointer, or if a reference (possibly an
10801 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10802 on an object pointed by a NULL pointer.
10804 @item -fsanitize=return
10805 @opindex fsanitize=return
10806 This option enables return statement checking.  Programs
10807 built with this option turned on will issue an error message
10808 when the end of a non-void function is reached without actually
10809 returning a value.  This option works in C++ only.
10811 @item -fsanitize=signed-integer-overflow
10812 @opindex fsanitize=signed-integer-overflow
10813 This option enables signed integer overflow checking.  We check that
10814 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10815 does not overflow in the signed arithmetics.  Note, integer promotion
10816 rules must be taken into account.  That is, the following is not an
10817 overflow:
10818 @smallexample
10819 signed char a = SCHAR_MAX;
10820 a++;
10821 @end smallexample
10823 @item -fsanitize=bounds
10824 @opindex fsanitize=bounds
10825 This option enables instrumentation of array bounds.  Various out of bounds
10826 accesses are detected.  Flexible array members, flexible array member-like
10827 arrays, and initializers of variables with static storage are not instrumented.
10829 @item -fsanitize=bounds-strict
10830 @opindex fsanitize=bounds-strict
10831 This option enables strict instrumentation of array bounds.  Most out of bounds
10832 accesses are detected, including flexible array members and flexible array
10833 member-like arrays.  Initializers of variables with static storage are not
10834 instrumented.
10836 @item -fsanitize=alignment
10837 @opindex fsanitize=alignment
10839 This option enables checking of alignment of pointers when they are
10840 dereferenced, or when a reference is bound to insufficiently aligned target,
10841 or when a method or constructor is invoked on insufficiently aligned object.
10843 @item -fsanitize=object-size
10844 @opindex fsanitize=object-size
10845 This option enables instrumentation of memory references using the
10846 @code{__builtin_object_size} function.  Various out of bounds pointer
10847 accesses are detected.
10849 @item -fsanitize=float-divide-by-zero
10850 @opindex fsanitize=float-divide-by-zero
10851 Detect floating-point division by zero.  Unlike other similar options,
10852 @option{-fsanitize=float-divide-by-zero} is not enabled by
10853 @option{-fsanitize=undefined}, since floating-point division by zero can
10854 be a legitimate way of obtaining infinities and NaNs.
10856 @item -fsanitize=float-cast-overflow
10857 @opindex fsanitize=float-cast-overflow
10858 This option enables floating-point type to integer conversion checking.
10859 We check that the result of the conversion does not overflow.
10860 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10861 not enabled by @option{-fsanitize=undefined}.
10862 This option does not work well with @code{FE_INVALID} exceptions enabled.
10864 @item -fsanitize=nonnull-attribute
10865 @opindex fsanitize=nonnull-attribute
10867 This option enables instrumentation of calls, checking whether null values
10868 are not passed to arguments marked as requiring a non-null value by the
10869 @code{nonnull} function attribute.
10871 @item -fsanitize=returns-nonnull-attribute
10872 @opindex fsanitize=returns-nonnull-attribute
10874 This option enables instrumentation of return statements in functions
10875 marked with @code{returns_nonnull} function attribute, to detect returning
10876 of null values from such functions.
10878 @item -fsanitize=bool
10879 @opindex fsanitize=bool
10881 This option enables instrumentation of loads from bool.  If a value other
10882 than 0/1 is loaded, a run-time error is issued.
10884 @item -fsanitize=enum
10885 @opindex fsanitize=enum
10887 This option enables instrumentation of loads from an enum type.  If
10888 a value outside the range of values for the enum type is loaded,
10889 a run-time error is issued.
10891 @item -fsanitize=vptr
10892 @opindex fsanitize=vptr
10894 This option enables instrumentation of C++ member function calls, member
10895 accesses and some conversions between pointers to base and derived classes,
10896 to verify the referenced object has the correct dynamic type.
10898 @end table
10900 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10901 @option{-fsanitize=undefined} gives a diagnostic message.
10902 This currently works only for the C family of languages.
10904 @item -fno-sanitize=all
10905 @opindex fno-sanitize=all
10907 This option disables all previously enabled sanitizers.
10908 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10909 together.
10911 @item -fasan-shadow-offset=@var{number}
10912 @opindex fasan-shadow-offset
10913 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10914 It is useful for experimenting with different shadow memory layouts in
10915 Kernel AddressSanitizer.
10917 @item -fsanitize-sections=@var{s1},@var{s2},...
10918 @opindex fsanitize-sections
10919 Sanitize global variables in selected user-defined sections.  @var{si} may
10920 contain wildcards.
10922 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10923 @opindex fsanitize-recover
10924 @opindex fno-sanitize-recover
10925 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10926 mentioned in comma-separated list of @var{opts}.  Enabling this option
10927 for a sanitizer component causes it to attempt to continue
10928 running the program as if no error happened.  This means multiple
10929 runtime errors can be reported in a single program run, and the exit
10930 code of the program may indicate success even when errors
10931 have been reported.  The @option{-fno-sanitize-recover=} option
10932 can be used to alter
10933 this behavior: only the first detected error is reported
10934 and program then exits with a non-zero exit code.
10936 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10937 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10938 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10939 @option{-fsanitize=bounds-strict},
10940 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10941 For these sanitizers error recovery is turned on by default,
10942 except @option{-fsanitize=address}, for which this feature is experimental.
10943 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10944 accepted, the former enables recovery for all sanitizers that support it,
10945 the latter disables recovery for all sanitizers that support it.
10947 Even if a recovery mode is turned on the compiler side, it needs to be also
10948 enabled on the runtime library side, otherwise the failures are still fatal.
10949 The runtime library defaults to @code{halt_on_error=0} for
10950 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10951 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10952 setting the @code{halt_on_error} flag in the corresponding environment variable.
10954 Syntax without an explicit @var{opts} parameter is deprecated.  It is
10955 equivalent to specifying an @var{opts} list of:
10957 @smallexample
10958 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
10959 @end smallexample
10961 @item -fsanitize-address-use-after-scope
10962 @opindex fsanitize-address-use-after-scope
10963 Enable sanitization of local variables to detect use-after-scope bugs.
10964 The option sets @option{-fstack-reuse} to @samp{none}.
10966 @item -fsanitize-undefined-trap-on-error
10967 @opindex fsanitize-undefined-trap-on-error
10968 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
10969 report undefined behavior using @code{__builtin_trap} rather than
10970 a @code{libubsan} library routine.  The advantage of this is that the
10971 @code{libubsan} library is not needed and is not linked in, so this
10972 is usable even in freestanding environments.
10974 @item -fsanitize-coverage=trace-pc
10975 @opindex fsanitize-coverage=trace-pc
10976 Enable coverage-guided fuzzing code instrumentation.
10977 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
10979 @item -fbounds-check
10980 @opindex fbounds-check
10981 For front ends that support it, generate additional code to check that
10982 indices used to access arrays are within the declared range.  This is
10983 currently only supported by the Fortran front end, where this option
10984 defaults to false.
10986 @item -fcheck-pointer-bounds
10987 @opindex fcheck-pointer-bounds
10988 @opindex fno-check-pointer-bounds
10989 @cindex Pointer Bounds Checker options
10990 Enable Pointer Bounds Checker instrumentation.  Each memory reference
10991 is instrumented with checks of the pointer used for memory access against
10992 bounds associated with that pointer.  
10994 Currently there
10995 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
10996 and @option{-mmpx} are required to enable this feature.  
10997 MPX-based instrumentation requires
10998 a runtime library to enable MPX in hardware and handle bounds
10999 violation signals.  By default when @option{-fcheck-pointer-bounds}
11000 and @option{-mmpx} options are used to link a program, the GCC driver
11001 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11002 Bounds checking on calls to dynamic libraries requires a linker
11003 with @option{-z bndplt} support; if GCC was configured with a linker
11004 without support for this option (including the Gold linker and older
11005 versions of ld), a warning is given if you link with @option{-mmpx}
11006 without also specifying @option{-static}, since the overall effectiveness
11007 of the bounds checking protection is reduced.
11008 See also @option{-static-libmpxwrappers}.
11010 MPX-based instrumentation
11011 may be used for debugging and also may be included in production code
11012 to increase program security.  Depending on usage, you may
11013 have different requirements for the runtime library.  The current version
11014 of the MPX runtime library is more oriented for use as a debugging
11015 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11016 also @option{-static-libmpx}.  The runtime library  behavior can be
11017 influenced using various @env{CHKP_RT_*} environment variables.  See
11018 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11019 for more details.
11021 Generated instrumentation may be controlled by various
11022 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11023 structure field attribute (@pxref{Type Attributes}) and
11024 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11025 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11026 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11027 Bounds Checker builtins}, for more information.
11029 @item -fchkp-check-incomplete-type
11030 @opindex fchkp-check-incomplete-type
11031 @opindex fno-chkp-check-incomplete-type
11032 Generate pointer bounds checks for variables with incomplete type.
11033 Enabled by default.
11035 @item -fchkp-narrow-bounds
11036 @opindex fchkp-narrow-bounds
11037 @opindex fno-chkp-narrow-bounds
11038 Controls bounds used by Pointer Bounds Checker for pointers to object
11039 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11040 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11041 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11043 @item -fchkp-first-field-has-own-bounds
11044 @opindex fchkp-first-field-has-own-bounds
11045 @opindex fno-chkp-first-field-has-own-bounds
11046 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11047 first field in the structure.  By default a pointer to the first field has
11048 the same bounds as a pointer to the whole structure.
11050 @item -fchkp-flexible-struct-trailing-arrays
11051 @opindex fchkp-flexible-struct-trailing-arrays
11052 @opindex fno-chkp-flexible-struct-trailing-arrays
11053 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11054 possibly flexible.  By default only array fields with zero length or that are
11055 marked with attribute bnd_variable_size are treated as flexible.
11057 @item -fchkp-narrow-to-innermost-array
11058 @opindex fchkp-narrow-to-innermost-array
11059 @opindex fno-chkp-narrow-to-innermost-array
11060 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11061 case of nested static array access.  By default this option is disabled and
11062 bounds of the outermost array are used.
11064 @item -fchkp-optimize
11065 @opindex fchkp-optimize
11066 @opindex fno-chkp-optimize
11067 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11068 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11070 @item -fchkp-use-fast-string-functions
11071 @opindex fchkp-use-fast-string-functions
11072 @opindex fno-chkp-use-fast-string-functions
11073 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11074 by Pointer Bounds Checker.  Disabled by default.
11076 @item -fchkp-use-nochk-string-functions
11077 @opindex fchkp-use-nochk-string-functions
11078 @opindex fno-chkp-use-nochk-string-functions
11079 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11080 by Pointer Bounds Checker.  Disabled by default.
11082 @item -fchkp-use-static-bounds
11083 @opindex fchkp-use-static-bounds
11084 @opindex fno-chkp-use-static-bounds
11085 Allow Pointer Bounds Checker to generate static bounds holding
11086 bounds of static variables.  Enabled by default.
11088 @item -fchkp-use-static-const-bounds
11089 @opindex fchkp-use-static-const-bounds
11090 @opindex fno-chkp-use-static-const-bounds
11091 Use statically-initialized bounds for constant bounds instead of
11092 generating them each time they are required.  By default enabled when
11093 @option{-fchkp-use-static-bounds} is enabled.
11095 @item -fchkp-treat-zero-dynamic-size-as-infinite
11096 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11097 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11098 With this option, objects with incomplete type whose
11099 dynamically-obtained size is zero are treated as having infinite size
11100 instead by Pointer Bounds
11101 Checker.  This option may be helpful if a program is linked with a library
11102 missing size information for some symbols.  Disabled by default.
11104 @item -fchkp-check-read
11105 @opindex fchkp-check-read
11106 @opindex fno-chkp-check-read
11107 Instructs Pointer Bounds Checker to generate checks for all read
11108 accesses to memory.  Enabled by default.
11110 @item -fchkp-check-write
11111 @opindex fchkp-check-write
11112 @opindex fno-chkp-check-write
11113 Instructs Pointer Bounds Checker to generate checks for all write
11114 accesses to memory.  Enabled by default.
11116 @item -fchkp-store-bounds
11117 @opindex fchkp-store-bounds
11118 @opindex fno-chkp-store-bounds
11119 Instructs Pointer Bounds Checker to generate bounds stores for
11120 pointer writes.  Enabled by default.
11122 @item -fchkp-instrument-calls
11123 @opindex fchkp-instrument-calls
11124 @opindex fno-chkp-instrument-calls
11125 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11126 Enabled by default.
11128 @item -fchkp-instrument-marked-only
11129 @opindex fchkp-instrument-marked-only
11130 @opindex fno-chkp-instrument-marked-only
11131 Instructs Pointer Bounds Checker to instrument only functions
11132 marked with the @code{bnd_instrument} attribute
11133 (@pxref{Function Attributes}).  Disabled by default.
11135 @item -fchkp-use-wrappers
11136 @opindex fchkp-use-wrappers
11137 @opindex fno-chkp-use-wrappers
11138 Allows Pointer Bounds Checker to replace calls to built-in functions
11139 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11140 is used to link a program, the GCC driver automatically links
11141 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11142 Enabled by default.
11144 @item -fstack-protector
11145 @opindex fstack-protector
11146 Emit extra code to check for buffer overflows, such as stack smashing
11147 attacks.  This is done by adding a guard variable to functions with
11148 vulnerable objects.  This includes functions that call @code{alloca}, and
11149 functions with buffers larger than 8 bytes.  The guards are initialized
11150 when a function is entered and then checked when the function exits.
11151 If a guard check fails, an error message is printed and the program exits.
11153 @item -fstack-protector-all
11154 @opindex fstack-protector-all
11155 Like @option{-fstack-protector} except that all functions are protected.
11157 @item -fstack-protector-strong
11158 @opindex fstack-protector-strong
11159 Like @option{-fstack-protector} but includes additional functions to
11160 be protected --- those that have local array definitions, or have
11161 references to local frame addresses.
11163 @item -fstack-protector-explicit
11164 @opindex fstack-protector-explicit
11165 Like @option{-fstack-protector} but only protects those functions which
11166 have the @code{stack_protect} attribute.
11168 @item -fstack-check
11169 @opindex fstack-check
11170 Generate code to verify that you do not go beyond the boundary of the
11171 stack.  You should specify this flag if you are running in an
11172 environment with multiple threads, but you only rarely need to specify it in
11173 a single-threaded environment since stack overflow is automatically
11174 detected on nearly all systems if there is only one stack.
11176 Note that this switch does not actually cause checking to be done; the
11177 operating system or the language runtime must do that.  The switch causes
11178 generation of code to ensure that they see the stack being extended.
11180 You can additionally specify a string parameter: @samp{no} means no
11181 checking, @samp{generic} means force the use of old-style checking,
11182 @samp{specific} means use the best checking method and is equivalent
11183 to bare @option{-fstack-check}.
11185 Old-style checking is a generic mechanism that requires no specific
11186 target support in the compiler but comes with the following drawbacks:
11188 @enumerate
11189 @item
11190 Modified allocation strategy for large objects: they are always
11191 allocated dynamically if their size exceeds a fixed threshold.
11193 @item
11194 Fixed limit on the size of the static frame of functions: when it is
11195 topped by a particular function, stack checking is not reliable and
11196 a warning is issued by the compiler.
11198 @item
11199 Inefficiency: because of both the modified allocation strategy and the
11200 generic implementation, code performance is hampered.
11201 @end enumerate
11203 Note that old-style stack checking is also the fallback method for
11204 @samp{specific} if no target support has been added in the compiler.
11206 @item -fstack-limit-register=@var{reg}
11207 @itemx -fstack-limit-symbol=@var{sym}
11208 @itemx -fno-stack-limit
11209 @opindex fstack-limit-register
11210 @opindex fstack-limit-symbol
11211 @opindex fno-stack-limit
11212 Generate code to ensure that the stack does not grow beyond a certain value,
11213 either the value of a register or the address of a symbol.  If a larger
11214 stack is required, a signal is raised at run time.  For most targets,
11215 the signal is raised before the stack overruns the boundary, so
11216 it is possible to catch the signal without taking special precautions.
11218 For instance, if the stack starts at absolute address @samp{0x80000000}
11219 and grows downwards, you can use the flags
11220 @option{-fstack-limit-symbol=__stack_limit} and
11221 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11222 of 128KB@.  Note that this may only work with the GNU linker.
11224 You can locally override stack limit checking by using the
11225 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11227 @item -fsplit-stack
11228 @opindex fsplit-stack
11229 Generate code to automatically split the stack before it overflows.
11230 The resulting program has a discontiguous stack which can only
11231 overflow if the program is unable to allocate any more memory.  This
11232 is most useful when running threaded programs, as it is no longer
11233 necessary to calculate a good stack size to use for each thread.  This
11234 is currently only implemented for the x86 targets running
11235 GNU/Linux.
11237 When code compiled with @option{-fsplit-stack} calls code compiled
11238 without @option{-fsplit-stack}, there may not be much stack space
11239 available for the latter code to run.  If compiling all code,
11240 including library code, with @option{-fsplit-stack} is not an option,
11241 then the linker can fix up these calls so that the code compiled
11242 without @option{-fsplit-stack} always has a large stack.  Support for
11243 this is implemented in the gold linker in GNU binutils release 2.21
11244 and later.
11246 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11247 @opindex fvtable-verify
11248 This option is only available when compiling C++ code.
11249 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11250 feature that verifies at run time, for every virtual call, that
11251 the vtable pointer through which the call is made is valid for the type of
11252 the object, and has not been corrupted or overwritten.  If an invalid vtable
11253 pointer is detected at run time, an error is reported and execution of the
11254 program is immediately halted.
11256 This option causes run-time data structures to be built at program startup,
11257 which are used for verifying the vtable pointers.  
11258 The options @samp{std} and @samp{preinit}
11259 control the timing of when these data structures are built.  In both cases the
11260 data structures are built before execution reaches @code{main}.  Using
11261 @option{-fvtable-verify=std} causes the data structures to be built after
11262 shared libraries have been loaded and initialized.
11263 @option{-fvtable-verify=preinit} causes them to be built before shared
11264 libraries have been loaded and initialized.
11266 If this option appears multiple times in the command line with different
11267 values specified, @samp{none} takes highest priority over both @samp{std} and
11268 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11270 @item -fvtv-debug
11271 @opindex fvtv-debug
11272 When used in conjunction with @option{-fvtable-verify=std} or 
11273 @option{-fvtable-verify=preinit}, causes debug versions of the 
11274 runtime functions for the vtable verification feature to be called.  
11275 This flag also causes the compiler to log information about which 
11276 vtable pointers it finds for each class.
11277 This information is written to a file named @file{vtv_set_ptr_data.log} 
11278 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11279 if that is defined or the current working directory otherwise.
11281 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11282 file, be sure to delete any existing one.
11284 @item -fvtv-counts
11285 @opindex fvtv-counts
11286 This is a debugging flag.  When used in conjunction with
11287 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11288 causes the compiler to keep track of the total number of virtual calls
11289 it encounters and the number of verifications it inserts.  It also
11290 counts the number of calls to certain run-time library functions
11291 that it inserts and logs this information for each compilation unit.
11292 The compiler writes this information to a file named
11293 @file{vtv_count_data.log} in the directory named by the environment
11294 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11295 directory otherwise.  It also counts the size of the vtable pointer sets
11296 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11297 in the same directory.
11299 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11300 files, be sure to delete any existing ones.
11302 @item -finstrument-functions
11303 @opindex finstrument-functions
11304 Generate instrumentation calls for entry and exit to functions.  Just
11305 after function entry and just before function exit, the following
11306 profiling functions are called with the address of the current
11307 function and its call site.  (On some platforms,
11308 @code{__builtin_return_address} does not work beyond the current
11309 function, so the call site information may not be available to the
11310 profiling functions otherwise.)
11312 @smallexample
11313 void __cyg_profile_func_enter (void *this_fn,
11314                                void *call_site);
11315 void __cyg_profile_func_exit  (void *this_fn,
11316                                void *call_site);
11317 @end smallexample
11319 The first argument is the address of the start of the current function,
11320 which may be looked up exactly in the symbol table.
11322 This instrumentation is also done for functions expanded inline in other
11323 functions.  The profiling calls indicate where, conceptually, the
11324 inline function is entered and exited.  This means that addressable
11325 versions of such functions must be available.  If all your uses of a
11326 function are expanded inline, this may mean an additional expansion of
11327 code size.  If you use @code{extern inline} in your C code, an
11328 addressable version of such functions must be provided.  (This is
11329 normally the case anyway, but if you get lucky and the optimizer always
11330 expands the functions inline, you might have gotten away without
11331 providing static copies.)
11333 A function may be given the attribute @code{no_instrument_function}, in
11334 which case this instrumentation is not done.  This can be used, for
11335 example, for the profiling functions listed above, high-priority
11336 interrupt routines, and any functions from which the profiling functions
11337 cannot safely be called (perhaps signal handlers, if the profiling
11338 routines generate output or allocate memory).
11340 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11341 @opindex finstrument-functions-exclude-file-list
11343 Set the list of functions that are excluded from instrumentation (see
11344 the description of @option{-finstrument-functions}).  If the file that
11345 contains a function definition matches with one of @var{file}, then
11346 that function is not instrumented.  The match is done on substrings:
11347 if the @var{file} parameter is a substring of the file name, it is
11348 considered to be a match.
11350 For example:
11352 @smallexample
11353 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11354 @end smallexample
11356 @noindent
11357 excludes any inline function defined in files whose pathnames
11358 contain @file{/bits/stl} or @file{include/sys}.
11360 If, for some reason, you want to include letter @samp{,} in one of
11361 @var{sym}, write @samp{\,}. For example,
11362 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11363 (note the single quote surrounding the option).
11365 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11366 @opindex finstrument-functions-exclude-function-list
11368 This is similar to @option{-finstrument-functions-exclude-file-list},
11369 but this option sets the list of function names to be excluded from
11370 instrumentation.  The function name to be matched is its user-visible
11371 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11372 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11373 match is done on substrings: if the @var{sym} parameter is a substring
11374 of the function name, it is considered to be a match.  For C99 and C++
11375 extended identifiers, the function name must be given in UTF-8, not
11376 using universal character names.
11378 @end table
11381 @node Preprocessor Options
11382 @section Options Controlling the Preprocessor
11383 @cindex preprocessor options
11384 @cindex options, preprocessor
11386 These options control the C preprocessor, which is run on each C source
11387 file before actual compilation.
11389 If you use the @option{-E} option, nothing is done except preprocessing.
11390 Some of these options make sense only together with @option{-E} because
11391 they cause the preprocessor output to be unsuitable for actual
11392 compilation.
11394 In addition to the options listed here, there are a number of options 
11395 to control search paths for include files documented in 
11396 @ref{Directory Options}.  
11397 Options to control preprocessor diagnostics are listed in 
11398 @ref{Warning Options}.
11400 @table @gcctabopt
11401 @include cppopts.texi
11403 @item -Wp,@var{option}
11404 @opindex Wp
11405 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11406 and pass @var{option} directly through to the preprocessor.  If
11407 @var{option} contains commas, it is split into multiple options at the
11408 commas.  However, many options are modified, translated or interpreted
11409 by the compiler driver before being passed to the preprocessor, and
11410 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11411 interface is undocumented and subject to change, so whenever possible
11412 you should avoid using @option{-Wp} and let the driver handle the
11413 options instead.
11415 @item -Xpreprocessor @var{option}
11416 @opindex Xpreprocessor
11417 Pass @var{option} as an option to the preprocessor.  You can use this to
11418 supply system-specific preprocessor options that GCC does not 
11419 recognize.
11421 If you want to pass an option that takes an argument, you must use
11422 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11424 @item -no-integrated-cpp
11425 @opindex no-integrated-cpp
11426 Perform preprocessing as a separate pass before compilation.
11427 By default, GCC performs preprocessing as an integrated part of
11428 input tokenization and parsing.
11429 If this option is provided, the appropriate language front end
11430 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11431 and Objective-C, respectively) is instead invoked twice,
11432 once for preprocessing only and once for actual compilation
11433 of the preprocessed input.
11434 This option may be useful in conjunction with the @option{-B} or
11435 @option{-wrapper} options to specify an alternate preprocessor or
11436 perform additional processing of the program source between
11437 normal preprocessing and compilation.
11439 @end table
11441 @node Assembler Options
11442 @section Passing Options to the Assembler
11444 @c prevent bad page break with this line
11445 You can pass options to the assembler.
11447 @table @gcctabopt
11448 @item -Wa,@var{option}
11449 @opindex Wa
11450 Pass @var{option} as an option to the assembler.  If @var{option}
11451 contains commas, it is split into multiple options at the commas.
11453 @item -Xassembler @var{option}
11454 @opindex Xassembler
11455 Pass @var{option} as an option to the assembler.  You can use this to
11456 supply system-specific assembler options that GCC does not
11457 recognize.
11459 If you want to pass an option that takes an argument, you must use
11460 @option{-Xassembler} twice, once for the option and once for the argument.
11462 @end table
11464 @node Link Options
11465 @section Options for Linking
11466 @cindex link options
11467 @cindex options, linking
11469 These options come into play when the compiler links object files into
11470 an executable output file.  They are meaningless if the compiler is
11471 not doing a link step.
11473 @table @gcctabopt
11474 @cindex file names
11475 @item @var{object-file-name}
11476 A file name that does not end in a special recognized suffix is
11477 considered to name an object file or library.  (Object files are
11478 distinguished from libraries by the linker according to the file
11479 contents.)  If linking is done, these object files are used as input
11480 to the linker.
11482 @item -c
11483 @itemx -S
11484 @itemx -E
11485 @opindex c
11486 @opindex S
11487 @opindex E
11488 If any of these options is used, then the linker is not run, and
11489 object file names should not be used as arguments.  @xref{Overall
11490 Options}.
11492 @item -fuse-ld=bfd
11493 @opindex fuse-ld=bfd
11494 Use the @command{bfd} linker instead of the default linker.
11496 @item -fuse-ld=gold
11497 @opindex fuse-ld=gold
11498 Use the @command{gold} linker instead of the default linker.
11500 @cindex Libraries
11501 @item -l@var{library}
11502 @itemx -l @var{library}
11503 @opindex l
11504 Search the library named @var{library} when linking.  (The second
11505 alternative with the library as a separate argument is only for
11506 POSIX compliance and is not recommended.)
11508 It makes a difference where in the command you write this option; the
11509 linker searches and processes libraries and object files in the order they
11510 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11511 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11512 to functions in @samp{z}, those functions may not be loaded.
11514 The linker searches a standard list of directories for the library,
11515 which is actually a file named @file{lib@var{library}.a}.  The linker
11516 then uses this file as if it had been specified precisely by name.
11518 The directories searched include several standard system directories
11519 plus any that you specify with @option{-L}.
11521 Normally the files found this way are library files---archive files
11522 whose members are object files.  The linker handles an archive file by
11523 scanning through it for members which define symbols that have so far
11524 been referenced but not defined.  But if the file that is found is an
11525 ordinary object file, it is linked in the usual fashion.  The only
11526 difference between using an @option{-l} option and specifying a file name
11527 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11528 and searches several directories.
11530 @item -lobjc
11531 @opindex lobjc
11532 You need this special case of the @option{-l} option in order to
11533 link an Objective-C or Objective-C++ program.
11535 @item -nostartfiles
11536 @opindex nostartfiles
11537 Do not use the standard system startup files when linking.
11538 The standard system libraries are used normally, unless @option{-nostdlib}
11539 or @option{-nodefaultlibs} is used.
11541 @item -nodefaultlibs
11542 @opindex nodefaultlibs
11543 Do not use the standard system libraries when linking.
11544 Only the libraries you specify are passed to the linker, and options
11545 specifying linkage of the system libraries, such as @option{-static-libgcc}
11546 or @option{-shared-libgcc}, are ignored.  
11547 The standard startup files are used normally, unless @option{-nostartfiles}
11548 is used.  
11550 The compiler may generate calls to @code{memcmp},
11551 @code{memset}, @code{memcpy} and @code{memmove}.
11552 These entries are usually resolved by entries in
11553 libc.  These entry points should be supplied through some other
11554 mechanism when this option is specified.
11556 @item -nostdlib
11557 @opindex nostdlib
11558 Do not use the standard system startup files or libraries when linking.
11559 No startup files and only the libraries you specify are passed to
11560 the linker, and options specifying linkage of the system libraries, such as
11561 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11563 The compiler may generate calls to @code{memcmp}, @code{memset},
11564 @code{memcpy} and @code{memmove}.
11565 These entries are usually resolved by entries in
11566 libc.  These entry points should be supplied through some other
11567 mechanism when this option is specified.
11569 @cindex @option{-lgcc}, use with @option{-nostdlib}
11570 @cindex @option{-nostdlib} and unresolved references
11571 @cindex unresolved references and @option{-nostdlib}
11572 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11573 @cindex @option{-nodefaultlibs} and unresolved references
11574 @cindex unresolved references and @option{-nodefaultlibs}
11575 One of the standard libraries bypassed by @option{-nostdlib} and
11576 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11577 which GCC uses to overcome shortcomings of particular machines, or special
11578 needs for some languages.
11579 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11580 Collection (GCC) Internals},
11581 for more discussion of @file{libgcc.a}.)
11582 In most cases, you need @file{libgcc.a} even when you want to avoid
11583 other standard libraries.  In other words, when you specify @option{-nostdlib}
11584 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11585 This ensures that you have no unresolved references to internal GCC
11586 library subroutines.
11587 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11588 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11589 GNU Compiler Collection (GCC) Internals}.)
11591 @item -pie
11592 @opindex pie
11593 Produce a position independent executable on targets that support it.
11594 For predictable results, you must also specify the same set of options
11595 used for compilation (@option{-fpie}, @option{-fPIE},
11596 or model suboptions) when you specify this linker option.
11598 @item -no-pie
11599 @opindex no-pie
11600 Don't produce a position independent executable.
11602 @item -pthread
11603 @opindex pthread
11604 Link with the POSIX threads library.  This option is supported on 
11605 GNU/Linux targets, most other Unix derivatives, and also on 
11606 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11607 flags for the preprocessor, so it should be used consistently for both
11608 compilation and linking.
11610 @item -rdynamic
11611 @opindex rdynamic
11612 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11613 that support it. This instructs the linker to add all symbols, not
11614 only used ones, to the dynamic symbol table. This option is needed
11615 for some uses of @code{dlopen} or to allow obtaining backtraces
11616 from within a program.
11618 @item -s
11619 @opindex s
11620 Remove all symbol table and relocation information from the executable.
11622 @item -static
11623 @opindex static
11624 On systems that support dynamic linking, this prevents linking with the shared
11625 libraries.  On other systems, this option has no effect.
11627 @item -shared
11628 @opindex shared
11629 Produce a shared object which can then be linked with other objects to
11630 form an executable.  Not all systems support this option.  For predictable
11631 results, you must also specify the same set of options used for compilation
11632 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11633 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11634 needs to build supplementary stub code for constructors to work.  On
11635 multi-libbed systems, @samp{gcc -shared} must select the correct support
11636 libraries to link against.  Failing to supply the correct flags may lead
11637 to subtle defects.  Supplying them in cases where they are not necessary
11638 is innocuous.}
11640 @item -shared-libgcc
11641 @itemx -static-libgcc
11642 @opindex shared-libgcc
11643 @opindex static-libgcc
11644 On systems that provide @file{libgcc} as a shared library, these options
11645 force the use of either the shared or static version, respectively.
11646 If no shared version of @file{libgcc} was built when the compiler was
11647 configured, these options have no effect.
11649 There are several situations in which an application should use the
11650 shared @file{libgcc} instead of the static version.  The most common
11651 of these is when the application wishes to throw and catch exceptions
11652 across different shared libraries.  In that case, each of the libraries
11653 as well as the application itself should use the shared @file{libgcc}.
11655 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11656  whenever you build a shared library or a main executable, because C++
11657  programs typically use exceptions, so this is the right thing to do.
11659 If, instead, you use the GCC driver to create shared libraries, you may
11660 find that they are not always linked with the shared @file{libgcc}.
11661 If GCC finds, at its configuration time, that you have a non-GNU linker
11662 or a GNU linker that does not support option @option{--eh-frame-hdr},
11663 it links the shared version of @file{libgcc} into shared libraries
11664 by default.  Otherwise, it takes advantage of the linker and optimizes
11665 away the linking with the shared version of @file{libgcc}, linking with
11666 the static version of libgcc by default.  This allows exceptions to
11667 propagate through such shared libraries, without incurring relocation
11668 costs at library load time.
11670 However, if a library or main executable is supposed to throw or catch
11671 exceptions, you must link it using the G++ driver, as appropriate
11672 for the languages used in the program, or using the option
11673 @option{-shared-libgcc}, such that it is linked with the shared
11674 @file{libgcc}.
11676 @item -static-libasan
11677 @opindex static-libasan
11678 When the @option{-fsanitize=address} option is used to link a program,
11679 the GCC driver automatically links against @option{libasan}.  If
11680 @file{libasan} is available as a shared library, and the @option{-static}
11681 option is not used, then this links against the shared version of
11682 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11683 driver to link @file{libasan} statically, without necessarily linking
11684 other libraries statically.
11686 @item -static-libtsan
11687 @opindex static-libtsan
11688 When the @option{-fsanitize=thread} option is used to link a program,
11689 the GCC driver automatically links against @option{libtsan}.  If
11690 @file{libtsan} is available as a shared library, and the @option{-static}
11691 option is not used, then this links against the shared version of
11692 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11693 driver to link @file{libtsan} statically, without necessarily linking
11694 other libraries statically.
11696 @item -static-liblsan
11697 @opindex static-liblsan
11698 When the @option{-fsanitize=leak} option is used to link a program,
11699 the GCC driver automatically links against @option{liblsan}.  If
11700 @file{liblsan} is available as a shared library, and the @option{-static}
11701 option is not used, then this links against the shared version of
11702 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11703 driver to link @file{liblsan} statically, without necessarily linking
11704 other libraries statically.
11706 @item -static-libubsan
11707 @opindex static-libubsan
11708 When the @option{-fsanitize=undefined} option is used to link a program,
11709 the GCC driver automatically links against @option{libubsan}.  If
11710 @file{libubsan} is available as a shared library, and the @option{-static}
11711 option is not used, then this links against the shared version of
11712 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11713 driver to link @file{libubsan} statically, without necessarily linking
11714 other libraries statically.
11716 @item -static-libmpx
11717 @opindex static-libmpx
11718 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11719 used to link a program, the GCC driver automatically links against
11720 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11721 and the @option{-static} option is not used, then this links against
11722 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11723 option directs the GCC driver to link @file{libmpx} statically,
11724 without necessarily linking other libraries statically.
11726 @item -static-libmpxwrappers
11727 @opindex static-libmpxwrappers
11728 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11729 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11730 GCC driver automatically links against @file{libmpxwrappers}.  If
11731 @file{libmpxwrappers} is available as a shared library, and the
11732 @option{-static} option is not used, then this links against the shared
11733 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11734 option directs the GCC driver to link @file{libmpxwrappers} statically,
11735 without necessarily linking other libraries statically.
11737 @item -static-libstdc++
11738 @opindex static-libstdc++
11739 When the @command{g++} program is used to link a C++ program, it
11740 normally automatically links against @option{libstdc++}.  If
11741 @file{libstdc++} is available as a shared library, and the
11742 @option{-static} option is not used, then this links against the
11743 shared version of @file{libstdc++}.  That is normally fine.  However, it
11744 is sometimes useful to freeze the version of @file{libstdc++} used by
11745 the program without going all the way to a fully static link.  The
11746 @option{-static-libstdc++} option directs the @command{g++} driver to
11747 link @file{libstdc++} statically, without necessarily linking other
11748 libraries statically.
11750 @item -symbolic
11751 @opindex symbolic
11752 Bind references to global symbols when building a shared object.  Warn
11753 about any unresolved references (unless overridden by the link editor
11754 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11755 this option.
11757 @item -T @var{script}
11758 @opindex T
11759 @cindex linker script
11760 Use @var{script} as the linker script.  This option is supported by most
11761 systems using the GNU linker.  On some targets, such as bare-board
11762 targets without an operating system, the @option{-T} option may be required
11763 when linking to avoid references to undefined symbols.
11765 @item -Xlinker @var{option}
11766 @opindex Xlinker
11767 Pass @var{option} as an option to the linker.  You can use this to
11768 supply system-specific linker options that GCC does not recognize.
11770 If you want to pass an option that takes a separate argument, you must use
11771 @option{-Xlinker} twice, once for the option and once for the argument.
11772 For example, to pass @option{-assert definitions}, you must write
11773 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11774 @option{-Xlinker "-assert definitions"}, because this passes the entire
11775 string as a single argument, which is not what the linker expects.
11777 When using the GNU linker, it is usually more convenient to pass
11778 arguments to linker options using the @option{@var{option}=@var{value}}
11779 syntax than as separate arguments.  For example, you can specify
11780 @option{-Xlinker -Map=output.map} rather than
11781 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11782 this syntax for command-line options.
11784 @item -Wl,@var{option}
11785 @opindex Wl
11786 Pass @var{option} as an option to the linker.  If @var{option} contains
11787 commas, it is split into multiple options at the commas.  You can use this
11788 syntax to pass an argument to the option.
11789 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11790 linker.  When using the GNU linker, you can also get the same effect with
11791 @option{-Wl,-Map=output.map}.
11793 @item -u @var{symbol}
11794 @opindex u
11795 Pretend the symbol @var{symbol} is undefined, to force linking of
11796 library modules to define it.  You can use @option{-u} multiple times with
11797 different symbols to force loading of additional library modules.
11799 @item -z @var{keyword}
11800 @opindex z
11801 @option{-z} is passed directly on to the linker along with the keyword
11802 @var{keyword}. See the section in the documentation of your linker for
11803 permitted values and their meanings.
11804 @end table
11806 @node Directory Options
11807 @section Options for Directory Search
11808 @cindex directory options
11809 @cindex options, directory search
11810 @cindex search path
11812 These options specify directories to search for header files, for
11813 libraries and for parts of the compiler:
11815 @table @gcctabopt
11816 @include cppdiropts.texi
11818 @item -iplugindir=@var{dir}
11819 @opindex iplugindir=
11820 Set the directory to search for plugins that are passed
11821 by @option{-fplugin=@var{name}} instead of
11822 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11823 to be used by the user, but only passed by the driver.
11825 @item -L@var{dir}
11826 @opindex L
11827 Add directory @var{dir} to the list of directories to be searched
11828 for @option{-l}.
11830 @item -B@var{prefix}
11831 @opindex B
11832 This option specifies where to find the executables, libraries,
11833 include files, and data files of the compiler itself.
11835 The compiler driver program runs one or more of the subprograms
11836 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11837 @var{prefix} as a prefix for each program it tries to run, both with and
11838 without @samp{@var{machine}/@var{version}/} for the corresponding target
11839 machine and compiler version.
11841 For each subprogram to be run, the compiler driver first tries the
11842 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11843 is not specified, the driver tries two standard prefixes, 
11844 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11845 those results in a file name that is found, the unmodified program
11846 name is searched for using the directories specified in your
11847 @env{PATH} environment variable.
11849 The compiler checks to see if the path provided by @option{-B}
11850 refers to a directory, and if necessary it adds a directory
11851 separator character at the end of the path.
11853 @option{-B} prefixes that effectively specify directory names also apply
11854 to libraries in the linker, because the compiler translates these
11855 options into @option{-L} options for the linker.  They also apply to
11856 include files in the preprocessor, because the compiler translates these
11857 options into @option{-isystem} options for the preprocessor.  In this case,
11858 the compiler appends @samp{include} to the prefix.
11860 The runtime support file @file{libgcc.a} can also be searched for using
11861 the @option{-B} prefix, if needed.  If it is not found there, the two
11862 standard prefixes above are tried, and that is all.  The file is left
11863 out of the link if it is not found by those means.
11865 Another way to specify a prefix much like the @option{-B} prefix is to use
11866 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11867 Variables}.
11869 As a special kludge, if the path provided by @option{-B} is
11870 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11871 9, then it is replaced by @file{[dir/]include}.  This is to help
11872 with boot-strapping the compiler.
11874 @item -no-canonical-prefixes
11875 @opindex no-canonical-prefixes
11876 Do not expand any symbolic links, resolve references to @samp{/../}
11877 or @samp{/./}, or make the path absolute when generating a relative
11878 prefix.
11880 @item --sysroot=@var{dir}
11881 @opindex sysroot
11882 Use @var{dir} as the logical root directory for headers and libraries.
11883 For example, if the compiler normally searches for headers in
11884 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11885 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11887 If you use both this option and the @option{-isysroot} option, then
11888 the @option{--sysroot} option applies to libraries, but the
11889 @option{-isysroot} option applies to header files.
11891 The GNU linker (beginning with version 2.16) has the necessary support
11892 for this option.  If your linker does not support this option, the
11893 header file aspect of @option{--sysroot} still works, but the
11894 library aspect does not.
11896 @item --no-sysroot-suffix
11897 @opindex no-sysroot-suffix
11898 For some targets, a suffix is added to the root directory specified
11899 with @option{--sysroot}, depending on the other options used, so that
11900 headers may for example be found in
11901 @file{@var{dir}/@var{suffix}/usr/include} instead of
11902 @file{@var{dir}/usr/include}.  This option disables the addition of
11903 such a suffix.
11905 @end table
11907 @node Code Gen Options
11908 @section Options for Code Generation Conventions
11909 @cindex code generation conventions
11910 @cindex options, code generation
11911 @cindex run-time options
11913 These machine-independent options control the interface conventions
11914 used in code generation.
11916 Most of them have both positive and negative forms; the negative form
11917 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11918 one of the forms is listed---the one that is not the default.  You
11919 can figure out the other form by either removing @samp{no-} or adding
11922 @table @gcctabopt
11923 @item -fstack-reuse=@var{reuse-level}
11924 @opindex fstack_reuse
11925 This option controls stack space reuse for user declared local/auto variables
11926 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11927 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11928 local variables and temporaries, @samp{named_vars} enables the reuse only for
11929 user defined local variables with names, and @samp{none} disables stack reuse
11930 completely. The default value is @samp{all}. The option is needed when the
11931 program extends the lifetime of a scoped local variable or a compiler generated
11932 temporary beyond the end point defined by the language.  When a lifetime of
11933 a variable ends, and if the variable lives in memory, the optimizing compiler
11934 has the freedom to reuse its stack space with other temporaries or scoped
11935 local variables whose live range does not overlap with it. Legacy code extending
11936 local lifetime is likely to break with the stack reuse optimization.
11938 For example,
11940 @smallexample
11941    int *p;
11942    @{
11943      int local1;
11945      p = &local1;
11946      local1 = 10;
11947      ....
11948    @}
11949    @{
11950       int local2;
11951       local2 = 20;
11952       ...
11953    @}
11955    if (*p == 10)  // out of scope use of local1
11956      @{
11958      @}
11959 @end smallexample
11961 Another example:
11962 @smallexample
11964    struct A
11965    @{
11966        A(int k) : i(k), j(k) @{ @}
11967        int i;
11968        int j;
11969    @};
11971    A *ap;
11973    void foo(const A& ar)
11974    @{
11975       ap = &ar;
11976    @}
11978    void bar()
11979    @{
11980       foo(A(10)); // temp object's lifetime ends when foo returns
11982       @{
11983         A a(20);
11984         ....
11985       @}
11986       ap->i+= 10;  // ap references out of scope temp whose space
11987                    // is reused with a. What is the value of ap->i?
11988    @}
11990 @end smallexample
11992 The lifetime of a compiler generated temporary is well defined by the C++
11993 standard. When a lifetime of a temporary ends, and if the temporary lives
11994 in memory, the optimizing compiler has the freedom to reuse its stack
11995 space with other temporaries or scoped local variables whose live range
11996 does not overlap with it. However some of the legacy code relies on
11997 the behavior of older compilers in which temporaries' stack space is
11998 not reused, the aggressive stack reuse can lead to runtime errors. This
11999 option is used to control the temporary stack reuse optimization.
12001 @item -ftrapv
12002 @opindex ftrapv
12003 This option generates traps for signed overflow on addition, subtraction,
12004 multiplication operations.
12005 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12006 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12007 @option{-fwrapv} being effective.  Note that only active options override, so
12008 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12009 results in @option{-ftrapv} being effective.
12011 @item -fwrapv
12012 @opindex fwrapv
12013 This option instructs the compiler to assume that signed arithmetic
12014 overflow of addition, subtraction and multiplication wraps around
12015 using twos-complement representation.  This flag enables some optimizations
12016 and disables others.
12017 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12018 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12019 @option{-fwrapv} being effective.  Note that only active options override, so
12020 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12021 results in @option{-ftrapv} being effective.
12023 @item -fexceptions
12024 @opindex fexceptions
12025 Enable exception handling.  Generates extra code needed to propagate
12026 exceptions.  For some targets, this implies GCC generates frame
12027 unwind information for all functions, which can produce significant data
12028 size overhead, although it does not affect execution.  If you do not
12029 specify this option, GCC enables it by default for languages like
12030 C++ that normally require exception handling, and disables it for
12031 languages like C that do not normally require it.  However, you may need
12032 to enable this option when compiling C code that needs to interoperate
12033 properly with exception handlers written in C++.  You may also wish to
12034 disable this option if you are compiling older C++ programs that don't
12035 use exception handling.
12037 @item -fnon-call-exceptions
12038 @opindex fnon-call-exceptions
12039 Generate code that allows trapping instructions to throw exceptions.
12040 Note that this requires platform-specific runtime support that does
12041 not exist everywhere.  Moreover, it only allows @emph{trapping}
12042 instructions to throw exceptions, i.e.@: memory references or floating-point
12043 instructions.  It does not allow exceptions to be thrown from
12044 arbitrary signal handlers such as @code{SIGALRM}.
12046 @item -fdelete-dead-exceptions
12047 @opindex fdelete-dead-exceptions
12048 Consider that instructions that may throw exceptions but don't otherwise
12049 contribute to the execution of the program can be optimized away.
12050 This option is enabled by default for the Ada front end, as permitted by
12051 the Ada language specification.
12052 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12054 @item -funwind-tables
12055 @opindex funwind-tables
12056 Similar to @option{-fexceptions}, except that it just generates any needed
12057 static data, but does not affect the generated code in any other way.
12058 You normally do not need to enable this option; instead, a language processor
12059 that needs this handling enables it on your behalf.
12061 @item -fasynchronous-unwind-tables
12062 @opindex fasynchronous-unwind-tables
12063 Generate unwind table in DWARF format, if supported by target machine.  The
12064 table is exact at each instruction boundary, so it can be used for stack
12065 unwinding from asynchronous events (such as debugger or garbage collector).
12067 @item -fno-gnu-unique
12068 @opindex fno-gnu-unique
12069 On systems with recent GNU assembler and C library, the C++ compiler
12070 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12071 of template static data members and static local variables in inline
12072 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12073 is necessary to avoid problems with a library used by two different
12074 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12075 therefore disagreeing with the other one about the binding of the
12076 symbol.  But this causes @code{dlclose} to be ignored for affected
12077 DSOs; if your program relies on reinitialization of a DSO via
12078 @code{dlclose} and @code{dlopen}, you can use
12079 @option{-fno-gnu-unique}.
12081 @item -fpcc-struct-return
12082 @opindex fpcc-struct-return
12083 Return ``short'' @code{struct} and @code{union} values in memory like
12084 longer ones, rather than in registers.  This convention is less
12085 efficient, but it has the advantage of allowing intercallability between
12086 GCC-compiled files and files compiled with other compilers, particularly
12087 the Portable C Compiler (pcc).
12089 The precise convention for returning structures in memory depends
12090 on the target configuration macros.
12092 Short structures and unions are those whose size and alignment match
12093 that of some integer type.
12095 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12096 switch is not binary compatible with code compiled with the
12097 @option{-freg-struct-return} switch.
12098 Use it to conform to a non-default application binary interface.
12100 @item -freg-struct-return
12101 @opindex freg-struct-return
12102 Return @code{struct} and @code{union} values in registers when possible.
12103 This is more efficient for small structures than
12104 @option{-fpcc-struct-return}.
12106 If you specify neither @option{-fpcc-struct-return} nor
12107 @option{-freg-struct-return}, GCC defaults to whichever convention is
12108 standard for the target.  If there is no standard convention, GCC
12109 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12110 the principal compiler.  In those cases, we can choose the standard, and
12111 we chose the more efficient register return alternative.
12113 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12114 switch is not binary compatible with code compiled with the
12115 @option{-fpcc-struct-return} switch.
12116 Use it to conform to a non-default application binary interface.
12118 @item -fshort-enums
12119 @opindex fshort-enums
12120 Allocate to an @code{enum} type only as many bytes as it needs for the
12121 declared range of possible values.  Specifically, the @code{enum} type
12122 is equivalent to the smallest integer type that has enough room.
12124 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12125 code that is not binary compatible with code generated without that switch.
12126 Use it to conform to a non-default application binary interface.
12128 @item -fshort-wchar
12129 @opindex fshort-wchar
12130 Override the underlying type for @code{wchar_t} to be @code{short
12131 unsigned int} instead of the default for the target.  This option is
12132 useful for building programs to run under WINE@.
12134 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12135 code that is not binary compatible with code generated without that switch.
12136 Use it to conform to a non-default application binary interface.
12138 @item -fno-common
12139 @opindex fno-common
12140 @cindex tentative definitions
12141 In C code, this option controls the placement of global variables 
12142 defined without an initializer, known as @dfn{tentative definitions} 
12143 in the C standard.  Tentative definitions are distinct from declarations 
12144 of a variable with the @code{extern} keyword, which do not allocate storage.
12146 Unix C compilers have traditionally allocated storage for
12147 uninitialized global variables in a common block.  This allows the
12148 linker to resolve all tentative definitions of the same variable
12149 in different compilation units to the same object, or to a non-tentative
12150 definition.  
12151 This is the behavior specified by @option{-fcommon}, and is the default for 
12152 GCC on most targets.  
12153 On the other hand, this behavior is not required by ISO
12154 C, and on some targets may carry a speed or code size penalty on
12155 variable references.
12157 The @option{-fno-common} option specifies that the compiler should instead
12158 place uninitialized global variables in the data section of the object file.
12159 This inhibits the merging of tentative definitions by the linker so
12160 you get a multiple-definition error if the same 
12161 variable is defined in more than one compilation unit.
12162 Compiling with @option{-fno-common} is useful on targets for which
12163 it provides better performance, or if you wish to verify that the
12164 program will work on other systems that always treat uninitialized
12165 variable definitions this way.
12167 @item -fno-ident
12168 @opindex fno-ident
12169 Ignore the @code{#ident} directive.
12171 @item -finhibit-size-directive
12172 @opindex finhibit-size-directive
12173 Don't output a @code{.size} assembler directive, or anything else that
12174 would cause trouble if the function is split in the middle, and the
12175 two halves are placed at locations far apart in memory.  This option is
12176 used when compiling @file{crtstuff.c}; you should not need to use it
12177 for anything else.
12179 @item -fverbose-asm
12180 @opindex fverbose-asm
12181 Put extra commentary information in the generated assembly code to
12182 make it more readable.  This option is generally only of use to those
12183 who actually need to read the generated assembly code (perhaps while
12184 debugging the compiler itself).
12186 @option{-fno-verbose-asm}, the default, causes the
12187 extra information to be omitted and is useful when comparing two assembler
12188 files.
12190 The added comments include:
12192 @itemize @bullet
12194 @item
12195 information on the compiler version and command-line options,
12197 @item
12198 the source code lines associated with the assembly instructions,
12199 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12201 @item
12202 hints on which high-level expressions correspond to
12203 the various assembly instruction operands.
12205 @end itemize
12207 For example, given this C source file:
12209 @smallexample
12210 int test (int n)
12212   int i;
12213   int total = 0;
12215   for (i = 0; i < n; i++)
12216     total += i * i;
12218   return total;
12220 @end smallexample
12222 compiling to (x86_64) assembly via @option{-S} and emitting the result
12223 direct to stdout via @option{-o} @option{-}
12225 @smallexample
12226 gcc -S test.c -fverbose-asm -Os -o -
12227 @end smallexample
12229 gives output similar to this:
12231 @smallexample
12232         .file   "test.c"
12233 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12234   [...snip...]
12235 # options passed:
12236   [...snip...]
12238         .text
12239         .globl  test
12240         .type   test, @@function
12241 test:
12242 .LFB0:
12243         .cfi_startproc
12244 # test.c:4:   int total = 0;
12245         xorl    %eax, %eax      # <retval>
12246 # test.c:6:   for (i = 0; i < n; i++)
12247         xorl    %edx, %edx      # i
12248 .L2:
12249 # test.c:6:   for (i = 0; i < n; i++)
12250         cmpl    %edi, %edx      # n, i
12251         jge     .L5     #,
12252 # test.c:7:     total += i * i;
12253         movl    %edx, %ecx      # i, tmp92
12254         imull   %edx, %ecx      # i, tmp92
12255 # test.c:6:   for (i = 0; i < n; i++)
12256         incl    %edx    # i
12257 # test.c:7:     total += i * i;
12258         addl    %ecx, %eax      # tmp92, <retval>
12259         jmp     .L2     #
12260 .L5:
12261 # test.c:10: @}
12262         ret
12263         .cfi_endproc
12264 .LFE0:
12265         .size   test, .-test
12266         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12267         .section        .note.GNU-stack,"",@@progbits
12268 @end smallexample
12270 The comments are intended for humans rather than machines and hence the
12271 precise format of the comments is subject to change.
12273 @item -frecord-gcc-switches
12274 @opindex frecord-gcc-switches
12275 This switch causes the command line used to invoke the
12276 compiler to be recorded into the object file that is being created.
12277 This switch is only implemented on some targets and the exact format
12278 of the recording is target and binary file format dependent, but it
12279 usually takes the form of a section containing ASCII text.  This
12280 switch is related to the @option{-fverbose-asm} switch, but that
12281 switch only records information in the assembler output file as
12282 comments, so it never reaches the object file.
12283 See also @option{-grecord-gcc-switches} for another
12284 way of storing compiler options into the object file.
12286 @item -fpic
12287 @opindex fpic
12288 @cindex global offset table
12289 @cindex PIC
12290 Generate position-independent code (PIC) suitable for use in a shared
12291 library, if supported for the target machine.  Such code accesses all
12292 constant addresses through a global offset table (GOT)@.  The dynamic
12293 loader resolves the GOT entries when the program starts (the dynamic
12294 loader is not part of GCC; it is part of the operating system).  If
12295 the GOT size for the linked executable exceeds a machine-specific
12296 maximum size, you get an error message from the linker indicating that
12297 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12298 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12299 on the m68k and RS/6000.  The x86 has no such limit.)
12301 Position-independent code requires special support, and therefore works
12302 only on certain machines.  For the x86, GCC supports PIC for System V
12303 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12304 position-independent.
12306 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12307 are defined to 1.
12309 @item -fPIC
12310 @opindex fPIC
12311 If supported for the target machine, emit position-independent code,
12312 suitable for dynamic linking and avoiding any limit on the size of the
12313 global offset table.  This option makes a difference on AArch64, m68k,
12314 PowerPC and SPARC@.
12316 Position-independent code requires special support, and therefore works
12317 only on certain machines.
12319 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12320 are defined to 2.
12322 @item -fpie
12323 @itemx -fPIE
12324 @opindex fpie
12325 @opindex fPIE
12326 These options are similar to @option{-fpic} and @option{-fPIC}, but
12327 generated position independent code can be only linked into executables.
12328 Usually these options are used when @option{-pie} GCC option is
12329 used during linking.
12331 @option{-fpie} and @option{-fPIE} both define the macros
12332 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12333 for @option{-fpie} and 2 for @option{-fPIE}.
12335 @item -fno-plt
12336 @opindex fno-plt
12337 Do not use the PLT for external function calls in position-independent code.
12338 Instead, load the callee address at call sites from the GOT and branch to it.
12339 This leads to more efficient code by eliminating PLT stubs and exposing
12340 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12341 PLT stubs expect the GOT pointer in a specific register, this gives more
12342 register allocation freedom to the compiler.
12343 Lazy binding requires use of the PLT; 
12344 with @option{-fno-plt} all external symbols are resolved at load time.
12346 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12347 through the PLT for specific external functions.
12349 In position-dependent code, a few targets also convert calls to
12350 functions that are marked to not use the PLT to use the GOT instead.
12352 @item -fno-jump-tables
12353 @opindex fno-jump-tables
12354 Do not use jump tables for switch statements even where it would be
12355 more efficient than other code generation strategies.  This option is
12356 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12357 building code that forms part of a dynamic linker and cannot
12358 reference the address of a jump table.  On some targets, jump tables
12359 do not require a GOT and this option is not needed.
12361 @item -ffixed-@var{reg}
12362 @opindex ffixed
12363 Treat the register named @var{reg} as a fixed register; generated code
12364 should never refer to it (except perhaps as a stack pointer, frame
12365 pointer or in some other fixed role).
12367 @var{reg} must be the name of a register.  The register names accepted
12368 are machine-specific and are defined in the @code{REGISTER_NAMES}
12369 macro in the machine description macro file.
12371 This flag does not have a negative form, because it specifies a
12372 three-way choice.
12374 @item -fcall-used-@var{reg}
12375 @opindex fcall-used
12376 Treat the register named @var{reg} as an allocable register that is
12377 clobbered by function calls.  It may be allocated for temporaries or
12378 variables that do not live across a call.  Functions compiled this way
12379 do not save and restore the register @var{reg}.
12381 It is an error to use this flag with the frame pointer or stack pointer.
12382 Use of this flag for other registers that have fixed pervasive roles in
12383 the machine's execution model produces disastrous results.
12385 This flag does not have a negative form, because it specifies a
12386 three-way choice.
12388 @item -fcall-saved-@var{reg}
12389 @opindex fcall-saved
12390 Treat the register named @var{reg} as an allocable register saved by
12391 functions.  It may be allocated even for temporaries or variables that
12392 live across a call.  Functions compiled this way save and restore
12393 the register @var{reg} if they use it.
12395 It is an error to use this flag with the frame pointer or stack pointer.
12396 Use of this flag for other registers that have fixed pervasive roles in
12397 the machine's execution model produces disastrous results.
12399 A different sort of disaster results from the use of this flag for
12400 a register in which function values may be returned.
12402 This flag does not have a negative form, because it specifies a
12403 three-way choice.
12405 @item -fpack-struct[=@var{n}]
12406 @opindex fpack-struct
12407 Without a value specified, pack all structure members together without
12408 holes.  When a value is specified (which must be a small power of two), pack
12409 structure members according to this value, representing the maximum
12410 alignment (that is, objects with default alignment requirements larger than
12411 this are output potentially unaligned at the next fitting location.
12413 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12414 code that is not binary compatible with code generated without that switch.
12415 Additionally, it makes the code suboptimal.
12416 Use it to conform to a non-default application binary interface.
12418 @item -fleading-underscore
12419 @opindex fleading-underscore
12420 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12421 change the way C symbols are represented in the object file.  One use
12422 is to help link with legacy assembly code.
12424 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12425 generate code that is not binary compatible with code generated without that
12426 switch.  Use it to conform to a non-default application binary interface.
12427 Not all targets provide complete support for this switch.
12429 @item -ftls-model=@var{model}
12430 @opindex ftls-model
12431 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12432 The @var{model} argument should be one of @samp{global-dynamic},
12433 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12434 Note that the choice is subject to optimization: the compiler may use
12435 a more efficient model for symbols not visible outside of the translation
12436 unit, or if @option{-fpic} is not given on the command line.
12438 The default without @option{-fpic} is @samp{initial-exec}; with
12439 @option{-fpic} the default is @samp{global-dynamic}.
12441 @item -ftrampolines
12442 @opindex ftrampolines
12443 For targets that normally need trampolines for nested functions, always
12444 generate them instead of using descriptors.  Otherwise, for targets that
12445 do not need them, like for example HP-PA or IA-64, do nothing.
12447 A trampoline is a small piece of code that is created at run time on the
12448 stack when the address of a nested function is taken, and is used to call
12449 the nested function indirectly.  Therefore, it requires the stack to be
12450 made executable in order for the program to work properly.
12452 @option{-fno-trampolines} is enabled by default on a language by language
12453 basis to let the compiler avoid generating them, if it computes that this
12454 is safe, and replace them with descriptors.  Descriptors are made up of data
12455 only, but the generated code must be prepared to deal with them.  As of this
12456 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12458 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12459 @option{-fno-trampolines} are not binary compatible if nested functions are
12460 present.  This option must therefore be used on a program-wide basis and be
12461 manipulated with extreme care.
12463 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12464 @opindex fvisibility
12465 Set the default ELF image symbol visibility to the specified option---all
12466 symbols are marked with this unless overridden within the code.
12467 Using this feature can very substantially improve linking and
12468 load times of shared object libraries, produce more optimized
12469 code, provide near-perfect API export and prevent symbol clashes.
12470 It is @strong{strongly} recommended that you use this in any shared objects
12471 you distribute.
12473 Despite the nomenclature, @samp{default} always means public; i.e.,
12474 available to be linked against from outside the shared object.
12475 @samp{protected} and @samp{internal} are pretty useless in real-world
12476 usage so the only other commonly used option is @samp{hidden}.
12477 The default if @option{-fvisibility} isn't specified is
12478 @samp{default}, i.e., make every symbol public.
12480 A good explanation of the benefits offered by ensuring ELF
12481 symbols have the correct visibility is given by ``How To Write
12482 Shared Libraries'' by Ulrich Drepper (which can be found at
12483 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12484 solution made possible by this option to marking things hidden when
12485 the default is public is to make the default hidden and mark things
12486 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12487 and @code{__attribute__ ((visibility("default")))} instead of
12488 @code{__declspec(dllexport)} you get almost identical semantics with
12489 identical syntax.  This is a great boon to those working with
12490 cross-platform projects.
12492 For those adding visibility support to existing code, you may find
12493 @code{#pragma GCC visibility} of use.  This works by you enclosing
12494 the declarations you wish to set visibility for with (for example)
12495 @code{#pragma GCC visibility push(hidden)} and
12496 @code{#pragma GCC visibility pop}.
12497 Bear in mind that symbol visibility should be viewed @strong{as
12498 part of the API interface contract} and thus all new code should
12499 always specify visibility when it is not the default; i.e., declarations
12500 only for use within the local DSO should @strong{always} be marked explicitly
12501 as hidden as so to avoid PLT indirection overheads---making this
12502 abundantly clear also aids readability and self-documentation of the code.
12503 Note that due to ISO C++ specification requirements, @code{operator new} and
12504 @code{operator delete} must always be of default visibility.
12506 Be aware that headers from outside your project, in particular system
12507 headers and headers from any other library you use, may not be
12508 expecting to be compiled with visibility other than the default.  You
12509 may need to explicitly say @code{#pragma GCC visibility push(default)}
12510 before including any such headers.
12512 @code{extern} declarations are not affected by @option{-fvisibility}, so
12513 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12514 no modifications.  However, this means that calls to @code{extern}
12515 functions with no explicit visibility use the PLT, so it is more
12516 effective to use @code{__attribute ((visibility))} and/or
12517 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12518 declarations should be treated as hidden.
12520 Note that @option{-fvisibility} does affect C++ vague linkage
12521 entities. This means that, for instance, an exception class that is
12522 be thrown between DSOs must be explicitly marked with default
12523 visibility so that the @samp{type_info} nodes are unified between
12524 the DSOs.
12526 An overview of these techniques, their benefits and how to use them
12527 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12529 @item -fstrict-volatile-bitfields
12530 @opindex fstrict-volatile-bitfields
12531 This option should be used if accesses to volatile bit-fields (or other
12532 structure fields, although the compiler usually honors those types
12533 anyway) should use a single access of the width of the
12534 field's type, aligned to a natural alignment if possible.  For
12535 example, targets with memory-mapped peripheral registers might require
12536 all such accesses to be 16 bits wide; with this flag you can
12537 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12538 is 16 bits on these targets) to force GCC to use 16-bit accesses
12539 instead of, perhaps, a more efficient 32-bit access.
12541 If this option is disabled, the compiler uses the most efficient
12542 instruction.  In the previous example, that might be a 32-bit load
12543 instruction, even though that accesses bytes that do not contain
12544 any portion of the bit-field, or memory-mapped registers unrelated to
12545 the one being updated.
12547 In some cases, such as when the @code{packed} attribute is applied to a 
12548 structure field, it may not be possible to access the field with a single
12549 read or write that is correctly aligned for the target machine.  In this
12550 case GCC falls back to generating multiple accesses rather than code that 
12551 will fault or truncate the result at run time.
12553 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12554 not allowed to touch non bit-field members.  It is therefore recommended
12555 to define all bits of the field's type as bit-field members.
12557 The default value of this option is determined by the application binary
12558 interface for the target processor.
12560 @item -fsync-libcalls
12561 @opindex fsync-libcalls
12562 This option controls whether any out-of-line instance of the @code{__sync}
12563 family of functions may be used to implement the C++11 @code{__atomic}
12564 family of functions.
12566 The default value of this option is enabled, thus the only useful form
12567 of the option is @option{-fno-sync-libcalls}.  This option is used in
12568 the implementation of the @file{libatomic} runtime library.
12570 @end table
12572 @node Developer Options
12573 @section GCC Developer Options
12574 @cindex developer options
12575 @cindex debugging GCC
12576 @cindex debug dump options
12577 @cindex dump options
12578 @cindex compilation statistics
12580 This section describes command-line options that are primarily of
12581 interest to GCC developers, including options to support compiler
12582 testing and investigation of compiler bugs and compile-time
12583 performance problems.  This includes options that produce debug dumps
12584 at various points in the compilation; that print statistics such as
12585 memory use and execution time; and that print information about GCC's
12586 configuration, such as where it searches for libraries.  You should
12587 rarely need to use any of these options for ordinary compilation and
12588 linking tasks.
12590 @table @gcctabopt
12592 @item -d@var{letters}
12593 @itemx -fdump-rtl-@var{pass}
12594 @itemx -fdump-rtl-@var{pass}=@var{filename}
12595 @opindex d
12596 @opindex fdump-rtl-@var{pass}
12597 Says to make debugging dumps during compilation at times specified by
12598 @var{letters}.  This is used for debugging the RTL-based passes of the
12599 compiler.  The file names for most of the dumps are made by appending
12600 a pass number and a word to the @var{dumpname}, and the files are
12601 created in the directory of the output file.  In case of
12602 @option{=@var{filename}} option, the dump is output on the given file
12603 instead of the pass numbered dump files.  Note that the pass number is
12604 assigned as passes are registered into the pass manager.  Most passes
12605 are registered in the order that they will execute and for these passes
12606 the number corresponds to the pass execution order.  However, passes
12607 registered by plugins, passes specific to compilation targets, or
12608 passes that are otherwise registered after all the other passes are
12609 numbered higher than a pass named "final", even if they are executed
12610 earlier.  @var{dumpname} is generated from the name of the output
12611 file if explicitly specified and not an executable, otherwise it is
12612 the basename of the source file.  
12614 Some @option{-d@var{letters}} switches have different meaning when
12615 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12616 for information about preprocessor-specific dump options.
12618 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12619 @option{-d} option @var{letters}.  Here are the possible
12620 letters for use in @var{pass} and @var{letters}, and their meanings:
12622 @table @gcctabopt
12624 @item -fdump-rtl-alignments
12625 @opindex fdump-rtl-alignments
12626 Dump after branch alignments have been computed.
12628 @item -fdump-rtl-asmcons
12629 @opindex fdump-rtl-asmcons
12630 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12632 @item -fdump-rtl-auto_inc_dec
12633 @opindex fdump-rtl-auto_inc_dec
12634 Dump after auto-inc-dec discovery.  This pass is only run on
12635 architectures that have auto inc or auto dec instructions.
12637 @item -fdump-rtl-barriers
12638 @opindex fdump-rtl-barriers
12639 Dump after cleaning up the barrier instructions.
12641 @item -fdump-rtl-bbpart
12642 @opindex fdump-rtl-bbpart
12643 Dump after partitioning hot and cold basic blocks.
12645 @item -fdump-rtl-bbro
12646 @opindex fdump-rtl-bbro
12647 Dump after block reordering.
12649 @item -fdump-rtl-btl1
12650 @itemx -fdump-rtl-btl2
12651 @opindex fdump-rtl-btl2
12652 @opindex fdump-rtl-btl2
12653 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12654 after the two branch
12655 target load optimization passes.
12657 @item -fdump-rtl-bypass
12658 @opindex fdump-rtl-bypass
12659 Dump after jump bypassing and control flow optimizations.
12661 @item -fdump-rtl-combine
12662 @opindex fdump-rtl-combine
12663 Dump after the RTL instruction combination pass.
12665 @item -fdump-rtl-compgotos
12666 @opindex fdump-rtl-compgotos
12667 Dump after duplicating the computed gotos.
12669 @item -fdump-rtl-ce1
12670 @itemx -fdump-rtl-ce2
12671 @itemx -fdump-rtl-ce3
12672 @opindex fdump-rtl-ce1
12673 @opindex fdump-rtl-ce2
12674 @opindex fdump-rtl-ce3
12675 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12676 @option{-fdump-rtl-ce3} enable dumping after the three
12677 if conversion passes.
12679 @item -fdump-rtl-cprop_hardreg
12680 @opindex fdump-rtl-cprop_hardreg
12681 Dump after hard register copy propagation.
12683 @item -fdump-rtl-csa
12684 @opindex fdump-rtl-csa
12685 Dump after combining stack adjustments.
12687 @item -fdump-rtl-cse1
12688 @itemx -fdump-rtl-cse2
12689 @opindex fdump-rtl-cse1
12690 @opindex fdump-rtl-cse2
12691 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12692 the two common subexpression elimination passes.
12694 @item -fdump-rtl-dce
12695 @opindex fdump-rtl-dce
12696 Dump after the standalone dead code elimination passes.
12698 @item -fdump-rtl-dbr
12699 @opindex fdump-rtl-dbr
12700 Dump after delayed branch scheduling.
12702 @item -fdump-rtl-dce1
12703 @itemx -fdump-rtl-dce2
12704 @opindex fdump-rtl-dce1
12705 @opindex fdump-rtl-dce2
12706 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12707 the two dead store elimination passes.
12709 @item -fdump-rtl-eh
12710 @opindex fdump-rtl-eh
12711 Dump after finalization of EH handling code.
12713 @item -fdump-rtl-eh_ranges
12714 @opindex fdump-rtl-eh_ranges
12715 Dump after conversion of EH handling range regions.
12717 @item -fdump-rtl-expand
12718 @opindex fdump-rtl-expand
12719 Dump after RTL generation.
12721 @item -fdump-rtl-fwprop1
12722 @itemx -fdump-rtl-fwprop2
12723 @opindex fdump-rtl-fwprop1
12724 @opindex fdump-rtl-fwprop2
12725 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12726 dumping after the two forward propagation passes.
12728 @item -fdump-rtl-gcse1
12729 @itemx -fdump-rtl-gcse2
12730 @opindex fdump-rtl-gcse1
12731 @opindex fdump-rtl-gcse2
12732 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12733 after global common subexpression elimination.
12735 @item -fdump-rtl-init-regs
12736 @opindex fdump-rtl-init-regs
12737 Dump after the initialization of the registers.
12739 @item -fdump-rtl-initvals
12740 @opindex fdump-rtl-initvals
12741 Dump after the computation of the initial value sets.
12743 @item -fdump-rtl-into_cfglayout
12744 @opindex fdump-rtl-into_cfglayout
12745 Dump after converting to cfglayout mode.
12747 @item -fdump-rtl-ira
12748 @opindex fdump-rtl-ira
12749 Dump after iterated register allocation.
12751 @item -fdump-rtl-jump
12752 @opindex fdump-rtl-jump
12753 Dump after the second jump optimization.
12755 @item -fdump-rtl-loop2
12756 @opindex fdump-rtl-loop2
12757 @option{-fdump-rtl-loop2} enables dumping after the rtl
12758 loop optimization passes.
12760 @item -fdump-rtl-mach
12761 @opindex fdump-rtl-mach
12762 Dump after performing the machine dependent reorganization pass, if that
12763 pass exists.
12765 @item -fdump-rtl-mode_sw
12766 @opindex fdump-rtl-mode_sw
12767 Dump after removing redundant mode switches.
12769 @item -fdump-rtl-rnreg
12770 @opindex fdump-rtl-rnreg
12771 Dump after register renumbering.
12773 @item -fdump-rtl-outof_cfglayout
12774 @opindex fdump-rtl-outof_cfglayout
12775 Dump after converting from cfglayout mode.
12777 @item -fdump-rtl-peephole2
12778 @opindex fdump-rtl-peephole2
12779 Dump after the peephole pass.
12781 @item -fdump-rtl-postreload
12782 @opindex fdump-rtl-postreload
12783 Dump after post-reload optimizations.
12785 @item -fdump-rtl-pro_and_epilogue
12786 @opindex fdump-rtl-pro_and_epilogue
12787 Dump after generating the function prologues and epilogues.
12789 @item -fdump-rtl-sched1
12790 @itemx -fdump-rtl-sched2
12791 @opindex fdump-rtl-sched1
12792 @opindex fdump-rtl-sched2
12793 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12794 after the basic block scheduling passes.
12796 @item -fdump-rtl-ree
12797 @opindex fdump-rtl-ree
12798 Dump after sign/zero extension elimination.
12800 @item -fdump-rtl-seqabstr
12801 @opindex fdump-rtl-seqabstr
12802 Dump after common sequence discovery.
12804 @item -fdump-rtl-shorten
12805 @opindex fdump-rtl-shorten
12806 Dump after shortening branches.
12808 @item -fdump-rtl-sibling
12809 @opindex fdump-rtl-sibling
12810 Dump after sibling call optimizations.
12812 @item -fdump-rtl-split1
12813 @itemx -fdump-rtl-split2
12814 @itemx -fdump-rtl-split3
12815 @itemx -fdump-rtl-split4
12816 @itemx -fdump-rtl-split5
12817 @opindex fdump-rtl-split1
12818 @opindex fdump-rtl-split2
12819 @opindex fdump-rtl-split3
12820 @opindex fdump-rtl-split4
12821 @opindex fdump-rtl-split5
12822 These options enable dumping after five rounds of
12823 instruction splitting.
12825 @item -fdump-rtl-sms
12826 @opindex fdump-rtl-sms
12827 Dump after modulo scheduling.  This pass is only run on some
12828 architectures.
12830 @item -fdump-rtl-stack
12831 @opindex fdump-rtl-stack
12832 Dump after conversion from GCC's ``flat register file'' registers to the
12833 x87's stack-like registers.  This pass is only run on x86 variants.
12835 @item -fdump-rtl-subreg1
12836 @itemx -fdump-rtl-subreg2
12837 @opindex fdump-rtl-subreg1
12838 @opindex fdump-rtl-subreg2
12839 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12840 the two subreg expansion passes.
12842 @item -fdump-rtl-unshare
12843 @opindex fdump-rtl-unshare
12844 Dump after all rtl has been unshared.
12846 @item -fdump-rtl-vartrack
12847 @opindex fdump-rtl-vartrack
12848 Dump after variable tracking.
12850 @item -fdump-rtl-vregs
12851 @opindex fdump-rtl-vregs
12852 Dump after converting virtual registers to hard registers.
12854 @item -fdump-rtl-web
12855 @opindex fdump-rtl-web
12856 Dump after live range splitting.
12858 @item -fdump-rtl-regclass
12859 @itemx -fdump-rtl-subregs_of_mode_init
12860 @itemx -fdump-rtl-subregs_of_mode_finish
12861 @itemx -fdump-rtl-dfinit
12862 @itemx -fdump-rtl-dfinish
12863 @opindex fdump-rtl-regclass
12864 @opindex fdump-rtl-subregs_of_mode_init
12865 @opindex fdump-rtl-subregs_of_mode_finish
12866 @opindex fdump-rtl-dfinit
12867 @opindex fdump-rtl-dfinish
12868 These dumps are defined but always produce empty files.
12870 @item -da
12871 @itemx -fdump-rtl-all
12872 @opindex da
12873 @opindex fdump-rtl-all
12874 Produce all the dumps listed above.
12876 @item -dA
12877 @opindex dA
12878 Annotate the assembler output with miscellaneous debugging information.
12880 @item -dD
12881 @opindex dD
12882 Dump all macro definitions, at the end of preprocessing, in addition to
12883 normal output.
12885 @item -dH
12886 @opindex dH
12887 Produce a core dump whenever an error occurs.
12889 @item -dp
12890 @opindex dp
12891 Annotate the assembler output with a comment indicating which
12892 pattern and alternative is used.  The length of each instruction is
12893 also printed.
12895 @item -dP
12896 @opindex dP
12897 Dump the RTL in the assembler output as a comment before each instruction.
12898 Also turns on @option{-dp} annotation.
12900 @item -dx
12901 @opindex dx
12902 Just generate RTL for a function instead of compiling it.  Usually used
12903 with @option{-fdump-rtl-expand}.
12904 @end table
12906 @item -fdump-noaddr
12907 @opindex fdump-noaddr
12908 When doing debugging dumps, suppress address output.  This makes it more
12909 feasible to use diff on debugging dumps for compiler invocations with
12910 different compiler binaries and/or different
12911 text / bss / data / heap / stack / dso start locations.
12913 @item -freport-bug
12914 @opindex freport-bug
12915 Collect and dump debug information into a temporary file if an
12916 internal compiler error (ICE) occurs.
12918 @item -fdump-unnumbered
12919 @opindex fdump-unnumbered
12920 When doing debugging dumps, suppress instruction numbers and address output.
12921 This makes it more feasible to use diff on debugging dumps for compiler
12922 invocations with different options, in particular with and without
12923 @option{-g}.
12925 @item -fdump-unnumbered-links
12926 @opindex fdump-unnumbered-links
12927 When doing debugging dumps (see @option{-d} option above), suppress
12928 instruction numbers for the links to the previous and next instructions
12929 in a sequence.
12931 @item -fdump-translation-unit @r{(C++ only)}
12932 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12933 @opindex fdump-translation-unit
12934 Dump a representation of the tree structure for the entire translation
12935 unit to a file.  The file name is made by appending @file{.tu} to the
12936 source file name, and the file is created in the same directory as the
12937 output file.  If the @samp{-@var{options}} form is used, @var{options}
12938 controls the details of the dump as described for the
12939 @option{-fdump-tree} options.
12941 @item -fdump-class-hierarchy @r{(C++ only)}
12942 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12943 @opindex fdump-class-hierarchy
12944 Dump a representation of each class's hierarchy and virtual function
12945 table layout to a file.  The file name is made by appending
12946 @file{.class} to the source file name, and the file is created in the
12947 same directory as the output file.  If the @samp{-@var{options}} form
12948 is used, @var{options} controls the details of the dump as described
12949 for the @option{-fdump-tree} options.
12951 @item -fdump-ipa-@var{switch}
12952 @opindex fdump-ipa
12953 Control the dumping at various stages of inter-procedural analysis
12954 language tree to a file.  The file name is generated by appending a
12955 switch specific suffix to the source file name, and the file is created
12956 in the same directory as the output file.  The following dumps are
12957 possible:
12959 @table @samp
12960 @item all
12961 Enables all inter-procedural analysis dumps.
12963 @item cgraph
12964 Dumps information about call-graph optimization, unused function removal,
12965 and inlining decisions.
12967 @item inline
12968 Dump after function inlining.
12970 @end table
12972 @item -fdump-passes
12973 @opindex fdump-passes
12974 Dump the list of optimization passes that are turned on and off by
12975 the current command-line options.
12977 @item -fdump-statistics-@var{option}
12978 @opindex fdump-statistics
12979 Enable and control dumping of pass statistics in a separate file.  The
12980 file name is generated by appending a suffix ending in
12981 @samp{.statistics} to the source file name, and the file is created in
12982 the same directory as the output file.  If the @samp{-@var{option}}
12983 form is used, @samp{-stats} causes counters to be summed over the
12984 whole compilation unit while @samp{-details} dumps every event as
12985 the passes generate them.  The default with no option is to sum
12986 counters for each function compiled.
12988 @item -fdump-tree-@var{switch}
12989 @itemx -fdump-tree-@var{switch}-@var{options}
12990 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
12991 @opindex fdump-tree
12992 Control the dumping at various stages of processing the intermediate
12993 language tree to a file.  The file name is generated by appending a
12994 switch-specific suffix to the source file name, and the file is
12995 created in the same directory as the output file. In case of
12996 @option{=@var{filename}} option, the dump is output on the given file
12997 instead of the auto named dump files.  If the @samp{-@var{options}}
12998 form is used, @var{options} is a list of @samp{-} separated options
12999 which control the details of the dump.  Not all options are applicable
13000 to all dumps; those that are not meaningful are ignored.  The
13001 following options are available
13003 @table @samp
13004 @item address
13005 Print the address of each node.  Usually this is not meaningful as it
13006 changes according to the environment and source file.  Its primary use
13007 is for tying up a dump file with a debug environment.
13008 @item asmname
13009 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13010 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13011 use working backward from mangled names in the assembly file.
13012 @item slim
13013 When dumping front-end intermediate representations, inhibit dumping
13014 of members of a scope or body of a function merely because that scope
13015 has been reached.  Only dump such items when they are directly reachable
13016 by some other path.
13018 When dumping pretty-printed trees, this option inhibits dumping the
13019 bodies of control structures.
13021 When dumping RTL, print the RTL in slim (condensed) form instead of
13022 the default LISP-like representation.
13023 @item raw
13024 Print a raw representation of the tree.  By default, trees are
13025 pretty-printed into a C-like representation.
13026 @item details
13027 Enable more detailed dumps (not honored by every dump option). Also
13028 include information from the optimization passes.
13029 @item stats
13030 Enable dumping various statistics about the pass (not honored by every dump
13031 option).
13032 @item blocks
13033 Enable showing basic block boundaries (disabled in raw dumps).
13034 @item graph
13035 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13036 dump a representation of the control flow graph suitable for viewing with
13037 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13038 the file is pretty-printed as a subgraph, so that GraphViz can render them
13039 all in a single plot.
13041 This option currently only works for RTL dumps, and the RTL is always
13042 dumped in slim form.
13043 @item vops
13044 Enable showing virtual operands for every statement.
13045 @item lineno
13046 Enable showing line numbers for statements.
13047 @item uid
13048 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13049 @item verbose
13050 Enable showing the tree dump for each statement.
13051 @item eh
13052 Enable showing the EH region number holding each statement.
13053 @item scev
13054 Enable showing scalar evolution analysis details.
13055 @item optimized
13056 Enable showing optimization information (only available in certain
13057 passes).
13058 @item missed
13059 Enable showing missed optimization information (only available in certain
13060 passes).
13061 @item note
13062 Enable other detailed optimization information (only available in
13063 certain passes).
13064 @item =@var{filename}
13065 Instead of an auto named dump file, output into the given file
13066 name. The file names @file{stdout} and @file{stderr} are treated
13067 specially and are considered already open standard streams. For
13068 example,
13070 @smallexample
13071 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13072      -fdump-tree-pre=stderr file.c
13073 @end smallexample
13075 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13076 output on to @file{stderr}. If two conflicting dump filenames are
13077 given for the same pass, then the latter option overrides the earlier
13078 one.
13080 @item split-paths
13081 @opindex fdump-tree-split-paths
13082 Dump each function after splitting paths to loop backedges.  The file
13083 name is made by appending @file{.split-paths} to the source file name.
13085 @item all
13086 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13087 and @option{lineno}.
13089 @item optall
13090 Turn on all optimization options, i.e., @option{optimized},
13091 @option{missed}, and @option{note}.
13092 @end table
13094 The following tree dumps are possible:
13095 @table @samp
13097 @item original
13098 @opindex fdump-tree-original
13099 Dump before any tree based optimization, to @file{@var{file}.original}.
13101 @item optimized
13102 @opindex fdump-tree-optimized
13103 Dump after all tree based optimization, to @file{@var{file}.optimized}.
13105 @item gimple
13106 @opindex fdump-tree-gimple
13107 Dump each function before and after the gimplification pass to a file.  The
13108 file name is made by appending @file{.gimple} to the source file name.
13110 @item cfg
13111 @opindex fdump-tree-cfg
13112 Dump the control flow graph of each function to a file.  The file name is
13113 made by appending @file{.cfg} to the source file name.
13115 @item ch
13116 @opindex fdump-tree-ch
13117 Dump each function after copying loop headers.  The file name is made by
13118 appending @file{.ch} to the source file name.
13120 @item ssa
13121 @opindex fdump-tree-ssa
13122 Dump SSA related information to a file.  The file name is made by appending
13123 @file{.ssa} to the source file name.
13125 @item alias
13126 @opindex fdump-tree-alias
13127 Dump aliasing information for each function.  The file name is made by
13128 appending @file{.alias} to the source file name.
13130 @item ccp
13131 @opindex fdump-tree-ccp
13132 Dump each function after CCP@.  The file name is made by appending
13133 @file{.ccp} to the source file name.
13135 @item storeccp
13136 @opindex fdump-tree-storeccp
13137 Dump each function after STORE-CCP@.  The file name is made by appending
13138 @file{.storeccp} to the source file name.
13140 @item pre
13141 @opindex fdump-tree-pre
13142 Dump trees after partial redundancy elimination and/or code hoisting.
13143 The file name is made by appending @file{.pre} to the source file name.
13145 @item fre
13146 @opindex fdump-tree-fre
13147 Dump trees after full redundancy elimination.  The file name is made
13148 by appending @file{.fre} to the source file name.
13150 @item copyprop
13151 @opindex fdump-tree-copyprop
13152 Dump trees after copy propagation.  The file name is made
13153 by appending @file{.copyprop} to the source file name.
13155 @item store_copyprop
13156 @opindex fdump-tree-store_copyprop
13157 Dump trees after store copy-propagation.  The file name is made
13158 by appending @file{.store_copyprop} to the source file name.
13160 @item dce
13161 @opindex fdump-tree-dce
13162 Dump each function after dead code elimination.  The file name is made by
13163 appending @file{.dce} to the source file name.
13165 @item sra
13166 @opindex fdump-tree-sra
13167 Dump each function after performing scalar replacement of aggregates.  The
13168 file name is made by appending @file{.sra} to the source file name.
13170 @item sink
13171 @opindex fdump-tree-sink
13172 Dump each function after performing code sinking.  The file name is made
13173 by appending @file{.sink} to the source file name.
13175 @item dom
13176 @opindex fdump-tree-dom
13177 Dump each function after applying dominator tree optimizations.  The file
13178 name is made by appending @file{.dom} to the source file name.
13180 @item dse
13181 @opindex fdump-tree-dse
13182 Dump each function after applying dead store elimination.  The file
13183 name is made by appending @file{.dse} to the source file name.
13185 @item phiopt
13186 @opindex fdump-tree-phiopt
13187 Dump each function after optimizing PHI nodes into straightline code.  The file
13188 name is made by appending @file{.phiopt} to the source file name.
13190 @item backprop
13191 @opindex fdump-tree-backprop
13192 Dump each function after back-propagating use information up the definition
13193 chain.  The file name is made by appending @file{.backprop} to the
13194 source file name.
13196 @item forwprop
13197 @opindex fdump-tree-forwprop
13198 Dump each function after forward propagating single use variables.  The file
13199 name is made by appending @file{.forwprop} to the source file name.
13201 @item nrv
13202 @opindex fdump-tree-nrv
13203 Dump each function after applying the named return value optimization on
13204 generic trees.  The file name is made by appending @file{.nrv} to the source
13205 file name.
13207 @item vect
13208 @opindex fdump-tree-vect
13209 Dump each function after applying vectorization of loops.  The file name is
13210 made by appending @file{.vect} to the source file name.
13212 @item slp
13213 @opindex fdump-tree-slp
13214 Dump each function after applying vectorization of basic blocks.  The file name
13215 is made by appending @file{.slp} to the source file name.
13217 @item vrp
13218 @opindex fdump-tree-vrp
13219 Dump each function after Value Range Propagation (VRP).  The file name
13220 is made by appending @file{.vrp} to the source file name.
13222 @item early vrp
13223 @opindex fdump-tree-evrp
13224 Dump each function after Early Value Range Propagation (EVRP).  The file name
13225 is made by appending @file{.evrp} to the source file name.
13227 @item oaccdevlow
13228 @opindex fdump-tree-oaccdevlow
13229 Dump each function after applying device-specific OpenACC transformations.
13230 The file name is made by appending @file{.oaccdevlow} to the source file name.
13232 @item all
13233 @opindex fdump-tree-all
13234 Enable all the available tree dumps with the flags provided in this option.
13235 @end table
13237 @item -fopt-info
13238 @itemx -fopt-info-@var{options}
13239 @itemx -fopt-info-@var{options}=@var{filename}
13240 @opindex fopt-info
13241 Controls optimization dumps from various optimization passes. If the
13242 @samp{-@var{options}} form is used, @var{options} is a list of
13243 @samp{-} separated option keywords to select the dump details and
13244 optimizations.  
13246 The @var{options} can be divided into two groups: options describing the
13247 verbosity of the dump, and options describing which optimizations
13248 should be included. The options from both the groups can be freely
13249 mixed as they are non-overlapping. However, in case of any conflicts,
13250 the later options override the earlier options on the command
13251 line. 
13253 The following options control the dump verbosity:
13255 @table @samp
13256 @item optimized
13257 Print information when an optimization is successfully applied. It is
13258 up to a pass to decide which information is relevant. For example, the
13259 vectorizer passes print the source location of loops which are
13260 successfully vectorized.
13261 @item missed
13262 Print information about missed optimizations. Individual passes
13263 control which information to include in the output. 
13264 @item note
13265 Print verbose information about optimizations, such as certain
13266 transformations, more detailed messages about decisions etc.
13267 @item all
13268 Print detailed optimization information. This includes
13269 @samp{optimized}, @samp{missed}, and @samp{note}.
13270 @end table
13272 One or more of the following option keywords can be used to describe a
13273 group of optimizations:
13275 @table @samp
13276 @item ipa
13277 Enable dumps from all interprocedural optimizations.
13278 @item loop
13279 Enable dumps from all loop optimizations.
13280 @item inline
13281 Enable dumps from all inlining optimizations.
13282 @item vec
13283 Enable dumps from all vectorization optimizations.
13284 @item optall
13285 Enable dumps from all optimizations. This is a superset of
13286 the optimization groups listed above.
13287 @end table
13289 If @var{options} is
13290 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13291 info about successful optimizations from all the passes.  
13293 If the @var{filename} is provided, then the dumps from all the
13294 applicable optimizations are concatenated into the @var{filename}.
13295 Otherwise the dump is output onto @file{stderr}. Though multiple
13296 @option{-fopt-info} options are accepted, only one of them can include
13297 a @var{filename}. If other filenames are provided then all but the
13298 first such option are ignored.
13300 Note that the output @var{filename} is overwritten
13301 in case of multiple translation units. If a combined output from
13302 multiple translation units is desired, @file{stderr} should be used
13303 instead.
13305 In the following example, the optimization info is output to
13306 @file{stderr}:
13308 @smallexample
13309 gcc -O3 -fopt-info
13310 @end smallexample
13312 This example:
13313 @smallexample
13314 gcc -O3 -fopt-info-missed=missed.all
13315 @end smallexample
13317 @noindent
13318 outputs missed optimization report from all the passes into
13319 @file{missed.all}, and this one:
13321 @smallexample
13322 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13323 @end smallexample
13325 @noindent
13326 prints information about missed optimization opportunities from
13327 vectorization passes on @file{stderr}.  
13328 Note that @option{-fopt-info-vec-missed} is equivalent to 
13329 @option{-fopt-info-missed-vec}.
13331 As another example,
13332 @smallexample
13333 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13334 @end smallexample
13336 @noindent
13337 outputs information about missed optimizations as well as
13338 optimized locations from all the inlining passes into
13339 @file{inline.txt}.
13341 Finally, consider:
13343 @smallexample
13344 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13345 @end smallexample
13347 @noindent
13348 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13349 in conflict since only one output file is allowed. In this case, only
13350 the first option takes effect and the subsequent options are
13351 ignored. Thus only @file{vec.miss} is produced which contains
13352 dumps from the vectorizer about missed opportunities.
13354 @item -fsched-verbose=@var{n}
13355 @opindex fsched-verbose
13356 On targets that use instruction scheduling, this option controls the
13357 amount of debugging output the scheduler prints to the dump files.
13359 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13360 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13361 For @var{n} greater than one, it also output basic block probabilities,
13362 detailed ready list information and unit/insn info.  For @var{n} greater
13363 than two, it includes RTL at abort point, control-flow and regions info.
13364 And for @var{n} over four, @option{-fsched-verbose} also includes
13365 dependence info.
13369 @item -fenable-@var{kind}-@var{pass}
13370 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13371 @opindex fdisable-
13372 @opindex fenable-
13374 This is a set of options that are used to explicitly disable/enable
13375 optimization passes.  These options are intended for use for debugging GCC.
13376 Compiler users should use regular options for enabling/disabling
13377 passes instead.
13379 @table @gcctabopt
13381 @item -fdisable-ipa-@var{pass}
13382 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13383 statically invoked in the compiler multiple times, the pass name should be
13384 appended with a sequential number starting from 1.
13386 @item -fdisable-rtl-@var{pass}
13387 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13388 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13389 statically invoked in the compiler multiple times, the pass name should be
13390 appended with a sequential number starting from 1.  @var{range-list} is a 
13391 comma-separated list of function ranges or assembler names.  Each range is a number
13392 pair separated by a colon.  The range is inclusive in both ends.  If the range
13393 is trivial, the number pair can be simplified as a single number.  If the
13394 function's call graph node's @var{uid} falls within one of the specified ranges,
13395 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13396 function header of a dump file, and the pass names can be dumped by using
13397 option @option{-fdump-passes}.
13399 @item -fdisable-tree-@var{pass}
13400 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13401 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13402 option arguments.
13404 @item -fenable-ipa-@var{pass}
13405 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13406 statically invoked in the compiler multiple times, the pass name should be
13407 appended with a sequential number starting from 1.
13409 @item -fenable-rtl-@var{pass}
13410 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13411 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13412 description and examples.
13414 @item -fenable-tree-@var{pass}
13415 @itemx -fenable-tree-@var{pass}=@var{range-list}
13416 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13417 of option arguments.
13419 @end table
13421 Here are some examples showing uses of these options.
13423 @smallexample
13425 # disable ccp1 for all functions
13426    -fdisable-tree-ccp1
13427 # disable complete unroll for function whose cgraph node uid is 1
13428    -fenable-tree-cunroll=1
13429 # disable gcse2 for functions at the following ranges [1,1],
13430 # [300,400], and [400,1000]
13431 # disable gcse2 for functions foo and foo2
13432    -fdisable-rtl-gcse2=foo,foo2
13433 # disable early inlining
13434    -fdisable-tree-einline
13435 # disable ipa inlining
13436    -fdisable-ipa-inline
13437 # enable tree full unroll
13438    -fenable-tree-unroll
13440 @end smallexample
13442 @item -fchecking
13443 @itemx -fchecking=@var{n}
13444 @opindex fchecking
13445 @opindex fno-checking
13446 Enable internal consistency checking.  The default depends on
13447 the compiler configuration.  @option{-fchecking=2} enables further
13448 internal consistency checking that might affect code generation.
13450 @item -frandom-seed=@var{string}
13451 @opindex frandom-seed
13452 This option provides a seed that GCC uses in place of
13453 random numbers in generating certain symbol names
13454 that have to be different in every compiled file.  It is also used to
13455 place unique stamps in coverage data files and the object files that
13456 produce them.  You can use the @option{-frandom-seed} option to produce
13457 reproducibly identical object files.
13459 The @var{string} can either be a number (decimal, octal or hex) or an
13460 arbitrary string (in which case it's converted to a number by
13461 computing CRC32).
13463 The @var{string} should be different for every file you compile.
13465 @item -save-temps
13466 @itemx -save-temps=cwd
13467 @opindex save-temps
13468 Store the usual ``temporary'' intermediate files permanently; place them
13469 in the current directory and name them based on the source file.  Thus,
13470 compiling @file{foo.c} with @option{-c -save-temps} produces files
13471 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13472 preprocessed @file{foo.i} output file even though the compiler now
13473 normally uses an integrated preprocessor.
13475 When used in combination with the @option{-x} command-line option,
13476 @option{-save-temps} is sensible enough to avoid over writing an
13477 input source file with the same extension as an intermediate file.
13478 The corresponding intermediate file may be obtained by renaming the
13479 source file before using @option{-save-temps}.
13481 If you invoke GCC in parallel, compiling several different source
13482 files that share a common base name in different subdirectories or the
13483 same source file compiled for multiple output destinations, it is
13484 likely that the different parallel compilers will interfere with each
13485 other, and overwrite the temporary files.  For instance:
13487 @smallexample
13488 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13489 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13490 @end smallexample
13492 may result in @file{foo.i} and @file{foo.o} being written to
13493 simultaneously by both compilers.
13495 @item -save-temps=obj
13496 @opindex save-temps=obj
13497 Store the usual ``temporary'' intermediate files permanently.  If the
13498 @option{-o} option is used, the temporary files are based on the
13499 object file.  If the @option{-o} option is not used, the
13500 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13502 For example:
13504 @smallexample
13505 gcc -save-temps=obj -c foo.c
13506 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13507 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13508 @end smallexample
13510 @noindent
13511 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13512 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13513 @file{dir2/yfoobar.o}.
13515 @item -time@r{[}=@var{file}@r{]}
13516 @opindex time
13517 Report the CPU time taken by each subprocess in the compilation
13518 sequence.  For C source files, this is the compiler proper and assembler
13519 (plus the linker if linking is done).
13521 Without the specification of an output file, the output looks like this:
13523 @smallexample
13524 # cc1 0.12 0.01
13525 # as 0.00 0.01
13526 @end smallexample
13528 The first number on each line is the ``user time'', that is time spent
13529 executing the program itself.  The second number is ``system time'',
13530 time spent executing operating system routines on behalf of the program.
13531 Both numbers are in seconds.
13533 With the specification of an output file, the output is appended to the
13534 named file, and it looks like this:
13536 @smallexample
13537 0.12 0.01 cc1 @var{options}
13538 0.00 0.01 as @var{options}
13539 @end smallexample
13541 The ``user time'' and the ``system time'' are moved before the program
13542 name, and the options passed to the program are displayed, so that one
13543 can later tell what file was being compiled, and with which options.
13545 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13546 @opindex fdump-final-insns
13547 Dump the final internal representation (RTL) to @var{file}.  If the
13548 optional argument is omitted (or if @var{file} is @code{.}), the name
13549 of the dump file is determined by appending @code{.gkd} to the
13550 compilation output file name.
13552 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13553 @opindex fcompare-debug
13554 @opindex fno-compare-debug
13555 If no error occurs during compilation, run the compiler a second time,
13556 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13557 passed to the second compilation.  Dump the final internal
13558 representation in both compilations, and print an error if they differ.
13560 If the equal sign is omitted, the default @option{-gtoggle} is used.
13562 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13563 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13564 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13565 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13566 is used.
13568 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13569 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13570 of the final representation and the second compilation, preventing even
13571 @env{GCC_COMPARE_DEBUG} from taking effect.
13573 To verify full coverage during @option{-fcompare-debug} testing, set
13574 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13575 which GCC rejects as an invalid option in any actual compilation
13576 (rather than preprocessing, assembly or linking).  To get just a
13577 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13578 not overridden} will do.
13580 @item -fcompare-debug-second
13581 @opindex fcompare-debug-second
13582 This option is implicitly passed to the compiler for the second
13583 compilation requested by @option{-fcompare-debug}, along with options to
13584 silence warnings, and omitting other options that would cause
13585 side-effect compiler outputs to files or to the standard output.  Dump
13586 files and preserved temporary files are renamed so as to contain the
13587 @code{.gk} additional extension during the second compilation, to avoid
13588 overwriting those generated by the first.
13590 When this option is passed to the compiler driver, it causes the
13591 @emph{first} compilation to be skipped, which makes it useful for little
13592 other than debugging the compiler proper.
13594 @item -gtoggle
13595 @opindex gtoggle
13596 Turn off generation of debug info, if leaving out this option
13597 generates it, or turn it on at level 2 otherwise.  The position of this
13598 argument in the command line does not matter; it takes effect after all
13599 other options are processed, and it does so only once, no matter how
13600 many times it is given.  This is mainly intended to be used with
13601 @option{-fcompare-debug}.
13603 @item -fvar-tracking-assignments-toggle
13604 @opindex fvar-tracking-assignments-toggle
13605 @opindex fno-var-tracking-assignments-toggle
13606 Toggle @option{-fvar-tracking-assignments}, in the same way that
13607 @option{-gtoggle} toggles @option{-g}.
13609 @item -Q
13610 @opindex Q
13611 Makes the compiler print out each function name as it is compiled, and
13612 print some statistics about each pass when it finishes.
13614 @item -ftime-report
13615 @opindex ftime-report
13616 Makes the compiler print some statistics about the time consumed by each
13617 pass when it finishes.
13619 @item -ftime-report-details
13620 @opindex ftime-report-details
13621 Record the time consumed by infrastructure parts separately for each pass.
13623 @item -fira-verbose=@var{n}
13624 @opindex fira-verbose
13625 Control the verbosity of the dump file for the integrated register allocator.
13626 The default value is 5.  If the value @var{n} is greater or equal to 10,
13627 the dump output is sent to stderr using the same format as @var{n} minus 10.
13629 @item -flto-report
13630 @opindex flto-report
13631 Prints a report with internal details on the workings of the link-time
13632 optimizer.  The contents of this report vary from version to version.
13633 It is meant to be useful to GCC developers when processing object
13634 files in LTO mode (via @option{-flto}).
13636 Disabled by default.
13638 @item -flto-report-wpa
13639 @opindex flto-report-wpa
13640 Like @option{-flto-report}, but only print for the WPA phase of Link
13641 Time Optimization.
13643 @item -fmem-report
13644 @opindex fmem-report
13645 Makes the compiler print some statistics about permanent memory
13646 allocation when it finishes.
13648 @item -fmem-report-wpa
13649 @opindex fmem-report-wpa
13650 Makes the compiler print some statistics about permanent memory
13651 allocation for the WPA phase only.
13653 @item -fpre-ipa-mem-report
13654 @opindex fpre-ipa-mem-report
13655 @item -fpost-ipa-mem-report
13656 @opindex fpost-ipa-mem-report
13657 Makes the compiler print some statistics about permanent memory
13658 allocation before or after interprocedural optimization.
13660 @item -fprofile-report
13661 @opindex fprofile-report
13662 Makes the compiler print some statistics about consistency of the
13663 (estimated) profile and effect of individual passes.
13665 @item -fstack-usage
13666 @opindex fstack-usage
13667 Makes the compiler output stack usage information for the program, on a
13668 per-function basis.  The filename for the dump is made by appending
13669 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13670 the output file, if explicitly specified and it is not an executable,
13671 otherwise it is the basename of the source file.  An entry is made up
13672 of three fields:
13674 @itemize
13675 @item
13676 The name of the function.
13677 @item
13678 A number of bytes.
13679 @item
13680 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13681 @end itemize
13683 The qualifier @code{static} means that the function manipulates the stack
13684 statically: a fixed number of bytes are allocated for the frame on function
13685 entry and released on function exit; no stack adjustments are otherwise made
13686 in the function.  The second field is this fixed number of bytes.
13688 The qualifier @code{dynamic} means that the function manipulates the stack
13689 dynamically: in addition to the static allocation described above, stack
13690 adjustments are made in the body of the function, for example to push/pop
13691 arguments around function calls.  If the qualifier @code{bounded} is also
13692 present, the amount of these adjustments is bounded at compile time and
13693 the second field is an upper bound of the total amount of stack used by
13694 the function.  If it is not present, the amount of these adjustments is
13695 not bounded at compile time and the second field only represents the
13696 bounded part.
13698 @item -fstats
13699 @opindex fstats
13700 Emit statistics about front-end processing at the end of the compilation.
13701 This option is supported only by the C++ front end, and
13702 the information is generally only useful to the G++ development team.
13704 @item -fdbg-cnt-list
13705 @opindex fdbg-cnt-list
13706 Print the name and the counter upper bound for all debug counters.
13709 @item -fdbg-cnt=@var{counter-value-list}
13710 @opindex fdbg-cnt
13711 Set the internal debug counter upper bound.  @var{counter-value-list}
13712 is a comma-separated list of @var{name}:@var{value} pairs
13713 which sets the upper bound of each debug counter @var{name} to @var{value}.
13714 All debug counters have the initial upper bound of @code{UINT_MAX};
13715 thus @code{dbg_cnt} returns true always unless the upper bound
13716 is set by this option.
13717 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13718 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13720 @item -print-file-name=@var{library}
13721 @opindex print-file-name
13722 Print the full absolute name of the library file @var{library} that
13723 would be used when linking---and don't do anything else.  With this
13724 option, GCC does not compile or link anything; it just prints the
13725 file name.
13727 @item -print-multi-directory
13728 @opindex print-multi-directory
13729 Print the directory name corresponding to the multilib selected by any
13730 other switches present in the command line.  This directory is supposed
13731 to exist in @env{GCC_EXEC_PREFIX}.
13733 @item -print-multi-lib
13734 @opindex print-multi-lib
13735 Print the mapping from multilib directory names to compiler switches
13736 that enable them.  The directory name is separated from the switches by
13737 @samp{;}, and each switch starts with an @samp{@@} instead of the
13738 @samp{-}, without spaces between multiple switches.  This is supposed to
13739 ease shell processing.
13741 @item -print-multi-os-directory
13742 @opindex print-multi-os-directory
13743 Print the path to OS libraries for the selected
13744 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13745 present in the @file{lib} subdirectory and no multilibs are used, this is
13746 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13747 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13748 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13749 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13751 @item -print-multiarch
13752 @opindex print-multiarch
13753 Print the path to OS libraries for the selected multiarch,
13754 relative to some @file{lib} subdirectory.
13756 @item -print-prog-name=@var{program}
13757 @opindex print-prog-name
13758 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13760 @item -print-libgcc-file-name
13761 @opindex print-libgcc-file-name
13762 Same as @option{-print-file-name=libgcc.a}.
13764 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13765 but you do want to link with @file{libgcc.a}.  You can do:
13767 @smallexample
13768 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13769 @end smallexample
13771 @item -print-search-dirs
13772 @opindex print-search-dirs
13773 Print the name of the configured installation directory and a list of
13774 program and library directories @command{gcc} searches---and don't do anything else.
13776 This is useful when @command{gcc} prints the error message
13777 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13778 To resolve this you either need to put @file{cpp0} and the other compiler
13779 components where @command{gcc} expects to find them, or you can set the environment
13780 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13781 Don't forget the trailing @samp{/}.
13782 @xref{Environment Variables}.
13784 @item -print-sysroot
13785 @opindex print-sysroot
13786 Print the target sysroot directory that is used during
13787 compilation.  This is the target sysroot specified either at configure
13788 time or using the @option{--sysroot} option, possibly with an extra
13789 suffix that depends on compilation options.  If no target sysroot is
13790 specified, the option prints nothing.
13792 @item -print-sysroot-headers-suffix
13793 @opindex print-sysroot-headers-suffix
13794 Print the suffix added to the target sysroot when searching for
13795 headers, or give an error if the compiler is not configured with such
13796 a suffix---and don't do anything else.
13798 @item -dumpmachine
13799 @opindex dumpmachine
13800 Print the compiler's target machine (for example,
13801 @samp{i686-pc-linux-gnu})---and don't do anything else.
13803 @item -dumpversion
13804 @opindex dumpversion
13805 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13806 anything else.  This is the compiler version used in filesystem paths,
13807 specs, can be depending on how the compiler has been configured just
13808 a single number (major version), two numbers separated by dot (major and
13809 minor version) or three numbers separated by dots (major, minor and patchlevel
13810 version).
13812 @item -dumpfullversion
13813 @opindex dumpfullversion
13814 Print the full compiler version, always 3 numbers separated by dots,
13815 major, minor and patchlevel version.
13817 @item -dumpspecs
13818 @opindex dumpspecs
13819 Print the compiler's built-in specs---and don't do anything else.  (This
13820 is used when GCC itself is being built.)  @xref{Spec Files}.
13821 @end table
13823 @node Submodel Options
13824 @section Machine-Dependent Options
13825 @cindex submodel options
13826 @cindex specifying hardware config
13827 @cindex hardware models and configurations, specifying
13828 @cindex target-dependent options
13829 @cindex machine-dependent options
13831 Each target machine supported by GCC can have its own options---for
13832 example, to allow you to compile for a particular processor variant or
13833 ABI, or to control optimizations specific to that machine.  By
13834 convention, the names of machine-specific options start with
13835 @samp{-m}.
13837 Some configurations of the compiler also support additional target-specific
13838 options, usually for compatibility with other compilers on the same
13839 platform.
13841 @c This list is ordered alphanumerically by subsection name.
13842 @c It should be the same order and spelling as these options are listed
13843 @c in Machine Dependent Options
13845 @menu
13846 * AArch64 Options::
13847 * Adapteva Epiphany Options::
13848 * ARC Options::
13849 * ARM Options::
13850 * AVR Options::
13851 * Blackfin Options::
13852 * C6X Options::
13853 * CRIS Options::
13854 * CR16 Options::
13855 * Darwin Options::
13856 * DEC Alpha Options::
13857 * FR30 Options::
13858 * FT32 Options::
13859 * FRV Options::
13860 * GNU/Linux Options::
13861 * H8/300 Options::
13862 * HPPA Options::
13863 * IA-64 Options::
13864 * LM32 Options::
13865 * M32C Options::
13866 * M32R/D Options::
13867 * M680x0 Options::
13868 * MCore Options::
13869 * MeP Options::
13870 * MicroBlaze Options::
13871 * MIPS Options::
13872 * MMIX Options::
13873 * MN10300 Options::
13874 * Moxie Options::
13875 * MSP430 Options::
13876 * NDS32 Options::
13877 * Nios II Options::
13878 * Nvidia PTX Options::
13879 * PDP-11 Options::
13880 * picoChip Options::
13881 * PowerPC Options::
13882 * RL78 Options::
13883 * RS/6000 and PowerPC Options::
13884 * RX Options::
13885 * S/390 and zSeries Options::
13886 * Score Options::
13887 * SH Options::
13888 * Solaris 2 Options::
13889 * SPARC Options::
13890 * SPU Options::
13891 * System V Options::
13892 * TILE-Gx Options::
13893 * TILEPro Options::
13894 * V850 Options::
13895 * VAX Options::
13896 * Visium Options::
13897 * VMS Options::
13898 * VxWorks Options::
13899 * x86 Options::
13900 * x86 Windows Options::
13901 * Xstormy16 Options::
13902 * Xtensa Options::
13903 * zSeries Options::
13904 @end menu
13906 @node AArch64 Options
13907 @subsection AArch64 Options
13908 @cindex AArch64 Options
13910 These options are defined for AArch64 implementations:
13912 @table @gcctabopt
13914 @item -mabi=@var{name}
13915 @opindex mabi
13916 Generate code for the specified data model.  Permissible values
13917 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13918 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13919 but long int and pointers are 64 bits.
13921 The default depends on the specific target configuration.  Note that
13922 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13923 entire program with the same ABI, and link with a compatible set of libraries.
13925 @item -mbig-endian
13926 @opindex mbig-endian
13927 Generate big-endian code.  This is the default when GCC is configured for an
13928 @samp{aarch64_be-*-*} target.
13930 @item -mgeneral-regs-only
13931 @opindex mgeneral-regs-only
13932 Generate code which uses only the general-purpose registers.  This will prevent
13933 the compiler from using floating-point and Advanced SIMD registers but will not
13934 impose any restrictions on the assembler.
13936 @item -mlittle-endian
13937 @opindex mlittle-endian
13938 Generate little-endian code.  This is the default when GCC is configured for an
13939 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13941 @item -mcmodel=tiny
13942 @opindex mcmodel=tiny
13943 Generate code for the tiny code model.  The program and its statically defined
13944 symbols must be within 1MB of each other.  Programs can be statically or
13945 dynamically linked.
13947 @item -mcmodel=small
13948 @opindex mcmodel=small
13949 Generate code for the small code model.  The program and its statically defined
13950 symbols must be within 4GB of each other.  Programs can be statically or
13951 dynamically linked.  This is the default code model.
13953 @item -mcmodel=large
13954 @opindex mcmodel=large
13955 Generate code for the large code model.  This makes no assumptions about
13956 addresses and sizes of sections.  Programs can be statically linked only.
13958 @item -mstrict-align
13959 @opindex mstrict-align
13960 Avoid generating memory accesses that may not be aligned on a natural object
13961 boundary as described in the architecture specification.
13963 @item -momit-leaf-frame-pointer
13964 @itemx -mno-omit-leaf-frame-pointer
13965 @opindex momit-leaf-frame-pointer
13966 @opindex mno-omit-leaf-frame-pointer
13967 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13968 default.
13970 @item -mtls-dialect=desc
13971 @opindex mtls-dialect=desc
13972 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13973 of TLS variables.  This is the default.
13975 @item -mtls-dialect=traditional
13976 @opindex mtls-dialect=traditional
13977 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13978 of TLS variables.
13980 @item -mtls-size=@var{size}
13981 @opindex mtls-size
13982 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13983 This option requires binutils 2.26 or newer.
13985 @item -mfix-cortex-a53-835769
13986 @itemx -mno-fix-cortex-a53-835769
13987 @opindex mfix-cortex-a53-835769
13988 @opindex mno-fix-cortex-a53-835769
13989 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13990 This involves inserting a NOP instruction between memory instructions and
13991 64-bit integer multiply-accumulate instructions.
13993 @item -mfix-cortex-a53-843419
13994 @itemx -mno-fix-cortex-a53-843419
13995 @opindex mfix-cortex-a53-843419
13996 @opindex mno-fix-cortex-a53-843419
13997 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13998 This erratum workaround is made at link time and this will only pass the
13999 corresponding flag to the linker.
14001 @item -mlow-precision-recip-sqrt
14002 @item -mno-low-precision-recip-sqrt
14003 @opindex mlow-precision-recip-sqrt
14004 @opindex mno-low-precision-recip-sqrt
14005 Enable or disable the reciprocal square root approximation.
14006 This option only has an effect if @option{-ffast-math} or
14007 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14008 precision of reciprocal square root results to about 16 bits for
14009 single precision and to 32 bits for double precision.
14011 @item -mlow-precision-sqrt
14012 @item -mno-low-precision-sqrt
14013 @opindex -mlow-precision-sqrt
14014 @opindex -mno-low-precision-sqrt
14015 Enable or disable the square root approximation.
14016 This option only has an effect if @option{-ffast-math} or
14017 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14018 precision of square root results to about 16 bits for
14019 single precision and to 32 bits for double precision.
14020 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14022 @item -mlow-precision-div
14023 @item -mno-low-precision-div
14024 @opindex -mlow-precision-div
14025 @opindex -mno-low-precision-div
14026 Enable or disable the division approximation.
14027 This option only has an effect if @option{-ffast-math} or
14028 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14029 precision of division results to about 16 bits for
14030 single precision and to 32 bits for double precision.
14032 @item -march=@var{name}
14033 @opindex march
14034 Specify the name of the target architecture and, optionally, one or
14035 more feature modifiers.  This option has the form
14036 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14038 The permissible values for @var{arch} are @samp{armv8-a},
14039 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14041 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14042 support for the ARMv8.3-A architecture extensions.
14044 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14045 support for the ARMv8.2-A architecture extensions.
14047 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14048 support for the ARMv8.1-A architecture extension.  In particular, it
14049 enables the @samp{+crc} and @samp{+lse} features.
14051 The value @samp{native} is available on native AArch64 GNU/Linux and
14052 causes the compiler to pick the architecture of the host system.  This
14053 option has no effect if the compiler is unable to recognize the
14054 architecture of the host system,
14056 The permissible values for @var{feature} are listed in the sub-section
14057 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14058 Feature Modifiers}.  Where conflicting feature modifiers are
14059 specified, the right-most feature is used.
14061 GCC uses @var{name} to determine what kind of instructions it can emit
14062 when generating assembly code.  If @option{-march} is specified
14063 without either of @option{-mtune} or @option{-mcpu} also being
14064 specified, the code is tuned to perform well across a range of target
14065 processors implementing the target architecture.
14067 @item -mtune=@var{name}
14068 @opindex mtune
14069 Specify the name of the target processor for which GCC should tune the
14070 performance of the code.  Permissible values for this option are:
14071 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
14072 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{falkor},
14073 @samp{qdf24xx}, @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14074 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14075 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14076 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14077 @samp{cortex-a73.cortex-a53}, @samp{native}.
14079 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14080 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
14081 specify that GCC should tune for a big.LITTLE system.
14083 Additionally on native AArch64 GNU/Linux systems the value
14084 @samp{native} tunes performance to the host system.  This option has no effect
14085 if the compiler is unable to recognize the processor of the host system.
14087 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14088 are specified, the code is tuned to perform well across a range
14089 of target processors.
14091 This option cannot be suffixed by feature modifiers.
14093 @item -mcpu=@var{name}
14094 @opindex mcpu
14095 Specify the name of the target processor, optionally suffixed by one
14096 or more feature modifiers.  This option has the form
14097 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14098 the permissible values for @var{cpu} are the same as those available
14099 for @option{-mtune}.  The permissible values for @var{feature} are
14100 documented in the sub-section on
14101 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14102 Feature Modifiers}.  Where conflicting feature modifiers are
14103 specified, the right-most feature is used.
14105 GCC uses @var{name} to determine what kind of instructions it can emit when
14106 generating assembly code (as if by @option{-march}) and to determine
14107 the target processor for which to tune for performance (as if
14108 by @option{-mtune}).  Where this option is used in conjunction
14109 with @option{-march} or @option{-mtune}, those options take precedence
14110 over the appropriate part of this option.
14112 @item -moverride=@var{string}
14113 @opindex moverride
14114 Override tuning decisions made by the back-end in response to a
14115 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14116 for @var{string} in this option are not guaranteed to be consistent
14117 across releases.
14119 This option is only intended to be useful when developing GCC.
14121 @item -mpc-relative-literal-loads
14122 @opindex mpc-relative-literal-loads
14123 Enable PC-relative literal loads.  With this option literal pools are
14124 accessed using a single instruction and emitted after each function.  This
14125 limits the maximum size of functions to 1MB.  This is enabled by default for
14126 @option{-mcmodel=tiny}.
14128 @item -msign-return-address=@var{scope}
14129 @opindex msign-return-address
14130 Select the function scope on which return address signing will be applied.
14131 Permissible values are @samp{none}, which disables return address signing,
14132 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14133 functions, and @samp{all}, which enables pointer signing for all functions.  The
14134 default value is @samp{none}.
14136 @end table
14138 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14139 @anchor{aarch64-feature-modifiers}
14140 @cindex @option{-march} feature modifiers
14141 @cindex @option{-mcpu} feature modifiers
14142 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14143 the following and their inverses @option{no@var{feature}}:
14145 @table @samp
14146 @item crc
14147 Enable CRC extension.  This is on by default for
14148 @option{-march=armv8.1-a}.
14149 @item crypto
14150 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14151 instructions.
14152 @item fp
14153 Enable floating-point instructions.  This is on by default for all possible
14154 values for options @option{-march} and @option{-mcpu}.
14155 @item simd
14156 Enable Advanced SIMD instructions.  This also enables floating-point
14157 instructions.  This is on by default for all possible values for options
14158 @option{-march} and @option{-mcpu}.
14159 @item lse
14160 Enable Large System Extension instructions.  This is on by default for
14161 @option{-march=armv8.1-a}.
14162 @item fp16
14163 Enable FP16 extension.  This also enables floating-point instructions.
14165 @end table
14167 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14168 Conversely, @option{nofp} implies @option{nosimd}, which implies
14169 @option{nocrypto}.
14171 @node Adapteva Epiphany Options
14172 @subsection Adapteva Epiphany Options
14174 These @samp{-m} options are defined for Adapteva Epiphany:
14176 @table @gcctabopt
14177 @item -mhalf-reg-file
14178 @opindex mhalf-reg-file
14179 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14180 That allows code to run on hardware variants that lack these registers.
14182 @item -mprefer-short-insn-regs
14183 @opindex mprefer-short-insn-regs
14184 Preferentially allocate registers that allow short instruction generation.
14185 This can result in increased instruction count, so this may either reduce or
14186 increase overall code size.
14188 @item -mbranch-cost=@var{num}
14189 @opindex mbranch-cost
14190 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14191 This cost is only a heuristic and is not guaranteed to produce
14192 consistent results across releases.
14194 @item -mcmove
14195 @opindex mcmove
14196 Enable the generation of conditional moves.
14198 @item -mnops=@var{num}
14199 @opindex mnops
14200 Emit @var{num} NOPs before every other generated instruction.
14202 @item -mno-soft-cmpsf
14203 @opindex mno-soft-cmpsf
14204 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14205 and test the flags.  This is faster than a software comparison, but can
14206 get incorrect results in the presence of NaNs, or when two different small
14207 numbers are compared such that their difference is calculated as zero.
14208 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14209 software comparisons.
14211 @item -mstack-offset=@var{num}
14212 @opindex mstack-offset
14213 Set the offset between the top of the stack and the stack pointer.
14214 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14215 can be used by leaf functions without stack allocation.
14216 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14217 Note also that this option changes the ABI; compiling a program with a
14218 different stack offset than the libraries have been compiled with
14219 generally does not work.
14220 This option can be useful if you want to evaluate if a different stack
14221 offset would give you better code, but to actually use a different stack
14222 offset to build working programs, it is recommended to configure the
14223 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14225 @item -mno-round-nearest
14226 @opindex mno-round-nearest
14227 Make the scheduler assume that the rounding mode has been set to
14228 truncating.  The default is @option{-mround-nearest}.
14230 @item -mlong-calls
14231 @opindex mlong-calls
14232 If not otherwise specified by an attribute, assume all calls might be beyond
14233 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14234 function address into a register before performing a (otherwise direct) call.
14235 This is the default.
14237 @item -mshort-calls
14238 @opindex short-calls
14239 If not otherwise specified by an attribute, assume all direct calls are
14240 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14241 for direct calls.  The default is @option{-mlong-calls}.
14243 @item -msmall16
14244 @opindex msmall16
14245 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14246 apply to function addresses for which @option{-mlong-calls} semantics
14247 are in effect.
14249 @item -mfp-mode=@var{mode}
14250 @opindex mfp-mode
14251 Set the prevailing mode of the floating-point unit.
14252 This determines the floating-point mode that is provided and expected
14253 at function call and return time.  Making this mode match the mode you
14254 predominantly need at function start can make your programs smaller and
14255 faster by avoiding unnecessary mode switches.
14257 @var{mode} can be set to one the following values:
14259 @table @samp
14260 @item caller
14261 Any mode at function entry is valid, and retained or restored when
14262 the function returns, and when it calls other functions.
14263 This mode is useful for compiling libraries or other compilation units
14264 you might want to incorporate into different programs with different
14265 prevailing FPU modes, and the convenience of being able to use a single
14266 object file outweighs the size and speed overhead for any extra
14267 mode switching that might be needed, compared with what would be needed
14268 with a more specific choice of prevailing FPU mode.
14270 @item truncate
14271 This is the mode used for floating-point calculations with
14272 truncating (i.e.@: round towards zero) rounding mode.  That includes
14273 conversion from floating point to integer.
14275 @item round-nearest
14276 This is the mode used for floating-point calculations with
14277 round-to-nearest-or-even rounding mode.
14279 @item int
14280 This is the mode used to perform integer calculations in the FPU, e.g.@:
14281 integer multiply, or integer multiply-and-accumulate.
14282 @end table
14284 The default is @option{-mfp-mode=caller}
14286 @item -mnosplit-lohi
14287 @itemx -mno-postinc
14288 @itemx -mno-postmodify
14289 @opindex mnosplit-lohi
14290 @opindex mno-postinc
14291 @opindex mno-postmodify
14292 Code generation tweaks that disable, respectively, splitting of 32-bit
14293 loads, generation of post-increment addresses, and generation of
14294 post-modify addresses.  The defaults are @option{msplit-lohi},
14295 @option{-mpost-inc}, and @option{-mpost-modify}.
14297 @item -mnovect-double
14298 @opindex mno-vect-double
14299 Change the preferred SIMD mode to SImode.  The default is
14300 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14302 @item -max-vect-align=@var{num}
14303 @opindex max-vect-align
14304 The maximum alignment for SIMD vector mode types.
14305 @var{num} may be 4 or 8.  The default is 8.
14306 Note that this is an ABI change, even though many library function
14307 interfaces are unaffected if they don't use SIMD vector modes
14308 in places that affect size and/or alignment of relevant types.
14310 @item -msplit-vecmove-early
14311 @opindex msplit-vecmove-early
14312 Split vector moves into single word moves before reload.  In theory this
14313 can give better register allocation, but so far the reverse seems to be
14314 generally the case.
14316 @item -m1reg-@var{reg}
14317 @opindex m1reg-
14318 Specify a register to hold the constant @minus{}1, which makes loading small negative
14319 constants and certain bitmasks faster.
14320 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14321 which specify use of that register as a fixed register,
14322 and @samp{none}, which means that no register is used for this
14323 purpose.  The default is @option{-m1reg-none}.
14325 @end table
14327 @node ARC Options
14328 @subsection ARC Options
14329 @cindex ARC options
14331 The following options control the architecture variant for which code
14332 is being compiled:
14334 @c architecture variants
14335 @table @gcctabopt
14337 @item -mbarrel-shifter
14338 @opindex mbarrel-shifter
14339 Generate instructions supported by barrel shifter.  This is the default
14340 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14342 @item -mcpu=@var{cpu}
14343 @opindex mcpu
14344 Set architecture type, register usage, and instruction scheduling
14345 parameters for @var{cpu}.  There are also shortcut alias options
14346 available for backward compatibility and convenience.  Supported
14347 values for @var{cpu} are
14349 @table @samp
14350 @opindex mA6
14351 @opindex mARC600
14352 @item arc600
14353 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14355 @item arc601
14356 @opindex mARC601
14357 Compile for ARC601.  Alias: @option{-mARC601}.
14359 @item arc700
14360 @opindex mA7
14361 @opindex mARC700
14362 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14363 This is the default when configured with @option{--with-cpu=arc700}@.
14365 @item arcem
14366 Compile for ARC EM.
14368 @item archs
14369 Compile for ARC HS.
14371 @item em
14372 @opindex em
14373 Compile for ARC EM cpu with no hardware extension.
14375 @item em4
14376 @opindex em4
14377 Compile for ARC EM4 cpu.
14379 @item em4_dmips
14380 @opindex em4_dmips
14381 Compile for ARC EM4 DMIPS cpu.
14383 @item em4_fpus
14384 @opindex em4_fpus
14385 Compile for ARC EM4 DMIPS cpu with single precision floating point
14386 extension.
14388 @item em4_fpuda
14389 @opindex em4_fpuda
14390 Compile for ARC EM4 DMIPS cpu with single precision floating point and
14391 double assists instructions.
14393 @item hs
14394 @opindex hs
14395 Compile for ARC HS cpu with no hardware extension, except the atomic
14396 instructions.
14398 @item hs34
14399 @opindex hs34
14400 Compile for ARC HS34 cpu.
14402 @item hs38
14403 @opindex hs38
14404 Compile for ARC HS38 cpu.
14406 @item hs38_linux
14407 @opindex hs38_linux
14408 Compile for ARC HS38 cpu with all hardware extensions on.
14410 @item arc600_norm
14411 @opindex arc600_norm
14412 Compile for ARC 600 cpu with norm instruction enabled.
14414 @item arc600_mul32x16
14415 @opindex arc600_mul32x16
14416 Compile for ARC 600 cpu with norm and mul32x16 instructions enabled.
14418 @item arc600_mul64
14419 @opindex arc600_mul64
14420 Compile for ARC 600 cpu with norm and mul64 instructions enabled.
14422 @item arc601_norm
14423 @opindex arc601_norm
14424 Compile for ARC 601 cpu with norm instruction enabled.
14426 @item arc601_mul32x16
14427 @opindex arc601_mul32x16
14428 Compile for ARC 601 cpu with norm and mul32x16 instructions enabled.
14430 @item arc601_mul64
14431 @opindex arc601_mul64
14432 Compile for ARC 601 cpu with norm and mul64 instructions enabled.
14434 @item nps400
14435 @opindex nps400
14436 Compile for ARC 700 on NPS400 chip.
14438 @end table
14440 @item -mdpfp
14441 @opindex mdpfp
14442 @itemx -mdpfp-compact
14443 @opindex mdpfp-compact
14444 FPX: Generate Double Precision FPX instructions, tuned for the compact
14445 implementation.
14447 @item -mdpfp-fast
14448 @opindex mdpfp-fast
14449 FPX: Generate Double Precision FPX instructions, tuned for the fast
14450 implementation.
14452 @item -mno-dpfp-lrsr
14453 @opindex mno-dpfp-lrsr
14454 Disable LR and SR instructions from using FPX extension aux registers.
14456 @item -mea
14457 @opindex mea
14458 Generate Extended arithmetic instructions.  Currently only
14459 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14460 supported.  This is always enabled for @option{-mcpu=ARC700}.
14462 @item -mno-mpy
14463 @opindex mno-mpy
14464 Do not generate mpy instructions for ARC700.  This instruction is
14465 deprecated.
14467 @item -mmul32x16
14468 @opindex mmul32x16
14469 Generate 32x16 bit multiply and mac instructions.
14471 @item -mmul64
14472 @opindex mmul64
14473 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
14475 @item -mnorm
14476 @opindex mnorm
14477 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
14478 is in effect.
14480 @item -mspfp
14481 @opindex mspfp
14482 @itemx -mspfp-compact
14483 @opindex mspfp-compact
14484 FPX: Generate Single Precision FPX instructions, tuned for the compact
14485 implementation.
14487 @item -mspfp-fast
14488 @opindex mspfp-fast
14489 FPX: Generate Single Precision FPX instructions, tuned for the fast
14490 implementation.
14492 @item -msimd
14493 @opindex msimd
14494 Enable generation of ARC SIMD instructions via target-specific
14495 builtins.  Only valid for @option{-mcpu=ARC700}.
14497 @item -msoft-float
14498 @opindex msoft-float
14499 This option ignored; it is provided for compatibility purposes only.
14500 Software floating point code is emitted by default, and this default
14501 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
14502 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
14503 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
14505 @item -mswap
14506 @opindex mswap
14507 Generate swap instructions.
14509 @item -matomic
14510 @opindex matomic
14511 This enables Locked Load/Store Conditional extension to implement
14512 atomic memopry built-in functions.  Not available for ARC 6xx or ARC
14513 EM cores.
14515 @item -mdiv-rem
14516 @opindex mdiv-rem
14517 Enable DIV/REM instructions for ARCv2 cores.
14519 @item -mcode-density
14520 @opindex mcode-density
14521 Enable code density instructions for ARC EM, default on for ARC HS.
14523 @item -mll64
14524 @opindex mll64
14525 Enable double load/store operations for ARC HS cores.
14527 @item -mtp-regno=@var{regno}
14528 @opindex mtp-regno
14529 Specify thread pointer register number.
14531 @item -mmpy-option=@var{multo}
14532 @opindex mmpy-option
14533 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
14534 the default value.  The recognized values for @var{multo} are:
14536 @table @samp
14537 @item 0
14538 No multiplier available.
14540 @item 1
14541 @opindex w
14542 The multiply option is set to w: 16x16 multiplier, fully pipelined.
14543 The following instructions are enabled: MPYW, and MPYUW.
14545 @item 2
14546 @opindex wlh1
14547 The multiply option is set to wlh1: 32x32 multiplier, fully
14548 pipelined (1 stage).  The following instructions are additionally
14549 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
14551 @item 3
14552 @opindex wlh2
14553 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
14554 (2 stages).  The following instructions are additionally enabled: MPY,
14555 MPYU, MPYM, MPYMU, and MPY_S.
14557 @item 4
14558 @opindex wlh3
14559 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
14560 sequential.  The following instructions are additionally enabled: MPY,
14561 MPYU, MPYM, MPYMU, and MPY_S.
14563 @item 5
14564 @opindex wlh4
14565 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
14566 sequential.  The following instructions are additionally enabled: MPY,
14567 MPYU, MPYM, MPYMU, and MPY_S.
14569 @item 6
14570 @opindex wlh5
14571 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
14572 sequential.  The following instructions are additionally enabled: MPY,
14573 MPYU, MPYM, MPYMU, and MPY_S.
14575 @end table
14577 This option is only available for ARCv2 cores@.
14579 @item -mfpu=@var{fpu}
14580 @opindex mfpu
14581 Enables specific floating-point hardware extension for ARCv2
14582 core.  Supported values for @var{fpu} are:
14584 @table @samp
14586 @item fpus
14587 @opindex fpus
14588 Enables support for single precision floating point hardware
14589 extensions@.
14591 @item fpud
14592 @opindex fpud
14593 Enables support for double precision floating point hardware
14594 extensions.  The single precision floating point extension is also
14595 enabled.  Not available for ARC EM@.
14597 @item fpuda
14598 @opindex fpuda
14599 Enables support for double precision floating point hardware
14600 extensions using double precision assist instructions.  The single
14601 precision floating point extension is also enabled.  This option is
14602 only available for ARC EM@.
14604 @item fpuda_div
14605 @opindex fpuda_div
14606 Enables support for double precision floating point hardware
14607 extensions using double precision assist instructions, and simple
14608 precision square-root and divide hardware extensions.  The single
14609 precision floating point extension is also enabled.  This option is
14610 only available for ARC EM@.
14612 @item fpuda_fma
14613 @opindex fpuda_fma
14614 Enables support for double precision floating point hardware
14615 extensions using double precision assist instructions, and simple
14616 precision fused multiple and add hardware extension.  The single
14617 precision floating point extension is also enabled.  This option is
14618 only available for ARC EM@.
14620 @item fpuda_all
14621 @opindex fpuda_all
14622 Enables support for double precision floating point hardware
14623 extensions using double precision assist instructions, and all simple
14624 precision hardware extensions.  The single precision floating point
14625 extension is also enabled.  This option is only available for ARC EM@.
14627 @item fpus_div
14628 @opindex fpus_div
14629 Enables support for single precision floating point, and single
14630 precision square-root and divide hardware extensions@.
14632 @item fpud_div
14633 @opindex fpud_div
14634 Enables support for double precision floating point, and double
14635 precision square-root and divide hardware extensions.  This option
14636 includes option @samp{fpus_div}. Not available for ARC EM@.
14638 @item fpus_fma
14639 @opindex fpus_fma
14640 Enables support for single precision floating point, and single
14641 precision fused multiple and add hardware extensions@.
14643 @item fpud_fma
14644 @opindex fpud_fma
14645 Enables support for double precision floating point, and double
14646 precision fused multiple and add hardware extensions.  This option
14647 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14649 @item fpus_all
14650 @opindex fpus_all
14651 Enables support for all single precision floating point hardware
14652 extensions@.
14654 @item fpud_all
14655 @opindex fpud_all
14656 Enables support for all single and double precision floating point
14657 hardware extensions.  Not available for ARC EM@.
14659 @end table
14661 @end table
14663 The following options are passed through to the assembler, and also
14664 define preprocessor macro symbols.
14666 @c Flags used by the assembler, but for which we define preprocessor
14667 @c macro symbols as well.
14668 @table @gcctabopt
14669 @item -mdsp-packa
14670 @opindex mdsp-packa
14671 Passed down to the assembler to enable the DSP Pack A extensions.
14672 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14673 deprecated.
14675 @item -mdvbf
14676 @opindex mdvbf
14677 Passed down to the assembler to enable the dual viterbi butterfly
14678 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14679 option is deprecated.
14681 @c ARC700 4.10 extension instruction
14682 @item -mlock
14683 @opindex mlock
14684 Passed down to the assembler to enable the Locked Load/Store
14685 Conditional extension.  Also sets the preprocessor symbol
14686 @code{__Xlock}.
14688 @item -mmac-d16
14689 @opindex mmac-d16
14690 Passed down to the assembler.  Also sets the preprocessor symbol
14691 @code{__Xxmac_d16}.  This option is deprecated.
14693 @item -mmac-24
14694 @opindex mmac-24
14695 Passed down to the assembler.  Also sets the preprocessor symbol
14696 @code{__Xxmac_24}.  This option is deprecated.
14698 @c ARC700 4.10 extension instruction
14699 @item -mrtsc
14700 @opindex mrtsc
14701 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
14702 extension instruction.  Also sets the preprocessor symbol
14703 @code{__Xrtsc}.  This option is deprecated.
14705 @c ARC700 4.10 extension instruction
14706 @item -mswape
14707 @opindex mswape
14708 Passed down to the assembler to enable the swap byte ordering
14709 extension instruction.  Also sets the preprocessor symbol
14710 @code{__Xswape}.
14712 @item -mtelephony
14713 @opindex mtelephony
14714 Passed down to the assembler to enable dual and single operand
14715 instructions for telephony.  Also sets the preprocessor symbol
14716 @code{__Xtelephony}.  This option is deprecated.
14718 @item -mxy
14719 @opindex mxy
14720 Passed down to the assembler to enable the XY Memory extension.  Also
14721 sets the preprocessor symbol @code{__Xxy}.
14723 @end table
14725 The following options control how the assembly code is annotated:
14727 @c Assembly annotation options
14728 @table @gcctabopt
14729 @item -misize
14730 @opindex misize
14731 Annotate assembler instructions with estimated addresses.
14733 @item -mannotate-align
14734 @opindex mannotate-align
14735 Explain what alignment considerations lead to the decision to make an
14736 instruction short or long.
14738 @end table
14740 The following options are passed through to the linker:
14742 @c options passed through to the linker
14743 @table @gcctabopt
14744 @item -marclinux
14745 @opindex marclinux
14746 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14747 This option is enabled by default in tool chains built for
14748 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14749 when profiling is not requested.
14751 @item -marclinux_prof
14752 @opindex marclinux_prof
14753 Passed through to the linker, to specify use of the
14754 @code{arclinux_prof} emulation.  This option is enabled by default in
14755 tool chains built for @w{@code{arc-linux-uclibc}} and
14756 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14758 @end table
14760 The following options control the semantics of generated code:
14762 @c semantically relevant code generation options
14763 @table @gcctabopt
14764 @item -mlong-calls
14765 @opindex mlong-calls
14766 Generate call insns as register indirect calls, thus providing access
14767 to the full 32-bit address range.
14769 @item -mmedium-calls
14770 @opindex mmedium-calls
14771 Don't use less than 25 bit addressing range for calls, which is the
14772 offset available for an unconditional branch-and-link
14773 instruction.  Conditional execution of function calls is suppressed, to
14774 allow use of the 25-bit range, rather than the 21-bit range with
14775 conditional branch-and-link.  This is the default for tool chains built
14776 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14778 @item -mno-sdata
14779 @opindex mno-sdata
14780 Do not generate sdata references.  This is the default for tool chains
14781 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14782 targets.
14784 @item -mvolatile-cache
14785 @opindex mvolatile-cache
14786 Use ordinarily cached memory accesses for volatile references.  This is the
14787 default.
14789 @item -mno-volatile-cache
14790 @opindex mno-volatile-cache
14791 Enable cache bypass for volatile references.
14793 @end table
14795 The following options fine tune code generation:
14796 @c code generation tuning options
14797 @table @gcctabopt
14798 @item -malign-call
14799 @opindex malign-call
14800 Do alignment optimizations for call instructions.
14802 @item -mauto-modify-reg
14803 @opindex mauto-modify-reg
14804 Enable the use of pre/post modify with register displacement.
14806 @item -mbbit-peephole
14807 @opindex mbbit-peephole
14808 Enable bbit peephole2.
14810 @item -mno-brcc
14811 @opindex mno-brcc
14812 This option disables a target-specific pass in @file{arc_reorg} to
14813 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
14814 generation driven by the combiner pass.
14816 @item -mcase-vector-pcrel
14817 @opindex mcase-vector-pcrel
14818 Use pc-relative switch case tables - this enables case table shortening.
14819 This is the default for @option{-Os}.
14821 @item -mcompact-casesi
14822 @opindex mcompact-casesi
14823 Enable compact casesi pattern.  This is the default for @option{-Os},
14824 and only available for ARCv1 cores.
14826 @item -mno-cond-exec
14827 @opindex mno-cond-exec
14828 Disable ARCompact specific pass to generate conditional execution instructions.
14829 Due to delay slot scheduling and interactions between operand numbers,
14830 literal sizes, instruction lengths, and the support for conditional execution,
14831 the target-independent pass to generate conditional execution is often lacking,
14832 so the ARC port has kept a special pass around that tries to find more
14833 conditional execution generating opportunities after register allocation,
14834 branch shortening, and delay slot scheduling have been done.  This pass
14835 generally, but not always, improves performance and code size, at the cost of
14836 extra compilation time, which is why there is an option to switch it off.
14837 If you have a problem with call instructions exceeding their allowable
14838 offset range because they are conditionalized, you should consider using
14839 @option{-mmedium-calls} instead.
14841 @item -mearly-cbranchsi
14842 @opindex mearly-cbranchsi
14843 Enable pre-reload use of the cbranchsi pattern.
14845 @item -mexpand-adddi
14846 @opindex mexpand-adddi
14847 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
14848 @code{add.f}, @code{adc} etc.
14850 @item -mindexed-loads
14851 @opindex mindexed-loads
14852 Enable the use of indexed loads.  This can be problematic because some
14853 optimizers then assume that indexed stores exist, which is not
14854 the case.
14856 @opindex mlra
14857 Enable Local Register Allocation.  This is still experimental for ARC,
14858 so by default the compiler uses standard reload
14859 (i.e. @option{-mno-lra}).
14861 @item -mlra-priority-none
14862 @opindex mlra-priority-none
14863 Don't indicate any priority for target registers.
14865 @item -mlra-priority-compact
14866 @opindex mlra-priority-compact
14867 Indicate target register priority for r0..r3 / r12..r15.
14869 @item -mlra-priority-noncompact
14870 @opindex mlra-priority-noncompact
14871 Reduce target register priority for r0..r3 / r12..r15.
14873 @item -mno-millicode
14874 @opindex mno-millicode
14875 When optimizing for size (using @option{-Os}), prologues and epilogues
14876 that have to save or restore a large number of registers are often
14877 shortened by using call to a special function in libgcc; this is
14878 referred to as a @emph{millicode} call.  As these calls can pose
14879 performance issues, and/or cause linking issues when linking in a
14880 nonstandard way, this option is provided to turn off millicode call
14881 generation.
14883 @item -mmixed-code
14884 @opindex mmixed-code
14885 Tweak register allocation to help 16-bit instruction generation.
14886 This generally has the effect of decreasing the average instruction size
14887 while increasing the instruction count.
14889 @item -mq-class
14890 @opindex mq-class
14891 Enable 'q' instruction alternatives.
14892 This is the default for @option{-Os}.
14894 @item -mRcq
14895 @opindex mRcq
14896 Enable Rcq constraint handling - most short code generation depends on this.
14897 This is the default.
14899 @item -mRcw
14900 @opindex mRcw
14901 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
14902 This is the default.
14904 @item -msize-level=@var{level}
14905 @opindex msize-level
14906 Fine-tune size optimization with regards to instruction lengths and alignment.
14907 The recognized values for @var{level} are:
14908 @table @samp
14909 @item 0
14910 No size optimization.  This level is deprecated and treated like @samp{1}.
14912 @item 1
14913 Short instructions are used opportunistically.
14915 @item 2
14916 In addition, alignment of loops and of code after barriers are dropped.
14918 @item 3
14919 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14921 @end table
14923 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14924 the behavior when this is not set is equivalent to level @samp{1}.
14926 @item -mtune=@var{cpu}
14927 @opindex mtune
14928 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14929 by @option{-mcpu=}.
14931 Supported values for @var{cpu} are
14933 @table @samp
14934 @item ARC600
14935 Tune for ARC600 cpu.
14937 @item ARC601
14938 Tune for ARC601 cpu.
14940 @item ARC700
14941 Tune for ARC700 cpu with standard multiplier block.
14943 @item ARC700-xmac
14944 Tune for ARC700 cpu with XMAC block.
14946 @item ARC725D
14947 Tune for ARC725D cpu.
14949 @item ARC750D
14950 Tune for ARC750D cpu.
14952 @end table
14954 @item -mmultcost=@var{num}
14955 @opindex mmultcost
14956 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14957 normal instruction.
14959 @item -munalign-prob-threshold=@var{probability}
14960 @opindex munalign-prob-threshold
14961 Set probability threshold for unaligning branches.
14962 When tuning for @samp{ARC700} and optimizing for speed, branches without
14963 filled delay slot are preferably emitted unaligned and long, unless
14964 profiling indicates that the probability for the branch to be taken
14965 is below @var{probability}.  @xref{Cross-profiling}.
14966 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14968 @end table
14970 The following options are maintained for backward compatibility, but
14971 are now deprecated and will be removed in a future release:
14973 @c Deprecated options
14974 @table @gcctabopt
14976 @item -margonaut
14977 @opindex margonaut
14978 Obsolete FPX.
14980 @item -mbig-endian
14981 @opindex mbig-endian
14982 @itemx -EB
14983 @opindex EB
14984 Compile code for big endian targets.  Use of these options is now
14985 deprecated.  Users wanting big-endian code, should use the
14986 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
14987 building the tool chain, for which big-endian is the default.
14989 @item -mlittle-endian
14990 @opindex mlittle-endian
14991 @itemx -EL
14992 @opindex EL
14993 Compile code for little endian targets.  Use of these options is now
14994 deprecated.  Users wanting little-endian code should use the
14995 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
14996 building the tool chain, for which little-endian is the default.
14998 @item -mbarrel_shifter
14999 @opindex mbarrel_shifter
15000 Replaced by @option{-mbarrel-shifter}.
15002 @item -mdpfp_compact
15003 @opindex mdpfp_compact
15004 Replaced by @option{-mdpfp-compact}.
15006 @item -mdpfp_fast
15007 @opindex mdpfp_fast
15008 Replaced by @option{-mdpfp-fast}.
15010 @item -mdsp_packa
15011 @opindex mdsp_packa
15012 Replaced by @option{-mdsp-packa}.
15014 @item -mEA
15015 @opindex mEA
15016 Replaced by @option{-mea}.
15018 @item -mmac_24
15019 @opindex mmac_24
15020 Replaced by @option{-mmac-24}.
15022 @item -mmac_d16
15023 @opindex mmac_d16
15024 Replaced by @option{-mmac-d16}.
15026 @item -mspfp_compact
15027 @opindex mspfp_compact
15028 Replaced by @option{-mspfp-compact}.
15030 @item -mspfp_fast
15031 @opindex mspfp_fast
15032 Replaced by @option{-mspfp-fast}.
15034 @item -mtune=@var{cpu}
15035 @opindex mtune
15036 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15037 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15038 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
15040 @item -multcost=@var{num}
15041 @opindex multcost
15042 Replaced by @option{-mmultcost}.
15044 @end table
15046 @node ARM Options
15047 @subsection ARM Options
15048 @cindex ARM options
15050 These @samp{-m} options are defined for the ARM port:
15052 @table @gcctabopt
15053 @item -mabi=@var{name}
15054 @opindex mabi
15055 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15056 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15058 @item -mapcs-frame
15059 @opindex mapcs-frame
15060 Generate a stack frame that is compliant with the ARM Procedure Call
15061 Standard for all functions, even if this is not strictly necessary for
15062 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15063 with this option causes the stack frames not to be generated for
15064 leaf functions.  The default is @option{-mno-apcs-frame}.
15065 This option is deprecated.
15067 @item -mapcs
15068 @opindex mapcs
15069 This is a synonym for @option{-mapcs-frame} and is deprecated.
15071 @ignore
15072 @c not currently implemented
15073 @item -mapcs-stack-check
15074 @opindex mapcs-stack-check
15075 Generate code to check the amount of stack space available upon entry to
15076 every function (that actually uses some stack space).  If there is
15077 insufficient space available then either the function
15078 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15079 called, depending upon the amount of stack space required.  The runtime
15080 system is required to provide these functions.  The default is
15081 @option{-mno-apcs-stack-check}, since this produces smaller code.
15083 @c not currently implemented
15084 @item -mapcs-reentrant
15085 @opindex mapcs-reentrant
15086 Generate reentrant, position-independent code.  The default is
15087 @option{-mno-apcs-reentrant}.
15088 @end ignore
15090 @item -mthumb-interwork
15091 @opindex mthumb-interwork
15092 Generate code that supports calling between the ARM and Thumb
15093 instruction sets.  Without this option, on pre-v5 architectures, the
15094 two instruction sets cannot be reliably used inside one program.  The
15095 default is @option{-mno-thumb-interwork}, since slightly larger code
15096 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15097 configurations this option is meaningless.
15099 @item -mno-sched-prolog
15100 @opindex mno-sched-prolog
15101 Prevent the reordering of instructions in the function prologue, or the
15102 merging of those instruction with the instructions in the function's
15103 body.  This means that all functions start with a recognizable set
15104 of instructions (or in fact one of a choice from a small set of
15105 different function prologues), and this information can be used to
15106 locate the start of functions inside an executable piece of code.  The
15107 default is @option{-msched-prolog}.
15109 @item -mfloat-abi=@var{name}
15110 @opindex mfloat-abi
15111 Specifies which floating-point ABI to use.  Permissible values
15112 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15114 Specifying @samp{soft} causes GCC to generate output containing
15115 library calls for floating-point operations.
15116 @samp{softfp} allows the generation of code using hardware floating-point
15117 instructions, but still uses the soft-float calling conventions.
15118 @samp{hard} allows generation of floating-point instructions
15119 and uses FPU-specific calling conventions.
15121 The default depends on the specific target configuration.  Note that
15122 the hard-float and soft-float ABIs are not link-compatible; you must
15123 compile your entire program with the same ABI, and link with a
15124 compatible set of libraries.
15126 @item -mlittle-endian
15127 @opindex mlittle-endian
15128 Generate code for a processor running in little-endian mode.  This is
15129 the default for all standard configurations.
15131 @item -mbig-endian
15132 @opindex mbig-endian
15133 Generate code for a processor running in big-endian mode; the default is
15134 to compile code for a little-endian processor.
15136 @item -march=@var{name}
15137 @opindex march
15138 This specifies the name of the target ARM architecture.  GCC uses this
15139 name to determine what kind of instructions it can emit when generating
15140 assembly code.  This option can be used in conjunction with or instead
15141 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15142 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15143 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15144 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15145 @samp{armv6kz}, @samp{armv6s-m},
15146 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15147 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15148 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15149 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15150 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15152 Architecture revisions older than @samp{armv4t} are deprecated.
15154 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15155 the (now mandatory) SVC instruction.
15157 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15158 compatibility.
15160 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15161 extensions.
15163 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15164 architecture together with the optional CRC32 extensions.
15166 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15167 architecture.  This also enables the features provided by
15168 @option{-march=armv8-a+crc}.
15170 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15171 architecture.  This also enables the features provided by
15172 @option{-march=armv8.1-a}.
15174 @option{-march=armv8.2-a+fp16} enables compiler support for the
15175 ARMv8.2-A architecture with the optional FP16 instructions extension.
15176 This also enables the features provided by @option{-march=armv8.1-a}
15177 and implies @option{-mfp16-format=ieee}.
15179 @option{-march=native} causes the compiler to auto-detect the architecture
15180 of the build computer.  At present, this feature is only supported on
15181 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15182 is unsuccessful the option has no effect.
15184 @item -mtune=@var{name}
15185 @opindex mtune
15186 This option specifies the name of the target ARM processor for
15187 which GCC should tune the performance of the code.
15188 For some ARM implementations better performance can be obtained by using
15189 this option.
15190 Permissible names are: @samp{arm2}, @samp{arm250},
15191 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15192 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15193 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15194 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15195 @samp{arm720},
15196 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15197 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15198 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15199 @samp{strongarm1110},
15200 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15201 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15202 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15203 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15204 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15205 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15206 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15207 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15208 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15209 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15210 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15211 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15212 @samp{cortex-m33},
15213 @samp{cortex-m23},
15214 @samp{cortex-m7},
15215 @samp{cortex-m4},
15216 @samp{cortex-m3},
15217 @samp{cortex-m1},
15218 @samp{cortex-m0},
15219 @samp{cortex-m0plus},
15220 @samp{cortex-m1.small-multiply},
15221 @samp{cortex-m0.small-multiply},
15222 @samp{cortex-m0plus.small-multiply},
15223 @samp{exynos-m1},
15224 @samp{falkor},
15225 @samp{qdf24xx},
15226 @samp{marvell-pj4},
15227 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15228 @samp{fa526}, @samp{fa626},
15229 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15230 @samp{xgene1}.
15232 Additionally, this option can specify that GCC should tune the performance
15233 of the code for a big.LITTLE system.  Permissible names are:
15234 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15235 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15236 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15238 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15239 performance for a blend of processors within architecture @var{arch}.
15240 The aim is to generate code that run well on the current most popular
15241 processors, balancing between optimizations that benefit some CPUs in the
15242 range, and avoiding performance pitfalls of other CPUs.  The effects of
15243 this option may change in future GCC versions as CPU models come and go.
15245 @option{-mtune=native} causes the compiler to auto-detect the CPU
15246 of the build computer.  At present, this feature is only supported on
15247 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15248 unsuccessful the option has no effect.
15250 @item -mcpu=@var{name}
15251 @opindex mcpu
15252 This specifies the name of the target ARM processor.  GCC uses this name
15253 to derive the name of the target ARM architecture (as if specified
15254 by @option{-march}) and the ARM processor type for which to tune for
15255 performance (as if specified by @option{-mtune}).  Where this option
15256 is used in conjunction with @option{-march} or @option{-mtune},
15257 those options take precedence over the appropriate part of this option.
15259 Permissible names for this option are the same as those for
15260 @option{-mtune}.
15262 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15263 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15264 See @option{-mtune} for more information.
15266 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15267 of the build computer.  At present, this feature is only supported on
15268 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15269 is unsuccessful the option has no effect.
15271 @item -mfpu=@var{name}
15272 @opindex mfpu
15273 This specifies what floating-point hardware (or hardware emulation) is
15274 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15275 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15276 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15277 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15278 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15279 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15280 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15281 is an alias for @samp{vfpv2}.
15283 If @option{-msoft-float} is specified this specifies the format of
15284 floating-point values.
15286 If the selected floating-point hardware includes the NEON extension
15287 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15288 operations are not generated by GCC's auto-vectorization pass unless
15289 @option{-funsafe-math-optimizations} is also specified.  This is
15290 because NEON hardware does not fully implement the IEEE 754 standard for
15291 floating-point arithmetic (in particular denormal values are treated as
15292 zero), so the use of NEON instructions may lead to a loss of precision.
15294 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}).
15296 @item -mfp16-format=@var{name}
15297 @opindex mfp16-format
15298 Specify the format of the @code{__fp16} half-precision floating-point type.
15299 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15300 the default is @samp{none}, in which case the @code{__fp16} type is not
15301 defined.  @xref{Half-Precision}, for more information.
15303 @item -mstructure-size-boundary=@var{n}
15304 @opindex mstructure-size-boundary
15305 The sizes of all structures and unions are rounded up to a multiple
15306 of the number of bits set by this option.  Permissible values are 8, 32
15307 and 64.  The default value varies for different toolchains.  For the COFF
15308 targeted toolchain the default value is 8.  A value of 64 is only allowed
15309 if the underlying ABI supports it.
15311 Specifying a larger number can produce faster, more efficient code, but
15312 can also increase the size of the program.  Different values are potentially
15313 incompatible.  Code compiled with one value cannot necessarily expect to
15314 work with code or libraries compiled with another value, if they exchange
15315 information using structures or unions.
15317 @item -mabort-on-noreturn
15318 @opindex mabort-on-noreturn
15319 Generate a call to the function @code{abort} at the end of a
15320 @code{noreturn} function.  It is executed if the function tries to
15321 return.
15323 @item -mlong-calls
15324 @itemx -mno-long-calls
15325 @opindex mlong-calls
15326 @opindex mno-long-calls
15327 Tells the compiler to perform function calls by first loading the
15328 address of the function into a register and then performing a subroutine
15329 call on this register.  This switch is needed if the target function
15330 lies outside of the 64-megabyte addressing range of the offset-based
15331 version of subroutine call instruction.
15333 Even if this switch is enabled, not all function calls are turned
15334 into long calls.  The heuristic is that static functions, functions
15335 that have the @code{short_call} attribute, functions that are inside
15336 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15337 definitions have already been compiled within the current compilation
15338 unit are not turned into long calls.  The exceptions to this rule are
15339 that weak function definitions, functions with the @code{long_call}
15340 attribute or the @code{section} attribute, and functions that are within
15341 the scope of a @code{#pragma long_calls} directive are always
15342 turned into long calls.
15344 This feature is not enabled by default.  Specifying
15345 @option{-mno-long-calls} restores the default behavior, as does
15346 placing the function calls within the scope of a @code{#pragma
15347 long_calls_off} directive.  Note these switches have no effect on how
15348 the compiler generates code to handle function calls via function
15349 pointers.
15351 @item -msingle-pic-base
15352 @opindex msingle-pic-base
15353 Treat the register used for PIC addressing as read-only, rather than
15354 loading it in the prologue for each function.  The runtime system is
15355 responsible for initializing this register with an appropriate value
15356 before execution begins.
15358 @item -mpic-register=@var{reg}
15359 @opindex mpic-register
15360 Specify the register to be used for PIC addressing.
15361 For standard PIC base case, the default is any suitable register
15362 determined by compiler.  For single PIC base case, the default is
15363 @samp{R9} if target is EABI based or stack-checking is enabled,
15364 otherwise the default is @samp{R10}.
15366 @item -mpic-data-is-text-relative
15367 @opindex mpic-data-is-text-relative
15368 Assume that the displacement between the text and data segments is fixed
15369 at static link time.  This permits using PC-relative addressing
15370 operations to access data known to be in the data segment.  For
15371 non-VxWorks RTP targets, this option is enabled by default.  When
15372 disabled on such targets, it will enable @option{-msingle-pic-base} by
15373 default.
15375 @item -mpoke-function-name
15376 @opindex mpoke-function-name
15377 Write the name of each function into the text section, directly
15378 preceding the function prologue.  The generated code is similar to this:
15380 @smallexample
15381      t0
15382          .ascii "arm_poke_function_name", 0
15383          .align
15384      t1
15385          .word 0xff000000 + (t1 - t0)
15386      arm_poke_function_name
15387          mov     ip, sp
15388          stmfd   sp!, @{fp, ip, lr, pc@}
15389          sub     fp, ip, #4
15390 @end smallexample
15392 When performing a stack backtrace, code can inspect the value of
15393 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15394 location @code{pc - 12} and the top 8 bits are set, then we know that
15395 there is a function name embedded immediately preceding this location
15396 and has length @code{((pc[-3]) & 0xff000000)}.
15398 @item -mthumb
15399 @itemx -marm
15400 @opindex marm
15401 @opindex mthumb
15403 Select between generating code that executes in ARM and Thumb
15404 states.  The default for most configurations is to generate code
15405 that executes in ARM state, but the default can be changed by
15406 configuring GCC with the @option{--with-mode=}@var{state}
15407 configure option.
15409 You can also override the ARM and Thumb mode for each function
15410 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15411 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15413 @item -mtpcs-frame
15414 @opindex mtpcs-frame
15415 Generate a stack frame that is compliant with the Thumb Procedure Call
15416 Standard for all non-leaf functions.  (A leaf function is one that does
15417 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15419 @item -mtpcs-leaf-frame
15420 @opindex mtpcs-leaf-frame
15421 Generate a stack frame that is compliant with the Thumb Procedure Call
15422 Standard for all leaf functions.  (A leaf function is one that does
15423 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15425 @item -mcallee-super-interworking
15426 @opindex mcallee-super-interworking
15427 Gives all externally visible functions in the file being compiled an ARM
15428 instruction set header which switches to Thumb mode before executing the
15429 rest of the function.  This allows these functions to be called from
15430 non-interworking code.  This option is not valid in AAPCS configurations
15431 because interworking is enabled by default.
15433 @item -mcaller-super-interworking
15434 @opindex mcaller-super-interworking
15435 Allows calls via function pointers (including virtual functions) to
15436 execute correctly regardless of whether the target code has been
15437 compiled for interworking or not.  There is a small overhead in the cost
15438 of executing a function pointer if this option is enabled.  This option
15439 is not valid in AAPCS configurations because interworking is enabled
15440 by default.
15442 @item -mtp=@var{name}
15443 @opindex mtp
15444 Specify the access model for the thread local storage pointer.  The valid
15445 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15446 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15447 (supported in the arm6k architecture), and @samp{auto}, which uses the
15448 best available method for the selected processor.  The default setting is
15449 @samp{auto}.
15451 @item -mtls-dialect=@var{dialect}
15452 @opindex mtls-dialect
15453 Specify the dialect to use for accessing thread local storage.  Two
15454 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15455 @samp{gnu} dialect selects the original GNU scheme for supporting
15456 local and global dynamic TLS models.  The @samp{gnu2} dialect
15457 selects the GNU descriptor scheme, which provides better performance
15458 for shared libraries.  The GNU descriptor scheme is compatible with
15459 the original scheme, but does require new assembler, linker and
15460 library support.  Initial and local exec TLS models are unaffected by
15461 this option and always use the original scheme.
15463 @item -mword-relocations
15464 @opindex mword-relocations
15465 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15466 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15467 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15468 is specified.
15470 @item -mfix-cortex-m3-ldrd
15471 @opindex mfix-cortex-m3-ldrd
15472 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15473 with overlapping destination and base registers are used.  This option avoids
15474 generating these instructions.  This option is enabled by default when
15475 @option{-mcpu=cortex-m3} is specified.
15477 @item -munaligned-access
15478 @itemx -mno-unaligned-access
15479 @opindex munaligned-access
15480 @opindex mno-unaligned-access
15481 Enables (or disables) reading and writing of 16- and 32- bit values
15482 from addresses that are not 16- or 32- bit aligned.  By default
15483 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15484 ARMv8-M Baseline architectures, and enabled for all other
15485 architectures.  If unaligned access is not enabled then words in packed
15486 data structures are accessed a byte at a time.
15488 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15489 generated object file to either true or false, depending upon the
15490 setting of this option.  If unaligned access is enabled then the
15491 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15492 defined.
15494 @item -mneon-for-64bits
15495 @opindex mneon-for-64bits
15496 Enables using Neon to handle scalar 64-bits operations. This is
15497 disabled by default since the cost of moving data from core registers
15498 to Neon is high.
15500 @item -mslow-flash-data
15501 @opindex mslow-flash-data
15502 Assume loading data from flash is slower than fetching instruction.
15503 Therefore literal load is minimized for better performance.
15504 This option is only supported when compiling for ARMv7 M-profile and
15505 off by default.
15507 @item -masm-syntax-unified
15508 @opindex masm-syntax-unified
15509 Assume inline assembler is using unified asm syntax.  The default is
15510 currently off which implies divided syntax.  This option has no impact
15511 on Thumb2. However, this may change in future releases of GCC.
15512 Divided syntax should be considered deprecated.
15514 @item -mrestrict-it
15515 @opindex mrestrict-it
15516 Restricts generation of IT blocks to conform to the rules of ARMv8.
15517 IT blocks can only contain a single 16-bit instruction from a select
15518 set of instructions. This option is on by default for ARMv8 Thumb mode.
15520 @item -mprint-tune-info
15521 @opindex mprint-tune-info
15522 Print CPU tuning information as comment in assembler file.  This is
15523 an option used only for regression testing of the compiler and not
15524 intended for ordinary use in compiling code.  This option is disabled
15525 by default.
15527 @item -mpure-code
15528 @opindex mpure-code
15529 Do not allow constant data to be placed in code sections.
15530 Additionally, when compiling for ELF object format give all text sections the
15531 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15532 is only available when generating non-pic code for ARMv7-M targets.
15534 @item -mcmse
15535 @opindex mcmse
15536 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15537 Development Tools Engineering Specification", which can be found on
15538 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15539 @end table
15541 @node AVR Options
15542 @subsection AVR Options
15543 @cindex AVR Options
15545 These options are defined for AVR implementations:
15547 @table @gcctabopt
15548 @item -mmcu=@var{mcu}
15549 @opindex mmcu
15550 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15552 The default for this option is@tie{}@samp{avr2}.
15554 GCC supports the following AVR devices and ISAs:
15556 @include avr-mmcu.texi
15558 @item -mabsdata
15559 @opindex mabsdata
15561 Assume that all data in static storage can be accessed by LDS / STS
15562 instructions.  This option has only an effect on reduced Tiny devices like
15563 ATtiny40.  See also the @code{absdata}
15564 @ref{AVR Variable Attributes,variable attribute}.
15566 @item -maccumulate-args
15567 @opindex maccumulate-args
15568 Accumulate outgoing function arguments and acquire/release the needed
15569 stack space for outgoing function arguments once in function
15570 prologue/epilogue.  Without this option, outgoing arguments are pushed
15571 before calling a function and popped afterwards.
15573 Popping the arguments after the function call can be expensive on
15574 AVR so that accumulating the stack space might lead to smaller
15575 executables because arguments need not to be removed from the
15576 stack after such a function call.
15578 This option can lead to reduced code size for functions that perform
15579 several calls to functions that get their arguments on the stack like
15580 calls to printf-like functions.
15582 @item -mbranch-cost=@var{cost}
15583 @opindex mbranch-cost
15584 Set the branch costs for conditional branch instructions to
15585 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15586 integers. The default branch cost is 0.
15588 @item -mcall-prologues
15589 @opindex mcall-prologues
15590 Functions prologues/epilogues are expanded as calls to appropriate
15591 subroutines.  Code size is smaller.
15593 @item -mint8
15594 @opindex mint8
15595 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15596 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15597 and @code{long long} is 4 bytes.  Please note that this option does not
15598 conform to the C standards, but it results in smaller code
15599 size.
15601 @item -mn-flash=@var{num}
15602 @opindex mn-flash
15603 Assume that the flash memory has a size of 
15604 @var{num} times 64@tie{}KiB.
15606 @item -mno-interrupts
15607 @opindex mno-interrupts
15608 Generated code is not compatible with hardware interrupts.
15609 Code size is smaller.
15611 @item -mrelax
15612 @opindex mrelax
15613 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15614 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15615 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15616 the assembler's command line and the @option{--relax} option to the
15617 linker's command line.
15619 Jump relaxing is performed by the linker because jump offsets are not
15620 known before code is located. Therefore, the assembler code generated by the
15621 compiler is the same, but the instructions in the executable may
15622 differ from instructions in the assembler code.
15624 Relaxing must be turned on if linker stubs are needed, see the
15625 section on @code{EIND} and linker stubs below.
15627 @item -mrmw
15628 @opindex mrmw
15629 Assume that the device supports the Read-Modify-Write
15630 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15632 @item -msp8
15633 @opindex msp8
15634 Treat the stack pointer register as an 8-bit register,
15635 i.e.@: assume the high byte of the stack pointer is zero.
15636 In general, you don't need to set this option by hand.
15638 This option is used internally by the compiler to select and
15639 build multilibs for architectures @code{avr2} and @code{avr25}.
15640 These architectures mix devices with and without @code{SPH}.
15641 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15642 the compiler driver adds or removes this option from the compiler
15643 proper's command line, because the compiler then knows if the device
15644 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15645 register or not.
15647 @item -mstrict-X
15648 @opindex mstrict-X
15649 Use address register @code{X} in a way proposed by the hardware.  This means
15650 that @code{X} is only used in indirect, post-increment or
15651 pre-decrement addressing.
15653 Without this option, the @code{X} register may be used in the same way
15654 as @code{Y} or @code{Z} which then is emulated by additional
15655 instructions.  
15656 For example, loading a value with @code{X+const} addressing with a
15657 small non-negative @code{const < 64} to a register @var{Rn} is
15658 performed as
15660 @example
15661 adiw r26, const   ; X += const
15662 ld   @var{Rn}, X        ; @var{Rn} = *X
15663 sbiw r26, const   ; X -= const
15664 @end example
15666 @item -mtiny-stack
15667 @opindex mtiny-stack
15668 Only change the lower 8@tie{}bits of the stack pointer.
15670 @item -mfract-convert-truncate
15671 @opindex mfract-convert-truncate
15672 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15674 @item -nodevicelib
15675 @opindex nodevicelib
15676 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15678 @item -Waddr-space-convert
15679 @opindex Waddr-space-convert
15680 Warn about conversions between address spaces in the case where the
15681 resulting address space is not contained in the incoming address space.
15683 @item -Wmisspelled-isr
15684 @opindex Wmisspelled-isr
15685 Warn if the ISR is misspelled, i.e. without __vector prefix.
15686 Enabled by default.
15687 @end table
15689 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15690 @cindex @code{EIND}
15691 Pointers in the implementation are 16@tie{}bits wide.
15692 The address of a function or label is represented as word address so
15693 that indirect jumps and calls can target any code address in the
15694 range of 64@tie{}Ki words.
15696 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15697 bytes of program memory space, there is a special function register called
15698 @code{EIND} that serves as most significant part of the target address
15699 when @code{EICALL} or @code{EIJMP} instructions are used.
15701 Indirect jumps and calls on these devices are handled as follows by
15702 the compiler and are subject to some limitations:
15704 @itemize @bullet
15706 @item
15707 The compiler never sets @code{EIND}.
15709 @item
15710 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15711 instructions or might read @code{EIND} directly in order to emulate an
15712 indirect call/jump by means of a @code{RET} instruction.
15714 @item
15715 The compiler assumes that @code{EIND} never changes during the startup
15716 code or during the application. In particular, @code{EIND} is not
15717 saved/restored in function or interrupt service routine
15718 prologue/epilogue.
15720 @item
15721 For indirect calls to functions and computed goto, the linker
15722 generates @emph{stubs}. Stubs are jump pads sometimes also called
15723 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15724 The stub contains a direct jump to the desired address.
15726 @item
15727 Linker relaxation must be turned on so that the linker generates
15728 the stubs correctly in all situations. See the compiler option
15729 @option{-mrelax} and the linker option @option{--relax}.
15730 There are corner cases where the linker is supposed to generate stubs
15731 but aborts without relaxation and without a helpful error message.
15733 @item
15734 The default linker script is arranged for code with @code{EIND = 0}.
15735 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15736 linker script has to be used in order to place the sections whose
15737 name start with @code{.trampolines} into the segment where @code{EIND}
15738 points to.
15740 @item
15741 The startup code from libgcc never sets @code{EIND}.
15742 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15743 For the impact of AVR-LibC on @code{EIND}, see the
15744 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15746 @item
15747 It is legitimate for user-specific startup code to set up @code{EIND}
15748 early, for example by means of initialization code located in
15749 section @code{.init3}. Such code runs prior to general startup code
15750 that initializes RAM and calls constructors, but after the bit
15751 of startup code from AVR-LibC that sets @code{EIND} to the segment
15752 where the vector table is located.
15753 @example
15754 #include <avr/io.h>
15756 static void
15757 __attribute__((section(".init3"),naked,used,no_instrument_function))
15758 init3_set_eind (void)
15760   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15761                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15763 @end example
15765 @noindent
15766 The @code{__trampolines_start} symbol is defined in the linker script.
15768 @item
15769 Stubs are generated automatically by the linker if
15770 the following two conditions are met:
15771 @itemize @minus
15773 @item The address of a label is taken by means of the @code{gs} modifier
15774 (short for @emph{generate stubs}) like so:
15775 @example
15776 LDI r24, lo8(gs(@var{func}))
15777 LDI r25, hi8(gs(@var{func}))
15778 @end example
15779 @item The final location of that label is in a code segment
15780 @emph{outside} the segment where the stubs are located.
15781 @end itemize
15783 @item
15784 The compiler emits such @code{gs} modifiers for code labels in the
15785 following situations:
15786 @itemize @minus
15787 @item Taking address of a function or code label.
15788 @item Computed goto.
15789 @item If prologue-save function is used, see @option{-mcall-prologues}
15790 command-line option.
15791 @item Switch/case dispatch tables. If you do not want such dispatch
15792 tables you can specify the @option{-fno-jump-tables} command-line option.
15793 @item C and C++ constructors/destructors called during startup/shutdown.
15794 @item If the tools hit a @code{gs()} modifier explained above.
15795 @end itemize
15797 @item
15798 Jumping to non-symbolic addresses like so is @emph{not} supported:
15800 @example
15801 int main (void)
15803     /* Call function at word address 0x2 */
15804     return ((int(*)(void)) 0x2)();
15806 @end example
15808 Instead, a stub has to be set up, i.e.@: the function has to be called
15809 through a symbol (@code{func_4} in the example):
15811 @example
15812 int main (void)
15814     extern int func_4 (void);
15816     /* Call function at byte address 0x4 */
15817     return func_4();
15819 @end example
15821 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15822 Alternatively, @code{func_4} can be defined in the linker script.
15823 @end itemize
15825 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15826 @cindex @code{RAMPD}
15827 @cindex @code{RAMPX}
15828 @cindex @code{RAMPY}
15829 @cindex @code{RAMPZ}
15830 Some AVR devices support memories larger than the 64@tie{}KiB range
15831 that can be accessed with 16-bit pointers.  To access memory locations
15832 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
15833 register is used as high part of the address:
15834 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15835 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15836 register, respectively, to get a wide address. Similarly,
15837 @code{RAMPD} is used together with direct addressing.
15839 @itemize
15840 @item
15841 The startup code initializes the @code{RAMP} special function
15842 registers with zero.
15844 @item
15845 If a @ref{AVR Named Address Spaces,named address space} other than
15846 generic or @code{__flash} is used, then @code{RAMPZ} is set
15847 as needed before the operation.
15849 @item
15850 If the device supports RAM larger than 64@tie{}KiB and the compiler
15851 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15852 is reset to zero after the operation.
15854 @item
15855 If the device comes with a specific @code{RAMP} register, the ISR
15856 prologue/epilogue saves/restores that SFR and initializes it with
15857 zero in case the ISR code might (implicitly) use it.
15859 @item
15860 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15861 If you use inline assembler to read from locations outside the
15862 16-bit address range and change one of the @code{RAMP} registers,
15863 you must reset it to zero after the access.
15865 @end itemize
15867 @subsubsection AVR Built-in Macros
15869 GCC defines several built-in macros so that the user code can test
15870 for the presence or absence of features.  Almost any of the following
15871 built-in macros are deduced from device capabilities and thus
15872 triggered by the @option{-mmcu=} command-line option.
15874 For even more AVR-specific built-in macros see
15875 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15877 @table @code
15879 @item __AVR_ARCH__
15880 Build-in macro that resolves to a decimal number that identifies the
15881 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15882 Possible values are:
15884 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15885 @code{4}, @code{5}, @code{51}, @code{6}
15887 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15888 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15890 respectively and
15892 @code{100}, @code{102}, @code{104},
15893 @code{105}, @code{106}, @code{107}
15895 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15896 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15897 If @var{mcu} specifies a device, this built-in macro is set
15898 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15899 defined to @code{4}.
15901 @item __AVR_@var{Device}__
15902 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15903 the device's name. For example, @option{-mmcu=atmega8} defines the
15904 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15905 @code{__AVR_ATtiny261A__}, etc.
15907 The built-in macros' names follow
15908 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15909 the device name as from the AVR user manual. The difference between
15910 @var{Device} in the built-in macro and @var{device} in
15911 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15913 If @var{device} is not a device but only a core architecture like
15914 @samp{avr51}, this macro is not defined.
15916 @item __AVR_DEVICE_NAME__
15917 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15918 the device's name. For example, with @option{-mmcu=atmega8} the macro
15919 is defined to @code{atmega8}.
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_XMEGA__
15925 The device / architecture belongs to the XMEGA family of devices.
15927 @item __AVR_HAVE_ELPM__
15928 The device has the @code{ELPM} instruction.
15930 @item __AVR_HAVE_ELPMX__
15931 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15932 R@var{n},Z+} instructions.
15934 @item __AVR_HAVE_MOVW__
15935 The device has the @code{MOVW} instruction to perform 16-bit
15936 register-register moves.
15938 @item __AVR_HAVE_LPMX__
15939 The device has the @code{LPM R@var{n},Z} and
15940 @code{LPM R@var{n},Z+} instructions.
15942 @item __AVR_HAVE_MUL__
15943 The device has a hardware multiplier. 
15945 @item __AVR_HAVE_JMP_CALL__
15946 The device has the @code{JMP} and @code{CALL} instructions.
15947 This is the case for devices with at least 16@tie{}KiB of program
15948 memory.
15950 @item __AVR_HAVE_EIJMP_EICALL__
15951 @itemx __AVR_3_BYTE_PC__
15952 The device has the @code{EIJMP} and @code{EICALL} instructions.
15953 This is the case for devices with more than 128@tie{}KiB of program memory.
15954 This also means that the program counter
15955 (PC) is 3@tie{}bytes wide.
15957 @item __AVR_2_BYTE_PC__
15958 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15959 with up to 128@tie{}KiB of program memory.
15961 @item __AVR_HAVE_8BIT_SP__
15962 @itemx __AVR_HAVE_16BIT_SP__
15963 The stack pointer (SP) register is treated as 8-bit respectively
15964 16-bit register by the compiler.
15965 The definition of these macros is affected by @option{-mtiny-stack}.
15967 @item __AVR_HAVE_SPH__
15968 @itemx __AVR_SP8__
15969 The device has the SPH (high part of stack pointer) special function
15970 register or has an 8-bit stack pointer, respectively.
15971 The definition of these macros is affected by @option{-mmcu=} and
15972 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15973 by @option{-msp8}.
15975 @item __AVR_HAVE_RAMPD__
15976 @itemx __AVR_HAVE_RAMPX__
15977 @itemx __AVR_HAVE_RAMPY__
15978 @itemx __AVR_HAVE_RAMPZ__
15979 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15980 @code{RAMPZ} special function register, respectively.
15982 @item __NO_INTERRUPTS__
15983 This macro reflects the @option{-mno-interrupts} command-line option.
15985 @item __AVR_ERRATA_SKIP__
15986 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15987 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15988 instructions because of a hardware erratum.  Skip instructions are
15989 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15990 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15991 set.
15993 @item __AVR_ISA_RMW__
15994 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15996 @item __AVR_SFR_OFFSET__=@var{offset}
15997 Instructions that can address I/O special function registers directly
15998 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15999 address as if addressed by an instruction to access RAM like @code{LD}
16000 or @code{STS}. This offset depends on the device architecture and has
16001 to be subtracted from the RAM address in order to get the
16002 respective I/O@tie{}address.
16004 @item __WITH_AVRLIBC__
16005 The compiler is configured to be used together with AVR-Libc.
16006 See the @option{--with-avrlibc} configure option.
16008 @end table
16010 @node Blackfin Options
16011 @subsection Blackfin Options
16012 @cindex Blackfin Options
16014 @table @gcctabopt
16015 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16016 @opindex mcpu=
16017 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16018 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16019 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16020 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16021 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16022 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16023 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16024 @samp{bf561}, @samp{bf592}.
16026 The optional @var{sirevision} specifies the silicon revision of the target
16027 Blackfin processor.  Any workarounds available for the targeted silicon revision
16028 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16029 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16030 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16031 hexadecimal digits representing the major and minor numbers in the silicon
16032 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16033 is not defined.  If @var{sirevision} is @samp{any}, the
16034 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16035 If this optional @var{sirevision} is not used, GCC assumes the latest known
16036 silicon revision of the targeted Blackfin processor.
16038 GCC defines a preprocessor macro for the specified @var{cpu}.
16039 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16040 provided by libgloss to be linked in if @option{-msim} is not given.
16042 Without this option, @samp{bf532} is used as the processor by default.
16044 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16045 only the preprocessor macro is defined.
16047 @item -msim
16048 @opindex msim
16049 Specifies that the program will be run on the simulator.  This causes
16050 the simulator BSP provided by libgloss to be linked in.  This option
16051 has effect only for @samp{bfin-elf} toolchain.
16052 Certain other options, such as @option{-mid-shared-library} and
16053 @option{-mfdpic}, imply @option{-msim}.
16055 @item -momit-leaf-frame-pointer
16056 @opindex momit-leaf-frame-pointer
16057 Don't keep the frame pointer in a register for leaf functions.  This
16058 avoids the instructions to save, set up and restore frame pointers and
16059 makes an extra register available in leaf functions.  The option
16060 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16061 which might make debugging harder.
16063 @item -mspecld-anomaly
16064 @opindex mspecld-anomaly
16065 When enabled, the compiler ensures that the generated code does not
16066 contain speculative loads after jump instructions. If this option is used,
16067 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16069 @item -mno-specld-anomaly
16070 @opindex mno-specld-anomaly
16071 Don't generate extra code to prevent speculative loads from occurring.
16073 @item -mcsync-anomaly
16074 @opindex mcsync-anomaly
16075 When enabled, the compiler ensures that the generated code does not
16076 contain CSYNC or SSYNC instructions too soon after conditional branches.
16077 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16079 @item -mno-csync-anomaly
16080 @opindex mno-csync-anomaly
16081 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16082 occurring too soon after a conditional branch.
16084 @item -mlow-64k
16085 @opindex mlow-64k
16086 When enabled, the compiler is free to take advantage of the knowledge that
16087 the entire program fits into the low 64k of memory.
16089 @item -mno-low-64k
16090 @opindex mno-low-64k
16091 Assume that the program is arbitrarily large.  This is the default.
16093 @item -mstack-check-l1
16094 @opindex mstack-check-l1
16095 Do stack checking using information placed into L1 scratchpad memory by the
16096 uClinux kernel.
16098 @item -mid-shared-library
16099 @opindex mid-shared-library
16100 Generate code that supports shared libraries via the library ID method.
16101 This allows for execute in place and shared libraries in an environment
16102 without virtual memory management.  This option implies @option{-fPIC}.
16103 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16105 @item -mno-id-shared-library
16106 @opindex mno-id-shared-library
16107 Generate code that doesn't assume ID-based shared libraries are being used.
16108 This is the default.
16110 @item -mleaf-id-shared-library
16111 @opindex mleaf-id-shared-library
16112 Generate code that supports shared libraries via the library ID method,
16113 but assumes that this library or executable won't link against any other
16114 ID shared libraries.  That allows the compiler to use faster code for jumps
16115 and calls.
16117 @item -mno-leaf-id-shared-library
16118 @opindex mno-leaf-id-shared-library
16119 Do not assume that the code being compiled won't link against any ID shared
16120 libraries.  Slower code is generated for jump and call insns.
16122 @item -mshared-library-id=n
16123 @opindex mshared-library-id
16124 Specifies the identification number of the ID-based shared library being
16125 compiled.  Specifying a value of 0 generates more compact code; specifying
16126 other values forces the allocation of that number to the current
16127 library but is no more space- or time-efficient than omitting this option.
16129 @item -msep-data
16130 @opindex msep-data
16131 Generate code that allows the data segment to be located in a different
16132 area of memory from the text segment.  This allows for execute in place in
16133 an environment without virtual memory management by eliminating relocations
16134 against the text section.
16136 @item -mno-sep-data
16137 @opindex mno-sep-data
16138 Generate code that assumes that the data segment follows the text segment.
16139 This is the default.
16141 @item -mlong-calls
16142 @itemx -mno-long-calls
16143 @opindex mlong-calls
16144 @opindex mno-long-calls
16145 Tells the compiler to perform function calls by first loading the
16146 address of the function into a register and then performing a subroutine
16147 call on this register.  This switch is needed if the target function
16148 lies outside of the 24-bit addressing range of the offset-based
16149 version of subroutine call instruction.
16151 This feature is not enabled by default.  Specifying
16152 @option{-mno-long-calls} restores the default behavior.  Note these
16153 switches have no effect on how the compiler generates code to handle
16154 function calls via function pointers.
16156 @item -mfast-fp
16157 @opindex mfast-fp
16158 Link with the fast floating-point library. This library relaxes some of
16159 the IEEE floating-point standard's rules for checking inputs against
16160 Not-a-Number (NAN), in the interest of performance.
16162 @item -minline-plt
16163 @opindex minline-plt
16164 Enable inlining of PLT entries in function calls to functions that are
16165 not known to bind locally.  It has no effect without @option{-mfdpic}.
16167 @item -mmulticore
16168 @opindex mmulticore
16169 Build a standalone application for multicore Blackfin processors. 
16170 This option causes proper start files and link scripts supporting 
16171 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16172 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16174 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16175 selects the one-application-per-core programming model.  Without
16176 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16177 programming model is used. In this model, the main function of Core B
16178 should be named as @code{coreb_main}.
16180 If this option is not used, the single-core application programming
16181 model is used.
16183 @item -mcorea
16184 @opindex mcorea
16185 Build a standalone application for Core A of BF561 when using
16186 the one-application-per-core programming model. Proper start files
16187 and link scripts are used to support Core A, and the macro
16188 @code{__BFIN_COREA} is defined.
16189 This option can only be used in conjunction with @option{-mmulticore}.
16191 @item -mcoreb
16192 @opindex mcoreb
16193 Build a standalone application for Core B of BF561 when using
16194 the one-application-per-core programming model. Proper start files
16195 and link scripts are used to support Core B, and the macro
16196 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16197 should be used instead of @code{main}. 
16198 This option can only be used in conjunction with @option{-mmulticore}.
16200 @item -msdram
16201 @opindex msdram
16202 Build a standalone application for SDRAM. Proper start files and
16203 link scripts are used to put the application into SDRAM, and the macro
16204 @code{__BFIN_SDRAM} is defined.
16205 The loader should initialize SDRAM before loading the application.
16207 @item -micplb
16208 @opindex micplb
16209 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16210 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16211 are enabled; for standalone applications the default is off.
16212 @end table
16214 @node C6X Options
16215 @subsection C6X Options
16216 @cindex C6X Options
16218 @table @gcctabopt
16219 @item -march=@var{name}
16220 @opindex march
16221 This specifies the name of the target architecture.  GCC uses this
16222 name to determine what kind of instructions it can emit when generating
16223 assembly code.  Permissible names are: @samp{c62x},
16224 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16226 @item -mbig-endian
16227 @opindex mbig-endian
16228 Generate code for a big-endian target.
16230 @item -mlittle-endian
16231 @opindex mlittle-endian
16232 Generate code for a little-endian target.  This is the default.
16234 @item -msim
16235 @opindex msim
16236 Choose startup files and linker script suitable for the simulator.
16238 @item -msdata=default
16239 @opindex msdata=default
16240 Put small global and static data in the @code{.neardata} section,
16241 which is pointed to by register @code{B14}.  Put small uninitialized
16242 global and static data in the @code{.bss} section, which is adjacent
16243 to the @code{.neardata} section.  Put small read-only data into the
16244 @code{.rodata} section.  The corresponding sections used for large
16245 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16247 @item -msdata=all
16248 @opindex msdata=all
16249 Put all data, not just small objects, into the sections reserved for
16250 small data, and use addressing relative to the @code{B14} register to
16251 access them.
16253 @item -msdata=none
16254 @opindex msdata=none
16255 Make no use of the sections reserved for small data, and use absolute
16256 addresses to access all data.  Put all initialized global and static
16257 data in the @code{.fardata} section, and all uninitialized data in the
16258 @code{.far} section.  Put all constant data into the @code{.const}
16259 section.
16260 @end table
16262 @node CRIS Options
16263 @subsection CRIS Options
16264 @cindex CRIS Options
16266 These options are defined specifically for the CRIS ports.
16268 @table @gcctabopt
16269 @item -march=@var{architecture-type}
16270 @itemx -mcpu=@var{architecture-type}
16271 @opindex march
16272 @opindex mcpu
16273 Generate code for the specified architecture.  The choices for
16274 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16275 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16276 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16277 @samp{v10}.
16279 @item -mtune=@var{architecture-type}
16280 @opindex mtune
16281 Tune to @var{architecture-type} everything applicable about the generated
16282 code, except for the ABI and the set of available instructions.  The
16283 choices for @var{architecture-type} are the same as for
16284 @option{-march=@var{architecture-type}}.
16286 @item -mmax-stack-frame=@var{n}
16287 @opindex mmax-stack-frame
16288 Warn when the stack frame of a function exceeds @var{n} bytes.
16290 @item -metrax4
16291 @itemx -metrax100
16292 @opindex metrax4
16293 @opindex metrax100
16294 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16295 @option{-march=v3} and @option{-march=v8} respectively.
16297 @item -mmul-bug-workaround
16298 @itemx -mno-mul-bug-workaround
16299 @opindex mmul-bug-workaround
16300 @opindex mno-mul-bug-workaround
16301 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16302 models where it applies.  This option is active by default.
16304 @item -mpdebug
16305 @opindex mpdebug
16306 Enable CRIS-specific verbose debug-related information in the assembly
16307 code.  This option also has the effect of turning off the @samp{#NO_APP}
16308 formatted-code indicator to the assembler at the beginning of the
16309 assembly file.
16311 @item -mcc-init
16312 @opindex mcc-init
16313 Do not use condition-code results from previous instruction; always emit
16314 compare and test instructions before use of condition codes.
16316 @item -mno-side-effects
16317 @opindex mno-side-effects
16318 Do not emit instructions with side effects in addressing modes other than
16319 post-increment.
16321 @item -mstack-align
16322 @itemx -mno-stack-align
16323 @itemx -mdata-align
16324 @itemx -mno-data-align
16325 @itemx -mconst-align
16326 @itemx -mno-const-align
16327 @opindex mstack-align
16328 @opindex mno-stack-align
16329 @opindex mdata-align
16330 @opindex mno-data-align
16331 @opindex mconst-align
16332 @opindex mno-const-align
16333 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16334 stack frame, individual data and constants to be aligned for the maximum
16335 single data access size for the chosen CPU model.  The default is to
16336 arrange for 32-bit alignment.  ABI details such as structure layout are
16337 not affected by these options.
16339 @item -m32-bit
16340 @itemx -m16-bit
16341 @itemx -m8-bit
16342 @opindex m32-bit
16343 @opindex m16-bit
16344 @opindex m8-bit
16345 Similar to the stack- data- and const-align options above, these options
16346 arrange for stack frame, writable data and constants to all be 32-bit,
16347 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16349 @item -mno-prologue-epilogue
16350 @itemx -mprologue-epilogue
16351 @opindex mno-prologue-epilogue
16352 @opindex mprologue-epilogue
16353 With @option{-mno-prologue-epilogue}, the normal function prologue and
16354 epilogue which set up the stack frame are omitted and no return
16355 instructions or return sequences are generated in the code.  Use this
16356 option only together with visual inspection of the compiled code: no
16357 warnings or errors are generated when call-saved registers must be saved,
16358 or storage for local variables needs to be allocated.
16360 @item -mno-gotplt
16361 @itemx -mgotplt
16362 @opindex mno-gotplt
16363 @opindex mgotplt
16364 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16365 instruction sequences that load addresses for functions from the PLT part
16366 of the GOT rather than (traditional on other architectures) calls to the
16367 PLT@.  The default is @option{-mgotplt}.
16369 @item -melf
16370 @opindex melf
16371 Legacy no-op option only recognized with the cris-axis-elf and
16372 cris-axis-linux-gnu targets.
16374 @item -mlinux
16375 @opindex mlinux
16376 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16378 @item -sim
16379 @opindex sim
16380 This option, recognized for the cris-axis-elf, arranges
16381 to link with input-output functions from a simulator library.  Code,
16382 initialized data and zero-initialized data are allocated consecutively.
16384 @item -sim2
16385 @opindex sim2
16386 Like @option{-sim}, but pass linker options to locate initialized data at
16387 0x40000000 and zero-initialized data at 0x80000000.
16388 @end table
16390 @node CR16 Options
16391 @subsection CR16 Options
16392 @cindex CR16 Options
16394 These options are defined specifically for the CR16 ports.
16396 @table @gcctabopt
16398 @item -mmac
16399 @opindex mmac
16400 Enable the use of multiply-accumulate instructions. Disabled by default.
16402 @item -mcr16cplus
16403 @itemx -mcr16c
16404 @opindex mcr16cplus
16405 @opindex mcr16c
16406 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16407 is default.
16409 @item -msim
16410 @opindex msim
16411 Links the library libsim.a which is in compatible with simulator. Applicable
16412 to ELF compiler only.
16414 @item -mint32
16415 @opindex mint32
16416 Choose integer type as 32-bit wide.
16418 @item -mbit-ops
16419 @opindex mbit-ops
16420 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16422 @item -mdata-model=@var{model}
16423 @opindex mdata-model
16424 Choose a data model. The choices for @var{model} are @samp{near},
16425 @samp{far} or @samp{medium}. @samp{medium} is default.
16426 However, @samp{far} is not valid with @option{-mcr16c}, as the
16427 CR16C architecture does not support the far data model.
16428 @end table
16430 @node Darwin Options
16431 @subsection Darwin Options
16432 @cindex Darwin options
16434 These options are defined for all architectures running the Darwin operating
16435 system.
16437 FSF GCC on Darwin does not create ``fat'' object files; it creates
16438 an object file for the single architecture that GCC was built to
16439 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16440 @option{-arch} options are used; it does so by running the compiler or
16441 linker multiple times and joining the results together with
16442 @file{lipo}.
16444 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16445 @samp{i686}) is determined by the flags that specify the ISA
16446 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16447 @option{-force_cpusubtype_ALL} option can be used to override this.
16449 The Darwin tools vary in their behavior when presented with an ISA
16450 mismatch.  The assembler, @file{as}, only permits instructions to
16451 be used that are valid for the subtype of the file it is generating,
16452 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16453 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16454 and prints an error if asked to create a shared library with a less
16455 restrictive subtype than its input files (for instance, trying to put
16456 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16457 for executables, @command{ld}, quietly gives the executable the most
16458 restrictive subtype of any of its input files.
16460 @table @gcctabopt
16461 @item -F@var{dir}
16462 @opindex F
16463 Add the framework directory @var{dir} to the head of the list of
16464 directories to be searched for header files.  These directories are
16465 interleaved with those specified by @option{-I} options and are
16466 scanned in a left-to-right order.
16468 A framework directory is a directory with frameworks in it.  A
16469 framework is a directory with a @file{Headers} and/or
16470 @file{PrivateHeaders} directory contained directly in it that ends
16471 in @file{.framework}.  The name of a framework is the name of this
16472 directory excluding the @file{.framework}.  Headers associated with
16473 the framework are found in one of those two directories, with
16474 @file{Headers} being searched first.  A subframework is a framework
16475 directory that is in a framework's @file{Frameworks} directory.
16476 Includes of subframework headers can only appear in a header of a
16477 framework that contains the subframework, or in a sibling subframework
16478 header.  Two subframeworks are siblings if they occur in the same
16479 framework.  A subframework should not have the same name as a
16480 framework; a warning is issued if this is violated.  Currently a
16481 subframework cannot have subframeworks; in the future, the mechanism
16482 may be extended to support this.  The standard frameworks can be found
16483 in @file{/System/Library/Frameworks} and
16484 @file{/Library/Frameworks}.  An example include looks like
16485 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16486 the name of the framework and @file{header.h} is found in the
16487 @file{PrivateHeaders} or @file{Headers} directory.
16489 @item -iframework@var{dir}
16490 @opindex iframework
16491 Like @option{-F} except the directory is a treated as a system
16492 directory.  The main difference between this @option{-iframework} and
16493 @option{-F} is that with @option{-iframework} the compiler does not
16494 warn about constructs contained within header files found via
16495 @var{dir}.  This option is valid only for the C family of languages.
16497 @item -gused
16498 @opindex gused
16499 Emit debugging information for symbols that are used.  For stabs
16500 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16501 This is by default ON@.
16503 @item -gfull
16504 @opindex gfull
16505 Emit debugging information for all symbols and types.
16507 @item -mmacosx-version-min=@var{version}
16508 The earliest version of MacOS X that this executable will run on
16509 is @var{version}.  Typical values of @var{version} include @code{10.1},
16510 @code{10.2}, and @code{10.3.9}.
16512 If the compiler was built to use the system's headers by default,
16513 then the default for this option is the system version on which the
16514 compiler is running, otherwise the default is to make choices that
16515 are compatible with as many systems and code bases as possible.
16517 @item -mkernel
16518 @opindex mkernel
16519 Enable kernel development mode.  The @option{-mkernel} option sets
16520 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16521 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16522 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16523 applicable.  This mode also sets @option{-mno-altivec},
16524 @option{-msoft-float}, @option{-fno-builtin} and
16525 @option{-mlong-branch} for PowerPC targets.
16527 @item -mone-byte-bool
16528 @opindex mone-byte-bool
16529 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16530 By default @code{sizeof(bool)} is @code{4} when compiling for
16531 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16532 option has no effect on x86.
16534 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16535 to generate code that is not binary compatible with code generated
16536 without that switch.  Using this switch may require recompiling all
16537 other modules in a program, including system libraries.  Use this
16538 switch to conform to a non-default data model.
16540 @item -mfix-and-continue
16541 @itemx -ffix-and-continue
16542 @itemx -findirect-data
16543 @opindex mfix-and-continue
16544 @opindex ffix-and-continue
16545 @opindex findirect-data
16546 Generate code suitable for fast turnaround development, such as to
16547 allow GDB to dynamically load @file{.o} files into already-running
16548 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16549 are provided for backwards compatibility.
16551 @item -all_load
16552 @opindex all_load
16553 Loads all members of static archive libraries.
16554 See man ld(1) for more information.
16556 @item -arch_errors_fatal
16557 @opindex arch_errors_fatal
16558 Cause the errors having to do with files that have the wrong architecture
16559 to be fatal.
16561 @item -bind_at_load
16562 @opindex bind_at_load
16563 Causes the output file to be marked such that the dynamic linker will
16564 bind all undefined references when the file is loaded or launched.
16566 @item -bundle
16567 @opindex bundle
16568 Produce a Mach-o bundle format file.
16569 See man ld(1) for more information.
16571 @item -bundle_loader @var{executable}
16572 @opindex bundle_loader
16573 This option specifies the @var{executable} that will load the build
16574 output file being linked.  See man ld(1) for more information.
16576 @item -dynamiclib
16577 @opindex dynamiclib
16578 When passed this option, GCC produces a dynamic library instead of
16579 an executable when linking, using the Darwin @file{libtool} command.
16581 @item -force_cpusubtype_ALL
16582 @opindex force_cpusubtype_ALL
16583 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16584 one controlled by the @option{-mcpu} or @option{-march} option.
16586 @item -allowable_client  @var{client_name}
16587 @itemx -client_name
16588 @itemx -compatibility_version
16589 @itemx -current_version
16590 @itemx -dead_strip
16591 @itemx -dependency-file
16592 @itemx -dylib_file
16593 @itemx -dylinker_install_name
16594 @itemx -dynamic
16595 @itemx -exported_symbols_list
16596 @itemx -filelist
16597 @need 800
16598 @itemx -flat_namespace
16599 @itemx -force_flat_namespace
16600 @itemx -headerpad_max_install_names
16601 @itemx -image_base
16602 @itemx -init
16603 @itemx -install_name
16604 @itemx -keep_private_externs
16605 @itemx -multi_module
16606 @itemx -multiply_defined
16607 @itemx -multiply_defined_unused
16608 @need 800
16609 @itemx -noall_load
16610 @itemx -no_dead_strip_inits_and_terms
16611 @itemx -nofixprebinding
16612 @itemx -nomultidefs
16613 @itemx -noprebind
16614 @itemx -noseglinkedit
16615 @itemx -pagezero_size
16616 @itemx -prebind
16617 @itemx -prebind_all_twolevel_modules
16618 @itemx -private_bundle
16619 @need 800
16620 @itemx -read_only_relocs
16621 @itemx -sectalign
16622 @itemx -sectobjectsymbols
16623 @itemx -whyload
16624 @itemx -seg1addr
16625 @itemx -sectcreate
16626 @itemx -sectobjectsymbols
16627 @itemx -sectorder
16628 @itemx -segaddr
16629 @itemx -segs_read_only_addr
16630 @need 800
16631 @itemx -segs_read_write_addr
16632 @itemx -seg_addr_table
16633 @itemx -seg_addr_table_filename
16634 @itemx -seglinkedit
16635 @itemx -segprot
16636 @itemx -segs_read_only_addr
16637 @itemx -segs_read_write_addr
16638 @itemx -single_module
16639 @itemx -static
16640 @itemx -sub_library
16641 @need 800
16642 @itemx -sub_umbrella
16643 @itemx -twolevel_namespace
16644 @itemx -umbrella
16645 @itemx -undefined
16646 @itemx -unexported_symbols_list
16647 @itemx -weak_reference_mismatches
16648 @itemx -whatsloaded
16649 @opindex allowable_client
16650 @opindex client_name
16651 @opindex compatibility_version
16652 @opindex current_version
16653 @opindex dead_strip
16654 @opindex dependency-file
16655 @opindex dylib_file
16656 @opindex dylinker_install_name
16657 @opindex dynamic
16658 @opindex exported_symbols_list
16659 @opindex filelist
16660 @opindex flat_namespace
16661 @opindex force_flat_namespace
16662 @opindex headerpad_max_install_names
16663 @opindex image_base
16664 @opindex init
16665 @opindex install_name
16666 @opindex keep_private_externs
16667 @opindex multi_module
16668 @opindex multiply_defined
16669 @opindex multiply_defined_unused
16670 @opindex noall_load
16671 @opindex no_dead_strip_inits_and_terms
16672 @opindex nofixprebinding
16673 @opindex nomultidefs
16674 @opindex noprebind
16675 @opindex noseglinkedit
16676 @opindex pagezero_size
16677 @opindex prebind
16678 @opindex prebind_all_twolevel_modules
16679 @opindex private_bundle
16680 @opindex read_only_relocs
16681 @opindex sectalign
16682 @opindex sectobjectsymbols
16683 @opindex whyload
16684 @opindex seg1addr
16685 @opindex sectcreate
16686 @opindex sectobjectsymbols
16687 @opindex sectorder
16688 @opindex segaddr
16689 @opindex segs_read_only_addr
16690 @opindex segs_read_write_addr
16691 @opindex seg_addr_table
16692 @opindex seg_addr_table_filename
16693 @opindex seglinkedit
16694 @opindex segprot
16695 @opindex segs_read_only_addr
16696 @opindex segs_read_write_addr
16697 @opindex single_module
16698 @opindex static
16699 @opindex sub_library
16700 @opindex sub_umbrella
16701 @opindex twolevel_namespace
16702 @opindex umbrella
16703 @opindex undefined
16704 @opindex unexported_symbols_list
16705 @opindex weak_reference_mismatches
16706 @opindex whatsloaded
16707 These options are passed to the Darwin linker.  The Darwin linker man page
16708 describes them in detail.
16709 @end table
16711 @node DEC Alpha Options
16712 @subsection DEC Alpha Options
16714 These @samp{-m} options are defined for the DEC Alpha implementations:
16716 @table @gcctabopt
16717 @item -mno-soft-float
16718 @itemx -msoft-float
16719 @opindex mno-soft-float
16720 @opindex msoft-float
16721 Use (do not use) the hardware floating-point instructions for
16722 floating-point operations.  When @option{-msoft-float} is specified,
16723 functions in @file{libgcc.a} are used to perform floating-point
16724 operations.  Unless they are replaced by routines that emulate the
16725 floating-point operations, or compiled in such a way as to call such
16726 emulations routines, these routines issue floating-point
16727 operations.   If you are compiling for an Alpha without floating-point
16728 operations, you must ensure that the library is built so as not to call
16729 them.
16731 Note that Alpha implementations without floating-point operations are
16732 required to have floating-point registers.
16734 @item -mfp-reg
16735 @itemx -mno-fp-regs
16736 @opindex mfp-reg
16737 @opindex mno-fp-regs
16738 Generate code that uses (does not use) the floating-point register set.
16739 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16740 register set is not used, floating-point operands are passed in integer
16741 registers as if they were integers and floating-point results are passed
16742 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16743 so any function with a floating-point argument or return value called by code
16744 compiled with @option{-mno-fp-regs} must also be compiled with that
16745 option.
16747 A typical use of this option is building a kernel that does not use,
16748 and hence need not save and restore, any floating-point registers.
16750 @item -mieee
16751 @opindex mieee
16752 The Alpha architecture implements floating-point hardware optimized for
16753 maximum performance.  It is mostly compliant with the IEEE floating-point
16754 standard.  However, for full compliance, software assistance is
16755 required.  This option generates code fully IEEE-compliant code
16756 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16757 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16758 defined during compilation.  The resulting code is less efficient but is
16759 able to correctly support denormalized numbers and exceptional IEEE
16760 values such as not-a-number and plus/minus infinity.  Other Alpha
16761 compilers call this option @option{-ieee_with_no_inexact}.
16763 @item -mieee-with-inexact
16764 @opindex mieee-with-inexact
16765 This is like @option{-mieee} except the generated code also maintains
16766 the IEEE @var{inexact-flag}.  Turning on this option causes the
16767 generated code to implement fully-compliant IEEE math.  In addition to
16768 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16769 macro.  On some Alpha implementations the resulting code may execute
16770 significantly slower than the code generated by default.  Since there is
16771 very little code that depends on the @var{inexact-flag}, you should
16772 normally not specify this option.  Other Alpha compilers call this
16773 option @option{-ieee_with_inexact}.
16775 @item -mfp-trap-mode=@var{trap-mode}
16776 @opindex mfp-trap-mode
16777 This option controls what floating-point related traps are enabled.
16778 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16779 The trap mode can be set to one of four values:
16781 @table @samp
16782 @item n
16783 This is the default (normal) setting.  The only traps that are enabled
16784 are the ones that cannot be disabled in software (e.g., division by zero
16785 trap).
16787 @item u
16788 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16789 as well.
16791 @item su
16792 Like @samp{u}, but the instructions are marked to be safe for software
16793 completion (see Alpha architecture manual for details).
16795 @item sui
16796 Like @samp{su}, but inexact traps are enabled as well.
16797 @end table
16799 @item -mfp-rounding-mode=@var{rounding-mode}
16800 @opindex mfp-rounding-mode
16801 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16802 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16805 @table @samp
16806 @item n
16807 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16808 the nearest machine number or towards the even machine number in case
16809 of a tie.
16811 @item m
16812 Round towards minus infinity.
16814 @item c
16815 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16817 @item d
16818 Dynamic rounding mode.  A field in the floating-point control register
16819 (@var{fpcr}, see Alpha architecture reference manual) controls the
16820 rounding mode in effect.  The C library initializes this register for
16821 rounding towards plus infinity.  Thus, unless your program modifies the
16822 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16823 @end table
16825 @item -mtrap-precision=@var{trap-precision}
16826 @opindex mtrap-precision
16827 In the Alpha architecture, floating-point traps are imprecise.  This
16828 means without software assistance it is impossible to recover from a
16829 floating trap and program execution normally needs to be terminated.
16830 GCC can generate code that can assist operating system trap handlers
16831 in determining the exact location that caused a floating-point trap.
16832 Depending on the requirements of an application, different levels of
16833 precisions can be selected:
16835 @table @samp
16836 @item p
16837 Program precision.  This option is the default and means a trap handler
16838 can only identify which program caused a floating-point exception.
16840 @item f
16841 Function precision.  The trap handler can determine the function that
16842 caused a floating-point exception.
16844 @item i
16845 Instruction precision.  The trap handler can determine the exact
16846 instruction that caused a floating-point exception.
16847 @end table
16849 Other Alpha compilers provide the equivalent options called
16850 @option{-scope_safe} and @option{-resumption_safe}.
16852 @item -mieee-conformant
16853 @opindex mieee-conformant
16854 This option marks the generated code as IEEE conformant.  You must not
16855 use this option unless you also specify @option{-mtrap-precision=i} and either
16856 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16857 is to emit the line @samp{.eflag 48} in the function prologue of the
16858 generated assembly file.
16860 @item -mbuild-constants
16861 @opindex mbuild-constants
16862 Normally GCC examines a 32- or 64-bit integer constant to
16863 see if it can construct it from smaller constants in two or three
16864 instructions.  If it cannot, it outputs the constant as a literal and
16865 generates code to load it from the data segment at run time.
16867 Use this option to require GCC to construct @emph{all} integer constants
16868 using code, even if it takes more instructions (the maximum is six).
16870 You typically use this option to build a shared library dynamic
16871 loader.  Itself a shared library, it must relocate itself in memory
16872 before it can find the variables and constants in its own data segment.
16874 @item -mbwx
16875 @itemx -mno-bwx
16876 @itemx -mcix
16877 @itemx -mno-cix
16878 @itemx -mfix
16879 @itemx -mno-fix
16880 @itemx -mmax
16881 @itemx -mno-max
16882 @opindex mbwx
16883 @opindex mno-bwx
16884 @opindex mcix
16885 @opindex mno-cix
16886 @opindex mfix
16887 @opindex mno-fix
16888 @opindex mmax
16889 @opindex mno-max
16890 Indicate whether GCC should generate code to use the optional BWX,
16891 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16892 sets supported by the CPU type specified via @option{-mcpu=} option or that
16893 of the CPU on which GCC was built if none is specified.
16895 @item -mfloat-vax
16896 @itemx -mfloat-ieee
16897 @opindex mfloat-vax
16898 @opindex mfloat-ieee
16899 Generate code that uses (does not use) VAX F and G floating-point
16900 arithmetic instead of IEEE single and double precision.
16902 @item -mexplicit-relocs
16903 @itemx -mno-explicit-relocs
16904 @opindex mexplicit-relocs
16905 @opindex mno-explicit-relocs
16906 Older Alpha assemblers provided no way to generate symbol relocations
16907 except via assembler macros.  Use of these macros does not allow
16908 optimal instruction scheduling.  GNU binutils as of version 2.12
16909 supports a new syntax that allows the compiler to explicitly mark
16910 which relocations should apply to which instructions.  This option
16911 is mostly useful for debugging, as GCC detects the capabilities of
16912 the assembler when it is built and sets the default accordingly.
16914 @item -msmall-data
16915 @itemx -mlarge-data
16916 @opindex msmall-data
16917 @opindex mlarge-data
16918 When @option{-mexplicit-relocs} is in effect, static data is
16919 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16920 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16921 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16922 16-bit relocations off of the @code{$gp} register.  This limits the
16923 size of the small data area to 64KB, but allows the variables to be
16924 directly accessed via a single instruction.
16926 The default is @option{-mlarge-data}.  With this option the data area
16927 is limited to just below 2GB@.  Programs that require more than 2GB of
16928 data must use @code{malloc} or @code{mmap} to allocate the data in the
16929 heap instead of in the program's data segment.
16931 When generating code for shared libraries, @option{-fpic} implies
16932 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16934 @item -msmall-text
16935 @itemx -mlarge-text
16936 @opindex msmall-text
16937 @opindex mlarge-text
16938 When @option{-msmall-text} is used, the compiler assumes that the
16939 code of the entire program (or shared library) fits in 4MB, and is
16940 thus reachable with a branch instruction.  When @option{-msmall-data}
16941 is used, the compiler can assume that all local symbols share the
16942 same @code{$gp} value, and thus reduce the number of instructions
16943 required for a function call from 4 to 1.
16945 The default is @option{-mlarge-text}.
16947 @item -mcpu=@var{cpu_type}
16948 @opindex mcpu
16949 Set the instruction set and instruction scheduling parameters for
16950 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16951 style name or the corresponding chip number.  GCC supports scheduling
16952 parameters for the EV4, EV5 and EV6 family of processors and
16953 chooses the default values for the instruction set from the processor
16954 you specify.  If you do not specify a processor type, GCC defaults
16955 to the processor on which the compiler was built.
16957 Supported values for @var{cpu_type} are
16959 @table @samp
16960 @item ev4
16961 @itemx ev45
16962 @itemx 21064
16963 Schedules as an EV4 and has no instruction set extensions.
16965 @item ev5
16966 @itemx 21164
16967 Schedules as an EV5 and has no instruction set extensions.
16969 @item ev56
16970 @itemx 21164a
16971 Schedules as an EV5 and supports the BWX extension.
16973 @item pca56
16974 @itemx 21164pc
16975 @itemx 21164PC
16976 Schedules as an EV5 and supports the BWX and MAX extensions.
16978 @item ev6
16979 @itemx 21264
16980 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16982 @item ev67
16983 @itemx 21264a
16984 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16985 @end table
16987 Native toolchains also support the value @samp{native},
16988 which selects the best architecture option for the host processor.
16989 @option{-mcpu=native} has no effect if GCC does not recognize
16990 the processor.
16992 @item -mtune=@var{cpu_type}
16993 @opindex mtune
16994 Set only the instruction scheduling parameters for machine type
16995 @var{cpu_type}.  The instruction set is not changed.
16997 Native toolchains also support the value @samp{native},
16998 which selects the best architecture option for the host processor.
16999 @option{-mtune=native} has no effect if GCC does not recognize
17000 the processor.
17002 @item -mmemory-latency=@var{time}
17003 @opindex mmemory-latency
17004 Sets the latency the scheduler should assume for typical memory
17005 references as seen by the application.  This number is highly
17006 dependent on the memory access patterns used by the application
17007 and the size of the external cache on the machine.
17009 Valid options for @var{time} are
17011 @table @samp
17012 @item @var{number}
17013 A decimal number representing clock cycles.
17015 @item L1
17016 @itemx L2
17017 @itemx L3
17018 @itemx main
17019 The compiler contains estimates of the number of clock cycles for
17020 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17021 (also called Dcache, Scache, and Bcache), as well as to main memory.
17022 Note that L3 is only valid for EV5.
17024 @end table
17025 @end table
17027 @node FR30 Options
17028 @subsection FR30 Options
17029 @cindex FR30 Options
17031 These options are defined specifically for the FR30 port.
17033 @table @gcctabopt
17035 @item -msmall-model
17036 @opindex msmall-model
17037 Use the small address space model.  This can produce smaller code, but
17038 it does assume that all symbolic values and addresses fit into a
17039 20-bit range.
17041 @item -mno-lsim
17042 @opindex mno-lsim
17043 Assume that runtime support has been provided and so there is no need
17044 to include the simulator library (@file{libsim.a}) on the linker
17045 command line.
17047 @end table
17049 @node FT32 Options
17050 @subsection FT32 Options
17051 @cindex FT32 Options
17053 These options are defined specifically for the FT32 port.
17055 @table @gcctabopt
17057 @item -msim
17058 @opindex msim
17059 Specifies that the program will be run on the simulator.  This causes
17060 an alternate runtime startup and library to be linked.
17061 You must not use this option when generating programs that will run on
17062 real hardware; you must provide your own runtime library for whatever
17063 I/O functions are needed.
17065 @item -mlra
17066 @opindex mlra
17067 Enable Local Register Allocation.  This is still experimental for FT32,
17068 so by default the compiler uses standard reload.
17070 @item -mnodiv
17071 @opindex mnodiv
17072 Do not use div and mod instructions.
17074 @end table
17076 @node FRV Options
17077 @subsection FRV Options
17078 @cindex FRV Options
17080 @table @gcctabopt
17081 @item -mgpr-32
17082 @opindex mgpr-32
17084 Only use the first 32 general-purpose registers.
17086 @item -mgpr-64
17087 @opindex mgpr-64
17089 Use all 64 general-purpose registers.
17091 @item -mfpr-32
17092 @opindex mfpr-32
17094 Use only the first 32 floating-point registers.
17096 @item -mfpr-64
17097 @opindex mfpr-64
17099 Use all 64 floating-point registers.
17101 @item -mhard-float
17102 @opindex mhard-float
17104 Use hardware instructions for floating-point operations.
17106 @item -msoft-float
17107 @opindex msoft-float
17109 Use library routines for floating-point operations.
17111 @item -malloc-cc
17112 @opindex malloc-cc
17114 Dynamically allocate condition code registers.
17116 @item -mfixed-cc
17117 @opindex mfixed-cc
17119 Do not try to dynamically allocate condition code registers, only
17120 use @code{icc0} and @code{fcc0}.
17122 @item -mdword
17123 @opindex mdword
17125 Change ABI to use double word insns.
17127 @item -mno-dword
17128 @opindex mno-dword
17130 Do not use double word instructions.
17132 @item -mdouble
17133 @opindex mdouble
17135 Use floating-point double instructions.
17137 @item -mno-double
17138 @opindex mno-double
17140 Do not use floating-point double instructions.
17142 @item -mmedia
17143 @opindex mmedia
17145 Use media instructions.
17147 @item -mno-media
17148 @opindex mno-media
17150 Do not use media instructions.
17152 @item -mmuladd
17153 @opindex mmuladd
17155 Use multiply and add/subtract instructions.
17157 @item -mno-muladd
17158 @opindex mno-muladd
17160 Do not use multiply and add/subtract instructions.
17162 @item -mfdpic
17163 @opindex mfdpic
17165 Select the FDPIC ABI, which uses function descriptors to represent
17166 pointers to functions.  Without any PIC/PIE-related options, it
17167 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17168 assumes GOT entries and small data are within a 12-bit range from the
17169 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17170 are computed with 32 bits.
17171 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17173 @item -minline-plt
17174 @opindex minline-plt
17176 Enable inlining of PLT entries in function calls to functions that are
17177 not known to bind locally.  It has no effect without @option{-mfdpic}.
17178 It's enabled by default if optimizing for speed and compiling for
17179 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17180 optimization option such as @option{-O3} or above is present in the
17181 command line.
17183 @item -mTLS
17184 @opindex mTLS
17186 Assume a large TLS segment when generating thread-local code.
17188 @item -mtls
17189 @opindex mtls
17191 Do not assume a large TLS segment when generating thread-local code.
17193 @item -mgprel-ro
17194 @opindex mgprel-ro
17196 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17197 that is known to be in read-only sections.  It's enabled by default,
17198 except for @option{-fpic} or @option{-fpie}: even though it may help
17199 make the global offset table smaller, it trades 1 instruction for 4.
17200 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17201 one of which may be shared by multiple symbols, and it avoids the need
17202 for a GOT entry for the referenced symbol, so it's more likely to be a
17203 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17205 @item -multilib-library-pic
17206 @opindex multilib-library-pic
17208 Link with the (library, not FD) pic libraries.  It's implied by
17209 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17210 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17211 it explicitly.
17213 @item -mlinked-fp
17214 @opindex mlinked-fp
17216 Follow the EABI requirement of always creating a frame pointer whenever
17217 a stack frame is allocated.  This option is enabled by default and can
17218 be disabled with @option{-mno-linked-fp}.
17220 @item -mlong-calls
17221 @opindex mlong-calls
17223 Use indirect addressing to call functions outside the current
17224 compilation unit.  This allows the functions to be placed anywhere
17225 within the 32-bit address space.
17227 @item -malign-labels
17228 @opindex malign-labels
17230 Try to align labels to an 8-byte boundary by inserting NOPs into the
17231 previous packet.  This option only has an effect when VLIW packing
17232 is enabled.  It doesn't create new packets; it merely adds NOPs to
17233 existing ones.
17235 @item -mlibrary-pic
17236 @opindex mlibrary-pic
17238 Generate position-independent EABI code.
17240 @item -macc-4
17241 @opindex macc-4
17243 Use only the first four media accumulator registers.
17245 @item -macc-8
17246 @opindex macc-8
17248 Use all eight media accumulator registers.
17250 @item -mpack
17251 @opindex mpack
17253 Pack VLIW instructions.
17255 @item -mno-pack
17256 @opindex mno-pack
17258 Do not pack VLIW instructions.
17260 @item -mno-eflags
17261 @opindex mno-eflags
17263 Do not mark ABI switches in e_flags.
17265 @item -mcond-move
17266 @opindex mcond-move
17268 Enable the use of conditional-move instructions (default).
17270 This switch is mainly for debugging the compiler and will likely be removed
17271 in a future version.
17273 @item -mno-cond-move
17274 @opindex mno-cond-move
17276 Disable the use of conditional-move instructions.
17278 This switch is mainly for debugging the compiler and will likely be removed
17279 in a future version.
17281 @item -mscc
17282 @opindex mscc
17284 Enable the use of conditional set instructions (default).
17286 This switch is mainly for debugging the compiler and will likely be removed
17287 in a future version.
17289 @item -mno-scc
17290 @opindex mno-scc
17292 Disable the use of conditional set instructions.
17294 This switch is mainly for debugging the compiler and will likely be removed
17295 in a future version.
17297 @item -mcond-exec
17298 @opindex mcond-exec
17300 Enable the use of conditional execution (default).
17302 This switch is mainly for debugging the compiler and will likely be removed
17303 in a future version.
17305 @item -mno-cond-exec
17306 @opindex mno-cond-exec
17308 Disable the use of conditional execution.
17310 This switch is mainly for debugging the compiler and will likely be removed
17311 in a future version.
17313 @item -mvliw-branch
17314 @opindex mvliw-branch
17316 Run a pass to pack branches into VLIW instructions (default).
17318 This switch is mainly for debugging the compiler and will likely be removed
17319 in a future version.
17321 @item -mno-vliw-branch
17322 @opindex mno-vliw-branch
17324 Do not run a pass to pack branches into VLIW instructions.
17326 This switch is mainly for debugging the compiler and will likely be removed
17327 in a future version.
17329 @item -mmulti-cond-exec
17330 @opindex mmulti-cond-exec
17332 Enable optimization of @code{&&} and @code{||} in conditional execution
17333 (default).
17335 This switch is mainly for debugging the compiler and will likely be removed
17336 in a future version.
17338 @item -mno-multi-cond-exec
17339 @opindex mno-multi-cond-exec
17341 Disable optimization of @code{&&} and @code{||} in conditional execution.
17343 This switch is mainly for debugging the compiler and will likely be removed
17344 in a future version.
17346 @item -mnested-cond-exec
17347 @opindex mnested-cond-exec
17349 Enable nested conditional execution optimizations (default).
17351 This switch is mainly for debugging the compiler and will likely be removed
17352 in a future version.
17354 @item -mno-nested-cond-exec
17355 @opindex mno-nested-cond-exec
17357 Disable nested conditional execution optimizations.
17359 This switch is mainly for debugging the compiler and will likely be removed
17360 in a future version.
17362 @item -moptimize-membar
17363 @opindex moptimize-membar
17365 This switch removes redundant @code{membar} instructions from the
17366 compiler-generated code.  It is enabled by default.
17368 @item -mno-optimize-membar
17369 @opindex mno-optimize-membar
17371 This switch disables the automatic removal of redundant @code{membar}
17372 instructions from the generated code.
17374 @item -mtomcat-stats
17375 @opindex mtomcat-stats
17377 Cause gas to print out tomcat statistics.
17379 @item -mcpu=@var{cpu}
17380 @opindex mcpu
17382 Select the processor type for which to generate code.  Possible values are
17383 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17384 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17386 @end table
17388 @node GNU/Linux Options
17389 @subsection GNU/Linux Options
17391 These @samp{-m} options are defined for GNU/Linux targets:
17393 @table @gcctabopt
17394 @item -mglibc
17395 @opindex mglibc
17396 Use the GNU C library.  This is the default except
17397 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17398 @samp{*-*-linux-*android*} targets.
17400 @item -muclibc
17401 @opindex muclibc
17402 Use uClibc C library.  This is the default on
17403 @samp{*-*-linux-*uclibc*} targets.
17405 @item -mmusl
17406 @opindex mmusl
17407 Use the musl C library.  This is the default on
17408 @samp{*-*-linux-*musl*} targets.
17410 @item -mbionic
17411 @opindex mbionic
17412 Use Bionic C library.  This is the default on
17413 @samp{*-*-linux-*android*} targets.
17415 @item -mandroid
17416 @opindex mandroid
17417 Compile code compatible with Android platform.  This is the default on
17418 @samp{*-*-linux-*android*} targets.
17420 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17421 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17422 this option makes the GCC driver pass Android-specific options to the linker.
17423 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17424 to be defined.
17426 @item -tno-android-cc
17427 @opindex tno-android-cc
17428 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17429 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17430 @option{-fno-rtti} by default.
17432 @item -tno-android-ld
17433 @opindex tno-android-ld
17434 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17435 linking options to the linker.
17437 @end table
17439 @node H8/300 Options
17440 @subsection H8/300 Options
17442 These @samp{-m} options are defined for the H8/300 implementations:
17444 @table @gcctabopt
17445 @item -mrelax
17446 @opindex mrelax
17447 Shorten some address references at link time, when possible; uses the
17448 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17449 ld, Using ld}, for a fuller description.
17451 @item -mh
17452 @opindex mh
17453 Generate code for the H8/300H@.
17455 @item -ms
17456 @opindex ms
17457 Generate code for the H8S@.
17459 @item -mn
17460 @opindex mn
17461 Generate code for the H8S and H8/300H in the normal mode.  This switch
17462 must be used either with @option{-mh} or @option{-ms}.
17464 @item -ms2600
17465 @opindex ms2600
17466 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17468 @item -mexr
17469 @opindex mexr
17470 Extended registers are stored on stack before execution of function
17471 with monitor attribute. Default option is @option{-mexr}.
17472 This option is valid only for H8S targets.
17474 @item -mno-exr
17475 @opindex mno-exr
17476 Extended registers are not stored on stack before execution of function 
17477 with monitor attribute. Default option is @option{-mno-exr}. 
17478 This option is valid only for H8S targets.
17480 @item -mint32
17481 @opindex mint32
17482 Make @code{int} data 32 bits by default.
17484 @item -malign-300
17485 @opindex malign-300
17486 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17487 The default for the H8/300H and H8S is to align longs and floats on
17488 4-byte boundaries.
17489 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17490 This option has no effect on the H8/300.
17491 @end table
17493 @node HPPA Options
17494 @subsection HPPA Options
17495 @cindex HPPA Options
17497 These @samp{-m} options are defined for the HPPA family of computers:
17499 @table @gcctabopt
17500 @item -march=@var{architecture-type}
17501 @opindex march
17502 Generate code for the specified architecture.  The choices for
17503 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17504 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17505 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17506 architecture option for your machine.  Code compiled for lower numbered
17507 architectures runs on higher numbered architectures, but not the
17508 other way around.
17510 @item -mpa-risc-1-0
17511 @itemx -mpa-risc-1-1
17512 @itemx -mpa-risc-2-0
17513 @opindex mpa-risc-1-0
17514 @opindex mpa-risc-1-1
17515 @opindex mpa-risc-2-0
17516 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17518 @item -mcaller-copies
17519 @opindex mcaller-copies
17520 The caller copies function arguments passed by hidden reference.  This
17521 option should be used with care as it is not compatible with the default
17522 32-bit runtime.  However, only aggregates larger than eight bytes are
17523 passed by hidden reference and the option provides better compatibility
17524 with OpenMP.
17526 @item -mjump-in-delay
17527 @opindex mjump-in-delay
17528 This option is ignored and provided for compatibility purposes only.
17530 @item -mdisable-fpregs
17531 @opindex mdisable-fpregs
17532 Prevent floating-point registers from being used in any manner.  This is
17533 necessary for compiling kernels that perform lazy context switching of
17534 floating-point registers.  If you use this option and attempt to perform
17535 floating-point operations, the compiler aborts.
17537 @item -mdisable-indexing
17538 @opindex mdisable-indexing
17539 Prevent the compiler from using indexing address modes.  This avoids some
17540 rather obscure problems when compiling MIG generated code under MACH@.
17542 @item -mno-space-regs
17543 @opindex mno-space-regs
17544 Generate code that assumes the target has no space registers.  This allows
17545 GCC to generate faster indirect calls and use unscaled index address modes.
17547 Such code is suitable for level 0 PA systems and kernels.
17549 @item -mfast-indirect-calls
17550 @opindex mfast-indirect-calls
17551 Generate code that assumes calls never cross space boundaries.  This
17552 allows GCC to emit code that performs faster indirect calls.
17554 This option does not work in the presence of shared libraries or nested
17555 functions.
17557 @item -mfixed-range=@var{register-range}
17558 @opindex mfixed-range
17559 Generate code treating the given register range as fixed registers.
17560 A fixed register is one that the register allocator cannot use.  This is
17561 useful when compiling kernel code.  A register range is specified as
17562 two registers separated by a dash.  Multiple register ranges can be
17563 specified separated by a comma.
17565 @item -mlong-load-store
17566 @opindex mlong-load-store
17567 Generate 3-instruction load and store sequences as sometimes required by
17568 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17569 the HP compilers.
17571 @item -mportable-runtime
17572 @opindex mportable-runtime
17573 Use the portable calling conventions proposed by HP for ELF systems.
17575 @item -mgas
17576 @opindex mgas
17577 Enable the use of assembler directives only GAS understands.
17579 @item -mschedule=@var{cpu-type}
17580 @opindex mschedule
17581 Schedule code according to the constraints for the machine type
17582 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17583 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17584 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17585 proper scheduling option for your machine.  The default scheduling is
17586 @samp{8000}.
17588 @item -mlinker-opt
17589 @opindex mlinker-opt
17590 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17591 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17592 linkers in which they give bogus error messages when linking some programs.
17594 @item -msoft-float
17595 @opindex msoft-float
17596 Generate output containing library calls for floating point.
17597 @strong{Warning:} the requisite libraries are not available for all HPPA
17598 targets.  Normally the facilities of the machine's usual C compiler are
17599 used, but this cannot be done directly in cross-compilation.  You must make
17600 your own arrangements to provide suitable library functions for
17601 cross-compilation.
17603 @option{-msoft-float} changes the calling convention in the output file;
17604 therefore, it is only useful if you compile @emph{all} of a program with
17605 this option.  In particular, you need to compile @file{libgcc.a}, the
17606 library that comes with GCC, with @option{-msoft-float} in order for
17607 this to work.
17609 @item -msio
17610 @opindex msio
17611 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17612 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17613 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17614 options are available under HP-UX and HI-UX@.
17616 @item -mgnu-ld
17617 @opindex mgnu-ld
17618 Use options specific to GNU @command{ld}.
17619 This passes @option{-shared} to @command{ld} when
17620 building a shared library.  It is the default when GCC is configured,
17621 explicitly or implicitly, with the GNU linker.  This option does not
17622 affect which @command{ld} is called; it only changes what parameters
17623 are passed to that @command{ld}.
17624 The @command{ld} that is called is determined by the
17625 @option{--with-ld} configure option, GCC's program search path, and
17626 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17627 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17628 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17630 @item -mhp-ld
17631 @opindex mhp-ld
17632 Use options specific to HP @command{ld}.
17633 This passes @option{-b} to @command{ld} when building
17634 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17635 links.  It is the default when GCC is configured, explicitly or
17636 implicitly, with the HP linker.  This option does not affect
17637 which @command{ld} is called; it only changes what parameters are passed to that
17638 @command{ld}.
17639 The @command{ld} that is called is determined by the @option{--with-ld}
17640 configure option, GCC's program search path, and finally by the user's
17641 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17642 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17643 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17645 @item -mlong-calls
17646 @opindex mno-long-calls
17647 Generate code that uses long call sequences.  This ensures that a call
17648 is always able to reach linker generated stubs.  The default is to generate
17649 long calls only when the distance from the call site to the beginning
17650 of the function or translation unit, as the case may be, exceeds a
17651 predefined limit set by the branch type being used.  The limits for
17652 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17653 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17654 240,000 bytes.
17656 Distances are measured from the beginning of functions when using the
17657 @option{-ffunction-sections} option, or when using the @option{-mgas}
17658 and @option{-mno-portable-runtime} options together under HP-UX with
17659 the SOM linker.
17661 It is normally not desirable to use this option as it degrades
17662 performance.  However, it may be useful in large applications,
17663 particularly when partial linking is used to build the application.
17665 The types of long calls used depends on the capabilities of the
17666 assembler and linker, and the type of code being generated.  The
17667 impact on systems that support long absolute calls, and long pic
17668 symbol-difference or pc-relative calls should be relatively small.
17669 However, an indirect call is used on 32-bit ELF systems in pic code
17670 and it is quite long.
17672 @item -munix=@var{unix-std}
17673 @opindex march
17674 Generate compiler predefines and select a startfile for the specified
17675 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17676 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17677 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17678 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17679 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17680 and later.
17682 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17683 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17684 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17685 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17686 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17687 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17689 It is @emph{important} to note that this option changes the interfaces
17690 for various library routines.  It also affects the operational behavior
17691 of the C library.  Thus, @emph{extreme} care is needed in using this
17692 option.
17694 Library code that is intended to operate with more than one UNIX
17695 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17696 as appropriate.  Most GNU software doesn't provide this capability.
17698 @item -nolibdld
17699 @opindex nolibdld
17700 Suppress the generation of link options to search libdld.sl when the
17701 @option{-static} option is specified on HP-UX 10 and later.
17703 @item -static
17704 @opindex static
17705 The HP-UX implementation of setlocale in libc has a dependency on
17706 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17707 when the @option{-static} option is specified, special link options
17708 are needed to resolve this dependency.
17710 On HP-UX 10 and later, the GCC driver adds the necessary options to
17711 link with libdld.sl when the @option{-static} option is specified.
17712 This causes the resulting binary to be dynamic.  On the 64-bit port,
17713 the linkers generate dynamic binaries by default in any case.  The
17714 @option{-nolibdld} option can be used to prevent the GCC driver from
17715 adding these link options.
17717 @item -threads
17718 @opindex threads
17719 Add support for multithreading with the @dfn{dce thread} library
17720 under HP-UX@.  This option sets flags for both the preprocessor and
17721 linker.
17722 @end table
17724 @node IA-64 Options
17725 @subsection IA-64 Options
17726 @cindex IA-64 Options
17728 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17730 @table @gcctabopt
17731 @item -mbig-endian
17732 @opindex mbig-endian
17733 Generate code for a big-endian target.  This is the default for HP-UX@.
17735 @item -mlittle-endian
17736 @opindex mlittle-endian
17737 Generate code for a little-endian target.  This is the default for AIX5
17738 and GNU/Linux.
17740 @item -mgnu-as
17741 @itemx -mno-gnu-as
17742 @opindex mgnu-as
17743 @opindex mno-gnu-as
17744 Generate (or don't) code for the GNU assembler.  This is the default.
17745 @c Also, this is the default if the configure option @option{--with-gnu-as}
17746 @c is used.
17748 @item -mgnu-ld
17749 @itemx -mno-gnu-ld
17750 @opindex mgnu-ld
17751 @opindex mno-gnu-ld
17752 Generate (or don't) code for the GNU linker.  This is the default.
17753 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17754 @c is used.
17756 @item -mno-pic
17757 @opindex mno-pic
17758 Generate code that does not use a global pointer register.  The result
17759 is not position independent code, and violates the IA-64 ABI@.
17761 @item -mvolatile-asm-stop
17762 @itemx -mno-volatile-asm-stop
17763 @opindex mvolatile-asm-stop
17764 @opindex mno-volatile-asm-stop
17765 Generate (or don't) a stop bit immediately before and after volatile asm
17766 statements.
17768 @item -mregister-names
17769 @itemx -mno-register-names
17770 @opindex mregister-names
17771 @opindex mno-register-names
17772 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17773 the stacked registers.  This may make assembler output more readable.
17775 @item -mno-sdata
17776 @itemx -msdata
17777 @opindex mno-sdata
17778 @opindex msdata
17779 Disable (or enable) optimizations that use the small data section.  This may
17780 be useful for working around optimizer bugs.
17782 @item -mconstant-gp
17783 @opindex mconstant-gp
17784 Generate code that uses a single constant global pointer value.  This is
17785 useful when compiling kernel code.
17787 @item -mauto-pic
17788 @opindex mauto-pic
17789 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17790 This is useful when compiling firmware code.
17792 @item -minline-float-divide-min-latency
17793 @opindex minline-float-divide-min-latency
17794 Generate code for inline divides of floating-point values
17795 using the minimum latency algorithm.
17797 @item -minline-float-divide-max-throughput
17798 @opindex minline-float-divide-max-throughput
17799 Generate code for inline divides of floating-point values
17800 using the maximum throughput algorithm.
17802 @item -mno-inline-float-divide
17803 @opindex mno-inline-float-divide
17804 Do not generate inline code for divides of floating-point values.
17806 @item -minline-int-divide-min-latency
17807 @opindex minline-int-divide-min-latency
17808 Generate code for inline divides of integer values
17809 using the minimum latency algorithm.
17811 @item -minline-int-divide-max-throughput
17812 @opindex minline-int-divide-max-throughput
17813 Generate code for inline divides of integer values
17814 using the maximum throughput algorithm.
17816 @item -mno-inline-int-divide
17817 @opindex mno-inline-int-divide
17818 Do not generate inline code for divides of integer values.
17820 @item -minline-sqrt-min-latency
17821 @opindex minline-sqrt-min-latency
17822 Generate code for inline square roots
17823 using the minimum latency algorithm.
17825 @item -minline-sqrt-max-throughput
17826 @opindex minline-sqrt-max-throughput
17827 Generate code for inline square roots
17828 using the maximum throughput algorithm.
17830 @item -mno-inline-sqrt
17831 @opindex mno-inline-sqrt
17832 Do not generate inline code for @code{sqrt}.
17834 @item -mfused-madd
17835 @itemx -mno-fused-madd
17836 @opindex mfused-madd
17837 @opindex mno-fused-madd
17838 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17839 instructions.  The default is to use these instructions.
17841 @item -mno-dwarf2-asm
17842 @itemx -mdwarf2-asm
17843 @opindex mno-dwarf2-asm
17844 @opindex mdwarf2-asm
17845 Don't (or do) generate assembler code for the DWARF line number debugging
17846 info.  This may be useful when not using the GNU assembler.
17848 @item -mearly-stop-bits
17849 @itemx -mno-early-stop-bits
17850 @opindex mearly-stop-bits
17851 @opindex mno-early-stop-bits
17852 Allow stop bits to be placed earlier than immediately preceding the
17853 instruction that triggered the stop bit.  This can improve instruction
17854 scheduling, but does not always do so.
17856 @item -mfixed-range=@var{register-range}
17857 @opindex mfixed-range
17858 Generate code treating the given register range as fixed registers.
17859 A fixed register is one that the register allocator cannot use.  This is
17860 useful when compiling kernel code.  A register range is specified as
17861 two registers separated by a dash.  Multiple register ranges can be
17862 specified separated by a comma.
17864 @item -mtls-size=@var{tls-size}
17865 @opindex mtls-size
17866 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17869 @item -mtune=@var{cpu-type}
17870 @opindex mtune
17871 Tune the instruction scheduling for a particular CPU, Valid values are
17872 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17873 and @samp{mckinley}.
17875 @item -milp32
17876 @itemx -mlp64
17877 @opindex milp32
17878 @opindex mlp64
17879 Generate code for a 32-bit or 64-bit environment.
17880 The 32-bit environment sets int, long and pointer to 32 bits.
17881 The 64-bit environment sets int to 32 bits and long and pointer
17882 to 64 bits.  These are HP-UX specific flags.
17884 @item -mno-sched-br-data-spec
17885 @itemx -msched-br-data-spec
17886 @opindex mno-sched-br-data-spec
17887 @opindex msched-br-data-spec
17888 (Dis/En)able data speculative scheduling before reload.
17889 This results in generation of @code{ld.a} instructions and
17890 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17891 The default setting is disabled.
17893 @item -msched-ar-data-spec
17894 @itemx -mno-sched-ar-data-spec
17895 @opindex msched-ar-data-spec
17896 @opindex mno-sched-ar-data-spec
17897 (En/Dis)able data speculative scheduling after reload.
17898 This results in generation of @code{ld.a} instructions and
17899 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17900 The default setting is enabled.
17902 @item -mno-sched-control-spec
17903 @itemx -msched-control-spec
17904 @opindex mno-sched-control-spec
17905 @opindex msched-control-spec
17906 (Dis/En)able control speculative scheduling.  This feature is
17907 available only during region scheduling (i.e.@: before reload).
17908 This results in generation of the @code{ld.s} instructions and
17909 the corresponding check instructions @code{chk.s}.
17910 The default setting is disabled.
17912 @item -msched-br-in-data-spec
17913 @itemx -mno-sched-br-in-data-spec
17914 @opindex msched-br-in-data-spec
17915 @opindex mno-sched-br-in-data-spec
17916 (En/Dis)able speculative scheduling of the instructions that
17917 are dependent on the data speculative loads before reload.
17918 This is effective only with @option{-msched-br-data-spec} enabled.
17919 The default setting is enabled.
17921 @item -msched-ar-in-data-spec
17922 @itemx -mno-sched-ar-in-data-spec
17923 @opindex msched-ar-in-data-spec
17924 @opindex mno-sched-ar-in-data-spec
17925 (En/Dis)able speculative scheduling of the instructions that
17926 are dependent on the data speculative loads after reload.
17927 This is effective only with @option{-msched-ar-data-spec} enabled.
17928 The default setting is enabled.
17930 @item -msched-in-control-spec
17931 @itemx -mno-sched-in-control-spec
17932 @opindex msched-in-control-spec
17933 @opindex mno-sched-in-control-spec
17934 (En/Dis)able speculative scheduling of the instructions that
17935 are dependent on the control speculative loads.
17936 This is effective only with @option{-msched-control-spec} enabled.
17937 The default setting is enabled.
17939 @item -mno-sched-prefer-non-data-spec-insns
17940 @itemx -msched-prefer-non-data-spec-insns
17941 @opindex mno-sched-prefer-non-data-spec-insns
17942 @opindex msched-prefer-non-data-spec-insns
17943 If enabled, data-speculative instructions are chosen for schedule
17944 only if there are no other choices at the moment.  This makes
17945 the use of the data speculation much more conservative.
17946 The default setting is disabled.
17948 @item -mno-sched-prefer-non-control-spec-insns
17949 @itemx -msched-prefer-non-control-spec-insns
17950 @opindex mno-sched-prefer-non-control-spec-insns
17951 @opindex msched-prefer-non-control-spec-insns
17952 If enabled, control-speculative instructions are chosen for schedule
17953 only if there are no other choices at the moment.  This makes
17954 the use of the control speculation much more conservative.
17955 The default setting is disabled.
17957 @item -mno-sched-count-spec-in-critical-path
17958 @itemx -msched-count-spec-in-critical-path
17959 @opindex mno-sched-count-spec-in-critical-path
17960 @opindex msched-count-spec-in-critical-path
17961 If enabled, speculative dependencies are considered during
17962 computation of the instructions priorities.  This makes the use of the
17963 speculation a bit more conservative.
17964 The default setting is disabled.
17966 @item -msched-spec-ldc
17967 @opindex msched-spec-ldc
17968 Use a simple data speculation check.  This option is on by default.
17970 @item -msched-control-spec-ldc
17971 @opindex msched-spec-ldc
17972 Use a simple check for control speculation.  This option is on by default.
17974 @item -msched-stop-bits-after-every-cycle
17975 @opindex msched-stop-bits-after-every-cycle
17976 Place a stop bit after every cycle when scheduling.  This option is on
17977 by default.
17979 @item -msched-fp-mem-deps-zero-cost
17980 @opindex msched-fp-mem-deps-zero-cost
17981 Assume that floating-point stores and loads are not likely to cause a conflict
17982 when placed into the same instruction group.  This option is disabled by
17983 default.
17985 @item -msel-sched-dont-check-control-spec
17986 @opindex msel-sched-dont-check-control-spec
17987 Generate checks for control speculation in selective scheduling.
17988 This flag is disabled by default.
17990 @item -msched-max-memory-insns=@var{max-insns}
17991 @opindex msched-max-memory-insns
17992 Limit on the number of memory insns per instruction group, giving lower
17993 priority to subsequent memory insns attempting to schedule in the same
17994 instruction group. Frequently useful to prevent cache bank conflicts.
17995 The default value is 1.
17997 @item -msched-max-memory-insns-hard-limit
17998 @opindex msched-max-memory-insns-hard-limit
17999 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18000 disallowing more than that number in an instruction group.
18001 Otherwise, the limit is ``soft'', meaning that non-memory operations
18002 are preferred when the limit is reached, but memory operations may still
18003 be scheduled.
18005 @end table
18007 @node LM32 Options
18008 @subsection LM32 Options
18009 @cindex LM32 options
18011 These @option{-m} options are defined for the LatticeMico32 architecture:
18013 @table @gcctabopt
18014 @item -mbarrel-shift-enabled
18015 @opindex mbarrel-shift-enabled
18016 Enable barrel-shift instructions.
18018 @item -mdivide-enabled
18019 @opindex mdivide-enabled
18020 Enable divide and modulus instructions.
18022 @item -mmultiply-enabled
18023 @opindex multiply-enabled
18024 Enable multiply instructions.
18026 @item -msign-extend-enabled
18027 @opindex msign-extend-enabled
18028 Enable sign extend instructions.
18030 @item -muser-enabled
18031 @opindex muser-enabled
18032 Enable user-defined instructions.
18034 @end table
18036 @node M32C Options
18037 @subsection M32C Options
18038 @cindex M32C options
18040 @table @gcctabopt
18041 @item -mcpu=@var{name}
18042 @opindex mcpu=
18043 Select the CPU for which code is generated.  @var{name} may be one of
18044 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18045 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18046 the M32C/80 series.
18048 @item -msim
18049 @opindex msim
18050 Specifies that the program will be run on the simulator.  This causes
18051 an alternate runtime library to be linked in which supports, for
18052 example, file I/O@.  You must not use this option when generating
18053 programs that will run on real hardware; you must provide your own
18054 runtime library for whatever I/O functions are needed.
18056 @item -memregs=@var{number}
18057 @opindex memregs=
18058 Specifies the number of memory-based pseudo-registers GCC uses
18059 during code generation.  These pseudo-registers are used like real
18060 registers, so there is a tradeoff between GCC's ability to fit the
18061 code into available registers, and the performance penalty of using
18062 memory instead of registers.  Note that all modules in a program must
18063 be compiled with the same value for this option.  Because of that, you
18064 must not use this option with GCC's default runtime libraries.
18066 @end table
18068 @node M32R/D Options
18069 @subsection M32R/D Options
18070 @cindex M32R/D options
18072 These @option{-m} options are defined for Renesas M32R/D architectures:
18074 @table @gcctabopt
18075 @item -m32r2
18076 @opindex m32r2
18077 Generate code for the M32R/2@.
18079 @item -m32rx
18080 @opindex m32rx
18081 Generate code for the M32R/X@.
18083 @item -m32r
18084 @opindex m32r
18085 Generate code for the M32R@.  This is the default.
18087 @item -mmodel=small
18088 @opindex mmodel=small
18089 Assume all objects live in the lower 16MB of memory (so that their addresses
18090 can be loaded with the @code{ld24} instruction), and assume all subroutines
18091 are reachable with the @code{bl} instruction.
18092 This is the default.
18094 The addressability of a particular object can be set with the
18095 @code{model} attribute.
18097 @item -mmodel=medium
18098 @opindex mmodel=medium
18099 Assume objects may be anywhere in the 32-bit address space (the compiler
18100 generates @code{seth/add3} instructions to load their addresses), and
18101 assume all subroutines are reachable with the @code{bl} instruction.
18103 @item -mmodel=large
18104 @opindex mmodel=large
18105 Assume objects may be anywhere in the 32-bit address space (the compiler
18106 generates @code{seth/add3} instructions to load their addresses), and
18107 assume subroutines may not be reachable with the @code{bl} instruction
18108 (the compiler generates the much slower @code{seth/add3/jl}
18109 instruction sequence).
18111 @item -msdata=none
18112 @opindex msdata=none
18113 Disable use of the small data area.  Variables are put into
18114 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18115 @code{section} attribute has been specified).
18116 This is the default.
18118 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18119 Objects may be explicitly put in the small data area with the
18120 @code{section} attribute using one of these sections.
18122 @item -msdata=sdata
18123 @opindex msdata=sdata
18124 Put small global and static data in the small data area, but do not
18125 generate special code to reference them.
18127 @item -msdata=use
18128 @opindex msdata=use
18129 Put small global and static data in the small data area, and generate
18130 special instructions to reference them.
18132 @item -G @var{num}
18133 @opindex G
18134 @cindex smaller data references
18135 Put global and static objects less than or equal to @var{num} bytes
18136 into the small data or BSS sections instead of the normal data or BSS
18137 sections.  The default value of @var{num} is 8.
18138 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18139 for this option to have any effect.
18141 All modules should be compiled with the same @option{-G @var{num}} value.
18142 Compiling with different values of @var{num} may or may not work; if it
18143 doesn't the linker gives an error message---incorrect code is not
18144 generated.
18146 @item -mdebug
18147 @opindex mdebug
18148 Makes the M32R-specific code in the compiler display some statistics
18149 that might help in debugging programs.
18151 @item -malign-loops
18152 @opindex malign-loops
18153 Align all loops to a 32-byte boundary.
18155 @item -mno-align-loops
18156 @opindex mno-align-loops
18157 Do not enforce a 32-byte alignment for loops.  This is the default.
18159 @item -missue-rate=@var{number}
18160 @opindex missue-rate=@var{number}
18161 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18162 or 2.
18164 @item -mbranch-cost=@var{number}
18165 @opindex mbranch-cost=@var{number}
18166 @var{number} can only be 1 or 2.  If it is 1 then branches are
18167 preferred over conditional code, if it is 2, then the opposite applies.
18169 @item -mflush-trap=@var{number}
18170 @opindex mflush-trap=@var{number}
18171 Specifies the trap number to use to flush the cache.  The default is
18172 12.  Valid numbers are between 0 and 15 inclusive.
18174 @item -mno-flush-trap
18175 @opindex mno-flush-trap
18176 Specifies that the cache cannot be flushed by using a trap.
18178 @item -mflush-func=@var{name}
18179 @opindex mflush-func=@var{name}
18180 Specifies the name of the operating system function to call to flush
18181 the cache.  The default is @samp{_flush_cache}, but a function call
18182 is only used if a trap is not available.
18184 @item -mno-flush-func
18185 @opindex mno-flush-func
18186 Indicates that there is no OS function for flushing the cache.
18188 @end table
18190 @node M680x0 Options
18191 @subsection M680x0 Options
18192 @cindex M680x0 options
18194 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18195 The default settings depend on which architecture was selected when
18196 the compiler was configured; the defaults for the most common choices
18197 are given below.
18199 @table @gcctabopt
18200 @item -march=@var{arch}
18201 @opindex march
18202 Generate code for a specific M680x0 or ColdFire instruction set
18203 architecture.  Permissible values of @var{arch} for M680x0
18204 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18205 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18206 architectures are selected according to Freescale's ISA classification
18207 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18208 @samp{isab} and @samp{isac}.
18210 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18211 code for a ColdFire target.  The @var{arch} in this macro is one of the
18212 @option{-march} arguments given above.
18214 When used together, @option{-march} and @option{-mtune} select code
18215 that runs on a family of similar processors but that is optimized
18216 for a particular microarchitecture.
18218 @item -mcpu=@var{cpu}
18219 @opindex mcpu
18220 Generate code for a specific M680x0 or ColdFire processor.
18221 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18222 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18223 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18224 below, which also classifies the CPUs into families:
18226 @multitable @columnfractions 0.20 0.80
18227 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18228 @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}
18229 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18230 @item @samp{5206e} @tab @samp{5206e}
18231 @item @samp{5208} @tab @samp{5207} @samp{5208}
18232 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18233 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18234 @item @samp{5216} @tab @samp{5214} @samp{5216}
18235 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18236 @item @samp{5225} @tab @samp{5224} @samp{5225}
18237 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18238 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18239 @item @samp{5249} @tab @samp{5249}
18240 @item @samp{5250} @tab @samp{5250}
18241 @item @samp{5271} @tab @samp{5270} @samp{5271}
18242 @item @samp{5272} @tab @samp{5272}
18243 @item @samp{5275} @tab @samp{5274} @samp{5275}
18244 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18245 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18246 @item @samp{5307} @tab @samp{5307}
18247 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18248 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18249 @item @samp{5407} @tab @samp{5407}
18250 @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}
18251 @end multitable
18253 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18254 @var{arch} is compatible with @var{cpu}.  Other combinations of
18255 @option{-mcpu} and @option{-march} are rejected.
18257 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18258 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18259 where the value of @var{family} is given by the table above.
18261 @item -mtune=@var{tune}
18262 @opindex mtune
18263 Tune the code for a particular microarchitecture within the
18264 constraints set by @option{-march} and @option{-mcpu}.
18265 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18266 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18267 and @samp{cpu32}.  The ColdFire microarchitectures
18268 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18270 You can also use @option{-mtune=68020-40} for code that needs
18271 to run relatively well on 68020, 68030 and 68040 targets.
18272 @option{-mtune=68020-60} is similar but includes 68060 targets
18273 as well.  These two options select the same tuning decisions as
18274 @option{-m68020-40} and @option{-m68020-60} respectively.
18276 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18277 when tuning for 680x0 architecture @var{arch}.  It also defines
18278 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18279 option is used.  If GCC is tuning for a range of architectures,
18280 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18281 it defines the macros for every architecture in the range.
18283 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18284 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18285 of the arguments given above.
18287 @item -m68000
18288 @itemx -mc68000
18289 @opindex m68000
18290 @opindex mc68000
18291 Generate output for a 68000.  This is the default
18292 when the compiler is configured for 68000-based systems.
18293 It is equivalent to @option{-march=68000}.
18295 Use this option for microcontrollers with a 68000 or EC000 core,
18296 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18298 @item -m68010
18299 @opindex m68010
18300 Generate output for a 68010.  This is the default
18301 when the compiler is configured for 68010-based systems.
18302 It is equivalent to @option{-march=68010}.
18304 @item -m68020
18305 @itemx -mc68020
18306 @opindex m68020
18307 @opindex mc68020
18308 Generate output for a 68020.  This is the default
18309 when the compiler is configured for 68020-based systems.
18310 It is equivalent to @option{-march=68020}.
18312 @item -m68030
18313 @opindex m68030
18314 Generate output for a 68030.  This is the default when the compiler is
18315 configured for 68030-based systems.  It is equivalent to
18316 @option{-march=68030}.
18318 @item -m68040
18319 @opindex m68040
18320 Generate output for a 68040.  This is the default when the compiler is
18321 configured for 68040-based systems.  It is equivalent to
18322 @option{-march=68040}.
18324 This option inhibits the use of 68881/68882 instructions that have to be
18325 emulated by software on the 68040.  Use this option if your 68040 does not
18326 have code to emulate those instructions.
18328 @item -m68060
18329 @opindex m68060
18330 Generate output for a 68060.  This is the default when the compiler is
18331 configured for 68060-based systems.  It is equivalent to
18332 @option{-march=68060}.
18334 This option inhibits the use of 68020 and 68881/68882 instructions that
18335 have to be emulated by software on the 68060.  Use this option if your 68060
18336 does not have code to emulate those instructions.
18338 @item -mcpu32
18339 @opindex mcpu32
18340 Generate output for a CPU32.  This is the default
18341 when the compiler is configured for CPU32-based systems.
18342 It is equivalent to @option{-march=cpu32}.
18344 Use this option for microcontrollers with a
18345 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18346 68336, 68340, 68341, 68349 and 68360.
18348 @item -m5200
18349 @opindex m5200
18350 Generate output for a 520X ColdFire CPU@.  This is the default
18351 when the compiler is configured for 520X-based systems.
18352 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18353 in favor of that option.
18355 Use this option for microcontroller with a 5200 core, including
18356 the MCF5202, MCF5203, MCF5204 and MCF5206.
18358 @item -m5206e
18359 @opindex m5206e
18360 Generate output for a 5206e ColdFire CPU@.  The option is now
18361 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18363 @item -m528x
18364 @opindex m528x
18365 Generate output for a member of the ColdFire 528X family.
18366 The option is now deprecated in favor of the equivalent
18367 @option{-mcpu=528x}.
18369 @item -m5307
18370 @opindex m5307
18371 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18372 in favor of the equivalent @option{-mcpu=5307}.
18374 @item -m5407
18375 @opindex m5407
18376 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18377 in favor of the equivalent @option{-mcpu=5407}.
18379 @item -mcfv4e
18380 @opindex mcfv4e
18381 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18382 This includes use of hardware floating-point instructions.
18383 The option is equivalent to @option{-mcpu=547x}, and is now
18384 deprecated in favor of that option.
18386 @item -m68020-40
18387 @opindex m68020-40
18388 Generate output for a 68040, without using any of the new instructions.
18389 This results in code that can run relatively efficiently on either a
18390 68020/68881 or a 68030 or a 68040.  The generated code does use the
18391 68881 instructions that are emulated on the 68040.
18393 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18395 @item -m68020-60
18396 @opindex m68020-60
18397 Generate output for a 68060, without using any of the new instructions.
18398 This results in code that can run relatively efficiently on either a
18399 68020/68881 or a 68030 or a 68040.  The generated code does use the
18400 68881 instructions that are emulated on the 68060.
18402 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18404 @item -mhard-float
18405 @itemx -m68881
18406 @opindex mhard-float
18407 @opindex m68881
18408 Generate floating-point instructions.  This is the default for 68020
18409 and above, and for ColdFire devices that have an FPU@.  It defines the
18410 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18411 on ColdFire targets.
18413 @item -msoft-float
18414 @opindex msoft-float
18415 Do not generate floating-point instructions; use library calls instead.
18416 This is the default for 68000, 68010, and 68832 targets.  It is also
18417 the default for ColdFire devices that have no FPU.
18419 @item -mdiv
18420 @itemx -mno-div
18421 @opindex mdiv
18422 @opindex mno-div
18423 Generate (do not generate) ColdFire hardware divide and remainder
18424 instructions.  If @option{-march} is used without @option{-mcpu},
18425 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18426 architectures.  Otherwise, the default is taken from the target CPU
18427 (either the default CPU, or the one specified by @option{-mcpu}).  For
18428 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18429 @option{-mcpu=5206e}.
18431 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18433 @item -mshort
18434 @opindex mshort
18435 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18436 Additionally, parameters passed on the stack are also aligned to a
18437 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18439 @item -mno-short
18440 @opindex mno-short
18441 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18443 @item -mnobitfield
18444 @itemx -mno-bitfield
18445 @opindex mnobitfield
18446 @opindex mno-bitfield
18447 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18448 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18450 @item -mbitfield
18451 @opindex mbitfield
18452 Do use the bit-field instructions.  The @option{-m68020} option implies
18453 @option{-mbitfield}.  This is the default if you use a configuration
18454 designed for a 68020.
18456 @item -mrtd
18457 @opindex mrtd
18458 Use a different function-calling convention, in which functions
18459 that take a fixed number of arguments return with the @code{rtd}
18460 instruction, which pops their arguments while returning.  This
18461 saves one instruction in the caller since there is no need to pop
18462 the arguments there.
18464 This calling convention is incompatible with the one normally
18465 used on Unix, so you cannot use it if you need to call libraries
18466 compiled with the Unix compiler.
18468 Also, you must provide function prototypes for all functions that
18469 take variable numbers of arguments (including @code{printf});
18470 otherwise incorrect code is generated for calls to those
18471 functions.
18473 In addition, seriously incorrect code results if you call a
18474 function with too many arguments.  (Normally, extra arguments are
18475 harmlessly ignored.)
18477 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18478 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18480 @item -mno-rtd
18481 @opindex mno-rtd
18482 Do not use the calling conventions selected by @option{-mrtd}.
18483 This is the default.
18485 @item -malign-int
18486 @itemx -mno-align-int
18487 @opindex malign-int
18488 @opindex mno-align-int
18489 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18490 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18491 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18492 Aligning variables on 32-bit boundaries produces code that runs somewhat
18493 faster on processors with 32-bit busses at the expense of more memory.
18495 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18496 aligns structures containing the above types differently than
18497 most published application binary interface specifications for the m68k.
18499 @item -mpcrel
18500 @opindex mpcrel
18501 Use the pc-relative addressing mode of the 68000 directly, instead of
18502 using a global offset table.  At present, this option implies @option{-fpic},
18503 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18504 not presently supported with @option{-mpcrel}, though this could be supported for
18505 68020 and higher processors.
18507 @item -mno-strict-align
18508 @itemx -mstrict-align
18509 @opindex mno-strict-align
18510 @opindex mstrict-align
18511 Do not (do) assume that unaligned memory references are handled by
18512 the system.
18514 @item -msep-data
18515 Generate code that allows the data segment to be located in a different
18516 area of memory from the text segment.  This allows for execute-in-place in
18517 an environment without virtual memory management.  This option implies
18518 @option{-fPIC}.
18520 @item -mno-sep-data
18521 Generate code that assumes that the data segment follows the text segment.
18522 This is the default.
18524 @item -mid-shared-library
18525 Generate code that supports shared libraries via the library ID method.
18526 This allows for execute-in-place and shared libraries in an environment
18527 without virtual memory management.  This option implies @option{-fPIC}.
18529 @item -mno-id-shared-library
18530 Generate code that doesn't assume ID-based shared libraries are being used.
18531 This is the default.
18533 @item -mshared-library-id=n
18534 Specifies the identification number of the ID-based shared library being
18535 compiled.  Specifying a value of 0 generates more compact code; specifying
18536 other values forces the allocation of that number to the current
18537 library, but is no more space- or time-efficient than omitting this option.
18539 @item -mxgot
18540 @itemx -mno-xgot
18541 @opindex mxgot
18542 @opindex mno-xgot
18543 When generating position-independent code for ColdFire, generate code
18544 that works if the GOT has more than 8192 entries.  This code is
18545 larger and slower than code generated without this option.  On M680x0
18546 processors, this option is not needed; @option{-fPIC} suffices.
18548 GCC normally uses a single instruction to load values from the GOT@.
18549 While this is relatively efficient, it only works if the GOT
18550 is smaller than about 64k.  Anything larger causes the linker
18551 to report an error such as:
18553 @cindex relocation truncated to fit (ColdFire)
18554 @smallexample
18555 relocation truncated to fit: R_68K_GOT16O foobar
18556 @end smallexample
18558 If this happens, you should recompile your code with @option{-mxgot}.
18559 It should then work with very large GOTs.  However, code generated with
18560 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18561 the value of a global symbol.
18563 Note that some linkers, including newer versions of the GNU linker,
18564 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18565 you should only need to use @option{-mxgot} when compiling a single
18566 object file that accesses more than 8192 GOT entries.  Very few do.
18568 These options have no effect unless GCC is generating
18569 position-independent code.
18571 @item -mlong-jump-table-offsets
18572 @opindex mlong-jump-table-offsets
18573 Use 32-bit offsets in @code{switch} tables.  The default is to use
18574 16-bit offsets.
18576 @end table
18578 @node MCore Options
18579 @subsection MCore Options
18580 @cindex MCore options
18582 These are the @samp{-m} options defined for the Motorola M*Core
18583 processors.
18585 @table @gcctabopt
18587 @item -mhardlit
18588 @itemx -mno-hardlit
18589 @opindex mhardlit
18590 @opindex mno-hardlit
18591 Inline constants into the code stream if it can be done in two
18592 instructions or less.
18594 @item -mdiv
18595 @itemx -mno-div
18596 @opindex mdiv
18597 @opindex mno-div
18598 Use the divide instruction.  (Enabled by default).
18600 @item -mrelax-immediate
18601 @itemx -mno-relax-immediate
18602 @opindex mrelax-immediate
18603 @opindex mno-relax-immediate
18604 Allow arbitrary-sized immediates in bit operations.
18606 @item -mwide-bitfields
18607 @itemx -mno-wide-bitfields
18608 @opindex mwide-bitfields
18609 @opindex mno-wide-bitfields
18610 Always treat bit-fields as @code{int}-sized.
18612 @item -m4byte-functions
18613 @itemx -mno-4byte-functions
18614 @opindex m4byte-functions
18615 @opindex mno-4byte-functions
18616 Force all functions to be aligned to a 4-byte boundary.
18618 @item -mcallgraph-data
18619 @itemx -mno-callgraph-data
18620 @opindex mcallgraph-data
18621 @opindex mno-callgraph-data
18622 Emit callgraph information.
18624 @item -mslow-bytes
18625 @itemx -mno-slow-bytes
18626 @opindex mslow-bytes
18627 @opindex mno-slow-bytes
18628 Prefer word access when reading byte quantities.
18630 @item -mlittle-endian
18631 @itemx -mbig-endian
18632 @opindex mlittle-endian
18633 @opindex mbig-endian
18634 Generate code for a little-endian target.
18636 @item -m210
18637 @itemx -m340
18638 @opindex m210
18639 @opindex m340
18640 Generate code for the 210 processor.
18642 @item -mno-lsim
18643 @opindex mno-lsim
18644 Assume that runtime support has been provided and so omit the
18645 simulator library (@file{libsim.a)} from the linker command line.
18647 @item -mstack-increment=@var{size}
18648 @opindex mstack-increment
18649 Set the maximum amount for a single stack increment operation.  Large
18650 values can increase the speed of programs that contain functions
18651 that need a large amount of stack space, but they can also trigger a
18652 segmentation fault if the stack is extended too much.  The default
18653 value is 0x1000.
18655 @end table
18657 @node MeP Options
18658 @subsection MeP Options
18659 @cindex MeP options
18661 @table @gcctabopt
18663 @item -mabsdiff
18664 @opindex mabsdiff
18665 Enables the @code{abs} instruction, which is the absolute difference
18666 between two registers.
18668 @item -mall-opts
18669 @opindex mall-opts
18670 Enables all the optional instructions---average, multiply, divide, bit
18671 operations, leading zero, absolute difference, min/max, clip, and
18672 saturation.
18675 @item -maverage
18676 @opindex maverage
18677 Enables the @code{ave} instruction, which computes the average of two
18678 registers.
18680 @item -mbased=@var{n}
18681 @opindex mbased=
18682 Variables of size @var{n} bytes or smaller are placed in the
18683 @code{.based} section by default.  Based variables use the @code{$tp}
18684 register as a base register, and there is a 128-byte limit to the
18685 @code{.based} section.
18687 @item -mbitops
18688 @opindex mbitops
18689 Enables the bit operation instructions---bit test (@code{btstm}), set
18690 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18691 test-and-set (@code{tas}).
18693 @item -mc=@var{name}
18694 @opindex mc=
18695 Selects which section constant data is placed in.  @var{name} may
18696 be @samp{tiny}, @samp{near}, or @samp{far}.
18698 @item -mclip
18699 @opindex mclip
18700 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18701 useful unless you also provide @option{-mminmax}.
18703 @item -mconfig=@var{name}
18704 @opindex mconfig=
18705 Selects one of the built-in core configurations.  Each MeP chip has
18706 one or more modules in it; each module has a core CPU and a variety of
18707 coprocessors, optional instructions, and peripherals.  The
18708 @code{MeP-Integrator} tool, not part of GCC, provides these
18709 configurations through this option; using this option is the same as
18710 using all the corresponding command-line options.  The default
18711 configuration is @samp{default}.
18713 @item -mcop
18714 @opindex mcop
18715 Enables the coprocessor instructions.  By default, this is a 32-bit
18716 coprocessor.  Note that the coprocessor is normally enabled via the
18717 @option{-mconfig=} option.
18719 @item -mcop32
18720 @opindex mcop32
18721 Enables the 32-bit coprocessor's instructions.
18723 @item -mcop64
18724 @opindex mcop64
18725 Enables the 64-bit coprocessor's instructions.
18727 @item -mivc2
18728 @opindex mivc2
18729 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18731 @item -mdc
18732 @opindex mdc
18733 Causes constant variables to be placed in the @code{.near} section.
18735 @item -mdiv
18736 @opindex mdiv
18737 Enables the @code{div} and @code{divu} instructions.
18739 @item -meb
18740 @opindex meb
18741 Generate big-endian code.
18743 @item -mel
18744 @opindex mel
18745 Generate little-endian code.
18747 @item -mio-volatile
18748 @opindex mio-volatile
18749 Tells the compiler that any variable marked with the @code{io}
18750 attribute is to be considered volatile.
18752 @item -ml
18753 @opindex ml
18754 Causes variables to be assigned to the @code{.far} section by default.
18756 @item -mleadz
18757 @opindex mleadz
18758 Enables the @code{leadz} (leading zero) instruction.
18760 @item -mm
18761 @opindex mm
18762 Causes variables to be assigned to the @code{.near} section by default.
18764 @item -mminmax
18765 @opindex mminmax
18766 Enables the @code{min} and @code{max} instructions.
18768 @item -mmult
18769 @opindex mmult
18770 Enables the multiplication and multiply-accumulate instructions.
18772 @item -mno-opts
18773 @opindex mno-opts
18774 Disables all the optional instructions enabled by @option{-mall-opts}.
18776 @item -mrepeat
18777 @opindex mrepeat
18778 Enables the @code{repeat} and @code{erepeat} instructions, used for
18779 low-overhead looping.
18781 @item -ms
18782 @opindex ms
18783 Causes all variables to default to the @code{.tiny} section.  Note
18784 that there is a 65536-byte limit to this section.  Accesses to these
18785 variables use the @code{%gp} base register.
18787 @item -msatur
18788 @opindex msatur
18789 Enables the saturation instructions.  Note that the compiler does not
18790 currently generate these itself, but this option is included for
18791 compatibility with other tools, like @code{as}.
18793 @item -msdram
18794 @opindex msdram
18795 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18797 @item -msim
18798 @opindex msim
18799 Link the simulator run-time libraries.
18801 @item -msimnovec
18802 @opindex msimnovec
18803 Link the simulator runtime libraries, excluding built-in support
18804 for reset and exception vectors and tables.
18806 @item -mtf
18807 @opindex mtf
18808 Causes all functions to default to the @code{.far} section.  Without
18809 this option, functions default to the @code{.near} section.
18811 @item -mtiny=@var{n}
18812 @opindex mtiny=
18813 Variables that are @var{n} bytes or smaller are allocated to the
18814 @code{.tiny} section.  These variables use the @code{$gp} base
18815 register.  The default for this option is 4, but note that there's a
18816 65536-byte limit to the @code{.tiny} section.
18818 @end table
18820 @node MicroBlaze Options
18821 @subsection MicroBlaze Options
18822 @cindex MicroBlaze Options
18824 @table @gcctabopt
18826 @item -msoft-float
18827 @opindex msoft-float
18828 Use software emulation for floating point (default).
18830 @item -mhard-float
18831 @opindex mhard-float
18832 Use hardware floating-point instructions.
18834 @item -mmemcpy
18835 @opindex mmemcpy
18836 Do not optimize block moves, use @code{memcpy}.
18838 @item -mno-clearbss
18839 @opindex mno-clearbss
18840 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18842 @item -mcpu=@var{cpu-type}
18843 @opindex mcpu=
18844 Use features of, and schedule code for, the given CPU.
18845 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18846 where @var{X} is a major version, @var{YY} is the minor version, and
18847 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18848 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18850 @item -mxl-soft-mul
18851 @opindex mxl-soft-mul
18852 Use software multiply emulation (default).
18854 @item -mxl-soft-div
18855 @opindex mxl-soft-div
18856 Use software emulation for divides (default).
18858 @item -mxl-barrel-shift
18859 @opindex mxl-barrel-shift
18860 Use the hardware barrel shifter.
18862 @item -mxl-pattern-compare
18863 @opindex mxl-pattern-compare
18864 Use pattern compare instructions.
18866 @item -msmall-divides
18867 @opindex msmall-divides
18868 Use table lookup optimization for small signed integer divisions.
18870 @item -mxl-stack-check
18871 @opindex mxl-stack-check
18872 This option is deprecated.  Use @option{-fstack-check} instead.
18874 @item -mxl-gp-opt
18875 @opindex mxl-gp-opt
18876 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18878 @item -mxl-multiply-high
18879 @opindex mxl-multiply-high
18880 Use multiply high instructions for high part of 32x32 multiply.
18882 @item -mxl-float-convert
18883 @opindex mxl-float-convert
18884 Use hardware floating-point conversion instructions.
18886 @item -mxl-float-sqrt
18887 @opindex mxl-float-sqrt
18888 Use hardware floating-point square root instruction.
18890 @item -mbig-endian
18891 @opindex mbig-endian
18892 Generate code for a big-endian target.
18894 @item -mlittle-endian
18895 @opindex mlittle-endian
18896 Generate code for a little-endian target.
18898 @item -mxl-reorder
18899 @opindex mxl-reorder
18900 Use reorder instructions (swap and byte reversed load/store).
18902 @item -mxl-mode-@var{app-model}
18903 Select application model @var{app-model}.  Valid models are
18904 @table @samp
18905 @item executable
18906 normal executable (default), uses startup code @file{crt0.o}.
18908 @item xmdstub
18909 for use with Xilinx Microprocessor Debugger (XMD) based
18910 software intrusive debug agent called xmdstub. This uses startup file
18911 @file{crt1.o} and sets the start address of the program to 0x800.
18913 @item bootstrap
18914 for applications that are loaded using a bootloader.
18915 This model uses startup file @file{crt2.o} which does not contain a processor
18916 reset vector handler. This is suitable for transferring control on a
18917 processor reset to the bootloader rather than the application.
18919 @item novectors
18920 for applications that do not require any of the
18921 MicroBlaze vectors. This option may be useful for applications running
18922 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18923 @end table
18925 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18926 @option{-mxl-mode-@var{app-model}}.
18928 @end table
18930 @node MIPS Options
18931 @subsection MIPS Options
18932 @cindex MIPS options
18934 @table @gcctabopt
18936 @item -EB
18937 @opindex EB
18938 Generate big-endian code.
18940 @item -EL
18941 @opindex EL
18942 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18943 configurations.
18945 @item -march=@var{arch}
18946 @opindex march
18947 Generate code that runs on @var{arch}, which can be the name of a
18948 generic MIPS ISA, or the name of a particular processor.
18949 The ISA names are:
18950 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18951 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18952 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18953 @samp{mips64r5} and @samp{mips64r6}.
18954 The processor names are:
18955 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18956 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18957 @samp{5kc}, @samp{5kf},
18958 @samp{20kc},
18959 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18960 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18961 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18962 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18963 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18964 @samp{i6400},
18965 @samp{interaptiv},
18966 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18967 @samp{m4k},
18968 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18969 @samp{m5100}, @samp{m5101},
18970 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18971 @samp{orion},
18972 @samp{p5600},
18973 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18974 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18975 @samp{rm7000}, @samp{rm9000},
18976 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18977 @samp{sb1},
18978 @samp{sr71000},
18979 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18980 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18981 @samp{xlr} and @samp{xlp}.
18982 The special value @samp{from-abi} selects the
18983 most compatible architecture for the selected ABI (that is,
18984 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18986 The native Linux/GNU toolchain also supports the value @samp{native},
18987 which selects the best architecture option for the host processor.
18988 @option{-march=native} has no effect if GCC does not recognize
18989 the processor.
18991 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18992 (for example, @option{-march=r2k}).  Prefixes are optional, and
18993 @samp{vr} may be written @samp{r}.
18995 Names of the form @samp{@var{n}f2_1} refer to processors with
18996 FPUs clocked at half the rate of the core, names of the form
18997 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18998 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18999 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19000 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19001 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19002 accepted as synonyms for @samp{@var{n}f1_1}.
19004 GCC defines two macros based on the value of this option.  The first
19005 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19006 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19007 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19008 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19009 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19011 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19012 above.  In other words, it has the full prefix and does not
19013 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19014 the macro names the resolved architecture (either @code{"mips1"} or
19015 @code{"mips3"}).  It names the default architecture when no
19016 @option{-march} option is given.
19018 @item -mtune=@var{arch}
19019 @opindex mtune
19020 Optimize for @var{arch}.  Among other things, this option controls
19021 the way instructions are scheduled, and the perceived cost of arithmetic
19022 operations.  The list of @var{arch} values is the same as for
19023 @option{-march}.
19025 When this option is not used, GCC optimizes for the processor
19026 specified by @option{-march}.  By using @option{-march} and
19027 @option{-mtune} together, it is possible to generate code that
19028 runs on a family of processors, but optimize the code for one
19029 particular member of that family.
19031 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19032 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19033 @option{-march} ones described above.
19035 @item -mips1
19036 @opindex mips1
19037 Equivalent to @option{-march=mips1}.
19039 @item -mips2
19040 @opindex mips2
19041 Equivalent to @option{-march=mips2}.
19043 @item -mips3
19044 @opindex mips3
19045 Equivalent to @option{-march=mips3}.
19047 @item -mips4
19048 @opindex mips4
19049 Equivalent to @option{-march=mips4}.
19051 @item -mips32
19052 @opindex mips32
19053 Equivalent to @option{-march=mips32}.
19055 @item -mips32r3
19056 @opindex mips32r3
19057 Equivalent to @option{-march=mips32r3}.
19059 @item -mips32r5
19060 @opindex mips32r5
19061 Equivalent to @option{-march=mips32r5}.
19063 @item -mips32r6
19064 @opindex mips32r6
19065 Equivalent to @option{-march=mips32r6}.
19067 @item -mips64
19068 @opindex mips64
19069 Equivalent to @option{-march=mips64}.
19071 @item -mips64r2
19072 @opindex mips64r2
19073 Equivalent to @option{-march=mips64r2}.
19075 @item -mips64r3
19076 @opindex mips64r3
19077 Equivalent to @option{-march=mips64r3}.
19079 @item -mips64r5
19080 @opindex mips64r5
19081 Equivalent to @option{-march=mips64r5}.
19083 @item -mips64r6
19084 @opindex mips64r6
19085 Equivalent to @option{-march=mips64r6}.
19087 @item -mips16
19088 @itemx -mno-mips16
19089 @opindex mips16
19090 @opindex mno-mips16
19091 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19092 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19094 MIPS16 code generation can also be controlled on a per-function basis
19095 by means of @code{mips16} and @code{nomips16} attributes.
19096 @xref{Function Attributes}, for more information.
19098 @item -mflip-mips16
19099 @opindex mflip-mips16
19100 Generate MIPS16 code on alternating functions.  This option is provided
19101 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19102 not intended for ordinary use in compiling user code.
19104 @item -minterlink-compressed
19105 @item -mno-interlink-compressed
19106 @opindex minterlink-compressed
19107 @opindex mno-interlink-compressed
19108 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19109 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19111 For example, code using the standard ISA encoding cannot jump directly
19112 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19113 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19114 knows that the target of the jump is not compressed.
19116 @item -minterlink-mips16
19117 @itemx -mno-interlink-mips16
19118 @opindex minterlink-mips16
19119 @opindex mno-interlink-mips16
19120 Aliases of @option{-minterlink-compressed} and
19121 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19122 and are retained for backwards compatibility.
19124 @item -mabi=32
19125 @itemx -mabi=o64
19126 @itemx -mabi=n32
19127 @itemx -mabi=64
19128 @itemx -mabi=eabi
19129 @opindex mabi=32
19130 @opindex mabi=o64
19131 @opindex mabi=n32
19132 @opindex mabi=64
19133 @opindex mabi=eabi
19134 Generate code for the given ABI@.
19136 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19137 generates 64-bit code when you select a 64-bit architecture, but you
19138 can use @option{-mgp32} to get 32-bit code instead.
19140 For information about the O64 ABI, see
19141 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19143 GCC supports a variant of the o32 ABI in which floating-point registers
19144 are 64 rather than 32 bits wide.  You can select this combination with
19145 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19146 and @code{mfhc1} instructions and is therefore only supported for
19147 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19149 The register assignments for arguments and return values remain the
19150 same, but each scalar value is passed in a single 64-bit register
19151 rather than a pair of 32-bit registers.  For example, scalar
19152 floating-point values are returned in @samp{$f0} only, not a
19153 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19154 remains the same in that the even-numbered double-precision registers
19155 are saved.
19157 Two additional variants of the o32 ABI are supported to enable
19158 a transition from 32-bit to 64-bit registers.  These are FPXX
19159 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19160 The FPXX extension mandates that all code must execute correctly
19161 when run using 32-bit or 64-bit registers.  The code can be interlinked
19162 with either FP32 or FP64, but not both.
19163 The FP64A extension is similar to the FP64 extension but forbids the
19164 use of odd-numbered single-precision registers.  This can be used
19165 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19166 processors and allows both FP32 and FP64A code to interlink and
19167 run in the same process without changing FPU modes.
19169 @item -mabicalls
19170 @itemx -mno-abicalls
19171 @opindex mabicalls
19172 @opindex mno-abicalls
19173 Generate (do not generate) code that is suitable for SVR4-style
19174 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19175 systems.
19177 @item -mshared
19178 @itemx -mno-shared
19179 Generate (do not generate) code that is fully position-independent,
19180 and that can therefore be linked into shared libraries.  This option
19181 only affects @option{-mabicalls}.
19183 All @option{-mabicalls} code has traditionally been position-independent,
19184 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19185 as an extension, the GNU toolchain allows executables to use absolute
19186 accesses for locally-binding symbols.  It can also use shorter GP
19187 initialization sequences and generate direct calls to locally-defined
19188 functions.  This mode is selected by @option{-mno-shared}.
19190 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19191 objects that can only be linked by the GNU linker.  However, the option
19192 does not affect the ABI of the final executable; it only affects the ABI
19193 of relocatable objects.  Using @option{-mno-shared} generally makes
19194 executables both smaller and quicker.
19196 @option{-mshared} is the default.
19198 @item -mplt
19199 @itemx -mno-plt
19200 @opindex mplt
19201 @opindex mno-plt
19202 Assume (do not assume) that the static and dynamic linkers
19203 support PLTs and copy relocations.  This option only affects
19204 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19205 has no effect without @option{-msym32}.
19207 You can make @option{-mplt} the default by configuring
19208 GCC with @option{--with-mips-plt}.  The default is
19209 @option{-mno-plt} otherwise.
19211 @item -mxgot
19212 @itemx -mno-xgot
19213 @opindex mxgot
19214 @opindex mno-xgot
19215 Lift (do not lift) the usual restrictions on the size of the global
19216 offset table.
19218 GCC normally uses a single instruction to load values from the GOT@.
19219 While this is relatively efficient, it only works if the GOT
19220 is smaller than about 64k.  Anything larger causes the linker
19221 to report an error such as:
19223 @cindex relocation truncated to fit (MIPS)
19224 @smallexample
19225 relocation truncated to fit: R_MIPS_GOT16 foobar
19226 @end smallexample
19228 If this happens, you should recompile your code with @option{-mxgot}.
19229 This works with very large GOTs, although the code is also
19230 less efficient, since it takes three instructions to fetch the
19231 value of a global symbol.
19233 Note that some linkers can create multiple GOTs.  If you have such a
19234 linker, you should only need to use @option{-mxgot} when a single object
19235 file accesses more than 64k's worth of GOT entries.  Very few do.
19237 These options have no effect unless GCC is generating position
19238 independent code.
19240 @item -mgp32
19241 @opindex mgp32
19242 Assume that general-purpose registers are 32 bits wide.
19244 @item -mgp64
19245 @opindex mgp64
19246 Assume that general-purpose registers are 64 bits wide.
19248 @item -mfp32
19249 @opindex mfp32
19250 Assume that floating-point registers are 32 bits wide.
19252 @item -mfp64
19253 @opindex mfp64
19254 Assume that floating-point registers are 64 bits wide.
19256 @item -mfpxx
19257 @opindex mfpxx
19258 Do not assume the width of floating-point registers.
19260 @item -mhard-float
19261 @opindex mhard-float
19262 Use floating-point coprocessor instructions.
19264 @item -msoft-float
19265 @opindex msoft-float
19266 Do not use floating-point coprocessor instructions.  Implement
19267 floating-point calculations using library calls instead.
19269 @item -mno-float
19270 @opindex mno-float
19271 Equivalent to @option{-msoft-float}, but additionally asserts that the
19272 program being compiled does not perform any floating-point operations.
19273 This option is presently supported only by some bare-metal MIPS
19274 configurations, where it may select a special set of libraries
19275 that lack all floating-point support (including, for example, the
19276 floating-point @code{printf} formats).  
19277 If code compiled with @option{-mno-float} accidentally contains
19278 floating-point operations, it is likely to suffer a link-time
19279 or run-time failure.
19281 @item -msingle-float
19282 @opindex msingle-float
19283 Assume that the floating-point coprocessor only supports single-precision
19284 operations.
19286 @item -mdouble-float
19287 @opindex mdouble-float
19288 Assume that the floating-point coprocessor supports double-precision
19289 operations.  This is the default.
19291 @item -modd-spreg
19292 @itemx -mno-odd-spreg
19293 @opindex modd-spreg
19294 @opindex mno-odd-spreg
19295 Enable the use of odd-numbered single-precision floating-point registers
19296 for the o32 ABI.  This is the default for processors that are known to
19297 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19298 is set by default.
19300 @item -mabs=2008
19301 @itemx -mabs=legacy
19302 @opindex mabs=2008
19303 @opindex mabs=legacy
19304 These options control the treatment of the special not-a-number (NaN)
19305 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19306 @code{neg.@i{fmt}} machine instructions.
19308 By default or when @option{-mabs=legacy} is used the legacy
19309 treatment is selected.  In this case these instructions are considered
19310 arithmetic and avoided where correct operation is required and the
19311 input operand might be a NaN.  A longer sequence of instructions that
19312 manipulate the sign bit of floating-point datum manually is used
19313 instead unless the @option{-ffinite-math-only} option has also been
19314 specified.
19316 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19317 this case these instructions are considered non-arithmetic and therefore
19318 operating correctly in all cases, including in particular where the
19319 input operand is a NaN.  These instructions are therefore always used
19320 for the respective operations.
19322 @item -mnan=2008
19323 @itemx -mnan=legacy
19324 @opindex mnan=2008
19325 @opindex mnan=legacy
19326 These options control the encoding of the special not-a-number (NaN)
19327 IEEE 754 floating-point data.
19329 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19330 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19331 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19332 by the first bit of their trailing significand field being 1.
19334 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19335 this case qNaNs are denoted by the first bit of their trailing
19336 significand field being 1, whereas sNaNs are denoted by the first bit of
19337 their trailing significand field being 0.
19339 The default is @option{-mnan=legacy} unless GCC has been configured with
19340 @option{--with-nan=2008}.
19342 @item -mllsc
19343 @itemx -mno-llsc
19344 @opindex mllsc
19345 @opindex mno-llsc
19346 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19347 implement atomic memory built-in functions.  When neither option is
19348 specified, GCC uses the instructions if the target architecture
19349 supports them.
19351 @option{-mllsc} is useful if the runtime environment can emulate the
19352 instructions and @option{-mno-llsc} can be useful when compiling for
19353 nonstandard ISAs.  You can make either option the default by
19354 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19355 respectively.  @option{--with-llsc} is the default for some
19356 configurations; see the installation documentation for details.
19358 @item -mdsp
19359 @itemx -mno-dsp
19360 @opindex mdsp
19361 @opindex mno-dsp
19362 Use (do not use) revision 1 of the MIPS DSP ASE@.
19363 @xref{MIPS DSP Built-in Functions}.  This option defines the
19364 preprocessor macro @code{__mips_dsp}.  It also defines
19365 @code{__mips_dsp_rev} to 1.
19367 @item -mdspr2
19368 @itemx -mno-dspr2
19369 @opindex mdspr2
19370 @opindex mno-dspr2
19371 Use (do not use) revision 2 of the MIPS DSP ASE@.
19372 @xref{MIPS DSP Built-in Functions}.  This option defines the
19373 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19374 It also defines @code{__mips_dsp_rev} to 2.
19376 @item -msmartmips
19377 @itemx -mno-smartmips
19378 @opindex msmartmips
19379 @opindex mno-smartmips
19380 Use (do not use) the MIPS SmartMIPS ASE.
19382 @item -mpaired-single
19383 @itemx -mno-paired-single
19384 @opindex mpaired-single
19385 @opindex mno-paired-single
19386 Use (do not use) paired-single floating-point instructions.
19387 @xref{MIPS Paired-Single Support}.  This option requires
19388 hardware floating-point support to be enabled.
19390 @item -mdmx
19391 @itemx -mno-mdmx
19392 @opindex mdmx
19393 @opindex mno-mdmx
19394 Use (do not use) MIPS Digital Media Extension instructions.
19395 This option can only be used when generating 64-bit code and requires
19396 hardware floating-point support to be enabled.
19398 @item -mips3d
19399 @itemx -mno-mips3d
19400 @opindex mips3d
19401 @opindex mno-mips3d
19402 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19403 The option @option{-mips3d} implies @option{-mpaired-single}.
19405 @item -mmicromips
19406 @itemx -mno-micromips
19407 @opindex mmicromips
19408 @opindex mno-mmicromips
19409 Generate (do not generate) microMIPS code.
19411 MicroMIPS code generation can also be controlled on a per-function basis
19412 by means of @code{micromips} and @code{nomicromips} attributes.
19413 @xref{Function Attributes}, for more information.
19415 @item -mmt
19416 @itemx -mno-mt
19417 @opindex mmt
19418 @opindex mno-mt
19419 Use (do not use) MT Multithreading instructions.
19421 @item -mmcu
19422 @itemx -mno-mcu
19423 @opindex mmcu
19424 @opindex mno-mcu
19425 Use (do not use) the MIPS MCU ASE instructions.
19427 @item -meva
19428 @itemx -mno-eva
19429 @opindex meva
19430 @opindex mno-eva
19431 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19433 @item -mvirt
19434 @itemx -mno-virt
19435 @opindex mvirt
19436 @opindex mno-virt
19437 Use (do not use) the MIPS Virtualization Application Specific instructions.
19439 @item -mxpa
19440 @itemx -mno-xpa
19441 @opindex mxpa
19442 @opindex mno-xpa
19443 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19445 @item -mlong64
19446 @opindex mlong64
19447 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19448 an explanation of the default and the way that the pointer size is
19449 determined.
19451 @item -mlong32
19452 @opindex mlong32
19453 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19455 The default size of @code{int}s, @code{long}s and pointers depends on
19456 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19457 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19458 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19459 or the same size as integer registers, whichever is smaller.
19461 @item -msym32
19462 @itemx -mno-sym32
19463 @opindex msym32
19464 @opindex mno-sym32
19465 Assume (do not assume) that all symbols have 32-bit values, regardless
19466 of the selected ABI@.  This option is useful in combination with
19467 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19468 to generate shorter and faster references to symbolic addresses.
19470 @item -G @var{num}
19471 @opindex G
19472 Put definitions of externally-visible data in a small data section
19473 if that data is no bigger than @var{num} bytes.  GCC can then generate
19474 more efficient accesses to the data; see @option{-mgpopt} for details.
19476 The default @option{-G} option depends on the configuration.
19478 @item -mlocal-sdata
19479 @itemx -mno-local-sdata
19480 @opindex mlocal-sdata
19481 @opindex mno-local-sdata
19482 Extend (do not extend) the @option{-G} behavior to local data too,
19483 such as to static variables in C@.  @option{-mlocal-sdata} is the
19484 default for all configurations.
19486 If the linker complains that an application is using too much small data,
19487 you might want to try rebuilding the less performance-critical parts with
19488 @option{-mno-local-sdata}.  You might also want to build large
19489 libraries with @option{-mno-local-sdata}, so that the libraries leave
19490 more room for the main program.
19492 @item -mextern-sdata
19493 @itemx -mno-extern-sdata
19494 @opindex mextern-sdata
19495 @opindex mno-extern-sdata
19496 Assume (do not assume) that externally-defined data is in
19497 a small data section if the size of that data is within the @option{-G} limit.
19498 @option{-mextern-sdata} is the default for all configurations.
19500 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19501 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19502 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19503 is placed in a small data section.  If @var{Var} is defined by another
19504 module, you must either compile that module with a high-enough
19505 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19506 definition.  If @var{Var} is common, you must link the application
19507 with a high-enough @option{-G} setting.
19509 The easiest way of satisfying these restrictions is to compile
19510 and link every module with the same @option{-G} option.  However,
19511 you may wish to build a library that supports several different
19512 small data limits.  You can do this by compiling the library with
19513 the highest supported @option{-G} setting and additionally using
19514 @option{-mno-extern-sdata} to stop the library from making assumptions
19515 about externally-defined data.
19517 @item -mgpopt
19518 @itemx -mno-gpopt
19519 @opindex mgpopt
19520 @opindex mno-gpopt
19521 Use (do not use) GP-relative accesses for symbols that are known to be
19522 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19523 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19524 configurations.
19526 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19527 might not hold the value of @code{_gp}.  For example, if the code is
19528 part of a library that might be used in a boot monitor, programs that
19529 call boot monitor routines pass an unknown value in @code{$gp}.
19530 (In such situations, the boot monitor itself is usually compiled
19531 with @option{-G0}.)
19533 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19534 @option{-mno-extern-sdata}.
19536 @item -membedded-data
19537 @itemx -mno-embedded-data
19538 @opindex membedded-data
19539 @opindex mno-embedded-data
19540 Allocate variables to the read-only data section first if possible, then
19541 next in the small data section if possible, otherwise in data.  This gives
19542 slightly slower code than the default, but reduces the amount of RAM required
19543 when executing, and thus may be preferred for some embedded systems.
19545 @item -muninit-const-in-rodata
19546 @itemx -mno-uninit-const-in-rodata
19547 @opindex muninit-const-in-rodata
19548 @opindex mno-uninit-const-in-rodata
19549 Put uninitialized @code{const} variables in the read-only data section.
19550 This option is only meaningful in conjunction with @option{-membedded-data}.
19552 @item -mcode-readable=@var{setting}
19553 @opindex mcode-readable
19554 Specify whether GCC may generate code that reads from executable sections.
19555 There are three possible settings:
19557 @table @gcctabopt
19558 @item -mcode-readable=yes
19559 Instructions may freely access executable sections.  This is the
19560 default setting.
19562 @item -mcode-readable=pcrel
19563 MIPS16 PC-relative load instructions can access executable sections,
19564 but other instructions must not do so.  This option is useful on 4KSc
19565 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19566 It is also useful on processors that can be configured to have a dual
19567 instruction/data SRAM interface and that, like the M4K, automatically
19568 redirect PC-relative loads to the instruction RAM.
19570 @item -mcode-readable=no
19571 Instructions must not access executable sections.  This option can be
19572 useful on targets that are configured to have a dual instruction/data
19573 SRAM interface but that (unlike the M4K) do not automatically redirect
19574 PC-relative loads to the instruction RAM.
19575 @end table
19577 @item -msplit-addresses
19578 @itemx -mno-split-addresses
19579 @opindex msplit-addresses
19580 @opindex mno-split-addresses
19581 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19582 relocation operators.  This option has been superseded by
19583 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19585 @item -mexplicit-relocs
19586 @itemx -mno-explicit-relocs
19587 @opindex mexplicit-relocs
19588 @opindex mno-explicit-relocs
19589 Use (do not use) assembler relocation operators when dealing with symbolic
19590 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19591 is to use assembler macros instead.
19593 @option{-mexplicit-relocs} is the default if GCC was configured
19594 to use an assembler that supports relocation operators.
19596 @item -mcheck-zero-division
19597 @itemx -mno-check-zero-division
19598 @opindex mcheck-zero-division
19599 @opindex mno-check-zero-division
19600 Trap (do not trap) on integer division by zero.
19602 The default is @option{-mcheck-zero-division}.
19604 @item -mdivide-traps
19605 @itemx -mdivide-breaks
19606 @opindex mdivide-traps
19607 @opindex mdivide-breaks
19608 MIPS systems check for division by zero by generating either a
19609 conditional trap or a break instruction.  Using traps results in
19610 smaller code, but is only supported on MIPS II and later.  Also, some
19611 versions of the Linux kernel have a bug that prevents trap from
19612 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19613 allow conditional traps on architectures that support them and
19614 @option{-mdivide-breaks} to force the use of breaks.
19616 The default is usually @option{-mdivide-traps}, but this can be
19617 overridden at configure time using @option{--with-divide=breaks}.
19618 Divide-by-zero checks can be completely disabled using
19619 @option{-mno-check-zero-division}.
19621 @item -mmemcpy
19622 @itemx -mno-memcpy
19623 @opindex mmemcpy
19624 @opindex mno-memcpy
19625 Force (do not force) the use of @code{memcpy} for non-trivial block
19626 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19627 most constant-sized copies.
19629 @item -mlong-calls
19630 @itemx -mno-long-calls
19631 @opindex mlong-calls
19632 @opindex mno-long-calls
19633 Disable (do not disable) use of the @code{jal} instruction.  Calling
19634 functions using @code{jal} is more efficient but requires the caller
19635 and callee to be in the same 256 megabyte segment.
19637 This option has no effect on abicalls code.  The default is
19638 @option{-mno-long-calls}.
19640 @item -mmad
19641 @itemx -mno-mad
19642 @opindex mmad
19643 @opindex mno-mad
19644 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19645 instructions, as provided by the R4650 ISA@.
19647 @item -mimadd
19648 @itemx -mno-imadd
19649 @opindex mimadd
19650 @opindex mno-imadd
19651 Enable (disable) use of the @code{madd} and @code{msub} integer
19652 instructions.  The default is @option{-mimadd} on architectures
19653 that support @code{madd} and @code{msub} except for the 74k 
19654 architecture where it was found to generate slower code.
19656 @item -mfused-madd
19657 @itemx -mno-fused-madd
19658 @opindex mfused-madd
19659 @opindex mno-fused-madd
19660 Enable (disable) use of the floating-point multiply-accumulate
19661 instructions, when they are available.  The default is
19662 @option{-mfused-madd}.
19664 On the R8000 CPU when multiply-accumulate instructions are used,
19665 the intermediate product is calculated to infinite precision
19666 and is not subject to the FCSR Flush to Zero bit.  This may be
19667 undesirable in some circumstances.  On other processors the result
19668 is numerically identical to the equivalent computation using
19669 separate multiply, add, subtract and negate instructions.
19671 @item -nocpp
19672 @opindex nocpp
19673 Tell the MIPS assembler to not run its preprocessor over user
19674 assembler files (with a @samp{.s} suffix) when assembling them.
19676 @item -mfix-24k
19677 @item -mno-fix-24k
19678 @opindex mfix-24k
19679 @opindex mno-fix-24k
19680 Work around the 24K E48 (lost data on stores during refill) errata.
19681 The workarounds are implemented by the assembler rather than by GCC@.
19683 @item -mfix-r4000
19684 @itemx -mno-fix-r4000
19685 @opindex mfix-r4000
19686 @opindex mno-fix-r4000
19687 Work around certain R4000 CPU errata:
19688 @itemize @minus
19689 @item
19690 A double-word or a variable shift may give an incorrect result if executed
19691 immediately after starting an integer division.
19692 @item
19693 A double-word or a variable shift may give an incorrect result if executed
19694 while an integer multiplication is in progress.
19695 @item
19696 An integer division may give an incorrect result if started in a delay slot
19697 of a taken branch or a jump.
19698 @end itemize
19700 @item -mfix-r4400
19701 @itemx -mno-fix-r4400
19702 @opindex mfix-r4400
19703 @opindex mno-fix-r4400
19704 Work around certain R4400 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 @end itemize
19711 @item -mfix-r10000
19712 @itemx -mno-fix-r10000
19713 @opindex mfix-r10000
19714 @opindex mno-fix-r10000
19715 Work around certain R10000 errata:
19716 @itemize @minus
19717 @item
19718 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19719 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19720 @end itemize
19722 This option can only be used if the target architecture supports
19723 branch-likely instructions.  @option{-mfix-r10000} is the default when
19724 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19725 otherwise.
19727 @item -mfix-rm7000
19728 @itemx -mno-fix-rm7000
19729 @opindex mfix-rm7000
19730 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19731 workarounds are implemented by the assembler rather than by GCC@.
19733 @item -mfix-vr4120
19734 @itemx -mno-fix-vr4120
19735 @opindex mfix-vr4120
19736 Work around certain VR4120 errata:
19737 @itemize @minus
19738 @item
19739 @code{dmultu} does not always produce the correct result.
19740 @item
19741 @code{div} and @code{ddiv} do not always produce the correct result if one
19742 of the operands is negative.
19743 @end itemize
19744 The workarounds for the division errata rely on special functions in
19745 @file{libgcc.a}.  At present, these functions are only provided by
19746 the @code{mips64vr*-elf} configurations.
19748 Other VR4120 errata require a NOP to be inserted between certain pairs of
19749 instructions.  These errata are handled by the assembler, not by GCC itself.
19751 @item -mfix-vr4130
19752 @opindex mfix-vr4130
19753 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19754 workarounds are implemented by the assembler rather than by GCC,
19755 although GCC avoids using @code{mflo} and @code{mfhi} if the
19756 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19757 instructions are available instead.
19759 @item -mfix-sb1
19760 @itemx -mno-fix-sb1
19761 @opindex mfix-sb1
19762 Work around certain SB-1 CPU core errata.
19763 (This flag currently works around the SB-1 revision 2
19764 ``F1'' and ``F2'' floating-point errata.)
19766 @item -mr10k-cache-barrier=@var{setting}
19767 @opindex mr10k-cache-barrier
19768 Specify whether GCC should insert cache barriers to avoid the
19769 side-effects of speculation on R10K processors.
19771 In common with many processors, the R10K tries to predict the outcome
19772 of a conditional branch and speculatively executes instructions from
19773 the ``taken'' branch.  It later aborts these instructions if the
19774 predicted outcome is wrong.  However, on the R10K, even aborted
19775 instructions can have side effects.
19777 This problem only affects kernel stores and, depending on the system,
19778 kernel loads.  As an example, a speculatively-executed store may load
19779 the target memory into cache and mark the cache line as dirty, even if
19780 the store itself is later aborted.  If a DMA operation writes to the
19781 same area of memory before the ``dirty'' line is flushed, the cached
19782 data overwrites the DMA-ed data.  See the R10K processor manual
19783 for a full description, including other potential problems.
19785 One workaround is to insert cache barrier instructions before every memory
19786 access that might be speculatively executed and that might have side
19787 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19788 controls GCC's implementation of this workaround.  It assumes that
19789 aborted accesses to any byte in the following regions does not have
19790 side effects:
19792 @enumerate
19793 @item
19794 the memory occupied by the current function's stack frame;
19796 @item
19797 the memory occupied by an incoming stack argument;
19799 @item
19800 the memory occupied by an object with a link-time-constant address.
19801 @end enumerate
19803 It is the kernel's responsibility to ensure that speculative
19804 accesses to these regions are indeed safe.
19806 If the input program contains a function declaration such as:
19808 @smallexample
19809 void foo (void);
19810 @end smallexample
19812 then the implementation of @code{foo} must allow @code{j foo} and
19813 @code{jal foo} to be executed speculatively.  GCC honors this
19814 restriction for functions it compiles itself.  It expects non-GCC
19815 functions (such as hand-written assembly code) to do the same.
19817 The option has three forms:
19819 @table @gcctabopt
19820 @item -mr10k-cache-barrier=load-store
19821 Insert a cache barrier before a load or store that might be
19822 speculatively executed and that might have side effects even
19823 if aborted.
19825 @item -mr10k-cache-barrier=store
19826 Insert a cache barrier before a store that might be speculatively
19827 executed and that might have side effects even if aborted.
19829 @item -mr10k-cache-barrier=none
19830 Disable the insertion of cache barriers.  This is the default setting.
19831 @end table
19833 @item -mflush-func=@var{func}
19834 @itemx -mno-flush-func
19835 @opindex mflush-func
19836 Specifies the function to call to flush the I and D caches, or to not
19837 call any such function.  If called, the function must take the same
19838 arguments as the common @code{_flush_func}, that is, the address of the
19839 memory range for which the cache is being flushed, the size of the
19840 memory range, and the number 3 (to flush both caches).  The default
19841 depends on the target GCC was configured for, but commonly is either
19842 @code{_flush_func} or @code{__cpu_flush}.
19844 @item mbranch-cost=@var{num}
19845 @opindex mbranch-cost
19846 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19847 This cost is only a heuristic and is not guaranteed to produce
19848 consistent results across releases.  A zero cost redundantly selects
19849 the default, which is based on the @option{-mtune} setting.
19851 @item -mbranch-likely
19852 @itemx -mno-branch-likely
19853 @opindex mbranch-likely
19854 @opindex mno-branch-likely
19855 Enable or disable use of Branch Likely instructions, regardless of the
19856 default for the selected architecture.  By default, Branch Likely
19857 instructions may be generated if they are supported by the selected
19858 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19859 and processors that implement those architectures; for those, Branch
19860 Likely instructions are not be generated by default because the MIPS32
19861 and MIPS64 architectures specifically deprecate their use.
19863 @item -mcompact-branches=never
19864 @itemx -mcompact-branches=optimal
19865 @itemx -mcompact-branches=always
19866 @opindex mcompact-branches=never
19867 @opindex mcompact-branches=optimal
19868 @opindex mcompact-branches=always
19869 These options control which form of branches will be generated.  The
19870 default is @option{-mcompact-branches=optimal}.
19872 The @option{-mcompact-branches=never} option ensures that compact branch
19873 instructions will never be generated.
19875 The @option{-mcompact-branches=always} option ensures that a compact
19876 branch instruction will be generated if available.  If a compact branch
19877 instruction is not available, a delay slot form of the branch will be
19878 used instead.
19880 This option is supported from MIPS Release 6 onwards.
19882 The @option{-mcompact-branches=optimal} option will cause a delay slot
19883 branch to be used if one is available in the current ISA and the delay
19884 slot is successfully filled.  If the delay slot is not filled, a compact
19885 branch will be chosen if one is available.
19887 @item -mfp-exceptions
19888 @itemx -mno-fp-exceptions
19889 @opindex mfp-exceptions
19890 Specifies whether FP exceptions are enabled.  This affects how
19891 FP instructions are scheduled for some processors.
19892 The default is that FP exceptions are
19893 enabled.
19895 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19896 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19897 FP pipe.
19899 @item -mvr4130-align
19900 @itemx -mno-vr4130-align
19901 @opindex mvr4130-align
19902 The VR4130 pipeline is two-way superscalar, but can only issue two
19903 instructions together if the first one is 8-byte aligned.  When this
19904 option is enabled, GCC aligns pairs of instructions that it
19905 thinks should execute in parallel.
19907 This option only has an effect when optimizing for the VR4130.
19908 It normally makes code faster, but at the expense of making it bigger.
19909 It is enabled by default at optimization level @option{-O3}.
19911 @item -msynci
19912 @itemx -mno-synci
19913 @opindex msynci
19914 Enable (disable) generation of @code{synci} instructions on
19915 architectures that support it.  The @code{synci} instructions (if
19916 enabled) are generated when @code{__builtin___clear_cache} is
19917 compiled.
19919 This option defaults to @option{-mno-synci}, but the default can be
19920 overridden by configuring GCC with @option{--with-synci}.
19922 When compiling code for single processor systems, it is generally safe
19923 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19924 does not invalidate the instruction caches on all cores and may lead
19925 to undefined behavior.
19927 @item -mrelax-pic-calls
19928 @itemx -mno-relax-pic-calls
19929 @opindex mrelax-pic-calls
19930 Try to turn PIC calls that are normally dispatched via register
19931 @code{$25} into direct calls.  This is only possible if the linker can
19932 resolve the destination at link time and if the destination is within
19933 range for a direct call.
19935 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19936 an assembler and a linker that support the @code{.reloc} assembly
19937 directive and @option{-mexplicit-relocs} is in effect.  With
19938 @option{-mno-explicit-relocs}, this optimization can be performed by the
19939 assembler and the linker alone without help from the compiler.
19941 @item -mmcount-ra-address
19942 @itemx -mno-mcount-ra-address
19943 @opindex mmcount-ra-address
19944 @opindex mno-mcount-ra-address
19945 Emit (do not emit) code that allows @code{_mcount} to modify the
19946 calling function's return address.  When enabled, this option extends
19947 the usual @code{_mcount} interface with a new @var{ra-address}
19948 parameter, which has type @code{intptr_t *} and is passed in register
19949 @code{$12}.  @code{_mcount} can then modify the return address by
19950 doing both of the following:
19951 @itemize
19952 @item
19953 Returning the new address in register @code{$31}.
19954 @item
19955 Storing the new address in @code{*@var{ra-address}},
19956 if @var{ra-address} is nonnull.
19957 @end itemize
19959 The default is @option{-mno-mcount-ra-address}.
19961 @item -mframe-header-opt
19962 @itemx -mno-frame-header-opt
19963 @opindex mframe-header-opt
19964 Enable (disable) frame header optimization in the o32 ABI.  When using the
19965 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19966 function to write out register arguments.  When enabled, this optimization
19967 will suppress the allocation of the frame header if it can be determined that
19968 it is unused.
19970 This optimization is off by default at all optimization levels.
19972 @item -mlxc1-sxc1
19973 @itemx -mno-lxc1-sxc1
19974 @opindex mlxc1-sxc1
19975 When applicable, enable (disable) the generation of @code{lwxc1},
19976 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
19978 @item -mmadd4
19979 @itemx -mno-madd4
19980 @opindex mmadd4
19981 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
19982 @code{madd.d} and related instructions.  Enabled by default.
19984 @end table
19986 @node MMIX Options
19987 @subsection MMIX Options
19988 @cindex MMIX Options
19990 These options are defined for the MMIX:
19992 @table @gcctabopt
19993 @item -mlibfuncs
19994 @itemx -mno-libfuncs
19995 @opindex mlibfuncs
19996 @opindex mno-libfuncs
19997 Specify that intrinsic library functions are being compiled, passing all
19998 values in registers, no matter the size.
20000 @item -mepsilon
20001 @itemx -mno-epsilon
20002 @opindex mepsilon
20003 @opindex mno-epsilon
20004 Generate floating-point comparison instructions that compare with respect
20005 to the @code{rE} epsilon register.
20007 @item -mabi=mmixware
20008 @itemx -mabi=gnu
20009 @opindex mabi=mmixware
20010 @opindex mabi=gnu
20011 Generate code that passes function parameters and return values that (in
20012 the called function) are seen as registers @code{$0} and up, as opposed to
20013 the GNU ABI which uses global registers @code{$231} and up.
20015 @item -mzero-extend
20016 @itemx -mno-zero-extend
20017 @opindex mzero-extend
20018 @opindex mno-zero-extend
20019 When reading data from memory in sizes shorter than 64 bits, use (do not
20020 use) zero-extending load instructions by default, rather than
20021 sign-extending ones.
20023 @item -mknuthdiv
20024 @itemx -mno-knuthdiv
20025 @opindex mknuthdiv
20026 @opindex mno-knuthdiv
20027 Make the result of a division yielding a remainder have the same sign as
20028 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20029 remainder follows the sign of the dividend.  Both methods are
20030 arithmetically valid, the latter being almost exclusively used.
20032 @item -mtoplevel-symbols
20033 @itemx -mno-toplevel-symbols
20034 @opindex mtoplevel-symbols
20035 @opindex mno-toplevel-symbols
20036 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20037 code can be used with the @code{PREFIX} assembly directive.
20039 @item -melf
20040 @opindex melf
20041 Generate an executable in the ELF format, rather than the default
20042 @samp{mmo} format used by the @command{mmix} simulator.
20044 @item -mbranch-predict
20045 @itemx -mno-branch-predict
20046 @opindex mbranch-predict
20047 @opindex mno-branch-predict
20048 Use (do not use) the probable-branch instructions, when static branch
20049 prediction indicates a probable branch.
20051 @item -mbase-addresses
20052 @itemx -mno-base-addresses
20053 @opindex mbase-addresses
20054 @opindex mno-base-addresses
20055 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20056 base address automatically generates a request (handled by the assembler
20057 and the linker) for a constant to be set up in a global register.  The
20058 register is used for one or more base address requests within the range 0
20059 to 255 from the value held in the register.  The generally leads to short
20060 and fast code, but the number of different data items that can be
20061 addressed is limited.  This means that a program that uses lots of static
20062 data may require @option{-mno-base-addresses}.
20064 @item -msingle-exit
20065 @itemx -mno-single-exit
20066 @opindex msingle-exit
20067 @opindex mno-single-exit
20068 Force (do not force) generated code to have a single exit point in each
20069 function.
20070 @end table
20072 @node MN10300 Options
20073 @subsection MN10300 Options
20074 @cindex MN10300 options
20076 These @option{-m} options are defined for Matsushita MN10300 architectures:
20078 @table @gcctabopt
20079 @item -mmult-bug
20080 @opindex mmult-bug
20081 Generate code to avoid bugs in the multiply instructions for the MN10300
20082 processors.  This is the default.
20084 @item -mno-mult-bug
20085 @opindex mno-mult-bug
20086 Do not generate code to avoid bugs in the multiply instructions for the
20087 MN10300 processors.
20089 @item -mam33
20090 @opindex mam33
20091 Generate code using features specific to the AM33 processor.
20093 @item -mno-am33
20094 @opindex mno-am33
20095 Do not generate code using features specific to the AM33 processor.  This
20096 is the default.
20098 @item -mam33-2
20099 @opindex mam33-2
20100 Generate code using features specific to the AM33/2.0 processor.
20102 @item -mam34
20103 @opindex mam34
20104 Generate code using features specific to the AM34 processor.
20106 @item -mtune=@var{cpu-type}
20107 @opindex mtune
20108 Use the timing characteristics of the indicated CPU type when
20109 scheduling instructions.  This does not change the targeted processor
20110 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20111 @samp{am33-2} or @samp{am34}.
20113 @item -mreturn-pointer-on-d0
20114 @opindex mreturn-pointer-on-d0
20115 When generating a function that returns a pointer, return the pointer
20116 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20117 only in @code{a0}, and attempts to call such functions without a prototype
20118 result in errors.  Note that this option is on by default; use
20119 @option{-mno-return-pointer-on-d0} to disable it.
20121 @item -mno-crt0
20122 @opindex mno-crt0
20123 Do not link in the C run-time initialization object file.
20125 @item -mrelax
20126 @opindex mrelax
20127 Indicate to the linker that it should perform a relaxation optimization pass
20128 to shorten branches, calls and absolute memory addresses.  This option only
20129 has an effect when used on the command line for the final link step.
20131 This option makes symbolic debugging impossible.
20133 @item -mliw
20134 @opindex mliw
20135 Allow the compiler to generate @emph{Long Instruction Word}
20136 instructions if the target is the @samp{AM33} or later.  This is the
20137 default.  This option defines the preprocessor macro @code{__LIW__}.
20139 @item -mnoliw
20140 @opindex mnoliw
20141 Do not allow the compiler to generate @emph{Long Instruction Word}
20142 instructions.  This option defines the preprocessor macro
20143 @code{__NO_LIW__}.
20145 @item -msetlb
20146 @opindex msetlb
20147 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20148 instructions if the target is the @samp{AM33} or later.  This is the
20149 default.  This option defines the preprocessor macro @code{__SETLB__}.
20151 @item -mnosetlb
20152 @opindex mnosetlb
20153 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20154 instructions.  This option defines the preprocessor macro
20155 @code{__NO_SETLB__}.
20157 @end table
20159 @node Moxie Options
20160 @subsection Moxie Options
20161 @cindex Moxie Options
20163 @table @gcctabopt
20165 @item -meb
20166 @opindex meb
20167 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20168 configurations.
20170 @item -mel
20171 @opindex mel
20172 Generate little-endian code.
20174 @item -mmul.x
20175 @opindex mmul.x
20176 Generate mul.x and umul.x instructions.  This is the default for
20177 @samp{moxiebox-*-*} configurations.
20179 @item -mno-crt0
20180 @opindex mno-crt0
20181 Do not link in the C run-time initialization object file.
20183 @end table
20185 @node MSP430 Options
20186 @subsection MSP430 Options
20187 @cindex MSP430 Options
20189 These options are defined for the MSP430:
20191 @table @gcctabopt
20193 @item -masm-hex
20194 @opindex masm-hex
20195 Force assembly output to always use hex constants.  Normally such
20196 constants are signed decimals, but this option is available for
20197 testsuite and/or aesthetic purposes.
20199 @item -mmcu=
20200 @opindex mmcu=
20201 Select the MCU to target.  This is used to create a C preprocessor
20202 symbol based upon the MCU name, converted to upper case and pre- and
20203 post-fixed with @samp{__}.  This in turn is used by the
20204 @file{msp430.h} header file to select an MCU-specific supplementary
20205 header file.
20207 The option also sets the ISA to use.  If the MCU name is one that is
20208 known to only support the 430 ISA then that is selected, otherwise the
20209 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20210 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20211 name selects the 430X ISA.
20213 In addition an MCU-specific linker script is added to the linker
20214 command line.  The script's name is the name of the MCU with
20215 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20216 command line defines the C preprocessor symbol @code{__XXX__} and
20217 cause the linker to search for a script called @file{xxx.ld}.
20219 This option is also passed on to the assembler.
20221 @item -mwarn-mcu
20222 @itemx -mno-warn-mcu
20223 @opindex mwarn-mcu
20224 @opindex mno-warn-mcu
20225 This option enables or disables warnings about conflicts between the
20226 MCU name specified by the @option{-mmcu} option and the ISA set by the
20227 @option{-mcpu} option and/or the hardware multiply support set by the
20228 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20229 MCU names.  This option is on by default.
20231 @item -mcpu=
20232 @opindex mcpu=
20233 Specifies the ISA to use.  Accepted values are @samp{msp430},
20234 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20235 @option{-mmcu=} option should be used to select the ISA.
20237 @item -msim
20238 @opindex msim
20239 Link to the simulator runtime libraries and linker script.  Overrides
20240 any scripts that would be selected by the @option{-mmcu=} option.
20242 @item -mlarge
20243 @opindex mlarge
20244 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20246 @item -msmall
20247 @opindex msmall
20248 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20250 @item -mrelax
20251 @opindex mrelax
20252 This option is passed to the assembler and linker, and allows the
20253 linker to perform certain optimizations that cannot be done until
20254 the final link.
20256 @item mhwmult=
20257 @opindex mhwmult=
20258 Describes the type of hardware multiply supported by the target.
20259 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20260 for the original 16-bit-only multiply supported by early MCUs.
20261 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20262 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20263 A value of @samp{auto} can also be given.  This tells GCC to deduce
20264 the hardware multiply support based upon the MCU name provided by the
20265 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20266 the MCU name is not recognized then no hardware multiply support is
20267 assumed.  @code{auto} is the default setting.
20269 Hardware multiplies are normally performed by calling a library
20270 routine.  This saves space in the generated code.  When compiling at
20271 @option{-O3} or higher however the hardware multiplier is invoked
20272 inline.  This makes for bigger, but faster code.
20274 The hardware multiply routines disable interrupts whilst running and
20275 restore the previous interrupt state when they finish.  This makes
20276 them safe to use inside interrupt handlers as well as in normal code.
20278 @item -minrt
20279 @opindex minrt
20280 Enable the use of a minimum runtime environment - no static
20281 initializers or constructors.  This is intended for memory-constrained
20282 devices.  The compiler includes special symbols in some objects
20283 that tell the linker and runtime which code fragments are required.
20285 @item -mcode-region=
20286 @itemx -mdata-region=
20287 @opindex mcode-region
20288 @opindex mdata-region
20289 These options tell the compiler where to place functions and data that
20290 do not have one of the @code{lower}, @code{upper}, @code{either} or
20291 @code{section} attributes.  Possible values are @code{lower},
20292 @code{upper}, @code{either} or @code{any}.  The first three behave
20293 like the corresponding attribute.  The fourth possible value -
20294 @code{any} - is the default.  It leaves placement entirely up to the
20295 linker script and how it assigns the standard sections
20296 (@code{.text}, @code{.data}, etc) to the memory regions.
20298 @item -msilicon-errata=
20299 @opindex msilicon-errata
20300 This option passes on a request to assembler to enable the fixes for
20301 the named silicon errata.
20303 @item -msilicon-errata-warn=
20304 @opindex msilicon-errata-warn
20305 This option passes on a request to the assembler to enable warning
20306 messages when a silicon errata might need to be applied.
20308 @end table
20310 @node NDS32 Options
20311 @subsection NDS32 Options
20312 @cindex NDS32 Options
20314 These options are defined for NDS32 implementations:
20316 @table @gcctabopt
20318 @item -mbig-endian
20319 @opindex mbig-endian
20320 Generate code in big-endian mode.
20322 @item -mlittle-endian
20323 @opindex mlittle-endian
20324 Generate code in little-endian mode.
20326 @item -mreduced-regs
20327 @opindex mreduced-regs
20328 Use reduced-set registers for register allocation.
20330 @item -mfull-regs
20331 @opindex mfull-regs
20332 Use full-set registers for register allocation.
20334 @item -mcmov
20335 @opindex mcmov
20336 Generate conditional move instructions.
20338 @item -mno-cmov
20339 @opindex mno-cmov
20340 Do not generate conditional move instructions.
20342 @item -mperf-ext
20343 @opindex mperf-ext
20344 Generate performance extension instructions.
20346 @item -mno-perf-ext
20347 @opindex mno-perf-ext
20348 Do not generate performance extension instructions.
20350 @item -mv3push
20351 @opindex mv3push
20352 Generate v3 push25/pop25 instructions.
20354 @item -mno-v3push
20355 @opindex mno-v3push
20356 Do not generate v3 push25/pop25 instructions.
20358 @item -m16-bit
20359 @opindex m16-bit
20360 Generate 16-bit instructions.
20362 @item -mno-16-bit
20363 @opindex mno-16-bit
20364 Do not generate 16-bit instructions.
20366 @item -misr-vector-size=@var{num}
20367 @opindex misr-vector-size
20368 Specify the size of each interrupt vector, which must be 4 or 16.
20370 @item -mcache-block-size=@var{num}
20371 @opindex mcache-block-size
20372 Specify the size of each cache block,
20373 which must be a power of 2 between 4 and 512.
20375 @item -march=@var{arch}
20376 @opindex march
20377 Specify the name of the target architecture.
20379 @item -mcmodel=@var{code-model}
20380 @opindex mcmodel
20381 Set the code model to one of
20382 @table @asis
20383 @item @samp{small}
20384 All the data and read-only data segments must be within 512KB addressing space.
20385 The text segment must be within 16MB addressing space.
20386 @item @samp{medium}
20387 The data segment must be within 512KB while the read-only data segment can be
20388 within 4GB addressing space.  The text segment should be still within 16MB
20389 addressing space.
20390 @item @samp{large}
20391 All the text and data segments can be within 4GB addressing space.
20392 @end table
20394 @item -mctor-dtor
20395 @opindex mctor-dtor
20396 Enable constructor/destructor feature.
20398 @item -mrelax
20399 @opindex mrelax
20400 Guide linker to relax instructions.
20402 @end table
20404 @node Nios II Options
20405 @subsection Nios II Options
20406 @cindex Nios II options
20407 @cindex Altera Nios II options
20409 These are the options defined for the Altera Nios II processor.
20411 @table @gcctabopt
20413 @item -G @var{num}
20414 @opindex G
20415 @cindex smaller data references
20416 Put global and static objects less than or equal to @var{num} bytes
20417 into the small data or BSS sections instead of the normal data or BSS
20418 sections.  The default value of @var{num} is 8.
20420 @item -mgpopt=@var{option}
20421 @item -mgpopt
20422 @itemx -mno-gpopt
20423 @opindex mgpopt
20424 @opindex mno-gpopt
20425 Generate (do not generate) GP-relative accesses.  The following 
20426 @var{option} names are recognized:
20428 @table @samp
20430 @item none
20431 Do not generate GP-relative accesses.
20433 @item local
20434 Generate GP-relative accesses for small data objects that are not 
20435 external, weak, or uninitialized common symbols.  
20436 Also use GP-relative addressing for objects that
20437 have been explicitly placed in a small data section via a @code{section}
20438 attribute.
20440 @item global
20441 As for @samp{local}, but also generate GP-relative accesses for
20442 small data objects that are external, weak, or common.  If you use this option,
20443 you must ensure that all parts of your program (including libraries) are
20444 compiled with the same @option{-G} setting.
20446 @item data
20447 Generate GP-relative accesses for all data objects in the program.  If you
20448 use this option, the entire data and BSS segments
20449 of your program must fit in 64K of memory and you must use an appropriate
20450 linker script to allocate them within the addressable range of the
20451 global pointer.
20453 @item all
20454 Generate GP-relative addresses for function pointers as well as data
20455 pointers.  If you use this option, the entire text, data, and BSS segments
20456 of your program must fit in 64K of memory and you must use an appropriate
20457 linker script to allocate them within the addressable range of the
20458 global pointer.
20460 @end table
20462 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20463 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20465 The default is @option{-mgpopt} except when @option{-fpic} or
20466 @option{-fPIC} is specified to generate position-independent code.
20467 Note that the Nios II ABI does not permit GP-relative accesses from
20468 shared libraries.
20470 You may need to specify @option{-mno-gpopt} explicitly when building
20471 programs that include large amounts of small data, including large
20472 GOT data sections.  In this case, the 16-bit offset for GP-relative
20473 addressing may not be large enough to allow access to the entire 
20474 small data section.
20476 @item -mel
20477 @itemx -meb
20478 @opindex mel
20479 @opindex meb
20480 Generate little-endian (default) or big-endian (experimental) code,
20481 respectively.
20483 @item -march=@var{arch}
20484 @opindex march
20485 This specifies the name of the target Nios II architecture.  GCC uses this
20486 name to determine what kind of instructions it can emit when generating
20487 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20489 The preprocessor macro @code{__nios2_arch__} is available to programs,
20490 with value 1 or 2, indicating the targeted ISA level.
20492 @item -mbypass-cache
20493 @itemx -mno-bypass-cache
20494 @opindex mno-bypass-cache
20495 @opindex mbypass-cache
20496 Force all load and store instructions to always bypass cache by 
20497 using I/O variants of the instructions. The default is not to
20498 bypass the cache.
20500 @item -mno-cache-volatile 
20501 @itemx -mcache-volatile       
20502 @opindex mcache-volatile 
20503 @opindex mno-cache-volatile
20504 Volatile memory access bypass the cache using the I/O variants of 
20505 the load and store instructions. The default is not to bypass the cache.
20507 @item -mno-fast-sw-div
20508 @itemx -mfast-sw-div
20509 @opindex mno-fast-sw-div
20510 @opindex mfast-sw-div
20511 Do not use table-based fast divide for small numbers. The default 
20512 is to use the fast divide at @option{-O3} and above.
20514 @item -mno-hw-mul
20515 @itemx -mhw-mul
20516 @itemx -mno-hw-mulx
20517 @itemx -mhw-mulx
20518 @itemx -mno-hw-div
20519 @itemx -mhw-div
20520 @opindex mno-hw-mul
20521 @opindex mhw-mul
20522 @opindex mno-hw-mulx
20523 @opindex mhw-mulx
20524 @opindex mno-hw-div
20525 @opindex mhw-div
20526 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20527 instructions by the compiler. The default is to emit @code{mul}
20528 and not emit @code{div} and @code{mulx}.
20530 @item -mbmx
20531 @itemx -mno-bmx
20532 @itemx -mcdx
20533 @itemx -mno-cdx
20534 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20535 CDX (code density) instructions.  Enabling these instructions also
20536 requires @option{-march=r2}.  Since these instructions are optional
20537 extensions to the R2 architecture, the default is not to emit them.
20539 @item -mcustom-@var{insn}=@var{N}
20540 @itemx -mno-custom-@var{insn}
20541 @opindex mcustom-@var{insn}
20542 @opindex mno-custom-@var{insn}
20543 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20544 custom instruction with encoding @var{N} when generating code that uses 
20545 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20546 instruction 253 for single-precision floating-point add operations instead
20547 of the default behavior of using a library call.
20549 The following values of @var{insn} are supported.  Except as otherwise
20550 noted, floating-point operations are expected to be implemented with
20551 normal IEEE 754 semantics and correspond directly to the C operators or the
20552 equivalent GCC built-in functions (@pxref{Other Builtins}).
20554 Single-precision floating point:
20555 @table @asis
20557 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20558 Binary arithmetic operations.
20560 @item @samp{fnegs}
20561 Unary negation.
20563 @item @samp{fabss}
20564 Unary absolute value.
20566 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20567 Comparison operations.
20569 @item @samp{fmins}, @samp{fmaxs}
20570 Floating-point minimum and maximum.  These instructions are only
20571 generated if @option{-ffinite-math-only} is specified.
20573 @item @samp{fsqrts}
20574 Unary square root operation.
20576 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20577 Floating-point trigonometric and exponential functions.  These instructions
20578 are only generated if @option{-funsafe-math-optimizations} is also specified.
20580 @end table
20582 Double-precision floating point:
20583 @table @asis
20585 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20586 Binary arithmetic operations.
20588 @item @samp{fnegd}
20589 Unary negation.
20591 @item @samp{fabsd}
20592 Unary absolute value.
20594 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20595 Comparison operations.
20597 @item @samp{fmind}, @samp{fmaxd}
20598 Double-precision minimum and maximum.  These instructions are only
20599 generated if @option{-ffinite-math-only} is specified.
20601 @item @samp{fsqrtd}
20602 Unary square root operation.
20604 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20605 Double-precision trigonometric and exponential functions.  These instructions
20606 are only generated if @option{-funsafe-math-optimizations} is also specified.
20608 @end table
20610 Conversions:
20611 @table @asis
20612 @item @samp{fextsd}
20613 Conversion from single precision to double precision.
20615 @item @samp{ftruncds}
20616 Conversion from double precision to single precision.
20618 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20619 Conversion from floating point to signed or unsigned integer types, with
20620 truncation towards zero.
20622 @item @samp{round}
20623 Conversion from single-precision floating point to signed integer,
20624 rounding to the nearest integer and ties away from zero.
20625 This corresponds to the @code{__builtin_lroundf} function when
20626 @option{-fno-math-errno} is used.
20628 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20629 Conversion from signed or unsigned integer types to floating-point types.
20631 @end table
20633 In addition, all of the following transfer instructions for internal
20634 registers X and Y must be provided to use any of the double-precision
20635 floating-point instructions.  Custom instructions taking two
20636 double-precision source operands expect the first operand in the
20637 64-bit register X.  The other operand (or only operand of a unary
20638 operation) is given to the custom arithmetic instruction with the
20639 least significant half in source register @var{src1} and the most
20640 significant half in @var{src2}.  A custom instruction that returns a
20641 double-precision result returns the most significant 32 bits in the
20642 destination register and the other half in 32-bit register Y.  
20643 GCC automatically generates the necessary code sequences to write
20644 register X and/or read register Y when double-precision floating-point
20645 instructions are used.
20647 @table @asis
20649 @item @samp{fwrx}
20650 Write @var{src1} into the least significant half of X and @var{src2} into
20651 the most significant half of X.
20653 @item @samp{fwry}
20654 Write @var{src1} into Y.
20656 @item @samp{frdxhi}, @samp{frdxlo}
20657 Read the most or least (respectively) significant half of X and store it in
20658 @var{dest}.
20660 @item @samp{frdy}
20661 Read the value of Y and store it into @var{dest}.
20662 @end table
20664 Note that you can gain more local control over generation of Nios II custom
20665 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20666 and @code{target("no-custom-@var{insn}")} function attributes
20667 (@pxref{Function Attributes})
20668 or pragmas (@pxref{Function Specific Option Pragmas}).
20670 @item -mcustom-fpu-cfg=@var{name}
20671 @opindex mcustom-fpu-cfg
20673 This option enables a predefined, named set of custom instruction encodings
20674 (see @option{-mcustom-@var{insn}} above).  
20675 Currently, the following sets are defined:
20677 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20678 @gccoptlist{-mcustom-fmuls=252 @gol
20679 -mcustom-fadds=253 @gol
20680 -mcustom-fsubs=254 @gol
20681 -fsingle-precision-constant}
20683 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20684 @gccoptlist{-mcustom-fmuls=252 @gol
20685 -mcustom-fadds=253 @gol
20686 -mcustom-fsubs=254 @gol
20687 -mcustom-fdivs=255 @gol
20688 -fsingle-precision-constant}
20690 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20691 @gccoptlist{-mcustom-floatus=243 @gol
20692 -mcustom-fixsi=244 @gol
20693 -mcustom-floatis=245 @gol
20694 -mcustom-fcmpgts=246 @gol
20695 -mcustom-fcmples=249 @gol
20696 -mcustom-fcmpeqs=250 @gol
20697 -mcustom-fcmpnes=251 @gol
20698 -mcustom-fmuls=252 @gol
20699 -mcustom-fadds=253 @gol
20700 -mcustom-fsubs=254 @gol
20701 -mcustom-fdivs=255 @gol
20702 -fsingle-precision-constant}
20704 Custom instruction assignments given by individual
20705 @option{-mcustom-@var{insn}=} options override those given by
20706 @option{-mcustom-fpu-cfg=}, regardless of the
20707 order of the options on the command line.
20709 Note that you can gain more local control over selection of a FPU
20710 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20711 function attribute (@pxref{Function Attributes})
20712 or pragma (@pxref{Function Specific Option Pragmas}).
20714 @end table
20716 These additional @samp{-m} options are available for the Altera Nios II
20717 ELF (bare-metal) target:
20719 @table @gcctabopt
20721 @item -mhal
20722 @opindex mhal
20723 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20724 startup and termination code, and is typically used in conjunction with
20725 @option{-msys-crt0=} to specify the location of the alternate startup code
20726 provided by the HAL BSP.
20728 @item -msmallc
20729 @opindex msmallc
20730 Link with a limited version of the C library, @option{-lsmallc}, rather than
20731 Newlib.
20733 @item -msys-crt0=@var{startfile}
20734 @opindex msys-crt0
20735 @var{startfile} is the file name of the startfile (crt0) to use 
20736 when linking.  This option is only useful in conjunction with @option{-mhal}.
20738 @item -msys-lib=@var{systemlib}
20739 @opindex msys-lib
20740 @var{systemlib} is the library name of the library that provides
20741 low-level system calls required by the C library,
20742 e.g. @code{read} and @code{write}.
20743 This option is typically used to link with a library provided by a HAL BSP.
20745 @end table
20747 @node Nvidia PTX Options
20748 @subsection Nvidia PTX Options
20749 @cindex Nvidia PTX options
20750 @cindex nvptx options
20752 These options are defined for Nvidia PTX:
20754 @table @gcctabopt
20756 @item -m32
20757 @itemx -m64
20758 @opindex m32
20759 @opindex m64
20760 Generate code for 32-bit or 64-bit ABI.
20762 @item -mmainkernel
20763 @opindex mmainkernel
20764 Link in code for a __main kernel.  This is for stand-alone instead of
20765 offloading execution.
20767 @item -moptimize
20768 @opindex moptimize
20769 Apply partitioned execution optimizations.  This is the default when any
20770 level of optimization is selected.
20772 @item -msoft-stack
20773 @opindex msoft-stack
20774 Generate code that does not use @code{.local} memory
20775 directly for stack storage. Instead, a per-warp stack pointer is
20776 maintained explicitly. This enables variable-length stack allocation (with
20777 variable-length arrays or @code{alloca}), and when global memory is used for
20778 underlying storage, makes it possible to access automatic variables from other
20779 threads, or with atomic instructions. This code generation variant is used
20780 for OpenMP offloading, but the option is exposed on its own for the purpose
20781 of testing the compiler; to generate code suitable for linking into programs
20782 using OpenMP offloading, use option @option{-mgomp}.
20784 @item -muniform-simt
20785 @opindex muniform-simt
20786 Switch to code generation variant that allows to execute all threads in each
20787 warp, while maintaining memory state and side effects as if only one thread
20788 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20789 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20790 current lane index equals the master lane index), and the register being
20791 assigned is copied via a shuffle instruction from the master lane.  Outside of
20792 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20793 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20794 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20795 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20796 with current lane index to compute the master lane index.
20798 @item -mgomp
20799 @opindex mgomp
20800 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20801 @option{-muniform-simt} options, and selects corresponding multilib variant.
20803 @end table
20805 @node PDP-11 Options
20806 @subsection PDP-11 Options
20807 @cindex PDP-11 Options
20809 These options are defined for the PDP-11:
20811 @table @gcctabopt
20812 @item -mfpu
20813 @opindex mfpu
20814 Use hardware FPP floating point.  This is the default.  (FIS floating
20815 point on the PDP-11/40 is not supported.)
20817 @item -msoft-float
20818 @opindex msoft-float
20819 Do not use hardware floating point.
20821 @item -mac0
20822 @opindex mac0
20823 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20825 @item -mno-ac0
20826 @opindex mno-ac0
20827 Return floating-point results in memory.  This is the default.
20829 @item -m40
20830 @opindex m40
20831 Generate code for a PDP-11/40.
20833 @item -m45
20834 @opindex m45
20835 Generate code for a PDP-11/45.  This is the default.
20837 @item -m10
20838 @opindex m10
20839 Generate code for a PDP-11/10.
20841 @item -mbcopy-builtin
20842 @opindex mbcopy-builtin
20843 Use inline @code{movmemhi} patterns for copying memory.  This is the
20844 default.
20846 @item -mbcopy
20847 @opindex mbcopy
20848 Do not use inline @code{movmemhi} patterns for copying memory.
20850 @item -mint16
20851 @itemx -mno-int32
20852 @opindex mint16
20853 @opindex mno-int32
20854 Use 16-bit @code{int}.  This is the default.
20856 @item -mint32
20857 @itemx -mno-int16
20858 @opindex mint32
20859 @opindex mno-int16
20860 Use 32-bit @code{int}.
20862 @item -mfloat64
20863 @itemx -mno-float32
20864 @opindex mfloat64
20865 @opindex mno-float32
20866 Use 64-bit @code{float}.  This is the default.
20868 @item -mfloat32
20869 @itemx -mno-float64
20870 @opindex mfloat32
20871 @opindex mno-float64
20872 Use 32-bit @code{float}.
20874 @item -mabshi
20875 @opindex mabshi
20876 Use @code{abshi2} pattern.  This is the default.
20878 @item -mno-abshi
20879 @opindex mno-abshi
20880 Do not use @code{abshi2} pattern.
20882 @item -mbranch-expensive
20883 @opindex mbranch-expensive
20884 Pretend that branches are expensive.  This is for experimenting with
20885 code generation only.
20887 @item -mbranch-cheap
20888 @opindex mbranch-cheap
20889 Do not pretend that branches are expensive.  This is the default.
20891 @item -munix-asm
20892 @opindex munix-asm
20893 Use Unix assembler syntax.  This is the default when configured for
20894 @samp{pdp11-*-bsd}.
20896 @item -mdec-asm
20897 @opindex mdec-asm
20898 Use DEC assembler syntax.  This is the default when configured for any
20899 PDP-11 target other than @samp{pdp11-*-bsd}.
20900 @end table
20902 @node picoChip Options
20903 @subsection picoChip Options
20904 @cindex picoChip options
20906 These @samp{-m} options are defined for picoChip implementations:
20908 @table @gcctabopt
20910 @item -mae=@var{ae_type}
20911 @opindex mcpu
20912 Set the instruction set, register set, and instruction scheduling
20913 parameters for array element type @var{ae_type}.  Supported values
20914 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20916 @option{-mae=ANY} selects a completely generic AE type.  Code
20917 generated with this option runs on any of the other AE types.  The
20918 code is not as efficient as it would be if compiled for a specific
20919 AE type, and some types of operation (e.g., multiplication) do not
20920 work properly on all types of AE.
20922 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20923 for compiled code, and is the default.
20925 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20926 option may suffer from poor performance of byte (char) manipulation,
20927 since the DSP AE does not provide hardware support for byte load/stores.
20929 @item -msymbol-as-address
20930 Enable the compiler to directly use a symbol name as an address in a
20931 load/store instruction, without first loading it into a
20932 register.  Typically, the use of this option generates larger
20933 programs, which run faster than when the option isn't used.  However, the
20934 results vary from program to program, so it is left as a user option,
20935 rather than being permanently enabled.
20937 @item -mno-inefficient-warnings
20938 Disables warnings about the generation of inefficient code.  These
20939 warnings can be generated, for example, when compiling code that
20940 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20941 no hardware support for byte-level memory operations, so all byte
20942 load/stores must be synthesized from word load/store operations.  This is
20943 inefficient and a warning is generated to indicate
20944 that you should rewrite the code to avoid byte operations, or to target
20945 an AE type that has the necessary hardware support.  This option disables
20946 these warnings.
20948 @end table
20950 @node PowerPC Options
20951 @subsection PowerPC Options
20952 @cindex PowerPC options
20954 These are listed under @xref{RS/6000 and PowerPC Options}.
20956 @node RL78 Options
20957 @subsection RL78 Options
20958 @cindex RL78 Options
20960 @table @gcctabopt
20962 @item -msim
20963 @opindex msim
20964 Links in additional target libraries to support operation within a
20965 simulator.
20967 @item -mmul=none
20968 @itemx -mmul=g10
20969 @itemx -mmul=g13
20970 @itemx -mmul=g14
20971 @itemx -mmul=rl78
20972 @opindex mmul
20973 Specifies the type of hardware multiplication and division support to
20974 be used.  The simplest is @code{none}, which uses software for both
20975 multiplication and division.  This is the default.  The @code{g13}
20976 value is for the hardware multiply/divide peripheral found on the
20977 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20978 the multiplication and division instructions supported by the RL78/G14
20979 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20980 the value @code{mg10} is an alias for @code{none}.
20982 In addition a C preprocessor macro is defined, based upon the setting
20983 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20984 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20986 @item -mcpu=g10
20987 @itemx -mcpu=g13
20988 @itemx -mcpu=g14
20989 @itemx -mcpu=rl78
20990 @opindex mcpu
20991 Specifies the RL78 core to target.  The default is the G14 core, also
20992 known as an S3 core or just RL78.  The G13 or S2 core does not have
20993 multiply or divide instructions, instead it uses a hardware peripheral
20994 for these operations.  The G10 or S1 core does not have register
20995 banks, so it uses a different calling convention.
20997 If this option is set it also selects the type of hardware multiply
20998 support to use, unless this is overridden by an explicit
20999 @option{-mmul=none} option on the command line.  Thus specifying
21000 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21001 peripheral and specifying @option{-mcpu=g10} disables the use of
21002 hardware multiplications altogether.
21004 Note, although the RL78/G14 core is the default target, specifying
21005 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21006 change the behavior of the toolchain since it also enables G14
21007 hardware multiply support.  If these options are not specified on the
21008 command line then software multiplication routines will be used even
21009 though the code targets the RL78 core.  This is for backwards
21010 compatibility with older toolchains which did not have hardware
21011 multiply and divide support.
21013 In addition a C preprocessor macro is defined, based upon the setting
21014 of this option.  Possible values are: @code{__RL78_G10__},
21015 @code{__RL78_G13__} or @code{__RL78_G14__}.
21017 @item -mg10
21018 @itemx -mg13
21019 @itemx -mg14
21020 @itemx -mrl78
21021 @opindex mg10
21022 @opindex mg13
21023 @opindex mg14
21024 @opindex mrl78
21025 These are aliases for the corresponding @option{-mcpu=} option.  They
21026 are provided for backwards compatibility.
21028 @item -mallregs
21029 @opindex mallregs
21030 Allow the compiler to use all of the available registers.  By default
21031 registers @code{r24..r31} are reserved for use in interrupt handlers.
21032 With this option enabled these registers can be used in ordinary
21033 functions as well.
21035 @item -m64bit-doubles
21036 @itemx -m32bit-doubles
21037 @opindex m64bit-doubles
21038 @opindex m32bit-doubles
21039 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21040 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21041 @option{-m32bit-doubles}.
21043 @item -msave-mduc-in-interrupts
21044 @item -mno-save-mduc-in-interrupts
21045 @opindex msave-mduc-in-interrupts
21046 @opindex mno-save-mduc-in-interrupts
21047 Specifies that interrupt handler functions should preserve the
21048 MDUC registers.  This is only necessary if normal code might use
21049 the MDUC registers, for example because it performs multiplication
21050 and division operations.  The default is to ignore the MDUC registers
21051 as this makes the interrupt handlers faster.  The target option -mg13
21052 needs to be passed for this to work as this feature is only available
21053 on the G13 target (S2 core).  The MDUC registers will only be saved
21054 if the interrupt handler performs a multiplication or division
21055 operation or it calls another function.
21057 @end table
21059 @node RS/6000 and PowerPC Options
21060 @subsection IBM RS/6000 and PowerPC Options
21061 @cindex RS/6000 and PowerPC Options
21062 @cindex IBM RS/6000 and PowerPC Options
21064 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21065 @table @gcctabopt
21066 @item -mpowerpc-gpopt
21067 @itemx -mno-powerpc-gpopt
21068 @itemx -mpowerpc-gfxopt
21069 @itemx -mno-powerpc-gfxopt
21070 @need 800
21071 @itemx -mpowerpc64
21072 @itemx -mno-powerpc64
21073 @itemx -mmfcrf
21074 @itemx -mno-mfcrf
21075 @itemx -mpopcntb
21076 @itemx -mno-popcntb
21077 @itemx -mpopcntd
21078 @itemx -mno-popcntd
21079 @itemx -mfprnd
21080 @itemx -mno-fprnd
21081 @need 800
21082 @itemx -mcmpb
21083 @itemx -mno-cmpb
21084 @itemx -mmfpgpr
21085 @itemx -mno-mfpgpr
21086 @itemx -mhard-dfp
21087 @itemx -mno-hard-dfp
21088 @opindex mpowerpc-gpopt
21089 @opindex mno-powerpc-gpopt
21090 @opindex mpowerpc-gfxopt
21091 @opindex mno-powerpc-gfxopt
21092 @opindex mpowerpc64
21093 @opindex mno-powerpc64
21094 @opindex mmfcrf
21095 @opindex mno-mfcrf
21096 @opindex mpopcntb
21097 @opindex mno-popcntb
21098 @opindex mpopcntd
21099 @opindex mno-popcntd
21100 @opindex mfprnd
21101 @opindex mno-fprnd
21102 @opindex mcmpb
21103 @opindex mno-cmpb
21104 @opindex mmfpgpr
21105 @opindex mno-mfpgpr
21106 @opindex mhard-dfp
21107 @opindex mno-hard-dfp
21108 You use these options to specify which instructions are available on the
21109 processor you are using.  The default value of these options is
21110 determined when configuring GCC@.  Specifying the
21111 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21112 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21113 rather than the options listed above.
21115 Specifying @option{-mpowerpc-gpopt} allows
21116 GCC to use the optional PowerPC architecture instructions in the
21117 General Purpose group, including floating-point square root.  Specifying
21118 @option{-mpowerpc-gfxopt} allows GCC to
21119 use the optional PowerPC architecture instructions in the Graphics
21120 group, including floating-point select.
21122 The @option{-mmfcrf} option allows GCC to generate the move from
21123 condition register field instruction implemented on the POWER4
21124 processor and other processors that support the PowerPC V2.01
21125 architecture.
21126 The @option{-mpopcntb} option allows GCC to generate the popcount and
21127 double-precision FP reciprocal estimate instruction implemented on the
21128 POWER5 processor and other processors that support the PowerPC V2.02
21129 architecture.
21130 The @option{-mpopcntd} option allows GCC to generate the popcount
21131 instruction implemented on the POWER7 processor and other processors
21132 that support the PowerPC V2.06 architecture.
21133 The @option{-mfprnd} option allows GCC to generate the FP round to
21134 integer instructions implemented on the POWER5+ processor and other
21135 processors that support the PowerPC V2.03 architecture.
21136 The @option{-mcmpb} option allows GCC to generate the compare bytes
21137 instruction implemented on the POWER6 processor and other processors
21138 that support the PowerPC V2.05 architecture.
21139 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21140 general-purpose register instructions implemented on the POWER6X
21141 processor and other processors that support the extended PowerPC V2.05
21142 architecture.
21143 The @option{-mhard-dfp} option allows GCC to generate the decimal
21144 floating-point instructions implemented on some POWER processors.
21146 The @option{-mpowerpc64} option allows GCC to generate the additional
21147 64-bit instructions that are found in the full PowerPC64 architecture
21148 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21149 @option{-mno-powerpc64}.
21151 @item -mcpu=@var{cpu_type}
21152 @opindex mcpu
21153 Set architecture type, register usage, and
21154 instruction scheduling parameters for machine type @var{cpu_type}.
21155 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21156 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21157 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21158 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21159 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21160 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21161 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21162 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21163 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21164 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21165 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21166 and @samp{rs64}.
21168 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21169 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21170 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21171 architecture machine types, with an appropriate, generic processor
21172 model assumed for scheduling purposes.
21174 The other options specify a specific processor.  Code generated under
21175 those options runs best on that processor, and may not run at all on
21176 others.
21178 The @option{-mcpu} options automatically enable or disable the
21179 following options:
21181 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21182 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21183 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21184 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21185 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21186 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21188 The particular options set for any particular CPU varies between
21189 compiler versions, depending on what setting seems to produce optimal
21190 code for that CPU; it doesn't necessarily reflect the actual hardware's
21191 capabilities.  If you wish to set an individual option to a particular
21192 value, you may specify it after the @option{-mcpu} option, like
21193 @option{-mcpu=970 -mno-altivec}.
21195 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21196 not enabled or disabled by the @option{-mcpu} option at present because
21197 AIX does not have full support for these options.  You may still
21198 enable or disable them individually if you're sure it'll work in your
21199 environment.
21201 @item -mtune=@var{cpu_type}
21202 @opindex mtune
21203 Set the instruction scheduling parameters for machine type
21204 @var{cpu_type}, but do not set the architecture type or register usage,
21205 as @option{-mcpu=@var{cpu_type}} does.  The same
21206 values for @var{cpu_type} are used for @option{-mtune} as for
21207 @option{-mcpu}.  If both are specified, the code generated uses the
21208 architecture and registers set by @option{-mcpu}, but the
21209 scheduling parameters set by @option{-mtune}.
21211 @item -mcmodel=small
21212 @opindex mcmodel=small
21213 Generate PowerPC64 code for the small model: The TOC is limited to
21214 64k.
21216 @item -mcmodel=medium
21217 @opindex mcmodel=medium
21218 Generate PowerPC64 code for the medium model: The TOC and other static
21219 data may be up to a total of 4G in size.
21221 @item -mcmodel=large
21222 @opindex mcmodel=large
21223 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21224 in size.  Other data and code is only limited by the 64-bit address
21225 space.
21227 @item -maltivec
21228 @itemx -mno-altivec
21229 @opindex maltivec
21230 @opindex mno-altivec
21231 Generate code that uses (does not use) AltiVec instructions, and also
21232 enable the use of built-in functions that allow more direct access to
21233 the AltiVec instruction set.  You may also need to set
21234 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21235 enhancements.
21237 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21238 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21239 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21240 match array element order corresponding to the endianness of the
21241 target.  That is, element zero identifies the leftmost element in a
21242 vector register when targeting a big-endian platform, and identifies
21243 the rightmost element in a vector register when targeting a
21244 little-endian platform.
21246 @item -maltivec=be
21247 @opindex maltivec=be
21248 Generate AltiVec instructions using big-endian element order,
21249 regardless of whether the target is big- or little-endian.  This is
21250 the default when targeting a big-endian platform.
21252 The element order is used to interpret element numbers in AltiVec
21253 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21254 @code{vec_insert}.  By default, these match array element order
21255 corresponding to the endianness for the target.
21257 @item -maltivec=le
21258 @opindex maltivec=le
21259 Generate AltiVec instructions using little-endian element order,
21260 regardless of whether the target is big- or little-endian.  This is
21261 the default when targeting a little-endian platform.  This option is
21262 currently ignored when targeting a big-endian platform.
21264 The element order is used to interpret element numbers in AltiVec
21265 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21266 @code{vec_insert}.  By default, these match array element order
21267 corresponding to the endianness for the target.
21269 @item -mvrsave
21270 @itemx -mno-vrsave
21271 @opindex mvrsave
21272 @opindex mno-vrsave
21273 Generate VRSAVE instructions when generating AltiVec code.
21275 @item -mgen-cell-microcode
21276 @opindex mgen-cell-microcode
21277 Generate Cell microcode instructions.
21279 @item -mwarn-cell-microcode
21280 @opindex mwarn-cell-microcode
21281 Warn when a Cell microcode instruction is emitted.  An example
21282 of a Cell microcode instruction is a variable shift.
21284 @item -msecure-plt
21285 @opindex msecure-plt
21286 Generate code that allows @command{ld} and @command{ld.so}
21287 to build executables and shared
21288 libraries with non-executable @code{.plt} and @code{.got} sections.
21289 This is a PowerPC
21290 32-bit SYSV ABI option.
21292 @item -mbss-plt
21293 @opindex mbss-plt
21294 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21295 fills in, and
21296 requires @code{.plt} and @code{.got}
21297 sections that are both writable and executable.
21298 This is a PowerPC 32-bit SYSV ABI option.
21300 @item -misel
21301 @itemx -mno-isel
21302 @opindex misel
21303 @opindex mno-isel
21304 This switch enables or disables the generation of ISEL instructions.
21306 @item -misel=@var{yes/no}
21307 This switch has been deprecated.  Use @option{-misel} and
21308 @option{-mno-isel} instead.
21310 @item -mlra
21311 @opindex mlra
21312 Enable Local Register Allocation. By default the port uses LRA.
21313 (i.e. @option{-mno-lra}).
21315 @item -mspe
21316 @itemx -mno-spe
21317 @opindex mspe
21318 @opindex mno-spe
21319 This switch enables or disables the generation of SPE simd
21320 instructions.
21322 @item -mpaired
21323 @itemx -mno-paired
21324 @opindex mpaired
21325 @opindex mno-paired
21326 This switch enables or disables the generation of PAIRED simd
21327 instructions.
21329 @item -mspe=@var{yes/no}
21330 This option has been deprecated.  Use @option{-mspe} and
21331 @option{-mno-spe} instead.
21333 @item -mvsx
21334 @itemx -mno-vsx
21335 @opindex mvsx
21336 @opindex mno-vsx
21337 Generate code that uses (does not use) vector/scalar (VSX)
21338 instructions, and also enable the use of built-in functions that allow
21339 more direct access to the VSX instruction set.
21341 @item -mcrypto
21342 @itemx -mno-crypto
21343 @opindex mcrypto
21344 @opindex mno-crypto
21345 Enable the use (disable) of the built-in functions that allow direct
21346 access to the cryptographic instructions that were added in version
21347 2.07 of the PowerPC ISA.
21349 @item -mdirect-move
21350 @itemx -mno-direct-move
21351 @opindex mdirect-move
21352 @opindex mno-direct-move
21353 Generate code that uses (does not use) the instructions to move data
21354 between the general purpose registers and the vector/scalar (VSX)
21355 registers that were added in version 2.07 of the PowerPC ISA.
21357 @item -mhtm
21358 @itemx -mno-htm
21359 @opindex mhtm
21360 @opindex mno-htm
21361 Enable (disable) the use of the built-in functions that allow direct
21362 access to the Hardware Transactional Memory (HTM) instructions that
21363 were added in version 2.07 of the PowerPC ISA.
21365 @item -mpower8-fusion
21366 @itemx -mno-power8-fusion
21367 @opindex mpower8-fusion
21368 @opindex mno-power8-fusion
21369 Generate code that keeps (does not keeps) some integer operations
21370 adjacent so that the instructions can be fused together on power8 and
21371 later processors.
21373 @item -mpower8-vector
21374 @itemx -mno-power8-vector
21375 @opindex mpower8-vector
21376 @opindex mno-power8-vector
21377 Generate code that uses (does not use) the vector and scalar
21378 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21379 enable the use of built-in functions that allow more direct access to
21380 the vector instructions.
21382 @item -mquad-memory
21383 @itemx -mno-quad-memory
21384 @opindex mquad-memory
21385 @opindex mno-quad-memory
21386 Generate code that uses (does not use) the non-atomic quad word memory
21387 instructions.  The @option{-mquad-memory} option requires use of
21388 64-bit mode.
21390 @item -mquad-memory-atomic
21391 @itemx -mno-quad-memory-atomic
21392 @opindex mquad-memory-atomic
21393 @opindex mno-quad-memory-atomic
21394 Generate code that uses (does not use) the atomic quad word memory
21395 instructions.  The @option{-mquad-memory-atomic} option requires use of
21396 64-bit mode.
21398 @item -mupper-regs-di
21399 @itemx -mno-upper-regs-di
21400 @opindex mupper-regs-di
21401 @opindex mno-upper-regs-di
21402 Generate code that uses (does not use) the scalar instructions that
21403 target all 64 registers in the vector/scalar floating point register
21404 set that were added in version 2.06 of the PowerPC ISA when processing
21405 integers.  @option{-mupper-regs-di} is turned on by default if you use
21406 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21407 @option{-mcpu=power9}, or @option{-mvsx} options.
21409 @item -mupper-regs-df
21410 @itemx -mno-upper-regs-df
21411 @opindex mupper-regs-df
21412 @opindex mno-upper-regs-df
21413 Generate code that uses (does not use) the scalar double precision
21414 instructions that target all 64 registers in the vector/scalar
21415 floating point register set that were added in version 2.06 of the
21416 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21417 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21418 @option{-mcpu=power9}, or @option{-mvsx} options.
21420 @item -mupper-regs-sf
21421 @itemx -mno-upper-regs-sf
21422 @opindex mupper-regs-sf
21423 @opindex mno-upper-regs-sf
21424 Generate code that uses (does not use) the scalar single precision
21425 instructions that target all 64 registers in the vector/scalar
21426 floating point register set that were added in version 2.07 of the
21427 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21428 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21429 @option{-mcpu=power9} options.
21431 @item -mupper-regs
21432 @itemx -mno-upper-regs
21433 @opindex mupper-regs
21434 @opindex mno-upper-regs
21435 Generate code that uses (does not use) the scalar
21436 instructions that target all 64 registers in the vector/scalar
21437 floating point register set, depending on the model of the machine.
21439 If the @option{-mno-upper-regs} option is used, it turns off both
21440 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21442 @item -mfloat128
21443 @itemx -mno-float128
21444 @opindex mfloat128
21445 @opindex mno-float128
21446 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21447 and use either software emulation for IEEE 128-bit floating point or
21448 hardware instructions.
21450 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21451 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21452 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21453 Linux systems.
21455 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21456 @option{-mfloat128} option will also enable the generation of ISA 3.0
21457 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21458 floating point will be done with software emulation.
21460 @item -mfloat128-hardware
21461 @itemx -mno-float128-hardware
21462 @opindex mfloat128-hardware
21463 @opindex mno-float128-hardware
21464 Enable/disable using ISA 3.0 hardware instructions to support the
21465 @var{__float128} data type.
21467 If you use @option{-mfloat128-hardware}, it will enable the option
21468 @option{-mfloat128} as well.
21470 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21471 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21472 the IEEE 128-bit floating point support will not be enabled.
21474 @item -mfloat-gprs=@var{yes/single/double/no}
21475 @itemx -mfloat-gprs
21476 @opindex mfloat-gprs
21477 This switch enables or disables the generation of floating-point
21478 operations on the general-purpose registers for architectures that
21479 support it.
21481 The argument @samp{yes} or @samp{single} enables the use of
21482 single-precision floating-point operations.
21484 The argument @samp{double} enables the use of single and
21485 double-precision floating-point operations.
21487 The argument @samp{no} disables floating-point operations on the
21488 general-purpose registers.
21490 This option is currently only available on the MPC854x.
21492 @item -m32
21493 @itemx -m64
21494 @opindex m32
21495 @opindex m64
21496 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21497 targets (including GNU/Linux).  The 32-bit environment sets int, long
21498 and pointer to 32 bits and generates code that runs on any PowerPC
21499 variant.  The 64-bit environment sets int to 32 bits and long and
21500 pointer to 64 bits, and generates code for PowerPC64, as for
21501 @option{-mpowerpc64}.
21503 @item -mfull-toc
21504 @itemx -mno-fp-in-toc
21505 @itemx -mno-sum-in-toc
21506 @itemx -mminimal-toc
21507 @opindex mfull-toc
21508 @opindex mno-fp-in-toc
21509 @opindex mno-sum-in-toc
21510 @opindex mminimal-toc
21511 Modify generation of the TOC (Table Of Contents), which is created for
21512 every executable file.  The @option{-mfull-toc} option is selected by
21513 default.  In that case, GCC allocates at least one TOC entry for
21514 each unique non-automatic variable reference in your program.  GCC
21515 also places floating-point constants in the TOC@.  However, only
21516 16,384 entries are available in the TOC@.
21518 If you receive a linker error message that saying you have overflowed
21519 the available TOC space, you can reduce the amount of TOC space used
21520 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21521 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21522 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21523 generate code to calculate the sum of an address and a constant at
21524 run time instead of putting that sum into the TOC@.  You may specify one
21525 or both of these options.  Each causes GCC to produce very slightly
21526 slower and larger code at the expense of conserving TOC space.
21528 If you still run out of space in the TOC even when you specify both of
21529 these options, specify @option{-mminimal-toc} instead.  This option causes
21530 GCC to make only one TOC entry for every file.  When you specify this
21531 option, GCC produces code that is slower and larger but which
21532 uses extremely little TOC space.  You may wish to use this option
21533 only on files that contain less frequently-executed code.
21535 @item -maix64
21536 @itemx -maix32
21537 @opindex maix64
21538 @opindex maix32
21539 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21540 @code{long} type, and the infrastructure needed to support them.
21541 Specifying @option{-maix64} implies @option{-mpowerpc64},
21542 while @option{-maix32} disables the 64-bit ABI and
21543 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21545 @item -mxl-compat
21546 @itemx -mno-xl-compat
21547 @opindex mxl-compat
21548 @opindex mno-xl-compat
21549 Produce code that conforms more closely to IBM XL compiler semantics
21550 when using AIX-compatible ABI@.  Pass floating-point arguments to
21551 prototyped functions beyond the register save area (RSA) on the stack
21552 in addition to argument FPRs.  Do not assume that most significant
21553 double in 128-bit long double value is properly rounded when comparing
21554 values and converting to double.  Use XL symbol names for long double
21555 support routines.
21557 The AIX calling convention was extended but not initially documented to
21558 handle an obscure K&R C case of calling a function that takes the
21559 address of its arguments with fewer arguments than declared.  IBM XL
21560 compilers access floating-point arguments that do not fit in the
21561 RSA from the stack when a subroutine is compiled without
21562 optimization.  Because always storing floating-point arguments on the
21563 stack is inefficient and rarely needed, this option is not enabled by
21564 default and only is necessary when calling subroutines compiled by IBM
21565 XL compilers without optimization.
21567 @item -mpe
21568 @opindex mpe
21569 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21570 application written to use message passing with special startup code to
21571 enable the application to run.  The system must have PE installed in the
21572 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21573 must be overridden with the @option{-specs=} option to specify the
21574 appropriate directory location.  The Parallel Environment does not
21575 support threads, so the @option{-mpe} option and the @option{-pthread}
21576 option are incompatible.
21578 @item -malign-natural
21579 @itemx -malign-power
21580 @opindex malign-natural
21581 @opindex malign-power
21582 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21583 @option{-malign-natural} overrides the ABI-defined alignment of larger
21584 types, such as floating-point doubles, on their natural size-based boundary.
21585 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21586 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21588 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21589 is not supported.
21591 @item -msoft-float
21592 @itemx -mhard-float
21593 @opindex msoft-float
21594 @opindex mhard-float
21595 Generate code that does not use (uses) the floating-point register set.
21596 Software floating-point emulation is provided if you use the
21597 @option{-msoft-float} option, and pass the option to GCC when linking.
21599 @item -msingle-float
21600 @itemx -mdouble-float
21601 @opindex msingle-float
21602 @opindex mdouble-float
21603 Generate code for single- or double-precision floating-point operations.
21604 @option{-mdouble-float} implies @option{-msingle-float}.
21606 @item -msimple-fpu
21607 @opindex msimple-fpu
21608 Do not generate @code{sqrt} and @code{div} instructions for hardware
21609 floating-point unit.
21611 @item -mfpu=@var{name}
21612 @opindex mfpu
21613 Specify type of floating-point unit.  Valid values for @var{name} are
21614 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21615 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21616 @samp{sp_full} (equivalent to @option{-msingle-float}),
21617 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21619 @item -mxilinx-fpu
21620 @opindex mxilinx-fpu
21621 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21623 @item -mmultiple
21624 @itemx -mno-multiple
21625 @opindex mmultiple
21626 @opindex mno-multiple
21627 Generate code that uses (does not use) the load multiple word
21628 instructions and the store multiple word instructions.  These
21629 instructions are generated by default on POWER systems, and not
21630 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21631 PowerPC systems, since those instructions do not work when the
21632 processor is in little-endian mode.  The exceptions are PPC740 and
21633 PPC750 which permit these instructions in little-endian mode.
21635 @item -mstring
21636 @itemx -mno-string
21637 @opindex mstring
21638 @opindex mno-string
21639 Generate code that uses (does not use) the load string instructions
21640 and the store string word instructions to save multiple registers and
21641 do small block moves.  These instructions are generated by default on
21642 POWER systems, and not generated on PowerPC systems.  Do not use
21643 @option{-mstring} on little-endian PowerPC systems, since those
21644 instructions do not work when the processor is in little-endian mode.
21645 The exceptions are PPC740 and PPC750 which permit these instructions
21646 in little-endian mode.
21648 @item -mupdate
21649 @itemx -mno-update
21650 @opindex mupdate
21651 @opindex mno-update
21652 Generate code that uses (does not use) the load or store instructions
21653 that update the base register to the address of the calculated memory
21654 location.  These instructions are generated by default.  If you use
21655 @option{-mno-update}, there is a small window between the time that the
21656 stack pointer is updated and the address of the previous frame is
21657 stored, which means code that walks the stack frame across interrupts or
21658 signals may get corrupted data.
21660 @item -mavoid-indexed-addresses
21661 @itemx -mno-avoid-indexed-addresses
21662 @opindex mavoid-indexed-addresses
21663 @opindex mno-avoid-indexed-addresses
21664 Generate code that tries to avoid (not avoid) the use of indexed load
21665 or store instructions. These instructions can incur a performance
21666 penalty on Power6 processors in certain situations, such as when
21667 stepping through large arrays that cross a 16M boundary.  This option
21668 is enabled by default when targeting Power6 and disabled otherwise.
21670 @item -mfused-madd
21671 @itemx -mno-fused-madd
21672 @opindex mfused-madd
21673 @opindex mno-fused-madd
21674 Generate code that uses (does not use) the floating-point multiply and
21675 accumulate instructions.  These instructions are generated by default
21676 if hardware floating point is used.  The machine-dependent
21677 @option{-mfused-madd} option is now mapped to the machine-independent
21678 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21679 mapped to @option{-ffp-contract=off}.
21681 @item -mmulhw
21682 @itemx -mno-mulhw
21683 @opindex mmulhw
21684 @opindex mno-mulhw
21685 Generate code that uses (does not use) the half-word multiply and
21686 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21687 These instructions are generated by default when targeting those
21688 processors.
21690 @item -mdlmzb
21691 @itemx -mno-dlmzb
21692 @opindex mdlmzb
21693 @opindex mno-dlmzb
21694 Generate code that uses (does not use) the string-search @samp{dlmzb}
21695 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21696 generated by default when targeting those processors.
21698 @item -mno-bit-align
21699 @itemx -mbit-align
21700 @opindex mno-bit-align
21701 @opindex mbit-align
21702 On System V.4 and embedded PowerPC systems do not (do) force structures
21703 and unions that contain bit-fields to be aligned to the base type of the
21704 bit-field.
21706 For example, by default a structure containing nothing but 8
21707 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21708 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21709 the structure is aligned to a 1-byte boundary and is 1 byte in
21710 size.
21712 @item -mno-strict-align
21713 @itemx -mstrict-align
21714 @opindex mno-strict-align
21715 @opindex mstrict-align
21716 On System V.4 and embedded PowerPC systems do not (do) assume that
21717 unaligned memory references are handled by the system.
21719 @item -mrelocatable
21720 @itemx -mno-relocatable
21721 @opindex mrelocatable
21722 @opindex mno-relocatable
21723 Generate code that allows (does not allow) a static executable to be
21724 relocated to a different address at run time.  A simple embedded
21725 PowerPC system loader should relocate the entire contents of
21726 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21727 a table of 32-bit addresses generated by this option.  For this to
21728 work, all objects linked together must be compiled with
21729 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21730 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21732 @item -mrelocatable-lib
21733 @itemx -mno-relocatable-lib
21734 @opindex mrelocatable-lib
21735 @opindex mno-relocatable-lib
21736 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21737 @code{.fixup} section to allow static executables to be relocated at
21738 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21739 alignment of @option{-mrelocatable}.  Objects compiled with
21740 @option{-mrelocatable-lib} may be linked with objects compiled with
21741 any combination of the @option{-mrelocatable} options.
21743 @item -mno-toc
21744 @itemx -mtoc
21745 @opindex mno-toc
21746 @opindex mtoc
21747 On System V.4 and embedded PowerPC systems do not (do) assume that
21748 register 2 contains a pointer to a global area pointing to the addresses
21749 used in the program.
21751 @item -mlittle
21752 @itemx -mlittle-endian
21753 @opindex mlittle
21754 @opindex mlittle-endian
21755 On System V.4 and embedded PowerPC systems compile code for the
21756 processor in little-endian mode.  The @option{-mlittle-endian} option is
21757 the same as @option{-mlittle}.
21759 @item -mbig
21760 @itemx -mbig-endian
21761 @opindex mbig
21762 @opindex mbig-endian
21763 On System V.4 and embedded PowerPC systems compile code for the
21764 processor in big-endian mode.  The @option{-mbig-endian} option is
21765 the same as @option{-mbig}.
21767 @item -mdynamic-no-pic
21768 @opindex mdynamic-no-pic
21769 On Darwin and Mac OS X systems, compile code so that it is not
21770 relocatable, but that its external references are relocatable.  The
21771 resulting code is suitable for applications, but not shared
21772 libraries.
21774 @item -msingle-pic-base
21775 @opindex msingle-pic-base
21776 Treat the register used for PIC addressing as read-only, rather than
21777 loading it in the prologue for each function.  The runtime system is
21778 responsible for initializing this register with an appropriate value
21779 before execution begins.
21781 @item -mprioritize-restricted-insns=@var{priority}
21782 @opindex mprioritize-restricted-insns
21783 This option controls the priority that is assigned to
21784 dispatch-slot restricted instructions during the second scheduling
21785 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21786 or @samp{2} to assign no, highest, or second-highest (respectively) 
21787 priority to dispatch-slot restricted
21788 instructions.
21790 @item -msched-costly-dep=@var{dependence_type}
21791 @opindex msched-costly-dep
21792 This option controls which dependences are considered costly
21793 by the target during instruction scheduling.  The argument
21794 @var{dependence_type} takes one of the following values:
21796 @table @asis
21797 @item @samp{no}
21798 No dependence is costly.
21800 @item @samp{all}
21801 All dependences are costly.
21803 @item @samp{true_store_to_load}
21804 A true dependence from store to load is costly.
21806 @item @samp{store_to_load}
21807 Any dependence from store to load is costly.
21809 @item @var{number}
21810 Any dependence for which the latency is greater than or equal to 
21811 @var{number} is costly.
21812 @end table
21814 @item -minsert-sched-nops=@var{scheme}
21815 @opindex minsert-sched-nops
21816 This option controls which NOP insertion scheme is used during
21817 the second scheduling pass.  The argument @var{scheme} takes one of the
21818 following values:
21820 @table @asis
21821 @item @samp{no}
21822 Don't insert NOPs.
21824 @item @samp{pad}
21825 Pad with NOPs any dispatch group that has vacant issue slots,
21826 according to the scheduler's grouping.
21828 @item @samp{regroup_exact}
21829 Insert NOPs to force costly dependent insns into
21830 separate groups.  Insert exactly as many NOPs as needed to force an insn
21831 to a new group, according to the estimated processor grouping.
21833 @item @var{number}
21834 Insert NOPs to force costly dependent insns into
21835 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21836 @end table
21838 @item -mcall-sysv
21839 @opindex mcall-sysv
21840 On System V.4 and embedded PowerPC systems compile code using calling
21841 conventions that adhere to the March 1995 draft of the System V
21842 Application Binary Interface, PowerPC processor supplement.  This is the
21843 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21845 @item -mcall-sysv-eabi
21846 @itemx -mcall-eabi
21847 @opindex mcall-sysv-eabi
21848 @opindex mcall-eabi
21849 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21851 @item -mcall-sysv-noeabi
21852 @opindex mcall-sysv-noeabi
21853 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21855 @item -mcall-aixdesc
21856 @opindex m
21857 On System V.4 and embedded PowerPC systems compile code for the AIX
21858 operating system.
21860 @item -mcall-linux
21861 @opindex mcall-linux
21862 On System V.4 and embedded PowerPC systems compile code for the
21863 Linux-based GNU system.
21865 @item -mcall-freebsd
21866 @opindex mcall-freebsd
21867 On System V.4 and embedded PowerPC systems compile code for the
21868 FreeBSD operating system.
21870 @item -mcall-netbsd
21871 @opindex mcall-netbsd
21872 On System V.4 and embedded PowerPC systems compile code for the
21873 NetBSD operating system.
21875 @item -mcall-openbsd
21876 @opindex mcall-netbsd
21877 On System V.4 and embedded PowerPC systems compile code for the
21878 OpenBSD operating system.
21880 @item -maix-struct-return
21881 @opindex maix-struct-return
21882 Return all structures in memory (as specified by the AIX ABI)@.
21884 @item -msvr4-struct-return
21885 @opindex msvr4-struct-return
21886 Return structures smaller than 8 bytes in registers (as specified by the
21887 SVR4 ABI)@.
21889 @item -mabi=@var{abi-type}
21890 @opindex mabi
21891 Extend the current ABI with a particular extension, or remove such extension.
21892 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21893 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21894 @samp{elfv1}, @samp{elfv2}@.
21896 @item -mabi=spe
21897 @opindex mabi=spe
21898 Extend the current ABI with SPE ABI extensions.  This does not change
21899 the default ABI, instead it adds the SPE ABI extensions to the current
21900 ABI@.
21902 @item -mabi=no-spe
21903 @opindex mabi=no-spe
21904 Disable Book-E SPE ABI extensions for the current ABI@.
21906 @item -mabi=ibmlongdouble
21907 @opindex mabi=ibmlongdouble
21908 Change the current ABI to use IBM extended-precision long double.
21909 This is a PowerPC 32-bit SYSV ABI option.
21911 @item -mabi=ieeelongdouble
21912 @opindex mabi=ieeelongdouble
21913 Change the current ABI to use IEEE extended-precision long double.
21914 This is a PowerPC 32-bit Linux ABI option.
21916 @item -mabi=elfv1
21917 @opindex mabi=elfv1
21918 Change the current ABI to use the ELFv1 ABI.
21919 This is the default ABI for big-endian PowerPC 64-bit Linux.
21920 Overriding the default ABI requires special system support and is
21921 likely to fail in spectacular ways.
21923 @item -mabi=elfv2
21924 @opindex mabi=elfv2
21925 Change the current ABI to use the ELFv2 ABI.
21926 This is the default ABI for little-endian PowerPC 64-bit Linux.
21927 Overriding the default ABI requires special system support and is
21928 likely to fail in spectacular ways.
21930 @item -mgnu-attribute
21931 @itemx -mno-gnu-attribute
21932 @opindex mgnu-attribute
21933 @opindex mno-gnu-attribute
21934 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21935 .gnu.attributes section that specify ABI variations in function
21936 parameters or return values.
21938 @item -mprototype
21939 @itemx -mno-prototype
21940 @opindex mprototype
21941 @opindex mno-prototype
21942 On System V.4 and embedded PowerPC systems assume that all calls to
21943 variable argument functions are properly prototyped.  Otherwise, the
21944 compiler must insert an instruction before every non-prototyped call to
21945 set or clear bit 6 of the condition code register (@code{CR}) to
21946 indicate whether floating-point values are passed in the floating-point
21947 registers in case the function takes variable arguments.  With
21948 @option{-mprototype}, only calls to prototyped variable argument functions
21949 set or clear the bit.
21951 @item -msim
21952 @opindex msim
21953 On embedded PowerPC systems, assume that the startup module is called
21954 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21955 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21956 configurations.
21958 @item -mmvme
21959 @opindex mmvme
21960 On embedded PowerPC systems, assume that the startup module is called
21961 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21962 @file{libc.a}.
21964 @item -mads
21965 @opindex mads
21966 On embedded PowerPC systems, assume that the startup module is called
21967 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21968 @file{libc.a}.
21970 @item -myellowknife
21971 @opindex myellowknife
21972 On embedded PowerPC systems, assume that the startup module is called
21973 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21974 @file{libc.a}.
21976 @item -mvxworks
21977 @opindex mvxworks
21978 On System V.4 and embedded PowerPC systems, specify that you are
21979 compiling for a VxWorks system.
21981 @item -memb
21982 @opindex memb
21983 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21984 header to indicate that @samp{eabi} extended relocations are used.
21986 @item -meabi
21987 @itemx -mno-eabi
21988 @opindex meabi
21989 @opindex mno-eabi
21990 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21991 Embedded Applications Binary Interface (EABI), which is a set of
21992 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21993 means that the stack is aligned to an 8-byte boundary, a function
21994 @code{__eabi} is called from @code{main} to set up the EABI
21995 environment, and the @option{-msdata} option can use both @code{r2} and
21996 @code{r13} to point to two separate small data areas.  Selecting
21997 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21998 no EABI initialization function is called from @code{main}, and the
21999 @option{-msdata} option only uses @code{r13} to point to a single
22000 small data area.  The @option{-meabi} option is on by default if you
22001 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22003 @item -msdata=eabi
22004 @opindex msdata=eabi
22005 On System V.4 and embedded PowerPC systems, put small initialized
22006 @code{const} global and static data in the @code{.sdata2} section, which
22007 is pointed to by register @code{r2}.  Put small initialized
22008 non-@code{const} global and static data in the @code{.sdata} section,
22009 which is pointed to by register @code{r13}.  Put small uninitialized
22010 global and static data in the @code{.sbss} section, which is adjacent to
22011 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22012 incompatible with the @option{-mrelocatable} option.  The
22013 @option{-msdata=eabi} option also sets the @option{-memb} option.
22015 @item -msdata=sysv
22016 @opindex msdata=sysv
22017 On System V.4 and embedded PowerPC systems, put small global and static
22018 data in the @code{.sdata} section, which is pointed to by register
22019 @code{r13}.  Put small uninitialized global and static data in the
22020 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22021 The @option{-msdata=sysv} option is incompatible with the
22022 @option{-mrelocatable} option.
22024 @item -msdata=default
22025 @itemx -msdata
22026 @opindex msdata=default
22027 @opindex msdata
22028 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22029 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22030 same as @option{-msdata=sysv}.
22032 @item -msdata=data
22033 @opindex msdata=data
22034 On System V.4 and embedded PowerPC systems, put small global
22035 data in the @code{.sdata} section.  Put small uninitialized global
22036 data in the @code{.sbss} section.  Do not use register @code{r13}
22037 to address small data however.  This is the default behavior unless
22038 other @option{-msdata} options are used.
22040 @item -msdata=none
22041 @itemx -mno-sdata
22042 @opindex msdata=none
22043 @opindex mno-sdata
22044 On embedded PowerPC systems, put all initialized global and static data
22045 in the @code{.data} section, and all uninitialized data in the
22046 @code{.bss} section.
22048 @item -mblock-move-inline-limit=@var{num}
22049 @opindex mblock-move-inline-limit
22050 Inline all block moves (such as calls to @code{memcpy} or structure
22051 copies) less than or equal to @var{num} bytes.  The minimum value for
22052 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22053 targets.  The default value is target-specific.
22055 @item -G @var{num}
22056 @opindex G
22057 @cindex smaller data references (PowerPC)
22058 @cindex .sdata/.sdata2 references (PowerPC)
22059 On embedded PowerPC systems, put global and static items less than or
22060 equal to @var{num} bytes into the small data or BSS sections instead of
22061 the normal data or BSS section.  By default, @var{num} is 8.  The
22062 @option{-G @var{num}} switch is also passed to the linker.
22063 All modules should be compiled with the same @option{-G @var{num}} value.
22065 @item -mregnames
22066 @itemx -mno-regnames
22067 @opindex mregnames
22068 @opindex mno-regnames
22069 On System V.4 and embedded PowerPC systems do (do not) emit register
22070 names in the assembly language output using symbolic forms.
22072 @item -mlongcall
22073 @itemx -mno-longcall
22074 @opindex mlongcall
22075 @opindex mno-longcall
22076 By default assume that all calls are far away so that a longer and more
22077 expensive calling sequence is required.  This is required for calls
22078 farther than 32 megabytes (33,554,432 bytes) from the current location.
22079 A short call is generated if the compiler knows
22080 the call cannot be that far away.  This setting can be overridden by
22081 the @code{shortcall} function attribute, or by @code{#pragma
22082 longcall(0)}.
22084 Some linkers are capable of detecting out-of-range calls and generating
22085 glue code on the fly.  On these systems, long calls are unnecessary and
22086 generate slower code.  As of this writing, the AIX linker can do this,
22087 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22088 to the GNU linker for 32-bit PowerPC systems as well.
22090 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22091 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22092 addresses represent the callee and the branch island.  The
22093 Darwin/PPC linker prefers the first address and generates a @code{bl
22094 callee} if the PPC @code{bl} instruction reaches the callee directly;
22095 otherwise, the linker generates @code{bl L42} to call the branch
22096 island.  The branch island is appended to the body of the
22097 calling function; it computes the full 32-bit address of the callee
22098 and jumps to it.
22100 On Mach-O (Darwin) systems, this option directs the compiler emit to
22101 the glue for every direct call, and the Darwin linker decides whether
22102 to use or discard it.
22104 In the future, GCC may ignore all longcall specifications
22105 when the linker is known to generate glue.
22107 @item -mtls-markers
22108 @itemx -mno-tls-markers
22109 @opindex mtls-markers
22110 @opindex mno-tls-markers
22111 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22112 specifying the function argument.  The relocation allows the linker to
22113 reliably associate function call with argument setup instructions for
22114 TLS optimization, which in turn allows GCC to better schedule the
22115 sequence.
22117 @item -mrecip
22118 @itemx -mno-recip
22119 @opindex mrecip
22120 This option enables use of the reciprocal estimate and
22121 reciprocal square root estimate instructions with additional
22122 Newton-Raphson steps to increase precision instead of doing a divide or
22123 square root and divide for floating-point arguments.  You should use
22124 the @option{-ffast-math} option when using @option{-mrecip} (or at
22125 least @option{-funsafe-math-optimizations},
22126 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22127 @option{-fno-trapping-math}).  Note that while the throughput of the
22128 sequence is generally higher than the throughput of the non-reciprocal
22129 instruction, the precision of the sequence can be decreased by up to 2
22130 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22131 roots.
22133 @item -mrecip=@var{opt}
22134 @opindex mrecip=opt
22135 This option controls which reciprocal estimate instructions
22136 may be used.  @var{opt} is a comma-separated list of options, which may
22137 be preceded by a @code{!} to invert the option:
22139 @table @samp
22141 @item all
22142 Enable all estimate instructions.
22144 @item default 
22145 Enable the default instructions, equivalent to @option{-mrecip}.
22147 @item none 
22148 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22150 @item div 
22151 Enable the reciprocal approximation instructions for both 
22152 single and double precision.
22154 @item divf 
22155 Enable the single-precision reciprocal approximation instructions.
22157 @item divd 
22158 Enable the double-precision reciprocal approximation instructions.
22160 @item rsqrt 
22161 Enable the reciprocal square root approximation instructions for both
22162 single and double precision.
22164 @item rsqrtf 
22165 Enable the single-precision reciprocal square root approximation instructions.
22167 @item rsqrtd 
22168 Enable the double-precision reciprocal square root approximation instructions.
22170 @end table
22172 So, for example, @option{-mrecip=all,!rsqrtd} enables
22173 all of the reciprocal estimate instructions, except for the
22174 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22175 which handle the double-precision reciprocal square root calculations.
22177 @item -mrecip-precision
22178 @itemx -mno-recip-precision
22179 @opindex mrecip-precision
22180 Assume (do not assume) that the reciprocal estimate instructions
22181 provide higher-precision estimates than is mandated by the PowerPC
22182 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22183 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22184 The double-precision square root estimate instructions are not generated by
22185 default on low-precision machines, since they do not provide an
22186 estimate that converges after three steps.
22188 @item -mveclibabi=@var{type}
22189 @opindex mveclibabi
22190 Specifies the ABI type to use for vectorizing intrinsics using an
22191 external library.  The only type supported at present is @samp{mass},
22192 which specifies to use IBM's Mathematical Acceleration Subsystem
22193 (MASS) libraries for vectorizing intrinsics using external libraries.
22194 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22195 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22196 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22197 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22198 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22199 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22200 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22201 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22202 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22203 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22204 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22205 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22206 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22207 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22208 for power7.  Both @option{-ftree-vectorize} and
22209 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22210 libraries must be specified at link time.
22212 @item -mfriz
22213 @itemx -mno-friz
22214 @opindex mfriz
22215 Generate (do not generate) the @code{friz} instruction when the
22216 @option{-funsafe-math-optimizations} option is used to optimize
22217 rounding of floating-point values to 64-bit integer and back to floating
22218 point.  The @code{friz} instruction does not return the same value if
22219 the floating-point number is too large to fit in an integer.
22221 @item -mpointers-to-nested-functions
22222 @itemx -mno-pointers-to-nested-functions
22223 @opindex mpointers-to-nested-functions
22224 Generate (do not generate) code to load up the static chain register
22225 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22226 systems where a function pointer points to a 3-word descriptor giving
22227 the function address, TOC value to be loaded in register @code{r2}, and
22228 static chain value to be loaded in register @code{r11}.  The
22229 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22230 call through pointers to nested functions or pointers
22231 to functions compiled in other languages that use the static chain if
22232 you use @option{-mno-pointers-to-nested-functions}.
22234 @item -msave-toc-indirect
22235 @itemx -mno-save-toc-indirect
22236 @opindex msave-toc-indirect
22237 Generate (do not generate) code to save the TOC value in the reserved
22238 stack location in the function prologue if the function calls through
22239 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22240 saved in the prologue, it is saved just before the call through the
22241 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22243 @item -mcompat-align-parm
22244 @itemx -mno-compat-align-parm
22245 @opindex mcompat-align-parm
22246 Generate (do not generate) code to pass structure parameters with a
22247 maximum alignment of 64 bits, for compatibility with older versions
22248 of GCC.
22250 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22251 structure parameter on a 128-bit boundary when that structure contained
22252 a member requiring 128-bit alignment.  This is corrected in more
22253 recent versions of GCC.  This option may be used to generate code
22254 that is compatible with functions compiled with older versions of
22255 GCC.
22257 The @option{-mno-compat-align-parm} option is the default.
22259 @item -mstack-protector-guard=@var{guard}
22260 @itemx -mstack-protector-guard-reg=@var{reg}
22261 @itemx -mstack-protector-guard-offset=@var{offset}
22262 @opindex mstack-protector-guard
22263 @opindex mstack-protector-guard-reg
22264 @opindex mstack-protector-guard-offset
22265 Generate stack protection code using canary at @var{guard}.  Supported
22266 locations are @samp{global} for global canary or @samp{tls} for per-thread
22267 canary in the TLS block (the default with GNU libc version 2.4 or later).
22269 With the latter choice the options
22270 @option{-mstack-protector-guard-reg=@var{reg}} and
22271 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22272 which register to use as base register for reading the canary, and from what
22273 offset from that base register. The default for those is as specified in the
22274 relevant ABI.
22275 @end table
22277 @node RX Options
22278 @subsection RX Options
22279 @cindex RX Options
22281 These command-line options are defined for RX targets:
22283 @table @gcctabopt
22284 @item -m64bit-doubles
22285 @itemx -m32bit-doubles
22286 @opindex m64bit-doubles
22287 @opindex m32bit-doubles
22288 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22289 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22290 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22291 works on 32-bit values, which is why the default is
22292 @option{-m32bit-doubles}.
22294 @item -fpu
22295 @itemx -nofpu
22296 @opindex fpu
22297 @opindex nofpu
22298 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22299 floating-point hardware.  The default is enabled for the RX600
22300 series and disabled for the RX200 series.
22302 Floating-point instructions are only generated for 32-bit floating-point 
22303 values, however, so the FPU hardware is not used for doubles if the
22304 @option{-m64bit-doubles} option is used.
22306 @emph{Note} If the @option{-fpu} option is enabled then
22307 @option{-funsafe-math-optimizations} is also enabled automatically.
22308 This is because the RX FPU instructions are themselves unsafe.
22310 @item -mcpu=@var{name}
22311 @opindex mcpu
22312 Selects the type of RX CPU to be targeted.  Currently three types are
22313 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22314 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22316 The only difference between @samp{RX600} and @samp{RX610} is that the
22317 @samp{RX610} does not support the @code{MVTIPL} instruction.
22319 The @samp{RX200} series does not have a hardware floating-point unit
22320 and so @option{-nofpu} is enabled by default when this type is
22321 selected.
22323 @item -mbig-endian-data
22324 @itemx -mlittle-endian-data
22325 @opindex mbig-endian-data
22326 @opindex mlittle-endian-data
22327 Store data (but not code) in the big-endian format.  The default is
22328 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22329 format.
22331 @item -msmall-data-limit=@var{N}
22332 @opindex msmall-data-limit
22333 Specifies the maximum size in bytes of global and static variables
22334 which can be placed into the small data area.  Using the small data
22335 area can lead to smaller and faster code, but the size of area is
22336 limited and it is up to the programmer to ensure that the area does
22337 not overflow.  Also when the small data area is used one of the RX's
22338 registers (usually @code{r13}) is reserved for use pointing to this
22339 area, so it is no longer available for use by the compiler.  This
22340 could result in slower and/or larger code if variables are pushed onto
22341 the stack instead of being held in this register.
22343 Note, common variables (variables that have not been initialized) and
22344 constants are not placed into the small data area as they are assigned
22345 to other sections in the output executable.
22347 The default value is zero, which disables this feature.  Note, this
22348 feature is not enabled by default with higher optimization levels
22349 (@option{-O2} etc) because of the potentially detrimental effects of
22350 reserving a register.  It is up to the programmer to experiment and
22351 discover whether this feature is of benefit to their program.  See the
22352 description of the @option{-mpid} option for a description of how the
22353 actual register to hold the small data area pointer is chosen.
22355 @item -msim
22356 @itemx -mno-sim
22357 @opindex msim
22358 @opindex mno-sim
22359 Use the simulator runtime.  The default is to use the libgloss
22360 board-specific runtime.
22362 @item -mas100-syntax
22363 @itemx -mno-as100-syntax
22364 @opindex mas100-syntax
22365 @opindex mno-as100-syntax
22366 When generating assembler output use a syntax that is compatible with
22367 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22368 assembler, but it has some restrictions so it is not generated by default.
22370 @item -mmax-constant-size=@var{N}
22371 @opindex mmax-constant-size
22372 Specifies the maximum size, in bytes, of a constant that can be used as
22373 an operand in a RX instruction.  Although the RX instruction set does
22374 allow constants of up to 4 bytes in length to be used in instructions,
22375 a longer value equates to a longer instruction.  Thus in some
22376 circumstances it can be beneficial to restrict the size of constants
22377 that are used in instructions.  Constants that are too big are instead
22378 placed into a constant pool and referenced via register indirection.
22380 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22381 or 4 means that constants of any size are allowed.
22383 @item -mrelax
22384 @opindex mrelax
22385 Enable linker relaxation.  Linker relaxation is a process whereby the
22386 linker attempts to reduce the size of a program by finding shorter
22387 versions of various instructions.  Disabled by default.
22389 @item -mint-register=@var{N}
22390 @opindex mint-register
22391 Specify the number of registers to reserve for fast interrupt handler
22392 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22393 means that register @code{r13} is reserved for the exclusive use
22394 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22395 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22396 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22397 A value of 0, the default, does not reserve any registers.
22399 @item -msave-acc-in-interrupts
22400 @opindex msave-acc-in-interrupts
22401 Specifies that interrupt handler functions should preserve the
22402 accumulator register.  This is only necessary if normal code might use
22403 the accumulator register, for example because it performs 64-bit
22404 multiplications.  The default is to ignore the accumulator as this
22405 makes the interrupt handlers faster.
22407 @item -mpid
22408 @itemx -mno-pid
22409 @opindex mpid
22410 @opindex mno-pid
22411 Enables the generation of position independent data.  When enabled any
22412 access to constant data is done via an offset from a base address
22413 held in a register.  This allows the location of constant data to be
22414 determined at run time without requiring the executable to be
22415 relocated, which is a benefit to embedded applications with tight
22416 memory constraints.  Data that can be modified is not affected by this
22417 option.
22419 Note, using this feature reserves a register, usually @code{r13}, for
22420 the constant data base address.  This can result in slower and/or
22421 larger code, especially in complicated functions.
22423 The actual register chosen to hold the constant data base address
22424 depends upon whether the @option{-msmall-data-limit} and/or the
22425 @option{-mint-register} command-line options are enabled.  Starting
22426 with register @code{r13} and proceeding downwards, registers are
22427 allocated first to satisfy the requirements of @option{-mint-register},
22428 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22429 is possible for the small data area register to be @code{r8} if both
22430 @option{-mint-register=4} and @option{-mpid} are specified on the
22431 command line.
22433 By default this feature is not enabled.  The default can be restored
22434 via the @option{-mno-pid} command-line option.
22436 @item -mno-warn-multiple-fast-interrupts
22437 @itemx -mwarn-multiple-fast-interrupts
22438 @opindex mno-warn-multiple-fast-interrupts
22439 @opindex mwarn-multiple-fast-interrupts
22440 Prevents GCC from issuing a warning message if it finds more than one
22441 fast interrupt handler when it is compiling a file.  The default is to
22442 issue a warning for each extra fast interrupt handler found, as the RX
22443 only supports one such interrupt.
22445 @item -mallow-string-insns
22446 @itemx -mno-allow-string-insns
22447 @opindex mallow-string-insns
22448 @opindex mno-allow-string-insns
22449 Enables or disables the use of the string manipulation instructions
22450 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22451 @code{SWHILE} and also the @code{RMPA} instruction.  These
22452 instructions may prefetch data, which is not safe to do if accessing
22453 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22454 for more information).
22456 The default is to allow these instructions, but it is not possible for
22457 GCC to reliably detect all circumstances where a string instruction
22458 might be used to access an I/O register, so their use cannot be
22459 disabled automatically.  Instead it is reliant upon the programmer to
22460 use the @option{-mno-allow-string-insns} option if their program
22461 accesses I/O space.
22463 When the instructions are enabled GCC defines the C preprocessor
22464 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22465 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22467 @item -mjsr
22468 @itemx -mno-jsr
22469 @opindex mjsr
22470 @opindex mno-jsr
22471 Use only (or not only) @code{JSR} instructions to access functions.
22472 This option can be used when code size exceeds the range of @code{BSR}
22473 instructions.  Note that @option{-mno-jsr} does not mean to not use
22474 @code{JSR} but instead means that any type of branch may be used.
22475 @end table
22477 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22478 has special significance to the RX port when used with the
22479 @code{interrupt} function attribute.  This attribute indicates a
22480 function intended to process fast interrupts.  GCC ensures
22481 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22482 and/or @code{r13} and only provided that the normal use of the
22483 corresponding registers have been restricted via the
22484 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22485 options.
22487 @node S/390 and zSeries Options
22488 @subsection S/390 and zSeries Options
22489 @cindex S/390 and zSeries Options
22491 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22493 @table @gcctabopt
22494 @item -mhard-float
22495 @itemx -msoft-float
22496 @opindex mhard-float
22497 @opindex msoft-float
22498 Use (do not use) the hardware floating-point instructions and registers
22499 for floating-point operations.  When @option{-msoft-float} is specified,
22500 functions in @file{libgcc.a} are used to perform floating-point
22501 operations.  When @option{-mhard-float} is specified, the compiler
22502 generates IEEE floating-point instructions.  This is the default.
22504 @item -mhard-dfp
22505 @itemx -mno-hard-dfp
22506 @opindex mhard-dfp
22507 @opindex mno-hard-dfp
22508 Use (do not use) the hardware decimal-floating-point instructions for
22509 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22510 specified, functions in @file{libgcc.a} are used to perform
22511 decimal-floating-point operations.  When @option{-mhard-dfp} is
22512 specified, the compiler generates decimal-floating-point hardware
22513 instructions.  This is the default for @option{-march=z9-ec} or higher.
22515 @item -mlong-double-64
22516 @itemx -mlong-double-128
22517 @opindex mlong-double-64
22518 @opindex mlong-double-128
22519 These switches control the size of @code{long double} type. A size
22520 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22521 type. This is the default.
22523 @item -mbackchain
22524 @itemx -mno-backchain
22525 @opindex mbackchain
22526 @opindex mno-backchain
22527 Store (do not store) the address of the caller's frame as backchain pointer
22528 into the callee's stack frame.
22529 A backchain may be needed to allow debugging using tools that do not understand
22530 DWARF call frame information.
22531 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22532 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22533 the backchain is placed into the topmost word of the 96/160 byte register
22534 save area.
22536 In general, code compiled with @option{-mbackchain} is call-compatible with
22537 code compiled with @option{-mmo-backchain}; however, use of the backchain
22538 for debugging purposes usually requires that the whole binary is built with
22539 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22540 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22541 to build a linux kernel use @option{-msoft-float}.
22543 The default is to not maintain the backchain.
22545 @item -mpacked-stack
22546 @itemx -mno-packed-stack
22547 @opindex mpacked-stack
22548 @opindex mno-packed-stack
22549 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22550 specified, the compiler uses the all fields of the 96/160 byte register save
22551 area only for their default purpose; unused fields still take up stack space.
22552 When @option{-mpacked-stack} is specified, register save slots are densely
22553 packed at the top of the register save area; unused space is reused for other
22554 purposes, allowing for more efficient use of the available stack space.
22555 However, when @option{-mbackchain} is also in effect, the topmost word of
22556 the save area is always used to store the backchain, and the return address
22557 register is always saved two words below the backchain.
22559 As long as the stack frame backchain is not used, code generated with
22560 @option{-mpacked-stack} is call-compatible with code generated with
22561 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22562 S/390 or zSeries generated code that uses the stack frame backchain at run
22563 time, not just for debugging purposes.  Such code is not call-compatible
22564 with code compiled with @option{-mpacked-stack}.  Also, note that the
22565 combination of @option{-mbackchain},
22566 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22567 to build a linux kernel use @option{-msoft-float}.
22569 The default is to not use the packed stack layout.
22571 @item -msmall-exec
22572 @itemx -mno-small-exec
22573 @opindex msmall-exec
22574 @opindex mno-small-exec
22575 Generate (or do not generate) code using the @code{bras} instruction
22576 to do subroutine calls.
22577 This only works reliably if the total executable size does not
22578 exceed 64k.  The default is to use the @code{basr} instruction instead,
22579 which does not have this limitation.
22581 @item -m64
22582 @itemx -m31
22583 @opindex m64
22584 @opindex m31
22585 When @option{-m31} is specified, generate code compliant to the
22586 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22587 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22588 particular to generate 64-bit instructions.  For the @samp{s390}
22589 targets, the default is @option{-m31}, while the @samp{s390x}
22590 targets default to @option{-m64}.
22592 @item -mzarch
22593 @itemx -mesa
22594 @opindex mzarch
22595 @opindex mesa
22596 When @option{-mzarch} is specified, generate code using the
22597 instructions available on z/Architecture.
22598 When @option{-mesa} is specified, generate code using the
22599 instructions available on ESA/390.  Note that @option{-mesa} is
22600 not possible with @option{-m64}.
22601 When generating code compliant to the GNU/Linux for S/390 ABI,
22602 the default is @option{-mesa}.  When generating code compliant
22603 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22605 @item -mhtm
22606 @itemx -mno-htm
22607 @opindex mhtm
22608 @opindex mno-htm
22609 The @option{-mhtm} option enables a set of builtins making use of
22610 instructions available with the transactional execution facility
22611 introduced with the IBM zEnterprise EC12 machine generation
22612 @ref{S/390 System z Built-in Functions}.
22613 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22615 @item -mvx
22616 @itemx -mno-vx
22617 @opindex mvx
22618 @opindex mno-vx
22619 When @option{-mvx} is specified, generate code using the instructions
22620 available with the vector extension facility introduced with the IBM
22621 z13 machine generation.
22622 This option changes the ABI for some vector type values with regard to
22623 alignment and calling conventions.  In case vector type values are
22624 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22625 command will be added to mark the resulting binary with the ABI used.
22626 @option{-mvx} is enabled by default when using @option{-march=z13}.
22628 @item -mzvector
22629 @itemx -mno-zvector
22630 @opindex mzvector
22631 @opindex mno-zvector
22632 The @option{-mzvector} option enables vector language extensions and
22633 builtins using instructions available with the vector extension
22634 facility introduced with the IBM z13 machine generation.
22635 This option adds support for @samp{vector} to be used as a keyword to
22636 define vector type variables and arguments.  @samp{vector} is only
22637 available when GNU extensions are enabled.  It will not be expanded
22638 when requesting strict standard compliance e.g. with @option{-std=c99}.
22639 In addition to the GCC low-level builtins @option{-mzvector} enables
22640 a set of builtins added for compatibility with AltiVec-style
22641 implementations like Power and Cell.  In order to make use of these
22642 builtins the header file @file{vecintrin.h} needs to be included.
22643 @option{-mzvector} is disabled by default.
22645 @item -mmvcle
22646 @itemx -mno-mvcle
22647 @opindex mmvcle
22648 @opindex mno-mvcle
22649 Generate (or do not generate) code using the @code{mvcle} instruction
22650 to perform block moves.  When @option{-mno-mvcle} is specified,
22651 use a @code{mvc} loop instead.  This is the default unless optimizing for
22652 size.
22654 @item -mdebug
22655 @itemx -mno-debug
22656 @opindex mdebug
22657 @opindex mno-debug
22658 Print (or do not print) additional debug information when compiling.
22659 The default is to not print debug information.
22661 @item -march=@var{cpu-type}
22662 @opindex march
22663 Generate code that runs on @var{cpu-type}, which is the name of a
22664 system representing a certain processor type.  Possible values for
22665 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22666 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22667 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22668 @samp{native}.
22670 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22671 @samp{g6} are deprecated and will be removed with future releases.
22673 Specifying @samp{native} as cpu type can be used to select the best
22674 architecture option for the host processor.
22675 @option{-march=native} has no effect if GCC does not recognize the
22676 processor.
22678 @item -mtune=@var{cpu-type}
22679 @opindex mtune
22680 Tune to @var{cpu-type} everything applicable about the generated code,
22681 except for the ABI and the set of available instructions.
22682 The list of @var{cpu-type} values is the same as for @option{-march}.
22683 The default is the value used for @option{-march}.
22685 @item -mtpf-trace
22686 @itemx -mno-tpf-trace
22687 @opindex mtpf-trace
22688 @opindex mno-tpf-trace
22689 Generate code that adds (does not add) in TPF OS specific branches to trace
22690 routines in the operating system.  This option is off by default, even
22691 when compiling for the TPF OS@.
22693 @item -mfused-madd
22694 @itemx -mno-fused-madd
22695 @opindex mfused-madd
22696 @opindex mno-fused-madd
22697 Generate code that uses (does not use) the floating-point multiply and
22698 accumulate instructions.  These instructions are generated by default if
22699 hardware floating point is used.
22701 @item -mwarn-framesize=@var{framesize}
22702 @opindex mwarn-framesize
22703 Emit a warning if the current function exceeds the given frame size.  Because
22704 this is a compile-time check it doesn't need to be a real problem when the program
22705 runs.  It is intended to identify functions that most probably cause
22706 a stack overflow.  It is useful to be used in an environment with limited stack
22707 size e.g.@: the linux kernel.
22709 @item -mwarn-dynamicstack
22710 @opindex mwarn-dynamicstack
22711 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22712 arrays.  This is generally a bad idea with a limited stack size.
22714 @item -mstack-guard=@var{stack-guard}
22715 @itemx -mstack-size=@var{stack-size}
22716 @opindex mstack-guard
22717 @opindex mstack-size
22718 If these options are provided the S/390 back end emits additional instructions in
22719 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22720 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22721 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22722 the frame size of the compiled function is chosen.
22723 These options are intended to be used to help debugging stack overflow problems.
22724 The additionally emitted code causes only little overhead and hence can also be
22725 used in production-like systems without greater performance degradation.  The given
22726 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22727 @var{stack-guard} without exceeding 64k.
22728 In order to be efficient the extra code makes the assumption that the stack starts
22729 at an address aligned to the value given by @var{stack-size}.
22730 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22732 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22733 @opindex mhotpatch
22734 If the hotpatch option is enabled, a ``hot-patching'' function
22735 prologue is generated for all functions in the compilation unit.
22736 The funtion label is prepended with the given number of two-byte
22737 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22738 the label, 2 * @var{post-halfwords} bytes are appended, using the
22739 largest NOP like instructions the architecture allows (maximum
22740 1000000).
22742 If both arguments are zero, hotpatching is disabled.
22744 This option can be overridden for individual functions with the
22745 @code{hotpatch} attribute.
22746 @end table
22748 @node Score Options
22749 @subsection Score Options
22750 @cindex Score Options
22752 These options are defined for Score implementations:
22754 @table @gcctabopt
22755 @item -meb
22756 @opindex meb
22757 Compile code for big-endian mode.  This is the default.
22759 @item -mel
22760 @opindex mel
22761 Compile code for little-endian mode.
22763 @item -mnhwloop
22764 @opindex mnhwloop
22765 Disable generation of @code{bcnz} instructions.
22767 @item -muls
22768 @opindex muls
22769 Enable generation of unaligned load and store instructions.
22771 @item -mmac
22772 @opindex mmac
22773 Enable the use of multiply-accumulate instructions. Disabled by default.
22775 @item -mscore5
22776 @opindex mscore5
22777 Specify the SCORE5 as the target architecture.
22779 @item -mscore5u
22780 @opindex mscore5u
22781 Specify the SCORE5U of the target architecture.
22783 @item -mscore7
22784 @opindex mscore7
22785 Specify the SCORE7 as the target architecture. This is the default.
22787 @item -mscore7d
22788 @opindex mscore7d
22789 Specify the SCORE7D as the target architecture.
22790 @end table
22792 @node SH Options
22793 @subsection SH Options
22795 These @samp{-m} options are defined for the SH implementations:
22797 @table @gcctabopt
22798 @item -m1
22799 @opindex m1
22800 Generate code for the SH1.
22802 @item -m2
22803 @opindex m2
22804 Generate code for the SH2.
22806 @item -m2e
22807 Generate code for the SH2e.
22809 @item -m2a-nofpu
22810 @opindex m2a-nofpu
22811 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22812 that the floating-point unit is not used.
22814 @item -m2a-single-only
22815 @opindex m2a-single-only
22816 Generate code for the SH2a-FPU, in such a way that no double-precision
22817 floating-point operations are used.
22819 @item -m2a-single
22820 @opindex m2a-single
22821 Generate code for the SH2a-FPU assuming the floating-point unit is in
22822 single-precision mode by default.
22824 @item -m2a
22825 @opindex m2a
22826 Generate code for the SH2a-FPU assuming the floating-point unit is in
22827 double-precision mode by default.
22829 @item -m3
22830 @opindex m3
22831 Generate code for the SH3.
22833 @item -m3e
22834 @opindex m3e
22835 Generate code for the SH3e.
22837 @item -m4-nofpu
22838 @opindex m4-nofpu
22839 Generate code for the SH4 without a floating-point unit.
22841 @item -m4-single-only
22842 @opindex m4-single-only
22843 Generate code for the SH4 with a floating-point unit that only
22844 supports single-precision arithmetic.
22846 @item -m4-single
22847 @opindex m4-single
22848 Generate code for the SH4 assuming the floating-point unit is in
22849 single-precision mode by default.
22851 @item -m4
22852 @opindex m4
22853 Generate code for the SH4.
22855 @item -m4-100
22856 @opindex m4-100
22857 Generate code for SH4-100.
22859 @item -m4-100-nofpu
22860 @opindex m4-100-nofpu
22861 Generate code for SH4-100 in such a way that the
22862 floating-point unit is not used.
22864 @item -m4-100-single
22865 @opindex m4-100-single
22866 Generate code for SH4-100 assuming the floating-point unit is in
22867 single-precision mode by default.
22869 @item -m4-100-single-only
22870 @opindex m4-100-single-only
22871 Generate code for SH4-100 in such a way that no double-precision
22872 floating-point operations are used.
22874 @item -m4-200
22875 @opindex m4-200
22876 Generate code for SH4-200.
22878 @item -m4-200-nofpu
22879 @opindex m4-200-nofpu
22880 Generate code for SH4-200 without in such a way that the
22881 floating-point unit is not used.
22883 @item -m4-200-single
22884 @opindex m4-200-single
22885 Generate code for SH4-200 assuming the floating-point unit is in
22886 single-precision mode by default.
22888 @item -m4-200-single-only
22889 @opindex m4-200-single-only
22890 Generate code for SH4-200 in such a way that no double-precision
22891 floating-point operations are used.
22893 @item -m4-300
22894 @opindex m4-300
22895 Generate code for SH4-300.
22897 @item -m4-300-nofpu
22898 @opindex m4-300-nofpu
22899 Generate code for SH4-300 without in such a way that the
22900 floating-point unit is not used.
22902 @item -m4-300-single
22903 @opindex m4-300-single
22904 Generate code for SH4-300 in such a way that no double-precision
22905 floating-point operations are used.
22907 @item -m4-300-single-only
22908 @opindex m4-300-single-only
22909 Generate code for SH4-300 in such a way that no double-precision
22910 floating-point operations are used.
22912 @item -m4-340
22913 @opindex m4-340
22914 Generate code for SH4-340 (no MMU, no FPU).
22916 @item -m4-500
22917 @opindex m4-500
22918 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22919 assembler.
22921 @item -m4a-nofpu
22922 @opindex m4a-nofpu
22923 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22924 floating-point unit is not used.
22926 @item -m4a-single-only
22927 @opindex m4a-single-only
22928 Generate code for the SH4a, in such a way that no double-precision
22929 floating-point operations are used.
22931 @item -m4a-single
22932 @opindex m4a-single
22933 Generate code for the SH4a assuming the floating-point unit is in
22934 single-precision mode by default.
22936 @item -m4a
22937 @opindex m4a
22938 Generate code for the SH4a.
22940 @item -m4al
22941 @opindex m4al
22942 Same as @option{-m4a-nofpu}, except that it implicitly passes
22943 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22944 instructions at the moment.
22946 @item -mb
22947 @opindex mb
22948 Compile code for the processor in big-endian mode.
22950 @item -ml
22951 @opindex ml
22952 Compile code for the processor in little-endian mode.
22954 @item -mdalign
22955 @opindex mdalign
22956 Align doubles at 64-bit boundaries.  Note that this changes the calling
22957 conventions, and thus some functions from the standard C library do
22958 not work unless you recompile it first with @option{-mdalign}.
22960 @item -mrelax
22961 @opindex mrelax
22962 Shorten some address references at link time, when possible; uses the
22963 linker option @option{-relax}.
22965 @item -mbigtable
22966 @opindex mbigtable
22967 Use 32-bit offsets in @code{switch} tables.  The default is to use
22968 16-bit offsets.
22970 @item -mbitops
22971 @opindex mbitops
22972 Enable the use of bit manipulation instructions on SH2A.
22974 @item -mfmovd
22975 @opindex mfmovd
22976 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22977 alignment constraints.
22979 @item -mrenesas
22980 @opindex mrenesas
22981 Comply with the calling conventions defined by Renesas.
22983 @item -mno-renesas
22984 @opindex mno-renesas
22985 Comply with the calling conventions defined for GCC before the Renesas
22986 conventions were available.  This option is the default for all
22987 targets of the SH toolchain.
22989 @item -mnomacsave
22990 @opindex mnomacsave
22991 Mark the @code{MAC} register as call-clobbered, even if
22992 @option{-mrenesas} is given.
22994 @item -mieee
22995 @itemx -mno-ieee
22996 @opindex mieee
22997 @opindex mno-ieee
22998 Control the IEEE compliance of floating-point comparisons, which affects the
22999 handling of cases where the result of a comparison is unordered.  By default
23000 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23001 enabled @option{-mno-ieee} is implicitly set, which results in faster
23002 floating-point greater-equal and less-equal comparisons.  The implicit settings
23003 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23005 @item -minline-ic_invalidate
23006 @opindex minline-ic_invalidate
23007 Inline code to invalidate instruction cache entries after setting up
23008 nested function trampolines.
23009 This option has no effect if @option{-musermode} is in effect and the selected
23010 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23011 instruction.
23012 If the selected code generation option does not allow the use of the @code{icbi}
23013 instruction, and @option{-musermode} is not in effect, the inlined code
23014 manipulates the instruction cache address array directly with an associative
23015 write.  This not only requires privileged mode at run time, but it also
23016 fails if the cache line had been mapped via the TLB and has become unmapped.
23018 @item -misize
23019 @opindex misize
23020 Dump instruction size and location in the assembly code.
23022 @item -mpadstruct
23023 @opindex mpadstruct
23024 This option is deprecated.  It pads structures to multiple of 4 bytes,
23025 which is incompatible with the SH ABI@.
23027 @item -matomic-model=@var{model}
23028 @opindex matomic-model=@var{model}
23029 Sets the model of atomic operations and additional parameters as a comma
23030 separated list.  For details on the atomic built-in functions see
23031 @ref{__atomic Builtins}.  The following models and parameters are supported:
23033 @table @samp
23035 @item none
23036 Disable compiler generated atomic sequences and emit library calls for atomic
23037 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23039 @item soft-gusa
23040 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23041 built-in functions.  The generated atomic sequences require additional support
23042 from the interrupt/exception handling code of the system and are only suitable
23043 for SH3* and SH4* single-core systems.  This option is enabled by default when
23044 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23045 this option also partially utilizes the hardware atomic instructions
23046 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23047 @samp{strict} is specified.  
23049 @item soft-tcb
23050 Generate software atomic sequences that use a variable in the thread control
23051 block.  This is a variation of the gUSA sequences which can also be used on
23052 SH1* and SH2* targets.  The generated atomic sequences require additional
23053 support from the interrupt/exception handling code of the system and are only
23054 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23055 parameter has to be specified as well.
23057 @item soft-imask
23058 Generate software atomic sequences that temporarily disable interrupts by
23059 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23060 in privileged mode and is only suitable for single-core systems.  Additional
23061 support from the interrupt/exception handling code of the system is not
23062 required.  This model is enabled by default when the target is
23063 @code{sh*-*-linux*} and SH1* or SH2*.
23065 @item hard-llcs
23066 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23067 instructions only.  This is only available on SH4A and is suitable for
23068 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23069 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23070 Code compiled with this option is also compatible with other software
23071 atomic model interrupt/exception handling systems if executed on an SH4A
23072 system.  Additional support from the interrupt/exception handling code of the
23073 system is not required for this model.
23075 @item gbr-offset=
23076 This parameter specifies the offset in bytes of the variable in the thread
23077 control block structure that should be used by the generated atomic sequences
23078 when the @samp{soft-tcb} model has been selected.  For other models this
23079 parameter is ignored.  The specified value must be an integer multiple of four
23080 and in the range 0-1020.
23082 @item strict
23083 This parameter prevents mixed usage of multiple atomic models, even if they
23084 are compatible, and makes the compiler generate atomic sequences of the
23085 specified model only.
23087 @end table
23089 @item -mtas
23090 @opindex mtas
23091 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23092 Notice that depending on the particular hardware and software configuration
23093 this can degrade overall performance due to the operand cache line flushes
23094 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23095 processors the @code{tas.b} instruction must be used with caution since it
23096 can result in data corruption for certain cache configurations.
23098 @item -mprefergot
23099 @opindex mprefergot
23100 When generating position-independent code, emit function calls using
23101 the Global Offset Table instead of the Procedure Linkage Table.
23103 @item -musermode
23104 @itemx -mno-usermode
23105 @opindex musermode
23106 @opindex mno-usermode
23107 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23108 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23109 inlined code would not work in user mode.  @option{-musermode} is the default
23110 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23111 @option{-musermode} has no effect, since there is no user mode.
23113 @item -multcost=@var{number}
23114 @opindex multcost=@var{number}
23115 Set the cost to assume for a multiply insn.
23117 @item -mdiv=@var{strategy}
23118 @opindex mdiv=@var{strategy}
23119 Set the division strategy to be used for integer division operations.
23120 @var{strategy} can be one of: 
23122 @table @samp
23124 @item call-div1
23125 Calls a library function that uses the single-step division instruction
23126 @code{div1} to perform the operation.  Division by zero calculates an
23127 unspecified result and does not trap.  This is the default except for SH4,
23128 SH2A and SHcompact.
23130 @item call-fp
23131 Calls a library function that performs the operation in double precision
23132 floating point.  Division by zero causes a floating-point exception.  This is
23133 the default for SHcompact with FPU.  Specifying this for targets that do not
23134 have a double precision FPU defaults to @code{call-div1}.
23136 @item call-table
23137 Calls a library function that uses a lookup table for small divisors and
23138 the @code{div1} instruction with case distinction for larger divisors.  Division
23139 by zero calculates an unspecified result and does not trap.  This is the default
23140 for SH4.  Specifying this for targets that do not have dynamic shift
23141 instructions defaults to @code{call-div1}.
23143 @end table
23145 When a division strategy has not been specified the default strategy is
23146 selected based on the current target.  For SH2A the default strategy is to
23147 use the @code{divs} and @code{divu} instructions instead of library function
23148 calls.
23150 @item -maccumulate-outgoing-args
23151 @opindex maccumulate-outgoing-args
23152 Reserve space once for outgoing arguments in the function prologue rather
23153 than around each call.  Generally beneficial for performance and size.  Also
23154 needed for unwinding to avoid changing the stack frame around conditional code.
23156 @item -mdivsi3_libfunc=@var{name}
23157 @opindex mdivsi3_libfunc=@var{name}
23158 Set the name of the library function used for 32-bit signed division to
23159 @var{name}.
23160 This only affects the name used in the @samp{call} division strategies, and
23161 the compiler still expects the same sets of input/output/clobbered registers as
23162 if this option were not present.
23164 @item -mfixed-range=@var{register-range}
23165 @opindex mfixed-range
23166 Generate code treating the given register range as fixed registers.
23167 A fixed register is one that the register allocator can not use.  This is
23168 useful when compiling kernel code.  A register range is specified as
23169 two registers separated by a dash.  Multiple register ranges can be
23170 specified separated by a comma.
23172 @item -mbranch-cost=@var{num}
23173 @opindex mbranch-cost=@var{num}
23174 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23175 make the compiler try to generate more branch-free code if possible.  
23176 If not specified the value is selected depending on the processor type that
23177 is being compiled for.
23179 @item -mzdcbranch
23180 @itemx -mno-zdcbranch
23181 @opindex mzdcbranch
23182 @opindex mno-zdcbranch
23183 Assume (do not assume) that zero displacement conditional branch instructions
23184 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23185 compiler prefers zero displacement branch code sequences.  This is
23186 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23187 disabled by specifying @option{-mno-zdcbranch}.
23189 @item -mcbranch-force-delay-slot
23190 @opindex mcbranch-force-delay-slot
23191 Force the usage of delay slots for conditional branches, which stuffs the delay
23192 slot with a @code{nop} if a suitable instruction can't be found.  By default
23193 this option is disabled.  It can be enabled to work around hardware bugs as
23194 found in the original SH7055.
23196 @item -mfused-madd
23197 @itemx -mno-fused-madd
23198 @opindex mfused-madd
23199 @opindex mno-fused-madd
23200 Generate code that uses (does not use) the floating-point multiply and
23201 accumulate instructions.  These instructions are generated by default
23202 if hardware floating point is used.  The machine-dependent
23203 @option{-mfused-madd} option is now mapped to the machine-independent
23204 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23205 mapped to @option{-ffp-contract=off}.
23207 @item -mfsca
23208 @itemx -mno-fsca
23209 @opindex mfsca
23210 @opindex mno-fsca
23211 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23212 and cosine approximations.  The option @option{-mfsca} must be used in
23213 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23214 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23215 approximations even if @option{-funsafe-math-optimizations} is in effect.
23217 @item -mfsrra
23218 @itemx -mno-fsrra
23219 @opindex mfsrra
23220 @opindex mno-fsrra
23221 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23222 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23223 in combination with @option{-funsafe-math-optimizations} and
23224 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23225 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23226 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23227 in effect.
23229 @item -mpretend-cmove
23230 @opindex mpretend-cmove
23231 Prefer zero-displacement conditional branches for conditional move instruction
23232 patterns.  This can result in faster code on the SH4 processor.
23234 @item -mfdpic
23235 @opindex fdpic
23236 Generate code using the FDPIC ABI.
23238 @end table
23240 @node Solaris 2 Options
23241 @subsection Solaris 2 Options
23242 @cindex Solaris 2 options
23244 These @samp{-m} options are supported on Solaris 2:
23246 @table @gcctabopt
23247 @item -mclear-hwcap
23248 @opindex mclear-hwcap
23249 @option{-mclear-hwcap} tells the compiler to remove the hardware
23250 capabilities generated by the Solaris assembler.  This is only necessary
23251 when object files use ISA extensions not supported by the current
23252 machine, but check at runtime whether or not to use them.
23254 @item -mimpure-text
23255 @opindex mimpure-text
23256 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23257 the compiler to not pass @option{-z text} to the linker when linking a
23258 shared object.  Using this option, you can link position-dependent
23259 code into a shared object.
23261 @option{-mimpure-text} suppresses the ``relocations remain against
23262 allocatable but non-writable sections'' linker error message.
23263 However, the necessary relocations trigger copy-on-write, and the
23264 shared object is not actually shared across processes.  Instead of
23265 using @option{-mimpure-text}, you should compile all source code with
23266 @option{-fpic} or @option{-fPIC}.
23268 @end table
23270 These switches are supported in addition to the above on Solaris 2:
23272 @table @gcctabopt
23273 @item -pthreads
23274 @opindex pthreads
23275 This is a synonym for @option{-pthread}.
23276 @end table
23278 @node SPARC Options
23279 @subsection SPARC Options
23280 @cindex SPARC options
23282 These @samp{-m} options are supported on the SPARC:
23284 @table @gcctabopt
23285 @item -mno-app-regs
23286 @itemx -mapp-regs
23287 @opindex mno-app-regs
23288 @opindex mapp-regs
23289 Specify @option{-mapp-regs} to generate output using the global registers
23290 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23291 global register 1, each global register 2 through 4 is then treated as an
23292 allocable register that is clobbered by function calls.  This is the default.
23294 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23295 specify @option{-mno-app-regs}.  You should compile libraries and system
23296 software with this option.
23298 @item -mflat
23299 @itemx -mno-flat
23300 @opindex mflat
23301 @opindex mno-flat
23302 With @option{-mflat}, the compiler does not generate save/restore instructions
23303 and uses a ``flat'' or single register window model.  This model is compatible
23304 with the regular register window model.  The local registers and the input
23305 registers (0--5) are still treated as ``call-saved'' registers and are
23306 saved on the stack as needed.
23308 With @option{-mno-flat} (the default), the compiler generates save/restore
23309 instructions (except for leaf functions).  This is the normal operating mode.
23311 @item -mfpu
23312 @itemx -mhard-float
23313 @opindex mfpu
23314 @opindex mhard-float
23315 Generate output containing floating-point instructions.  This is the
23316 default.
23318 @item -mno-fpu
23319 @itemx -msoft-float
23320 @opindex mno-fpu
23321 @opindex msoft-float
23322 Generate output containing library calls for floating point.
23323 @strong{Warning:} the requisite libraries are not available for all SPARC
23324 targets.  Normally the facilities of the machine's usual C compiler are
23325 used, but this cannot be done directly in cross-compilation.  You must make
23326 your own arrangements to provide suitable library functions for
23327 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23328 @samp{sparclite-*-*} do provide software floating-point support.
23330 @option{-msoft-float} changes the calling convention in the output file;
23331 therefore, it is only useful if you compile @emph{all} of a program with
23332 this option.  In particular, you need to compile @file{libgcc.a}, the
23333 library that comes with GCC, with @option{-msoft-float} in order for
23334 this to work.
23336 @item -mhard-quad-float
23337 @opindex mhard-quad-float
23338 Generate output containing quad-word (long double) floating-point
23339 instructions.
23341 @item -msoft-quad-float
23342 @opindex msoft-quad-float
23343 Generate output containing library calls for quad-word (long double)
23344 floating-point instructions.  The functions called are those specified
23345 in the SPARC ABI@.  This is the default.
23347 As of this writing, there are no SPARC implementations that have hardware
23348 support for the quad-word floating-point instructions.  They all invoke
23349 a trap handler for one of these instructions, and then the trap handler
23350 emulates the effect of the instruction.  Because of the trap handler overhead,
23351 this is much slower than calling the ABI library routines.  Thus the
23352 @option{-msoft-quad-float} option is the default.
23354 @item -mno-unaligned-doubles
23355 @itemx -munaligned-doubles
23356 @opindex mno-unaligned-doubles
23357 @opindex munaligned-doubles
23358 Assume that doubles have 8-byte alignment.  This is the default.
23360 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23361 alignment only if they are contained in another type, or if they have an
23362 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23363 Specifying this option avoids some rare compatibility problems with code
23364 generated by other compilers.  It is not the default because it results
23365 in a performance loss, especially for floating-point code.
23367 @item -muser-mode
23368 @itemx -mno-user-mode
23369 @opindex muser-mode
23370 @opindex mno-user-mode
23371 Do not generate code that can only run in supervisor mode.  This is relevant
23372 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23373 is the default.
23375 @item -mfaster-structs
23376 @itemx -mno-faster-structs
23377 @opindex mfaster-structs
23378 @opindex mno-faster-structs
23379 With @option{-mfaster-structs}, the compiler assumes that structures
23380 should have 8-byte alignment.  This enables the use of pairs of
23381 @code{ldd} and @code{std} instructions for copies in structure
23382 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23383 However, the use of this changed alignment directly violates the SPARC
23384 ABI@.  Thus, it's intended only for use on targets where the developer
23385 acknowledges that their resulting code is not directly in line with
23386 the rules of the ABI@.
23388 @item -mstd-struct-return
23389 @itemx -mno-std-struct-return
23390 @opindex mstd-struct-return
23391 @opindex mno-std-struct-return
23392 With @option{-mstd-struct-return}, the compiler generates checking code
23393 in functions returning structures or unions to detect size mismatches
23394 between the two sides of function calls, as per the 32-bit ABI@.
23396 The default is @option{-mno-std-struct-return}.  This option has no effect
23397 in 64-bit mode.
23399 @item -mlra
23400 @itemx -mno-lra
23401 @opindex mlra
23402 @opindex mno-lra
23403 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23404 so @option{-mno-lra} needs to be passed to get old Reload.
23406 @item -mcpu=@var{cpu_type}
23407 @opindex mcpu
23408 Set the instruction set, register set, and instruction scheduling parameters
23409 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23410 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23411 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23412 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23413 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23414 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23416 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23417 which selects the best architecture option for the host processor.
23418 @option{-mcpu=native} has no effect if GCC does not recognize
23419 the processor.
23421 Default instruction scheduling parameters are used for values that select
23422 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23423 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23425 Here is a list of each supported architecture and their supported
23426 implementations.
23428 @table @asis
23429 @item v7
23430 cypress, leon3v7
23432 @item v8
23433 supersparc, hypersparc, leon, leon3
23435 @item sparclite
23436 f930, f934, sparclite86x
23438 @item sparclet
23439 tsc701
23441 @item v9
23442 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23443 @end table
23445 By default (unless configured otherwise), GCC generates code for the V7
23446 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23447 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23448 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23449 SPARCStation 1, 2, IPX etc.
23451 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23452 architecture.  The only difference from V7 code is that the compiler emits
23453 the integer multiply and integer divide instructions which exist in SPARC-V8
23454 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23455 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23456 2000 series.
23458 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23459 the SPARC architecture.  This adds the integer multiply, integer divide step
23460 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23461 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23462 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23463 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23464 MB86934 chip, which is the more recent SPARClite with FPU@.
23466 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23467 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23468 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23469 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23470 optimizes it for the TEMIC SPARClet chip.
23472 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23473 architecture.  This adds 64-bit integer and floating-point move instructions,
23474 3 additional floating-point condition code registers and conditional move
23475 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23476 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23477 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23478 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23479 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23480 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23481 additionally optimizes it for Sun UltraSPARC T2 chips. With
23482 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23483 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23484 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23485 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23486 Oracle SPARC M7 chips.
23488 @item -mtune=@var{cpu_type}
23489 @opindex mtune
23490 Set the instruction scheduling parameters for machine type
23491 @var{cpu_type}, but do not set the instruction set or register set that the
23492 option @option{-mcpu=@var{cpu_type}} does.
23494 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23495 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23496 that select a particular CPU implementation.  Those are
23497 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23498 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23499 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23500 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23501 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23502 GNU/Linux toolchains, @samp{native} can also be used.
23504 @item -mv8plus
23505 @itemx -mno-v8plus
23506 @opindex mv8plus
23507 @opindex mno-v8plus
23508 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23509 difference from the V8 ABI is that the global and out registers are
23510 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23511 mode for all SPARC-V9 processors.
23513 @item -mvis
23514 @itemx -mno-vis
23515 @opindex mvis
23516 @opindex mno-vis
23517 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23518 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23520 @item -mvis2
23521 @itemx -mno-vis2
23522 @opindex mvis2
23523 @opindex mno-vis2
23524 With @option{-mvis2}, GCC generates code that takes advantage of
23525 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23526 default is @option{-mvis2} when targeting a cpu that supports such
23527 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23528 also sets @option{-mvis}.
23530 @item -mvis3
23531 @itemx -mno-vis3
23532 @opindex mvis3
23533 @opindex mno-vis3
23534 With @option{-mvis3}, GCC generates code that takes advantage of
23535 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23536 default is @option{-mvis3} when targeting a cpu that supports such
23537 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23538 also sets @option{-mvis2} and @option{-mvis}.
23540 @item -mvis4
23541 @itemx -mno-vis4
23542 @opindex mvis4
23543 @opindex mno-vis4
23544 With @option{-mvis4}, GCC generates code that takes advantage of
23545 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23546 default is @option{-mvis4} when targeting a cpu that supports such
23547 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23548 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23550 @item -mcbcond
23551 @itemx -mno-cbcond
23552 @opindex mcbcond
23553 @opindex mno-cbcond
23554 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23555 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23556 when targeting a CPU that supports such instructions, such as Niagara-4 and
23557 later.
23559 @item -mfmaf
23560 @itemx -mno-fmaf
23561 @opindex mfmaf
23562 @opindex mno-fmaf
23563 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23564 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23565 when targeting a CPU that supports such instructions, such as Niagara-3 and
23566 later.
23568 @item -mpopc
23569 @itemx -mno-popc
23570 @opindex mpopc
23571 @opindex mno-popc
23572 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23573 Population Count instruction.  The default is @option{-mpopc}
23574 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23575 later.
23577 @item -msubxc
23578 @itemx -mno-subxc
23579 @opindex msubxc
23580 @opindex mno-subxc
23581 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23582 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23583 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23584 later.
23586 @item -mfix-at697f
23587 @opindex mfix-at697f
23588 Enable the documented workaround for the single erratum of the Atmel AT697F
23589 processor (which corresponds to erratum #13 of the AT697E processor).
23591 @item -mfix-ut699
23592 @opindex mfix-ut699
23593 Enable the documented workarounds for the floating-point errata and the data
23594 cache nullify errata of the UT699 processor.
23595 @end table
23597 These @samp{-m} options are supported in addition to the above
23598 on SPARC-V9 processors in 64-bit environments:
23600 @table @gcctabopt
23601 @item -m32
23602 @itemx -m64
23603 @opindex m32
23604 @opindex m64
23605 Generate code for a 32-bit or 64-bit environment.
23606 The 32-bit environment sets int, long and pointer to 32 bits.
23607 The 64-bit environment sets int to 32 bits and long and pointer
23608 to 64 bits.
23610 @item -mcmodel=@var{which}
23611 @opindex mcmodel
23612 Set the code model to one of
23614 @table @samp
23615 @item medlow
23616 The Medium/Low code model: 64-bit addresses, programs
23617 must be linked in the low 32 bits of memory.  Programs can be statically
23618 or dynamically linked.
23620 @item medmid
23621 The Medium/Middle code model: 64-bit addresses, programs
23622 must be linked in the low 44 bits of memory, the text and data segments must
23623 be less than 2GB in size and the data segment must be located within 2GB of
23624 the text segment.
23626 @item medany
23627 The Medium/Anywhere code model: 64-bit addresses, programs
23628 may be linked anywhere in memory, the text and data segments must be less
23629 than 2GB in size and the data segment must be located within 2GB of the
23630 text segment.
23632 @item embmedany
23633 The Medium/Anywhere code model for embedded systems:
23634 64-bit addresses, the text and data segments must be less than 2GB in
23635 size, both starting anywhere in memory (determined at link time).  The
23636 global register %g4 points to the base of the data segment.  Programs
23637 are statically linked and PIC is not supported.
23638 @end table
23640 @item -mmemory-model=@var{mem-model}
23641 @opindex mmemory-model
23642 Set the memory model in force on the processor to one of
23644 @table @samp
23645 @item default
23646 The default memory model for the processor and operating system.
23648 @item rmo
23649 Relaxed Memory Order
23651 @item pso
23652 Partial Store Order
23654 @item tso
23655 Total Store Order
23657 @item sc
23658 Sequential Consistency
23659 @end table
23661 These memory models are formally defined in Appendix D of the SPARC-V9
23662 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23664 @item -mstack-bias
23665 @itemx -mno-stack-bias
23666 @opindex mstack-bias
23667 @opindex mno-stack-bias
23668 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23669 frame pointer if present, are offset by @minus{}2047 which must be added back
23670 when making stack frame references.  This is the default in 64-bit mode.
23671 Otherwise, assume no such offset is present.
23672 @end table
23674 @node SPU Options
23675 @subsection SPU Options
23676 @cindex SPU options
23678 These @samp{-m} options are supported on the SPU:
23680 @table @gcctabopt
23681 @item -mwarn-reloc
23682 @itemx -merror-reloc
23683 @opindex mwarn-reloc
23684 @opindex merror-reloc
23686 The loader for SPU does not handle dynamic relocations.  By default, GCC
23687 gives an error when it generates code that requires a dynamic
23688 relocation.  @option{-mno-error-reloc} disables the error,
23689 @option{-mwarn-reloc} generates a warning instead.
23691 @item -msafe-dma
23692 @itemx -munsafe-dma
23693 @opindex msafe-dma
23694 @opindex munsafe-dma
23696 Instructions that initiate or test completion of DMA must not be
23697 reordered with respect to loads and stores of the memory that is being
23698 accessed.
23699 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23700 memory accesses, but that can lead to inefficient code in places where the
23701 memory is known to not change.  Rather than mark the memory as volatile,
23702 you can use @option{-msafe-dma} to tell the compiler to treat
23703 the DMA instructions as potentially affecting all memory.  
23705 @item -mbranch-hints
23706 @opindex mbranch-hints
23708 By default, GCC generates a branch hint instruction to avoid
23709 pipeline stalls for always-taken or probably-taken branches.  A hint
23710 is not generated closer than 8 instructions away from its branch.
23711 There is little reason to disable them, except for debugging purposes,
23712 or to make an object a little bit smaller.
23714 @item -msmall-mem
23715 @itemx -mlarge-mem
23716 @opindex msmall-mem
23717 @opindex mlarge-mem
23719 By default, GCC generates code assuming that addresses are never larger
23720 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23721 a full 32-bit address.
23723 @item -mstdmain
23724 @opindex mstdmain
23726 By default, GCC links against startup code that assumes the SPU-style
23727 main function interface (which has an unconventional parameter list).
23728 With @option{-mstdmain}, GCC links your program against startup
23729 code that assumes a C99-style interface to @code{main}, including a
23730 local copy of @code{argv} strings.
23732 @item -mfixed-range=@var{register-range}
23733 @opindex mfixed-range
23734 Generate code treating the given register range as fixed registers.
23735 A fixed register is one that the register allocator cannot use.  This is
23736 useful when compiling kernel code.  A register range is specified as
23737 two registers separated by a dash.  Multiple register ranges can be
23738 specified separated by a comma.
23740 @item -mea32
23741 @itemx -mea64
23742 @opindex mea32
23743 @opindex mea64
23744 Compile code assuming that pointers to the PPU address space accessed
23745 via the @code{__ea} named address space qualifier are either 32 or 64
23746 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23747 all object code in an executable must be compiled with the same setting.
23749 @item -maddress-space-conversion
23750 @itemx -mno-address-space-conversion
23751 @opindex maddress-space-conversion
23752 @opindex mno-address-space-conversion
23753 Allow/disallow treating the @code{__ea} address space as superset
23754 of the generic address space.  This enables explicit type casts
23755 between @code{__ea} and generic pointer as well as implicit
23756 conversions of generic pointers to @code{__ea} pointers.  The
23757 default is to allow address space pointer conversions.
23759 @item -mcache-size=@var{cache-size}
23760 @opindex mcache-size
23761 This option controls the version of libgcc that the compiler links to an
23762 executable and selects a software-managed cache for accessing variables
23763 in the @code{__ea} address space with a particular cache size.  Possible
23764 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23765 and @samp{128}.  The default cache size is 64KB.
23767 @item -matomic-updates
23768 @itemx -mno-atomic-updates
23769 @opindex matomic-updates
23770 @opindex mno-atomic-updates
23771 This option controls the version of libgcc that the compiler links to an
23772 executable and selects whether atomic updates to the software-managed
23773 cache of PPU-side variables are used.  If you use atomic updates, changes
23774 to a PPU variable from SPU code using the @code{__ea} named address space
23775 qualifier do not interfere with changes to other PPU variables residing
23776 in the same cache line from PPU code.  If you do not use atomic updates,
23777 such interference may occur; however, writing back cache lines is
23778 more efficient.  The default behavior is to use atomic updates.
23780 @item -mdual-nops
23781 @itemx -mdual-nops=@var{n}
23782 @opindex mdual-nops
23783 By default, GCC inserts NOPs to increase dual issue when it expects
23784 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23785 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23786 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23788 @item -mhint-max-nops=@var{n}
23789 @opindex mhint-max-nops
23790 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23791 be at least 8 instructions away from the branch it is affecting.  GCC
23792 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23793 generate the branch hint.
23795 @item -mhint-max-distance=@var{n}
23796 @opindex mhint-max-distance
23797 The encoding of the branch hint instruction limits the hint to be within
23798 256 instructions of the branch it is affecting.  By default, GCC makes
23799 sure it is within 125.
23801 @item -msafe-hints
23802 @opindex msafe-hints
23803 Work around a hardware bug that causes the SPU to stall indefinitely.
23804 By default, GCC inserts the @code{hbrp} instruction to make sure
23805 this stall won't happen.
23807 @end table
23809 @node System V Options
23810 @subsection Options for System V
23812 These additional options are available on System V Release 4 for
23813 compatibility with other compilers on those systems:
23815 @table @gcctabopt
23816 @item -G
23817 @opindex G
23818 Create a shared object.
23819 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23821 @item -Qy
23822 @opindex Qy
23823 Identify the versions of each tool used by the compiler, in a
23824 @code{.ident} assembler directive in the output.
23826 @item -Qn
23827 @opindex Qn
23828 Refrain from adding @code{.ident} directives to the output file (this is
23829 the default).
23831 @item -YP,@var{dirs}
23832 @opindex YP
23833 Search the directories @var{dirs}, and no others, for libraries
23834 specified with @option{-l}.
23836 @item -Ym,@var{dir}
23837 @opindex Ym
23838 Look in the directory @var{dir} to find the M4 preprocessor.
23839 The assembler uses this option.
23840 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23841 @c the generic assembler that comes with Solaris takes just -Ym.
23842 @end table
23844 @node TILE-Gx Options
23845 @subsection TILE-Gx Options
23846 @cindex TILE-Gx options
23848 These @samp{-m} options are supported on the TILE-Gx:
23850 @table @gcctabopt
23851 @item -mcmodel=small
23852 @opindex mcmodel=small
23853 Generate code for the small model.  The distance for direct calls is
23854 limited to 500M in either direction.  PC-relative addresses are 32
23855 bits.  Absolute addresses support the full address range.
23857 @item -mcmodel=large
23858 @opindex mcmodel=large
23859 Generate code for the large model.  There is no limitation on call
23860 distance, pc-relative addresses, or absolute addresses.
23862 @item -mcpu=@var{name}
23863 @opindex mcpu
23864 Selects the type of CPU to be targeted.  Currently the only supported
23865 type is @samp{tilegx}.
23867 @item -m32
23868 @itemx -m64
23869 @opindex m32
23870 @opindex m64
23871 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23872 environment sets int, long, and pointer to 32 bits.  The 64-bit
23873 environment sets int to 32 bits and long and pointer to 64 bits.
23875 @item -mbig-endian
23876 @itemx -mlittle-endian
23877 @opindex mbig-endian
23878 @opindex mlittle-endian
23879 Generate code in big/little endian mode, respectively.
23880 @end table
23882 @node TILEPro Options
23883 @subsection TILEPro Options
23884 @cindex TILEPro options
23886 These @samp{-m} options are supported on the TILEPro:
23888 @table @gcctabopt
23889 @item -mcpu=@var{name}
23890 @opindex mcpu
23891 Selects the type of CPU to be targeted.  Currently the only supported
23892 type is @samp{tilepro}.
23894 @item -m32
23895 @opindex m32
23896 Generate code for a 32-bit environment, which sets int, long, and
23897 pointer to 32 bits.  This is the only supported behavior so the flag
23898 is essentially ignored.
23899 @end table
23901 @node V850 Options
23902 @subsection V850 Options
23903 @cindex V850 Options
23905 These @samp{-m} options are defined for V850 implementations:
23907 @table @gcctabopt
23908 @item -mlong-calls
23909 @itemx -mno-long-calls
23910 @opindex mlong-calls
23911 @opindex mno-long-calls
23912 Treat all calls as being far away (near).  If calls are assumed to be
23913 far away, the compiler always loads the function's address into a
23914 register, and calls indirect through the pointer.
23916 @item -mno-ep
23917 @itemx -mep
23918 @opindex mno-ep
23919 @opindex mep
23920 Do not optimize (do optimize) basic blocks that use the same index
23921 pointer 4 or more times to copy pointer into the @code{ep} register, and
23922 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23923 option is on by default if you optimize.
23925 @item -mno-prolog-function
23926 @itemx -mprolog-function
23927 @opindex mno-prolog-function
23928 @opindex mprolog-function
23929 Do not use (do use) external functions to save and restore registers
23930 at the prologue and epilogue of a function.  The external functions
23931 are slower, but use less code space if more than one function saves
23932 the same number of registers.  The @option{-mprolog-function} option
23933 is on by default if you optimize.
23935 @item -mspace
23936 @opindex mspace
23937 Try to make the code as small as possible.  At present, this just turns
23938 on the @option{-mep} and @option{-mprolog-function} options.
23940 @item -mtda=@var{n}
23941 @opindex mtda
23942 Put static or global variables whose size is @var{n} bytes or less into
23943 the tiny data area that register @code{ep} points to.  The tiny data
23944 area can hold up to 256 bytes in total (128 bytes for byte references).
23946 @item -msda=@var{n}
23947 @opindex msda
23948 Put static or global variables whose size is @var{n} bytes or less into
23949 the small data area that register @code{gp} points to.  The small data
23950 area can hold up to 64 kilobytes.
23952 @item -mzda=@var{n}
23953 @opindex mzda
23954 Put static or global variables whose size is @var{n} bytes or less into
23955 the first 32 kilobytes of memory.
23957 @item -mv850
23958 @opindex mv850
23959 Specify that the target processor is the V850.
23961 @item -mv850e3v5
23962 @opindex mv850e3v5
23963 Specify that the target processor is the V850E3V5.  The preprocessor
23964 constant @code{__v850e3v5__} is defined if this option is used.
23966 @item -mv850e2v4
23967 @opindex mv850e2v4
23968 Specify that the target processor is the V850E3V5.  This is an alias for
23969 the @option{-mv850e3v5} option.
23971 @item -mv850e2v3
23972 @opindex mv850e2v3
23973 Specify that the target processor is the V850E2V3.  The preprocessor
23974 constant @code{__v850e2v3__} is defined if this option is used.
23976 @item -mv850e2
23977 @opindex mv850e2
23978 Specify that the target processor is the V850E2.  The preprocessor
23979 constant @code{__v850e2__} is defined if this option is used.
23981 @item -mv850e1
23982 @opindex mv850e1
23983 Specify that the target processor is the V850E1.  The preprocessor
23984 constants @code{__v850e1__} and @code{__v850e__} are defined if
23985 this option is used.
23987 @item -mv850es
23988 @opindex mv850es
23989 Specify that the target processor is the V850ES.  This is an alias for
23990 the @option{-mv850e1} option.
23992 @item -mv850e
23993 @opindex mv850e
23994 Specify that the target processor is the V850E@.  The preprocessor
23995 constant @code{__v850e__} is defined if this option is used.
23997 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23998 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23999 are defined then a default target processor is chosen and the
24000 relevant @samp{__v850*__} preprocessor constant is defined.
24002 The preprocessor constants @code{__v850} and @code{__v851__} are always
24003 defined, regardless of which processor variant is the target.
24005 @item -mdisable-callt
24006 @itemx -mno-disable-callt
24007 @opindex mdisable-callt
24008 @opindex mno-disable-callt
24009 This option suppresses generation of the @code{CALLT} instruction for the
24010 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24011 architecture.
24013 This option is enabled by default when the RH850 ABI is
24014 in use (see @option{-mrh850-abi}), and disabled by default when the
24015 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24016 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24018 @item -mrelax
24019 @itemx -mno-relax
24020 @opindex mrelax
24021 @opindex mno-relax
24022 Pass on (or do not pass on) the @option{-mrelax} command-line option
24023 to the assembler.
24025 @item -mlong-jumps
24026 @itemx -mno-long-jumps
24027 @opindex mlong-jumps
24028 @opindex mno-long-jumps
24029 Disable (or re-enable) the generation of PC-relative jump instructions.
24031 @item -msoft-float
24032 @itemx -mhard-float
24033 @opindex msoft-float
24034 @opindex mhard-float
24035 Disable (or re-enable) the generation of hardware floating point
24036 instructions.  This option is only significant when the target
24037 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24038 instructions are being generated then the C preprocessor symbol
24039 @code{__FPU_OK__} is defined, otherwise the symbol
24040 @code{__NO_FPU__} is defined.
24042 @item -mloop
24043 @opindex mloop
24044 Enables the use of the e3v5 LOOP instruction.  The use of this
24045 instruction is not enabled by default when the e3v5 architecture is
24046 selected because its use is still experimental.
24048 @item -mrh850-abi
24049 @itemx -mghs
24050 @opindex mrh850-abi
24051 @opindex mghs
24052 Enables support for the RH850 version of the V850 ABI.  This is the
24053 default.  With this version of the ABI the following rules apply:
24055 @itemize
24056 @item
24057 Integer sized structures and unions are returned via a memory pointer
24058 rather than a register.
24060 @item
24061 Large structures and unions (more than 8 bytes in size) are passed by
24062 value.
24064 @item
24065 Functions are aligned to 16-bit boundaries.
24067 @item
24068 The @option{-m8byte-align} command-line option is supported.
24070 @item
24071 The @option{-mdisable-callt} command-line option is enabled by
24072 default.  The @option{-mno-disable-callt} command-line option is not
24073 supported.
24074 @end itemize
24076 When this version of the ABI is enabled the C preprocessor symbol
24077 @code{__V850_RH850_ABI__} is defined.
24079 @item -mgcc-abi
24080 @opindex mgcc-abi
24081 Enables support for the old GCC version of the V850 ABI.  With this
24082 version of the ABI the following rules apply:
24084 @itemize
24085 @item
24086 Integer sized structures and unions are returned in register @code{r10}.
24088 @item
24089 Large structures and unions (more than 8 bytes in size) are passed by
24090 reference.
24092 @item
24093 Functions are aligned to 32-bit boundaries, unless optimizing for
24094 size.
24096 @item
24097 The @option{-m8byte-align} command-line option is not supported.
24099 @item
24100 The @option{-mdisable-callt} command-line option is supported but not
24101 enabled by default.
24102 @end itemize
24104 When this version of the ABI is enabled the C preprocessor symbol
24105 @code{__V850_GCC_ABI__} is defined.
24107 @item -m8byte-align
24108 @itemx -mno-8byte-align
24109 @opindex m8byte-align
24110 @opindex mno-8byte-align
24111 Enables support for @code{double} and @code{long long} types to be
24112 aligned on 8-byte boundaries.  The default is to restrict the
24113 alignment of all objects to at most 4-bytes.  When
24114 @option{-m8byte-align} is in effect the C preprocessor symbol
24115 @code{__V850_8BYTE_ALIGN__} is defined.
24117 @item -mbig-switch
24118 @opindex mbig-switch
24119 Generate code suitable for big switch tables.  Use this option only if
24120 the assembler/linker complain about out of range branches within a switch
24121 table.
24123 @item -mapp-regs
24124 @opindex mapp-regs
24125 This option causes r2 and r5 to be used in the code generated by
24126 the compiler.  This setting is the default.
24128 @item -mno-app-regs
24129 @opindex mno-app-regs
24130 This option causes r2 and r5 to be treated as fixed registers.
24132 @end table
24134 @node VAX Options
24135 @subsection VAX Options
24136 @cindex VAX options
24138 These @samp{-m} options are defined for the VAX:
24140 @table @gcctabopt
24141 @item -munix
24142 @opindex munix
24143 Do not output certain jump instructions (@code{aobleq} and so on)
24144 that the Unix assembler for the VAX cannot handle across long
24145 ranges.
24147 @item -mgnu
24148 @opindex mgnu
24149 Do output those jump instructions, on the assumption that the
24150 GNU assembler is being used.
24152 @item -mg
24153 @opindex mg
24154 Output code for G-format floating-point numbers instead of D-format.
24155 @end table
24157 @node Visium Options
24158 @subsection Visium Options
24159 @cindex Visium options
24161 @table @gcctabopt
24163 @item -mdebug
24164 @opindex mdebug
24165 A program which performs file I/O and is destined to run on an MCM target
24166 should be linked with this option.  It causes the libraries libc.a and
24167 libdebug.a to be linked.  The program should be run on the target under
24168 the control of the GDB remote debugging stub.
24170 @item -msim
24171 @opindex msim
24172 A program which performs file I/O and is destined to run on the simulator
24173 should be linked with option.  This causes libraries libc.a and libsim.a to
24174 be linked.
24176 @item -mfpu
24177 @itemx -mhard-float
24178 @opindex mfpu
24179 @opindex mhard-float
24180 Generate code containing floating-point instructions.  This is the
24181 default.
24183 @item -mno-fpu
24184 @itemx -msoft-float
24185 @opindex mno-fpu
24186 @opindex msoft-float
24187 Generate code containing library calls for floating-point.
24189 @option{-msoft-float} changes the calling convention in the output file;
24190 therefore, it is only useful if you compile @emph{all} of a program with
24191 this option.  In particular, you need to compile @file{libgcc.a}, the
24192 library that comes with GCC, with @option{-msoft-float} in order for
24193 this to work.
24195 @item -mcpu=@var{cpu_type}
24196 @opindex mcpu
24197 Set the instruction set, register set, and instruction scheduling parameters
24198 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24199 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24201 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24203 By default (unless configured otherwise), GCC generates code for the GR5
24204 variant of the Visium architecture.  
24206 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24207 architecture.  The only difference from GR5 code is that the compiler will
24208 generate block move instructions.
24210 @item -mtune=@var{cpu_type}
24211 @opindex mtune
24212 Set the instruction scheduling parameters for machine type @var{cpu_type},
24213 but do not set the instruction set or register set that the option
24214 @option{-mcpu=@var{cpu_type}} would.
24216 @item -msv-mode
24217 @opindex msv-mode
24218 Generate code for the supervisor mode, where there are no restrictions on
24219 the access to general registers.  This is the default.
24221 @item -muser-mode
24222 @opindex muser-mode
24223 Generate code for the user mode, where the access to some general registers
24224 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24225 mode; on the GR6, only registers r29 to r31 are affected.
24226 @end table
24228 @node VMS Options
24229 @subsection VMS Options
24231 These @samp{-m} options are defined for the VMS implementations:
24233 @table @gcctabopt
24234 @item -mvms-return-codes
24235 @opindex mvms-return-codes
24236 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24237 condition (e.g.@ error) codes.
24239 @item -mdebug-main=@var{prefix}
24240 @opindex mdebug-main=@var{prefix}
24241 Flag the first routine whose name starts with @var{prefix} as the main
24242 routine for the debugger.
24244 @item -mmalloc64
24245 @opindex mmalloc64
24246 Default to 64-bit memory allocation routines.
24248 @item -mpointer-size=@var{size}
24249 @opindex mpointer-size=@var{size}
24250 Set the default size of pointers. Possible options for @var{size} are
24251 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24252 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24253 The later option disables @code{pragma pointer_size}.
24254 @end table
24256 @node VxWorks Options
24257 @subsection VxWorks Options
24258 @cindex VxWorks Options
24260 The options in this section are defined for all VxWorks targets.
24261 Options specific to the target hardware are listed with the other
24262 options for that target.
24264 @table @gcctabopt
24265 @item -mrtp
24266 @opindex mrtp
24267 GCC can generate code for both VxWorks kernels and real time processes
24268 (RTPs).  This option switches from the former to the latter.  It also
24269 defines the preprocessor macro @code{__RTP__}.
24271 @item -non-static
24272 @opindex non-static
24273 Link an RTP executable against shared libraries rather than static
24274 libraries.  The options @option{-static} and @option{-shared} can
24275 also be used for RTPs (@pxref{Link Options}); @option{-static}
24276 is the default.
24278 @item -Bstatic
24279 @itemx -Bdynamic
24280 @opindex Bstatic
24281 @opindex Bdynamic
24282 These options are passed down to the linker.  They are defined for
24283 compatibility with Diab.
24285 @item -Xbind-lazy
24286 @opindex Xbind-lazy
24287 Enable lazy binding of function calls.  This option is equivalent to
24288 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24290 @item -Xbind-now
24291 @opindex Xbind-now
24292 Disable lazy binding of function calls.  This option is the default and
24293 is defined for compatibility with Diab.
24294 @end table
24296 @node x86 Options
24297 @subsection x86 Options
24298 @cindex x86 Options
24300 These @samp{-m} options are defined for the x86 family of computers.
24302 @table @gcctabopt
24304 @item -march=@var{cpu-type}
24305 @opindex march
24306 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24307 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24308 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24309 to generate code that may not run at all on processors other than the one
24310 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24311 @option{-mtune=@var{cpu-type}}.
24313 The choices for @var{cpu-type} are:
24315 @table @samp
24316 @item native
24317 This selects the CPU to generate code for at compilation time by determining
24318 the processor type of the compiling machine.  Using @option{-march=native}
24319 enables all instruction subsets supported by the local machine (hence
24320 the result might not run on different machines).  Using @option{-mtune=native}
24321 produces code optimized for the local machine under the constraints
24322 of the selected instruction set.  
24324 @item i386
24325 Original Intel i386 CPU@.
24327 @item i486
24328 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24330 @item i586
24331 @itemx pentium
24332 Intel Pentium CPU with no MMX support.
24334 @item lakemont
24335 Intel Lakemont MCU, based on Intel Pentium CPU.
24337 @item pentium-mmx
24338 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24340 @item pentiumpro
24341 Intel Pentium Pro CPU@.
24343 @item i686
24344 When used with @option{-march}, the Pentium Pro
24345 instruction set is used, so the code runs on all i686 family chips.
24346 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24348 @item pentium2
24349 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24350 support.
24352 @item pentium3
24353 @itemx pentium3m
24354 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24355 set support.
24357 @item pentium-m
24358 Intel Pentium M; low-power version of Intel Pentium III CPU
24359 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24361 @item pentium4
24362 @itemx pentium4m
24363 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24365 @item prescott
24366 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24367 set support.
24369 @item nocona
24370 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24371 SSE2 and SSE3 instruction set support.
24373 @item core2
24374 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24375 instruction set support.
24377 @item nehalem
24378 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24379 SSE4.1, SSE4.2 and POPCNT instruction set support.
24381 @item westmere
24382 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24383 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24385 @item sandybridge
24386 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24387 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24389 @item ivybridge
24390 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24391 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24392 instruction set support.
24394 @item haswell
24395 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24396 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24397 BMI, BMI2 and F16C instruction set support.
24399 @item broadwell
24400 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24401 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24402 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24404 @item skylake
24405 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24406 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24407 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24408 XSAVES instruction set support.
24410 @item bonnell
24411 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24412 instruction set support.
24414 @item silvermont
24415 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24416 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24418 @item knl
24419 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24420 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24421 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24422 AVX512CD instruction set support.
24424 @item skylake-avx512
24425 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24426 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24427 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24428 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24430 @item k6
24431 AMD K6 CPU with MMX instruction set support.
24433 @item k6-2
24434 @itemx k6-3
24435 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24437 @item athlon
24438 @itemx athlon-tbird
24439 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24440 support.
24442 @item athlon-4
24443 @itemx athlon-xp
24444 @itemx athlon-mp
24445 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24446 instruction set support.
24448 @item k8
24449 @itemx opteron
24450 @itemx athlon64
24451 @itemx athlon-fx
24452 Processors based on the AMD K8 core with x86-64 instruction set support,
24453 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24454 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24455 instruction set extensions.)
24457 @item k8-sse3
24458 @itemx opteron-sse3
24459 @itemx athlon64-sse3
24460 Improved versions of AMD K8 cores with SSE3 instruction set support.
24462 @item amdfam10
24463 @itemx barcelona
24464 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24465 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24466 instruction set extensions.)
24468 @item bdver1
24469 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24470 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24471 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24472 @item bdver2
24473 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24474 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24475 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24476 extensions.)
24477 @item bdver3
24478 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24479 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24480 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24481 64-bit instruction set extensions.
24482 @item bdver4
24483 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24484 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24485 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24486 SSE4.2, ABM and 64-bit instruction set extensions.
24488 @item znver1
24489 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24490 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24491 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24492 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24493 instruction set extensions.
24495 @item btver1
24496 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24497 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24498 instruction set extensions.)
24500 @item btver2
24501 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24502 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24503 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24505 @item winchip-c6
24506 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24507 set support.
24509 @item winchip2
24510 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24511 instruction set support.
24513 @item c3
24514 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24515 (No scheduling is implemented for this chip.)
24517 @item c3-2
24518 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24519 (No scheduling is implemented for this chip.)
24521 @item c7
24522 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24523 (No scheduling is implemented for this chip.)
24525 @item samuel-2
24526 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24527 (No scheduling is implemented for this chip.)
24529 @item nehemiah
24530 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24531 (No scheduling is implemented for this chip.)
24533 @item esther
24534 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24535 (No scheduling is implemented for this chip.)
24537 @item eden-x2
24538 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24539 (No scheduling is implemented for this chip.)
24541 @item eden-x4
24542 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24543 AVX and AVX2 instruction set support.
24544 (No scheduling is implemented for this chip.)
24546 @item nano
24547 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24548 instruction set support.
24549 (No scheduling is implemented for this chip.)
24551 @item nano-1000
24552 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24553 instruction set support.
24554 (No scheduling is implemented for this chip.)
24556 @item nano-2000
24557 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24558 instruction set support.
24559 (No scheduling is implemented for this chip.)
24561 @item nano-3000
24562 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24563 instruction set support.
24564 (No scheduling is implemented for this chip.)
24566 @item nano-x2
24567 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24568 instruction set support.
24569 (No scheduling is implemented for this chip.)
24571 @item nano-x4
24572 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24573 instruction set support.
24574 (No scheduling is implemented for this chip.)
24576 @item geode
24577 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24578 @end table
24580 @item -mtune=@var{cpu-type}
24581 @opindex mtune
24582 Tune to @var{cpu-type} everything applicable about the generated code, except
24583 for the ABI and the set of available instructions.  
24584 While picking a specific @var{cpu-type} schedules things appropriately
24585 for that particular chip, the compiler does not generate any code that
24586 cannot run on the default machine type unless you use a
24587 @option{-march=@var{cpu-type}} option.
24588 For example, if GCC is configured for i686-pc-linux-gnu
24589 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24590 but still runs on i686 machines.
24592 The choices for @var{cpu-type} are the same as for @option{-march}.
24593 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24595 @table @samp
24596 @item generic
24597 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24598 If you know the CPU on which your code will run, then you should use
24599 the corresponding @option{-mtune} or @option{-march} option instead of
24600 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24601 of your application will have, then you should use this option.
24603 As new processors are deployed in the marketplace, the behavior of this
24604 option will change.  Therefore, if you upgrade to a newer version of
24605 GCC, code generation controlled by this option will change to reflect
24606 the processors
24607 that are most common at the time that version of GCC is released.
24609 There is no @option{-march=generic} option because @option{-march}
24610 indicates the instruction set the compiler can use, and there is no
24611 generic instruction set applicable to all processors.  In contrast,
24612 @option{-mtune} indicates the processor (or, in this case, collection of
24613 processors) for which the code is optimized.
24615 @item intel
24616 Produce code optimized for the most current Intel processors, which are
24617 Haswell and Silvermont for this version of GCC.  If you know the CPU
24618 on which your code will run, then you should use the corresponding
24619 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24620 But, if you want your application performs better on both Haswell and
24621 Silvermont, then you should use this option.
24623 As new Intel processors are deployed in the marketplace, the behavior of
24624 this option will change.  Therefore, if you upgrade to a newer version of
24625 GCC, code generation controlled by this option will change to reflect
24626 the most current Intel processors at the time that version of GCC is
24627 released.
24629 There is no @option{-march=intel} option because @option{-march} indicates
24630 the instruction set the compiler can use, and there is no common
24631 instruction set applicable to all processors.  In contrast,
24632 @option{-mtune} indicates the processor (or, in this case, collection of
24633 processors) for which the code is optimized.
24634 @end table
24636 @item -mcpu=@var{cpu-type}
24637 @opindex mcpu
24638 A deprecated synonym for @option{-mtune}.
24640 @item -mfpmath=@var{unit}
24641 @opindex mfpmath
24642 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24643 for @var{unit} are:
24645 @table @samp
24646 @item 387
24647 Use the standard 387 floating-point coprocessor present on the majority of chips and
24648 emulated otherwise.  Code compiled with this option runs almost everywhere.
24649 The temporary results are computed in 80-bit precision instead of the precision
24650 specified by the type, resulting in slightly different results compared to most
24651 of other chips.  See @option{-ffloat-store} for more detailed description.
24653 This is the default choice for x86-32 targets.
24655 @item sse
24656 Use scalar floating-point instructions present in the SSE instruction set.
24657 This instruction set is supported by Pentium III and newer chips,
24658 and in the AMD line
24659 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24660 instruction set supports only single-precision arithmetic, thus the double and
24661 extended-precision arithmetic are still done using 387.  A later version, present
24662 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24663 arithmetic too.
24665 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24666 or @option{-msse2} switches to enable SSE extensions and make this option
24667 effective.  For the x86-64 compiler, these extensions are enabled by default.
24669 The resulting code should be considerably faster in the majority of cases and avoid
24670 the numerical instability problems of 387 code, but may break some existing
24671 code that expects temporaries to be 80 bits.
24673 This is the default choice for the x86-64 compiler.
24675 @item sse,387
24676 @itemx sse+387
24677 @itemx both
24678 Attempt to utilize both instruction sets at once.  This effectively doubles the
24679 amount of available registers, and on chips with separate execution units for
24680 387 and SSE the execution resources too.  Use this option with care, as it is
24681 still experimental, because the GCC register allocator does not model separate
24682 functional units well, resulting in unstable performance.
24683 @end table
24685 @item -masm=@var{dialect}
24686 @opindex masm=@var{dialect}
24687 Output assembly instructions using selected @var{dialect}.  Also affects
24688 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24689 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24690 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24691 not support @samp{intel}.
24693 @item -mieee-fp
24694 @itemx -mno-ieee-fp
24695 @opindex mieee-fp
24696 @opindex mno-ieee-fp
24697 Control whether or not the compiler uses IEEE floating-point
24698 comparisons.  These correctly handle the case where the result of a
24699 comparison is unordered.
24701 @item -m80387
24702 @item -mhard-float
24703 @opindex 80387
24704 @opindex mhard-float
24705 Generate output containing 80387 instructions for floating point.
24707 @item -mno-80387
24708 @item -msoft-float
24709 @opindex no-80387
24710 @opindex msoft-float
24711 Generate output containing library calls for floating point.
24713 @strong{Warning:} the requisite libraries are not part of GCC@.
24714 Normally the facilities of the machine's usual C compiler are used, but
24715 this can't be done directly in cross-compilation.  You must make your
24716 own arrangements to provide suitable library functions for
24717 cross-compilation.
24719 On machines where a function returns floating-point results in the 80387
24720 register stack, some floating-point opcodes may be emitted even if
24721 @option{-msoft-float} is used.
24723 @item -mno-fp-ret-in-387
24724 @opindex mno-fp-ret-in-387
24725 Do not use the FPU registers for return values of functions.
24727 The usual calling convention has functions return values of types
24728 @code{float} and @code{double} in an FPU register, even if there
24729 is no FPU@.  The idea is that the operating system should emulate
24730 an FPU@.
24732 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24733 in ordinary CPU registers instead.
24735 @item -mno-fancy-math-387
24736 @opindex mno-fancy-math-387
24737 Some 387 emulators do not support the @code{sin}, @code{cos} and
24738 @code{sqrt} instructions for the 387.  Specify this option to avoid
24739 generating those instructions.  This option is the default on
24740 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24741 indicates that the target CPU always has an FPU and so the
24742 instruction does not need emulation.  These
24743 instructions are not generated unless you also use the
24744 @option{-funsafe-math-optimizations} switch.
24746 @item -malign-double
24747 @itemx -mno-align-double
24748 @opindex malign-double
24749 @opindex mno-align-double
24750 Control whether GCC aligns @code{double}, @code{long double}, and
24751 @code{long long} variables on a two-word boundary or a one-word
24752 boundary.  Aligning @code{double} variables on a two-word boundary
24753 produces code that runs somewhat faster on a Pentium at the
24754 expense of more memory.
24756 On x86-64, @option{-malign-double} is enabled by default.
24758 @strong{Warning:} if you use the @option{-malign-double} switch,
24759 structures containing the above types are aligned differently than
24760 the published application binary interface specifications for the x86-32
24761 and are not binary compatible with structures in code compiled
24762 without that switch.
24764 @item -m96bit-long-double
24765 @itemx -m128bit-long-double
24766 @opindex m96bit-long-double
24767 @opindex m128bit-long-double
24768 These switches control the size of @code{long double} type.  The x86-32
24769 application binary interface specifies the size to be 96 bits,
24770 so @option{-m96bit-long-double} is the default in 32-bit mode.
24772 Modern architectures (Pentium and newer) prefer @code{long double}
24773 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24774 conforming to the ABI, this is not possible.  So specifying
24775 @option{-m128bit-long-double} aligns @code{long double}
24776 to a 16-byte boundary by padding the @code{long double} with an additional
24777 32-bit zero.
24779 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24780 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24782 Notice that neither of these options enable any extra precision over the x87
24783 standard of 80 bits for a @code{long double}.
24785 @strong{Warning:} if you override the default value for your target ABI, this
24786 changes the size of 
24787 structures and arrays containing @code{long double} variables,
24788 as well as modifying the function calling convention for functions taking
24789 @code{long double}.  Hence they are not binary-compatible
24790 with code compiled without that switch.
24792 @item -mlong-double-64
24793 @itemx -mlong-double-80
24794 @itemx -mlong-double-128
24795 @opindex mlong-double-64
24796 @opindex mlong-double-80
24797 @opindex mlong-double-128
24798 These switches control the size of @code{long double} type. A size
24799 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24800 type. This is the default for 32-bit Bionic C library.  A size
24801 of 128 bits makes the @code{long double} type equivalent to the
24802 @code{__float128} type. This is the default for 64-bit Bionic C library.
24804 @strong{Warning:} if you override the default value for your target ABI, this
24805 changes the size of
24806 structures and arrays containing @code{long double} variables,
24807 as well as modifying the function calling convention for functions taking
24808 @code{long double}.  Hence they are not binary-compatible
24809 with code compiled without that switch.
24811 @item -malign-data=@var{type}
24812 @opindex malign-data
24813 Control how GCC aligns variables.  Supported values for @var{type} are
24814 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24815 and earlier, @samp{abi} uses alignment value as specified by the
24816 psABI, and @samp{cacheline} uses increased alignment value to match
24817 the cache line size.  @samp{compat} is the default.
24819 @item -mlarge-data-threshold=@var{threshold}
24820 @opindex mlarge-data-threshold
24821 When @option{-mcmodel=medium} is specified, data objects larger than
24822 @var{threshold} are placed in the large data section.  This value must be the
24823 same across all objects linked into the binary, and defaults to 65535.
24825 @item -mrtd
24826 @opindex mrtd
24827 Use a different function-calling convention, in which functions that
24828 take a fixed number of arguments return with the @code{ret @var{num}}
24829 instruction, which pops their arguments while returning.  This saves one
24830 instruction in the caller since there is no need to pop the arguments
24831 there.
24833 You can specify that an individual function is called with this calling
24834 sequence with the function attribute @code{stdcall}.  You can also
24835 override the @option{-mrtd} option by using the function attribute
24836 @code{cdecl}.  @xref{Function Attributes}.
24838 @strong{Warning:} this calling convention is incompatible with the one
24839 normally used on Unix, so you cannot use it if you need to call
24840 libraries compiled with the Unix compiler.
24842 Also, you must provide function prototypes for all functions that
24843 take variable numbers of arguments (including @code{printf});
24844 otherwise incorrect code is generated for calls to those
24845 functions.
24847 In addition, seriously incorrect code results if you call a
24848 function with too many arguments.  (Normally, extra arguments are
24849 harmlessly ignored.)
24851 @item -mregparm=@var{num}
24852 @opindex mregparm
24853 Control how many registers are used to pass integer arguments.  By
24854 default, no registers are used to pass arguments, and at most 3
24855 registers can be used.  You can control this behavior for a specific
24856 function by using the function attribute @code{regparm}.
24857 @xref{Function Attributes}.
24859 @strong{Warning:} if you use this switch, and
24860 @var{num} is nonzero, then you must build all modules with the same
24861 value, including any libraries.  This includes the system libraries and
24862 startup modules.
24864 @item -msseregparm
24865 @opindex msseregparm
24866 Use SSE register passing conventions for float and double arguments
24867 and return values.  You can control this behavior for a specific
24868 function by using the function attribute @code{sseregparm}.
24869 @xref{Function Attributes}.
24871 @strong{Warning:} if you use this switch then you must build all
24872 modules with the same value, including any libraries.  This includes
24873 the system libraries and startup modules.
24875 @item -mvect8-ret-in-mem
24876 @opindex mvect8-ret-in-mem
24877 Return 8-byte vectors in memory instead of MMX registers.  This is the
24878 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24879 Studio compilers until version 12.  Later compiler versions (starting
24880 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24881 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24882 you need to remain compatible with existing code produced by those
24883 previous compiler versions or older versions of GCC@.
24885 @item -mpc32
24886 @itemx -mpc64
24887 @itemx -mpc80
24888 @opindex mpc32
24889 @opindex mpc64
24890 @opindex mpc80
24892 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24893 is specified, the significands of results of floating-point operations are
24894 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24895 significands of results of floating-point operations to 53 bits (double
24896 precision) and @option{-mpc80} rounds the significands of results of
24897 floating-point operations to 64 bits (extended double precision), which is
24898 the default.  When this option is used, floating-point operations in higher
24899 precisions are not available to the programmer without setting the FPU
24900 control word explicitly.
24902 Setting the rounding of floating-point operations to less than the default
24903 80 bits can speed some programs by 2% or more.  Note that some mathematical
24904 libraries assume that extended-precision (80-bit) floating-point operations
24905 are enabled by default; routines in such libraries could suffer significant
24906 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24907 when this option is used to set the precision to less than extended precision.
24909 @item -mstackrealign
24910 @opindex mstackrealign
24911 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24912 option generates an alternate prologue and epilogue that realigns the
24913 run-time stack if necessary.  This supports mixing legacy codes that keep
24914 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24915 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24916 applicable to individual functions.
24918 @item -mpreferred-stack-boundary=@var{num}
24919 @opindex mpreferred-stack-boundary
24920 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24921 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24922 the default is 4 (16 bytes or 128 bits).
24924 @strong{Warning:} When generating code for the x86-64 architecture with
24925 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24926 used to keep the stack boundary aligned to 8 byte boundary.  Since
24927 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24928 intended to be used in controlled environment where stack space is
24929 important limitation.  This option leads to wrong code when functions
24930 compiled with 16 byte stack alignment (such as functions from a standard
24931 library) are called with misaligned stack.  In this case, SSE
24932 instructions may lead to misaligned memory access traps.  In addition,
24933 variable arguments are handled incorrectly for 16 byte aligned
24934 objects (including x87 long double and __int128), leading to wrong
24935 results.  You must build all modules with
24936 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24937 includes the system libraries and startup modules.
24939 @item -mincoming-stack-boundary=@var{num}
24940 @opindex mincoming-stack-boundary
24941 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24942 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24943 the one specified by @option{-mpreferred-stack-boundary} is used.
24945 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24946 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24947 suffer significant run time performance penalties.  On Pentium III, the
24948 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24949 properly if it is not 16-byte aligned.
24951 To ensure proper alignment of this values on the stack, the stack boundary
24952 must be as aligned as that required by any value stored on the stack.
24953 Further, every function must be generated such that it keeps the stack
24954 aligned.  Thus calling a function compiled with a higher preferred
24955 stack boundary from a function compiled with a lower preferred stack
24956 boundary most likely misaligns the stack.  It is recommended that
24957 libraries that use callbacks always use the default setting.
24959 This extra alignment does consume extra stack space, and generally
24960 increases code size.  Code that is sensitive to stack space usage, such
24961 as embedded systems and operating system kernels, may want to reduce the
24962 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24964 @need 200
24965 @item -mmmx
24966 @opindex mmmx
24967 @need 200
24968 @itemx -msse
24969 @opindex msse
24970 @need 200
24971 @itemx -msse2
24972 @opindex msse2
24973 @need 200
24974 @itemx -msse3
24975 @opindex msse3
24976 @need 200
24977 @itemx -mssse3
24978 @opindex mssse3
24979 @need 200
24980 @itemx -msse4
24981 @opindex msse4
24982 @need 200
24983 @itemx -msse4a
24984 @opindex msse4a
24985 @need 200
24986 @itemx -msse4.1
24987 @opindex msse4.1
24988 @need 200
24989 @itemx -msse4.2
24990 @opindex msse4.2
24991 @need 200
24992 @itemx -mavx
24993 @opindex mavx
24994 @need 200
24995 @itemx -mavx2
24996 @opindex mavx2
24997 @need 200
24998 @itemx -mavx512f
24999 @opindex mavx512f
25000 @need 200
25001 @itemx -mavx512pf
25002 @opindex mavx512pf
25003 @need 200
25004 @itemx -mavx512er
25005 @opindex mavx512er
25006 @need 200
25007 @itemx -mavx512cd
25008 @opindex mavx512cd
25009 @need 200
25010 @itemx -mavx512vl
25011 @opindex mavx512vl
25012 @need 200
25013 @itemx -mavx512bw
25014 @opindex mavx512bw
25015 @need 200
25016 @itemx -mavx512dq
25017 @opindex mavx512dq
25018 @need 200
25019 @itemx -mavx512ifma
25020 @opindex mavx512ifma
25021 @need 200
25022 @itemx -mavx512vbmi
25023 @opindex mavx512vbmi
25024 @need 200
25025 @itemx -msha
25026 @opindex msha
25027 @need 200
25028 @itemx -maes
25029 @opindex maes
25030 @need 200
25031 @itemx -mpclmul
25032 @opindex mpclmul
25033 @need 200
25034 @itemx -mclfushopt
25035 @opindex mclfushopt
25036 @need 200
25037 @itemx -mfsgsbase
25038 @opindex mfsgsbase
25039 @need 200
25040 @itemx -mrdrnd
25041 @opindex mrdrnd
25042 @need 200
25043 @itemx -mf16c
25044 @opindex mf16c
25045 @need 200
25046 @itemx -mfma
25047 @opindex mfma
25048 @need 200
25049 @itemx -mfma4
25050 @opindex mfma4
25051 @need 200
25052 @itemx -mprefetchwt1
25053 @opindex mprefetchwt1
25054 @need 200
25055 @itemx -mxop
25056 @opindex mxop
25057 @need 200
25058 @itemx -mlwp
25059 @opindex mlwp
25060 @need 200
25061 @itemx -m3dnow
25062 @opindex m3dnow
25063 @need 200
25064 @itemx -mpopcnt
25065 @opindex mpopcnt
25066 @need 200
25067 @itemx -mabm
25068 @opindex mabm
25069 @need 200
25070 @itemx -mbmi
25071 @opindex mbmi
25072 @need 200
25073 @itemx -mbmi2
25074 @need 200
25075 @itemx -mlzcnt
25076 @opindex mlzcnt
25077 @need 200
25078 @itemx -mfxsr
25079 @opindex mfxsr
25080 @need 200
25081 @itemx -mxsave
25082 @opindex mxsave
25083 @need 200
25084 @itemx -mxsaveopt
25085 @opindex mxsaveopt
25086 @need 200
25087 @itemx -mxsavec
25088 @opindex mxsavec
25089 @need 200
25090 @itemx -mxsaves
25091 @opindex mxsaves
25092 @need 200
25093 @itemx -mrtm
25094 @opindex mrtm
25095 @need 200
25096 @itemx -mtbm
25097 @opindex mtbm
25098 @need 200
25099 @itemx -mmpx
25100 @opindex mmpx
25101 @need 200
25102 @itemx -mmwaitx
25103 @opindex mmwaitx
25104 @need 200
25105 @itemx -mclzero
25106 @opindex mclzero
25107 @itemx -mpku
25108 @opindex mpku
25109 These switches enable the use of instructions in the MMX, SSE,
25110 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25111 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25112 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25113 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU or 3DNow!@:
25114 extended instruction sets.  Each has a corresponding @option{-mno-} option
25115 to disable use of these instructions.
25117 These extensions are also available as built-in functions: see
25118 @ref{x86 Built-in Functions}, for details of the functions enabled and
25119 disabled by these switches.
25121 To generate SSE/SSE2 instructions automatically from floating-point
25122 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25124 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25125 generates new AVX instructions or AVX equivalence for all SSEx instructions
25126 when needed.
25128 These options enable GCC to use these extended instructions in
25129 generated code, even without @option{-mfpmath=sse}.  Applications that
25130 perform run-time CPU detection must compile separate files for each
25131 supported architecture, using the appropriate flags.  In particular,
25132 the file containing the CPU detection code should be compiled without
25133 these options.
25135 @item -mdump-tune-features
25136 @opindex mdump-tune-features
25137 This option instructs GCC to dump the names of the x86 performance 
25138 tuning features and default settings. The names can be used in 
25139 @option{-mtune-ctrl=@var{feature-list}}.
25141 @item -mtune-ctrl=@var{feature-list}
25142 @opindex mtune-ctrl=@var{feature-list}
25143 This option is used to do fine grain control of x86 code generation features.
25144 @var{feature-list} is a comma separated list of @var{feature} names. See also
25145 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25146 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25147 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25148 developers. Using it may lead to code paths not covered by testing and can
25149 potentially result in compiler ICEs or runtime errors.
25151 @item -mno-default
25152 @opindex mno-default
25153 This option instructs GCC to turn off all tunable features. See also 
25154 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25156 @item -mcld
25157 @opindex mcld
25158 This option instructs GCC to emit a @code{cld} instruction in the prologue
25159 of functions that use string instructions.  String instructions depend on
25160 the DF flag to select between autoincrement or autodecrement mode.  While the
25161 ABI specifies the DF flag to be cleared on function entry, some operating
25162 systems violate this specification by not clearing the DF flag in their
25163 exception dispatchers.  The exception handler can be invoked with the DF flag
25164 set, which leads to wrong direction mode when string instructions are used.
25165 This option can be enabled by default on 32-bit x86 targets by configuring
25166 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25167 instructions can be suppressed with the @option{-mno-cld} compiler option
25168 in this case.
25170 @item -mvzeroupper
25171 @opindex mvzeroupper
25172 This option instructs GCC to emit a @code{vzeroupper} instruction
25173 before a transfer of control flow out of the function to minimize
25174 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25175 intrinsics.
25177 @item -mprefer-avx128
25178 @opindex mprefer-avx128
25179 This option instructs GCC to use 128-bit AVX instructions instead of
25180 256-bit AVX instructions in the auto-vectorizer.
25182 @item -mcx16
25183 @opindex mcx16
25184 This option enables GCC to generate @code{CMPXCHG16B} instructions.
25185 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
25186 (or oword) data types.  
25187 This is useful for high-resolution counters that can be updated
25188 by multiple processors (or cores).  This instruction is generated as part of
25189 atomic built-in functions: see @ref{__sync Builtins} or
25190 @ref{__atomic Builtins} for details.
25192 @item -msahf
25193 @opindex msahf
25194 This option enables generation of @code{SAHF} instructions in 64-bit code.
25195 Early Intel Pentium 4 CPUs with Intel 64 support,
25196 prior to the introduction of Pentium 4 G1 step in December 2005,
25197 lacked the @code{LAHF} and @code{SAHF} instructions
25198 which are supported by AMD64.
25199 These are load and store instructions, respectively, for certain status flags.
25200 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25201 @code{drem}, and @code{remainder} built-in functions;
25202 see @ref{Other Builtins} for details.
25204 @item -mmovbe
25205 @opindex mmovbe
25206 This option enables use of the @code{movbe} instruction to implement
25207 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25209 @item -mcrc32
25210 @opindex mcrc32
25211 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25212 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25213 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25215 @item -mrecip
25216 @opindex mrecip
25217 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25218 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25219 with an additional Newton-Raphson step
25220 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25221 (and their vectorized
25222 variants) for single-precision floating-point arguments.  These instructions
25223 are generated only when @option{-funsafe-math-optimizations} is enabled
25224 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25225 Note that while the throughput of the sequence is higher than the throughput
25226 of the non-reciprocal instruction, the precision of the sequence can be
25227 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25229 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25230 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25231 combination), and doesn't need @option{-mrecip}.
25233 Also note that GCC emits the above sequence with additional Newton-Raphson step
25234 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25235 already with @option{-ffast-math} (or the above option combination), and
25236 doesn't need @option{-mrecip}.
25238 @item -mrecip=@var{opt}
25239 @opindex mrecip=opt
25240 This option controls which reciprocal estimate instructions
25241 may be used.  @var{opt} is a comma-separated list of options, which may
25242 be preceded by a @samp{!} to invert the option:
25244 @table @samp
25245 @item all
25246 Enable all estimate instructions.
25248 @item default
25249 Enable the default instructions, equivalent to @option{-mrecip}.
25251 @item none
25252 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25254 @item div
25255 Enable the approximation for scalar division.
25257 @item vec-div
25258 Enable the approximation for vectorized division.
25260 @item sqrt
25261 Enable the approximation for scalar square root.
25263 @item vec-sqrt
25264 Enable the approximation for vectorized square root.
25265 @end table
25267 So, for example, @option{-mrecip=all,!sqrt} enables
25268 all of the reciprocal approximations, except for square root.
25270 @item -mveclibabi=@var{type}
25271 @opindex mveclibabi
25272 Specifies the ABI type to use for vectorizing intrinsics using an
25273 external library.  Supported values for @var{type} are @samp{svml} 
25274 for the Intel short
25275 vector math library and @samp{acml} for the AMD math core library.
25276 To use this option, both @option{-ftree-vectorize} and
25277 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25278 ABI-compatible library must be specified at link time.
25280 GCC currently emits calls to @code{vmldExp2},
25281 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25282 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25283 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25284 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25285 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25286 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25287 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25288 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25289 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25290 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25291 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25292 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25293 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25294 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25295 when @option{-mveclibabi=acml} is used.  
25297 @item -mabi=@var{name}
25298 @opindex mabi
25299 Generate code for the specified calling convention.  Permissible values
25300 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25301 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25302 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25303 You can control this behavior for specific functions by
25304 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25305 @xref{Function Attributes}.
25307 @item -mtls-dialect=@var{type}
25308 @opindex mtls-dialect
25309 Generate code to access thread-local storage using the @samp{gnu} or
25310 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25311 @samp{gnu2} is more efficient, but it may add compile- and run-time
25312 requirements that cannot be satisfied on all systems.
25314 @item -mpush-args
25315 @itemx -mno-push-args
25316 @opindex mpush-args
25317 @opindex mno-push-args
25318 Use PUSH operations to store outgoing parameters.  This method is shorter
25319 and usually equally fast as method using SUB/MOV operations and is enabled
25320 by default.  In some cases disabling it may improve performance because of
25321 improved scheduling and reduced dependencies.
25323 @item -maccumulate-outgoing-args
25324 @opindex maccumulate-outgoing-args
25325 If enabled, the maximum amount of space required for outgoing arguments is
25326 computed in the function prologue.  This is faster on most modern CPUs
25327 because of reduced dependencies, improved scheduling and reduced stack usage
25328 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25329 increase in code size.  This switch implies @option{-mno-push-args}.
25331 @item -mthreads
25332 @opindex mthreads
25333 Support thread-safe exception handling on MinGW.  Programs that rely
25334 on thread-safe exception handling must compile and link all code with the
25335 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25336 @option{-D_MT}; when linking, it links in a special thread helper library
25337 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25339 @item -mms-bitfields
25340 @itemx -mno-ms-bitfields
25341 @opindex mms-bitfields
25342 @opindex mno-ms-bitfields
25344 Enable/disable bit-field layout compatible with the native Microsoft
25345 Windows compiler.  
25347 If @code{packed} is used on a structure, or if bit-fields are used,
25348 it may be that the Microsoft ABI lays out the structure differently
25349 than the way GCC normally does.  Particularly when moving packed
25350 data between functions compiled with GCC and the native Microsoft compiler
25351 (either via function call or as data in a file), it may be necessary to access
25352 either format.
25354 This option is enabled by default for Microsoft Windows
25355 targets.  This behavior can also be controlled locally by use of variable
25356 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25357 and @ref{x86 Type Attributes}.
25359 The Microsoft structure layout algorithm is fairly simple with the exception
25360 of the bit-field packing.  
25361 The padding and alignment of members of structures and whether a bit-field 
25362 can straddle a storage-unit boundary are determine by these rules:
25364 @enumerate
25365 @item Structure members are stored sequentially in the order in which they are
25366 declared: the first member has the lowest memory address and the last member
25367 the highest.
25369 @item Every data object has an alignment requirement.  The alignment requirement
25370 for all data except structures, unions, and arrays is either the size of the
25371 object or the current packing size (specified with either the
25372 @code{aligned} attribute or the @code{pack} pragma),
25373 whichever is less.  For structures, unions, and arrays,
25374 the alignment requirement is the largest alignment requirement of its members.
25375 Every object is allocated an offset so that:
25377 @smallexample
25378 offset % alignment_requirement == 0
25379 @end smallexample
25381 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25382 unit if the integral types are the same size and if the next bit-field fits
25383 into the current allocation unit without crossing the boundary imposed by the
25384 common alignment requirements of the bit-fields.
25385 @end enumerate
25387 MSVC interprets zero-length bit-fields in the following ways:
25389 @enumerate
25390 @item If a zero-length bit-field is inserted between two bit-fields that
25391 are normally coalesced, the bit-fields are not coalesced.
25393 For example:
25395 @smallexample
25396 struct
25397  @{
25398    unsigned long bf_1 : 12;
25399    unsigned long : 0;
25400    unsigned long bf_2 : 12;
25401  @} t1;
25402 @end smallexample
25404 @noindent
25405 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25406 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25408 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25409 alignment of the zero-length bit-field is greater than the member that follows it,
25410 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25412 For example:
25414 @smallexample
25415 struct
25416  @{
25417    char foo : 4;
25418    short : 0;
25419    char bar;
25420  @} t2;
25422 struct
25423  @{
25424    char foo : 4;
25425    short : 0;
25426    double bar;
25427  @} t3;
25428 @end smallexample
25430 @noindent
25431 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25432 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25433 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25434 of the structure.
25436 Taking this into account, it is important to note the following:
25438 @enumerate
25439 @item If a zero-length bit-field follows a normal bit-field, the type of the
25440 zero-length bit-field may affect the alignment of the structure as whole. For
25441 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25442 normal bit-field, and is of type short.
25444 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25445 still affect the alignment of the structure:
25447 @smallexample
25448 struct
25449  @{
25450    char foo : 6;
25451    long : 0;
25452  @} t4;
25453 @end smallexample
25455 @noindent
25456 Here, @code{t4} takes up 4 bytes.
25457 @end enumerate
25459 @item Zero-length bit-fields following non-bit-field members are ignored:
25461 @smallexample
25462 struct
25463  @{
25464    char foo;
25465    long : 0;
25466    char bar;
25467  @} t5;
25468 @end smallexample
25470 @noindent
25471 Here, @code{t5} takes up 2 bytes.
25472 @end enumerate
25475 @item -mno-align-stringops
25476 @opindex mno-align-stringops
25477 Do not align the destination of inlined string operations.  This switch reduces
25478 code size and improves performance in case the destination is already aligned,
25479 but GCC doesn't know about it.
25481 @item -minline-all-stringops
25482 @opindex minline-all-stringops
25483 By default GCC inlines string operations only when the destination is 
25484 known to be aligned to least a 4-byte boundary.  
25485 This enables more inlining and increases code
25486 size, but may improve performance of code that depends on fast
25487 @code{memcpy}, @code{strlen},
25488 and @code{memset} for short lengths.
25490 @item -minline-stringops-dynamically
25491 @opindex minline-stringops-dynamically
25492 For string operations of unknown size, use run-time checks with
25493 inline code for small blocks and a library call for large blocks.
25495 @item -mstringop-strategy=@var{alg}
25496 @opindex mstringop-strategy=@var{alg}
25497 Override the internal decision heuristic for the particular algorithm to use
25498 for inlining string operations.  The allowed values for @var{alg} are:
25500 @table @samp
25501 @item rep_byte
25502 @itemx rep_4byte
25503 @itemx rep_8byte
25504 Expand using i386 @code{rep} prefix of the specified size.
25506 @item byte_loop
25507 @itemx loop
25508 @itemx unrolled_loop
25509 Expand into an inline loop.
25511 @item libcall
25512 Always use a library call.
25513 @end table
25515 @item -mmemcpy-strategy=@var{strategy}
25516 @opindex mmemcpy-strategy=@var{strategy}
25517 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25518 should be inlined and what inline algorithm to use when the expected size
25519 of the copy operation is known. @var{strategy} 
25520 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25521 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25522 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25523 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25524 in the list must be specified in increasing order.  The minimal byte size for 
25525 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25526 preceding range.
25528 @item -mmemset-strategy=@var{strategy}
25529 @opindex mmemset-strategy=@var{strategy}
25530 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25531 @code{__builtin_memset} expansion.
25533 @item -momit-leaf-frame-pointer
25534 @opindex momit-leaf-frame-pointer
25535 Don't keep the frame pointer in a register for leaf functions.  This
25536 avoids the instructions to save, set up, and restore frame pointers and
25537 makes an extra register available in leaf functions.  The option
25538 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25539 which might make debugging harder.
25541 @item -mtls-direct-seg-refs
25542 @itemx -mno-tls-direct-seg-refs
25543 @opindex mtls-direct-seg-refs
25544 Controls whether TLS variables may be accessed with offsets from the
25545 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25546 or whether the thread base pointer must be added.  Whether or not this
25547 is valid depends on the operating system, and whether it maps the
25548 segment to cover the entire TLS area.
25550 For systems that use the GNU C Library, the default is on.
25552 @item -msse2avx
25553 @itemx -mno-sse2avx
25554 @opindex msse2avx
25555 Specify that the assembler should encode SSE instructions with VEX
25556 prefix.  The option @option{-mavx} turns this on by default.
25558 @item -mfentry
25559 @itemx -mno-fentry
25560 @opindex mfentry
25561 If profiling is active (@option{-pg}), put the profiling
25562 counter call before the prologue.
25563 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25564 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25566 @item -mrecord-mcount
25567 @itemx -mno-record-mcount
25568 @opindex mrecord-mcount
25569 If profiling is active (@option{-pg}), generate a __mcount_loc section
25570 that contains pointers to each profiling call. This is useful for
25571 automatically patching and out calls.
25573 @item -mnop-mcount
25574 @itemx -mno-nop-mcount
25575 @opindex mnop-mcount
25576 If profiling is active (@option{-pg}), generate the calls to
25577 the profiling functions as NOPs. This is useful when they
25578 should be patched in later dynamically. This is likely only
25579 useful together with @option{-mrecord-mcount}.
25581 @item -mskip-rax-setup
25582 @itemx -mno-skip-rax-setup
25583 @opindex mskip-rax-setup
25584 When generating code for the x86-64 architecture with SSE extensions
25585 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25586 register when there are no variable arguments passed in vector registers.
25588 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25589 saving vector registers on stack when passing variable arguments, the
25590 impacts of this option are callees may waste some stack space,
25591 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25592 those issues, regardless the RAX register value.
25594 @item -m8bit-idiv
25595 @itemx -mno-8bit-idiv
25596 @opindex m8bit-idiv
25597 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25598 much faster than 32-bit/64-bit integer divide.  This option generates a
25599 run-time check.  If both dividend and divisor are within range of 0
25600 to 255, 8-bit unsigned integer divide is used instead of
25601 32-bit/64-bit integer divide.
25603 @item -mavx256-split-unaligned-load
25604 @itemx -mavx256-split-unaligned-store
25605 @opindex mavx256-split-unaligned-load
25606 @opindex mavx256-split-unaligned-store
25607 Split 32-byte AVX unaligned load and store.
25609 @item -mstack-protector-guard=@var{guard}
25610 @opindex mstack-protector-guard=@var{guard}
25611 Generate stack protection code using canary at @var{guard}.  Supported
25612 locations are @samp{global} for global canary or @samp{tls} for per-thread
25613 canary in the TLS block (the default).  This option has effect only when
25614 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25616 @item -mmitigate-rop
25617 @opindex mmitigate-rop
25618 Try to avoid generating code sequences that contain unintended return
25619 opcodes, to mitigate against certain forms of attack. At the moment,
25620 this option is limited in what it can do and should not be relied
25621 on to provide serious protection.
25623 @item -mgeneral-regs-only
25624 @opindex mgeneral-regs-only
25625 Generate code that uses only the general-purpose registers.  This
25626 prevents the compiler from using floating-point, vector, mask and bound
25627 registers.
25629 @end table
25631 These @samp{-m} switches are supported in addition to the above
25632 on x86-64 processors in 64-bit environments.
25634 @table @gcctabopt
25635 @item -m32
25636 @itemx -m64
25637 @itemx -mx32
25638 @itemx -m16
25639 @itemx -miamcu
25640 @opindex m32
25641 @opindex m64
25642 @opindex mx32
25643 @opindex m16
25644 @opindex miamcu
25645 Generate code for a 16-bit, 32-bit or 64-bit environment.
25646 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25647 to 32 bits, and
25648 generates code that runs on any i386 system.
25650 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25651 types to 64 bits, and generates code for the x86-64 architecture.
25652 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25653 and @option{-mdynamic-no-pic} options.
25655 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25656 to 32 bits, and
25657 generates code for the x86-64 architecture.
25659 The @option{-m16} option is the same as @option{-m32}, except for that
25660 it outputs the @code{.code16gcc} assembly directive at the beginning of
25661 the assembly output so that the binary can run in 16-bit mode.
25663 The @option{-miamcu} option generates code which conforms to Intel MCU
25664 psABI.  It requires the @option{-m32} option to be turned on.
25666 @item -mno-red-zone
25667 @opindex mno-red-zone
25668 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25669 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25670 stack pointer that is not modified by signal or interrupt handlers
25671 and therefore can be used for temporary data without adjusting the stack
25672 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25674 @item -mcmodel=small
25675 @opindex mcmodel=small
25676 Generate code for the small code model: the program and its symbols must
25677 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25678 Programs can be statically or dynamically linked.  This is the default
25679 code model.
25681 @item -mcmodel=kernel
25682 @opindex mcmodel=kernel
25683 Generate code for the kernel code model.  The kernel runs in the
25684 negative 2 GB of the address space.
25685 This model has to be used for Linux kernel code.
25687 @item -mcmodel=medium
25688 @opindex mcmodel=medium
25689 Generate code for the medium model: the program is linked in the lower 2
25690 GB of the address space.  Small symbols are also placed there.  Symbols
25691 with sizes larger than @option{-mlarge-data-threshold} are put into
25692 large data or BSS sections and can be located above 2GB.  Programs can
25693 be statically or dynamically linked.
25695 @item -mcmodel=large
25696 @opindex mcmodel=large
25697 Generate code for the large model.  This model makes no assumptions
25698 about addresses and sizes of sections.
25700 @item -maddress-mode=long
25701 @opindex maddress-mode=long
25702 Generate code for long address mode.  This is only supported for 64-bit
25703 and x32 environments.  It is the default address mode for 64-bit
25704 environments.
25706 @item -maddress-mode=short
25707 @opindex maddress-mode=short
25708 Generate code for short address mode.  This is only supported for 32-bit
25709 and x32 environments.  It is the default address mode for 32-bit and
25710 x32 environments.
25711 @end table
25713 @node x86 Windows Options
25714 @subsection x86 Windows Options
25715 @cindex x86 Windows Options
25716 @cindex Windows Options for x86
25718 These additional options are available for Microsoft Windows targets:
25720 @table @gcctabopt
25721 @item -mconsole
25722 @opindex mconsole
25723 This option
25724 specifies that a console application is to be generated, by
25725 instructing the linker to set the PE header subsystem type
25726 required for console applications.
25727 This option is available for Cygwin and MinGW targets and is
25728 enabled by default on those targets.
25730 @item -mdll
25731 @opindex mdll
25732 This option is available for Cygwin and MinGW targets.  It
25733 specifies that a DLL---a dynamic link library---is to be
25734 generated, enabling the selection of the required runtime
25735 startup object and entry point.
25737 @item -mnop-fun-dllimport
25738 @opindex mnop-fun-dllimport
25739 This option is available for Cygwin and MinGW targets.  It
25740 specifies that the @code{dllimport} attribute should be ignored.
25742 @item -mthread
25743 @opindex mthread
25744 This option is available for MinGW targets. It specifies
25745 that MinGW-specific thread support is to be used.
25747 @item -municode
25748 @opindex municode
25749 This option is available for MinGW-w64 targets.  It causes
25750 the @code{UNICODE} preprocessor macro to be predefined, and
25751 chooses Unicode-capable runtime startup code.
25753 @item -mwin32
25754 @opindex mwin32
25755 This option is available for Cygwin and MinGW targets.  It
25756 specifies that the typical Microsoft Windows predefined macros are to
25757 be set in the pre-processor, but does not influence the choice
25758 of runtime library/startup code.
25760 @item -mwindows
25761 @opindex mwindows
25762 This option is available for Cygwin and MinGW targets.  It
25763 specifies that a GUI application is to be generated by
25764 instructing the linker to set the PE header subsystem type
25765 appropriately.
25767 @item -fno-set-stack-executable
25768 @opindex fno-set-stack-executable
25769 This option is available for MinGW targets. It specifies that
25770 the executable flag for the stack used by nested functions isn't
25771 set. This is necessary for binaries running in kernel mode of
25772 Microsoft Windows, as there the User32 API, which is used to set executable
25773 privileges, isn't available.
25775 @item -fwritable-relocated-rdata
25776 @opindex fno-writable-relocated-rdata
25777 This option is available for MinGW and Cygwin targets.  It specifies
25778 that relocated-data in read-only section is put into the @code{.data}
25779 section.  This is a necessary for older runtimes not supporting
25780 modification of @code{.rdata} sections for pseudo-relocation.
25782 @item -mpe-aligned-commons
25783 @opindex mpe-aligned-commons
25784 This option is available for Cygwin and MinGW targets.  It
25785 specifies that the GNU extension to the PE file format that
25786 permits the correct alignment of COMMON variables should be
25787 used when generating code.  It is enabled by default if
25788 GCC detects that the target assembler found during configuration
25789 supports the feature.
25790 @end table
25792 See also under @ref{x86 Options} for standard options.
25794 @node Xstormy16 Options
25795 @subsection Xstormy16 Options
25796 @cindex Xstormy16 Options
25798 These options are defined for Xstormy16:
25800 @table @gcctabopt
25801 @item -msim
25802 @opindex msim
25803 Choose startup files and linker script suitable for the simulator.
25804 @end table
25806 @node Xtensa Options
25807 @subsection Xtensa Options
25808 @cindex Xtensa Options
25810 These options are supported for Xtensa targets:
25812 @table @gcctabopt
25813 @item -mconst16
25814 @itemx -mno-const16
25815 @opindex mconst16
25816 @opindex mno-const16
25817 Enable or disable use of @code{CONST16} instructions for loading
25818 constant values.  The @code{CONST16} instruction is currently not a
25819 standard option from Tensilica.  When enabled, @code{CONST16}
25820 instructions are always used in place of the standard @code{L32R}
25821 instructions.  The use of @code{CONST16} is enabled by default only if
25822 the @code{L32R} instruction is not available.
25824 @item -mfused-madd
25825 @itemx -mno-fused-madd
25826 @opindex mfused-madd
25827 @opindex mno-fused-madd
25828 Enable or disable use of fused multiply/add and multiply/subtract
25829 instructions in the floating-point option.  This has no effect if the
25830 floating-point option is not also enabled.  Disabling fused multiply/add
25831 and multiply/subtract instructions forces the compiler to use separate
25832 instructions for the multiply and add/subtract operations.  This may be
25833 desirable in some cases where strict IEEE 754-compliant results are
25834 required: the fused multiply add/subtract instructions do not round the
25835 intermediate result, thereby producing results with @emph{more} bits of
25836 precision than specified by the IEEE standard.  Disabling fused multiply
25837 add/subtract instructions also ensures that the program output is not
25838 sensitive to the compiler's ability to combine multiply and add/subtract
25839 operations.
25841 @item -mserialize-volatile
25842 @itemx -mno-serialize-volatile
25843 @opindex mserialize-volatile
25844 @opindex mno-serialize-volatile
25845 When this option is enabled, GCC inserts @code{MEMW} instructions before
25846 @code{volatile} memory references to guarantee sequential consistency.
25847 The default is @option{-mserialize-volatile}.  Use
25848 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25850 @item -mforce-no-pic
25851 @opindex mforce-no-pic
25852 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25853 position-independent code (PIC), this option disables PIC for compiling
25854 kernel code.
25856 @item -mtext-section-literals
25857 @itemx -mno-text-section-literals
25858 @opindex mtext-section-literals
25859 @opindex mno-text-section-literals
25860 These options control the treatment of literal pools.  The default is
25861 @option{-mno-text-section-literals}, which places literals in a separate
25862 section in the output file.  This allows the literal pool to be placed
25863 in a data RAM/ROM, and it also allows the linker to combine literal
25864 pools from separate object files to remove redundant literals and
25865 improve code size.  With @option{-mtext-section-literals}, the literals
25866 are interspersed in the text section in order to keep them as close as
25867 possible to their references.  This may be necessary for large assembly
25868 files.  Literals for each function are placed right before that function.
25870 @item -mauto-litpools
25871 @itemx -mno-auto-litpools
25872 @opindex mauto-litpools
25873 @opindex mno-auto-litpools
25874 These options control the treatment of literal pools.  The default is
25875 @option{-mno-auto-litpools}, which places literals in a separate
25876 section in the output file unless @option{-mtext-section-literals} is
25877 used.  With @option{-mauto-litpools} the literals are interspersed in
25878 the text section by the assembler.  Compiler does not produce explicit
25879 @code{.literal} directives and loads literals into registers with
25880 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25881 do relaxation and place literals as necessary.  This option allows
25882 assembler to create several literal pools per function and assemble
25883 very big functions, which may not be possible with
25884 @option{-mtext-section-literals}.
25886 @item -mtarget-align
25887 @itemx -mno-target-align
25888 @opindex mtarget-align
25889 @opindex mno-target-align
25890 When this option is enabled, GCC instructs the assembler to
25891 automatically align instructions to reduce branch penalties at the
25892 expense of some code density.  The assembler attempts to widen density
25893 instructions to align branch targets and the instructions following call
25894 instructions.  If there are not enough preceding safe density
25895 instructions to align a target, no widening is performed.  The
25896 default is @option{-mtarget-align}.  These options do not affect the
25897 treatment of auto-aligned instructions like @code{LOOP}, which the
25898 assembler always aligns, either by widening density instructions or
25899 by inserting NOP instructions.
25901 @item -mlongcalls
25902 @itemx -mno-longcalls
25903 @opindex mlongcalls
25904 @opindex mno-longcalls
25905 When this option is enabled, GCC instructs the assembler to translate
25906 direct calls to indirect calls unless it can determine that the target
25907 of a direct call is in the range allowed by the call instruction.  This
25908 translation typically occurs for calls to functions in other source
25909 files.  Specifically, the assembler translates a direct @code{CALL}
25910 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25911 The default is @option{-mno-longcalls}.  This option should be used in
25912 programs where the call target can potentially be out of range.  This
25913 option is implemented in the assembler, not the compiler, so the
25914 assembly code generated by GCC still shows direct call
25915 instructions---look at the disassembled object code to see the actual
25916 instructions.  Note that the assembler uses an indirect call for
25917 every cross-file call, not just those that really are out of range.
25918 @end table
25920 @node zSeries Options
25921 @subsection zSeries Options
25922 @cindex zSeries options
25924 These are listed under @xref{S/390 and zSeries Options}.
25927 @c man end
25929 @node Spec Files
25930 @section Specifying Subprocesses and the Switches to Pass to Them
25931 @cindex Spec Files
25933 @command{gcc} is a driver program.  It performs its job by invoking a
25934 sequence of other programs to do the work of compiling, assembling and
25935 linking.  GCC interprets its command-line parameters and uses these to
25936 deduce which programs it should invoke, and which command-line options
25937 it ought to place on their command lines.  This behavior is controlled
25938 by @dfn{spec strings}.  In most cases there is one spec string for each
25939 program that GCC can invoke, but a few programs have multiple spec
25940 strings to control their behavior.  The spec strings built into GCC can
25941 be overridden by using the @option{-specs=} command-line switch to specify
25942 a spec file.
25944 @dfn{Spec files} are plain-text files that are used to construct spec
25945 strings.  They consist of a sequence of directives separated by blank
25946 lines.  The type of directive is determined by the first non-whitespace
25947 character on the line, which can be one of the following:
25949 @table @code
25950 @item %@var{command}
25951 Issues a @var{command} to the spec file processor.  The commands that can
25952 appear here are:
25954 @table @code
25955 @item %include <@var{file}>
25956 @cindex @code{%include}
25957 Search for @var{file} and insert its text at the current point in the
25958 specs file.
25960 @item %include_noerr <@var{file}>
25961 @cindex @code{%include_noerr}
25962 Just like @samp{%include}, but do not generate an error message if the include
25963 file cannot be found.
25965 @item %rename @var{old_name} @var{new_name}
25966 @cindex @code{%rename}
25967 Rename the spec string @var{old_name} to @var{new_name}.
25969 @end table
25971 @item *[@var{spec_name}]:
25972 This tells the compiler to create, override or delete the named spec
25973 string.  All lines after this directive up to the next directive or
25974 blank line are considered to be the text for the spec string.  If this
25975 results in an empty string then the spec is deleted.  (Or, if the
25976 spec did not exist, then nothing happens.)  Otherwise, if the spec
25977 does not currently exist a new spec is created.  If the spec does
25978 exist then its contents are overridden by the text of this
25979 directive, unless the first character of that text is the @samp{+}
25980 character, in which case the text is appended to the spec.
25982 @item [@var{suffix}]:
25983 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25984 and up to the next directive or blank line are considered to make up the
25985 spec string for the indicated suffix.  When the compiler encounters an
25986 input file with the named suffix, it processes the spec string in
25987 order to work out how to compile that file.  For example:
25989 @smallexample
25990 .ZZ:
25991 z-compile -input %i
25992 @end smallexample
25994 This says that any input file whose name ends in @samp{.ZZ} should be
25995 passed to the program @samp{z-compile}, which should be invoked with the
25996 command-line switch @option{-input} and with the result of performing the
25997 @samp{%i} substitution.  (See below.)
25999 As an alternative to providing a spec string, the text following a
26000 suffix directive can be one of the following:
26002 @table @code
26003 @item @@@var{language}
26004 This says that the suffix is an alias for a known @var{language}.  This is
26005 similar to using the @option{-x} command-line switch to GCC to specify a
26006 language explicitly.  For example:
26008 @smallexample
26009 .ZZ:
26010 @@c++
26011 @end smallexample
26013 Says that .ZZ files are, in fact, C++ source files.
26015 @item #@var{name}
26016 This causes an error messages saying:
26018 @smallexample
26019 @var{name} compiler not installed on this system.
26020 @end smallexample
26021 @end table
26023 GCC already has an extensive list of suffixes built into it.
26024 This directive adds an entry to the end of the list of suffixes, but
26025 since the list is searched from the end backwards, it is effectively
26026 possible to override earlier entries using this technique.
26028 @end table
26030 GCC has the following spec strings built into it.  Spec files can
26031 override these strings or create their own.  Note that individual
26032 targets can also add their own spec strings to this list.
26034 @smallexample
26035 asm          Options to pass to the assembler
26036 asm_final    Options to pass to the assembler post-processor
26037 cpp          Options to pass to the C preprocessor
26038 cc1          Options to pass to the C compiler
26039 cc1plus      Options to pass to the C++ compiler
26040 endfile      Object files to include at the end of the link
26041 link         Options to pass to the linker
26042 lib          Libraries to include on the command line to the linker
26043 libgcc       Decides which GCC support library to pass to the linker
26044 linker       Sets the name of the linker
26045 predefines   Defines to be passed to the C preprocessor
26046 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26047              by default
26048 startfile    Object files to include at the start of the link
26049 @end smallexample
26051 Here is a small example of a spec file:
26053 @smallexample
26054 %rename lib                 old_lib
26056 *lib:
26057 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26058 @end smallexample
26060 This example renames the spec called @samp{lib} to @samp{old_lib} and
26061 then overrides the previous definition of @samp{lib} with a new one.
26062 The new definition adds in some extra command-line options before
26063 including the text of the old definition.
26065 @dfn{Spec strings} are a list of command-line options to be passed to their
26066 corresponding program.  In addition, the spec strings can contain
26067 @samp{%}-prefixed sequences to substitute variable text or to
26068 conditionally insert text into the command line.  Using these constructs
26069 it is possible to generate quite complex command lines.
26071 Here is a table of all defined @samp{%}-sequences for spec
26072 strings.  Note that spaces are not generated automatically around the
26073 results of expanding these sequences.  Therefore you can concatenate them
26074 together or combine them with constant text in a single argument.
26076 @table @code
26077 @item %%
26078 Substitute one @samp{%} into the program name or argument.
26080 @item %i
26081 Substitute the name of the input file being processed.
26083 @item %b
26084 Substitute the basename of the input file being processed.
26085 This is the substring up to (and not including) the last period
26086 and not including the directory.
26088 @item %B
26089 This is the same as @samp{%b}, but include the file suffix (text after
26090 the last period).
26092 @item %d
26093 Marks the argument containing or following the @samp{%d} as a
26094 temporary file name, so that that file is deleted if GCC exits
26095 successfully.  Unlike @samp{%g}, this contributes no text to the
26096 argument.
26098 @item %g@var{suffix}
26099 Substitute a file name that has suffix @var{suffix} and is chosen
26100 once per compilation, and mark the argument in the same way as
26101 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26102 name is now chosen in a way that is hard to predict even when previously
26103 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26104 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26105 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26106 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26107 was simply substituted with a file name chosen once per compilation,
26108 without regard to any appended suffix (which was therefore treated
26109 just like ordinary text), making such attacks more likely to succeed.
26111 @item %u@var{suffix}
26112 Like @samp{%g}, but generates a new temporary file name
26113 each time it appears instead of once per compilation.
26115 @item %U@var{suffix}
26116 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26117 new one if there is no such last file name.  In the absence of any
26118 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26119 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26120 involves the generation of two distinct file names, one
26121 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26122 simply substituted with a file name chosen for the previous @samp{%u},
26123 without regard to any appended suffix.
26125 @item %j@var{suffix}
26126 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26127 writable, and if @option{-save-temps} is not used; 
26128 otherwise, substitute the name
26129 of a temporary file, just like @samp{%u}.  This temporary file is not
26130 meant for communication between processes, but rather as a junk
26131 disposal mechanism.
26133 @item %|@var{suffix}
26134 @itemx %m@var{suffix}
26135 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26136 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26137 all.  These are the two most common ways to instruct a program that it
26138 should read from standard input or write to standard output.  If you
26139 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26140 construct: see for example @file{f/lang-specs.h}.
26142 @item %.@var{SUFFIX}
26143 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26144 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26145 terminated by the next space or %.
26147 @item %w
26148 Marks the argument containing or following the @samp{%w} as the
26149 designated output file of this compilation.  This puts the argument
26150 into the sequence of arguments that @samp{%o} substitutes.
26152 @item %o
26153 Substitutes the names of all the output files, with spaces
26154 automatically placed around them.  You should write spaces
26155 around the @samp{%o} as well or the results are undefined.
26156 @samp{%o} is for use in the specs for running the linker.
26157 Input files whose names have no recognized suffix are not compiled
26158 at all, but they are included among the output files, so they are
26159 linked.
26161 @item %O
26162 Substitutes the suffix for object files.  Note that this is
26163 handled specially when it immediately follows @samp{%g, %u, or %U},
26164 because of the need for those to form complete file names.  The
26165 handling is such that @samp{%O} is treated exactly as if it had already
26166 been substituted, except that @samp{%g, %u, and %U} do not currently
26167 support additional @var{suffix} characters following @samp{%O} as they do
26168 following, for example, @samp{.o}.
26170 @item %p
26171 Substitutes the standard macro predefinitions for the
26172 current target machine.  Use this when running @command{cpp}.
26174 @item %P
26175 Like @samp{%p}, but puts @samp{__} before and after the name of each
26176 predefined macro, except for macros that start with @samp{__} or with
26177 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26180 @item %I
26181 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26182 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26183 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26184 and @option{-imultilib} as necessary.
26186 @item %s
26187 Current argument is the name of a library or startup file of some sort.
26188 Search for that file in a standard list of directories and substitute
26189 the full name found.  The current working directory is included in the
26190 list of directories scanned.
26192 @item %T
26193 Current argument is the name of a linker script.  Search for that file
26194 in the current list of directories to scan for libraries. If the file
26195 is located insert a @option{--script} option into the command line
26196 followed by the full path name found.  If the file is not found then
26197 generate an error message.  Note: the current working directory is not
26198 searched.
26200 @item %e@var{str}
26201 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26202 Use this when inconsistent options are detected.
26204 @item %(@var{name})
26205 Substitute the contents of spec string @var{name} at this point.
26207 @item %x@{@var{option}@}
26208 Accumulate an option for @samp{%X}.
26210 @item %X
26211 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26212 spec string.
26214 @item %Y
26215 Output the accumulated assembler options specified by @option{-Wa}.
26217 @item %Z
26218 Output the accumulated preprocessor options specified by @option{-Wp}.
26220 @item %a
26221 Process the @code{asm} spec.  This is used to compute the
26222 switches to be passed to the assembler.
26224 @item %A
26225 Process the @code{asm_final} spec.  This is a spec string for
26226 passing switches to an assembler post-processor, if such a program is
26227 needed.
26229 @item %l
26230 Process the @code{link} spec.  This is the spec for computing the
26231 command line passed to the linker.  Typically it makes use of the
26232 @samp{%L %G %S %D and %E} sequences.
26234 @item %D
26235 Dump out a @option{-L} option for each directory that GCC believes might
26236 contain startup files.  If the target supports multilibs then the
26237 current multilib directory is prepended to each of these paths.
26239 @item %L
26240 Process the @code{lib} spec.  This is a spec string for deciding which
26241 libraries are included on the command line to the linker.
26243 @item %G
26244 Process the @code{libgcc} spec.  This is a spec string for deciding
26245 which GCC support library is included on the command line to the linker.
26247 @item %S
26248 Process the @code{startfile} spec.  This is a spec for deciding which
26249 object files are the first ones passed to the linker.  Typically
26250 this might be a file named @file{crt0.o}.
26252 @item %E
26253 Process the @code{endfile} spec.  This is a spec string that specifies
26254 the last object files that are passed to the linker.
26256 @item %C
26257 Process the @code{cpp} spec.  This is used to construct the arguments
26258 to be passed to the C preprocessor.
26260 @item %1
26261 Process the @code{cc1} spec.  This is used to construct the options to be
26262 passed to the actual C compiler (@command{cc1}).
26264 @item %2
26265 Process the @code{cc1plus} spec.  This is used to construct the options to be
26266 passed to the actual C++ compiler (@command{cc1plus}).
26268 @item %*
26269 Substitute the variable part of a matched option.  See below.
26270 Note that each comma in the substituted string is replaced by
26271 a single space.
26273 @item %<@code{S}
26274 Remove all occurrences of @code{-S} from the command line.  Note---this
26275 command is position dependent.  @samp{%} commands in the spec string
26276 before this one see @code{-S}, @samp{%} commands in the spec string
26277 after this one do not.
26279 @item %:@var{function}(@var{args})
26280 Call the named function @var{function}, passing it @var{args}.
26281 @var{args} is first processed as a nested spec string, then split
26282 into an argument vector in the usual fashion.  The function returns
26283 a string which is processed as if it had appeared literally as part
26284 of the current spec.
26286 The following built-in spec functions are provided:
26288 @table @code
26289 @item @code{getenv}
26290 The @code{getenv} spec function takes two arguments: an environment
26291 variable name and a string.  If the environment variable is not
26292 defined, a fatal error is issued.  Otherwise, the return value is the
26293 value of the environment variable concatenated with the string.  For
26294 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26296 @smallexample
26297 %:getenv(TOPDIR /include)
26298 @end smallexample
26300 expands to @file{/path/to/top/include}.
26302 @item @code{if-exists}
26303 The @code{if-exists} spec function takes one argument, an absolute
26304 pathname to a file.  If the file exists, @code{if-exists} returns the
26305 pathname.  Here is a small example of its usage:
26307 @smallexample
26308 *startfile:
26309 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26310 @end smallexample
26312 @item @code{if-exists-else}
26313 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26314 spec function, except that it takes two arguments.  The first argument is
26315 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26316 returns the pathname.  If it does not exist, it returns the second argument.
26317 This way, @code{if-exists-else} can be used to select one file or another,
26318 based on the existence of the first.  Here is a small example of its usage:
26320 @smallexample
26321 *startfile:
26322 crt0%O%s %:if-exists(crti%O%s) \
26323 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26324 @end smallexample
26326 @item @code{replace-outfile}
26327 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26328 first argument in the outfiles array and replaces it with the second argument.  Here
26329 is a small example of its usage:
26331 @smallexample
26332 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26333 @end smallexample
26335 @item @code{remove-outfile}
26336 The @code{remove-outfile} spec function takes one argument.  It looks for the
26337 first argument in the outfiles array and removes it.  Here is a small example
26338 its usage:
26340 @smallexample
26341 %:remove-outfile(-lm)
26342 @end smallexample
26344 @item @code{pass-through-libs}
26345 The @code{pass-through-libs} spec function takes any number of arguments.  It
26346 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26347 assumes are the names of linker input library archive files) and returns a
26348 result containing all the found arguments each prepended by
26349 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26350 intended to be passed to the LTO linker plugin.
26352 @smallexample
26353 %:pass-through-libs(%G %L %G)
26354 @end smallexample
26356 @item @code{print-asm-header}
26357 The @code{print-asm-header} function takes no arguments and simply
26358 prints a banner like:
26360 @smallexample
26361 Assembler options
26362 =================
26364 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26365 @end smallexample
26367 It is used to separate compiler options from assembler options
26368 in the @option{--target-help} output.
26369 @end table
26371 @item %@{@code{S}@}
26372 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26373 If that switch is not specified, this substitutes nothing.  Note that
26374 the leading dash is omitted when specifying this option, and it is
26375 automatically inserted if the substitution is performed.  Thus the spec
26376 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26377 and outputs the command-line option @option{-foo}.
26379 @item %W@{@code{S}@}
26380 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26381 deleted on failure.
26383 @item %@{@code{S}*@}
26384 Substitutes all the switches specified to GCC whose names start
26385 with @code{-S}, but which also take an argument.  This is used for
26386 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26387 GCC considers @option{-o foo} as being
26388 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26389 text, including the space.  Thus two arguments are generated.
26391 @item %@{@code{S}*&@code{T}*@}
26392 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26393 (the order of @code{S} and @code{T} in the spec is not significant).
26394 There can be any number of ampersand-separated variables; for each the
26395 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26397 @item %@{@code{S}:@code{X}@}
26398 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26400 @item %@{!@code{S}:@code{X}@}
26401 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26403 @item %@{@code{S}*:@code{X}@}
26404 Substitutes @code{X} if one or more switches whose names start with
26405 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26406 once, no matter how many such switches appeared.  However, if @code{%*}
26407 appears somewhere in @code{X}, then @code{X} is substituted once
26408 for each matching switch, with the @code{%*} replaced by the part of
26409 that switch matching the @code{*}.
26411 If @code{%*} appears as the last part of a spec sequence then a space
26412 is added after the end of the last substitution.  If there is more
26413 text in the sequence, however, then a space is not generated.  This
26414 allows the @code{%*} substitution to be used as part of a larger
26415 string.  For example, a spec string like this:
26417 @smallexample
26418 %@{mcu=*:--script=%*/memory.ld@}
26419 @end smallexample
26421 @noindent
26422 when matching an option like @option{-mcu=newchip} produces:
26424 @smallexample
26425 --script=newchip/memory.ld
26426 @end smallexample
26428 @item %@{.@code{S}:@code{X}@}
26429 Substitutes @code{X}, if processing a file with suffix @code{S}.
26431 @item %@{!.@code{S}:@code{X}@}
26432 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26434 @item %@{,@code{S}:@code{X}@}
26435 Substitutes @code{X}, if processing a file for language @code{S}.
26437 @item %@{!,@code{S}:@code{X}@}
26438 Substitutes @code{X}, if not processing a file for language @code{S}.
26440 @item %@{@code{S}|@code{P}:@code{X}@}
26441 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26442 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26443 @code{*} sequences as well, although they have a stronger binding than
26444 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26445 alternatives must be starred, and only the first matching alternative
26446 is substituted.
26448 For example, a spec string like this:
26450 @smallexample
26451 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26452 @end smallexample
26454 @noindent
26455 outputs the following command-line options from the following input
26456 command-line options:
26458 @smallexample
26459 fred.c        -foo -baz
26460 jim.d         -bar -boggle
26461 -d fred.c     -foo -baz -boggle
26462 -d jim.d      -bar -baz -boggle
26463 @end smallexample
26465 @item %@{S:X; T:Y; :D@}
26467 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26468 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26469 be as many clauses as you need.  This may be combined with @code{.},
26470 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26473 @end table
26475 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26476 construct may contain other nested @samp{%} constructs or spaces, or
26477 even newlines.  They are processed as usual, as described above.
26478 Trailing white space in @code{X} is ignored.  White space may also
26479 appear anywhere on the left side of the colon in these constructs,
26480 except between @code{.} or @code{*} and the corresponding word.
26482 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26483 handled specifically in these constructs.  If another value of
26484 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26485 @option{-W} switch is found later in the command line, the earlier
26486 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26487 just one letter, which passes all matching options.
26489 The character @samp{|} at the beginning of the predicate text is used to
26490 indicate that a command should be piped to the following command, but
26491 only if @option{-pipe} is specified.
26493 It is built into GCC which switches take arguments and which do not.
26494 (You might think it would be useful to generalize this to allow each
26495 compiler's spec to say which switches take arguments.  But this cannot
26496 be done in a consistent fashion.  GCC cannot even decide which input
26497 files have been specified without knowing which switches take arguments,
26498 and it must know which input files to compile in order to tell which
26499 compilers to run).
26501 GCC also knows implicitly that arguments starting in @option{-l} are to be
26502 treated as compiler output files, and passed to the linker in their
26503 proper position among the other output files.
26505 @node Environment Variables
26506 @section Environment Variables Affecting GCC
26507 @cindex environment variables
26509 @c man begin ENVIRONMENT
26510 This section describes several environment variables that affect how GCC
26511 operates.  Some of them work by specifying directories or prefixes to use
26512 when searching for various kinds of files.  Some are used to specify other
26513 aspects of the compilation environment.
26515 Note that you can also specify places to search using options such as
26516 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26517 take precedence over places specified using environment variables, which
26518 in turn take precedence over those specified by the configuration of GCC@.
26519 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26520 GNU Compiler Collection (GCC) Internals}.
26522 @table @env
26523 @item LANG
26524 @itemx LC_CTYPE
26525 @c @itemx LC_COLLATE
26526 @itemx LC_MESSAGES
26527 @c @itemx LC_MONETARY
26528 @c @itemx LC_NUMERIC
26529 @c @itemx LC_TIME
26530 @itemx LC_ALL
26531 @findex LANG
26532 @findex LC_CTYPE
26533 @c @findex LC_COLLATE
26534 @findex LC_MESSAGES
26535 @c @findex LC_MONETARY
26536 @c @findex LC_NUMERIC
26537 @c @findex LC_TIME
26538 @findex LC_ALL
26539 @cindex locale
26540 These environment variables control the way that GCC uses
26541 localization information which allows GCC to work with different
26542 national conventions.  GCC inspects the locale categories
26543 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26544 so.  These locale categories can be set to any value supported by your
26545 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26546 Kingdom encoded in UTF-8.
26548 The @env{LC_CTYPE} environment variable specifies character
26549 classification.  GCC uses it to determine the character boundaries in
26550 a string; this is needed for some multibyte encodings that contain quote
26551 and escape characters that are otherwise interpreted as a string
26552 end or escape.
26554 The @env{LC_MESSAGES} environment variable specifies the language to
26555 use in diagnostic messages.
26557 If the @env{LC_ALL} environment variable is set, it overrides the value
26558 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26559 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26560 environment variable.  If none of these variables are set, GCC
26561 defaults to traditional C English behavior.
26563 @item TMPDIR
26564 @findex TMPDIR
26565 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26566 files.  GCC uses temporary files to hold the output of one stage of
26567 compilation which is to be used as input to the next stage: for example,
26568 the output of the preprocessor, which is the input to the compiler
26569 proper.
26571 @item GCC_COMPARE_DEBUG
26572 @findex GCC_COMPARE_DEBUG
26573 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26574 @option{-fcompare-debug} to the compiler driver.  See the documentation
26575 of this option for more details.
26577 @item GCC_EXEC_PREFIX
26578 @findex GCC_EXEC_PREFIX
26579 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26580 names of the subprograms executed by the compiler.  No slash is added
26581 when this prefix is combined with the name of a subprogram, but you can
26582 specify a prefix that ends with a slash if you wish.
26584 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26585 an appropriate prefix to use based on the pathname it is invoked with.
26587 If GCC cannot find the subprogram using the specified prefix, it
26588 tries looking in the usual places for the subprogram.
26590 The default value of @env{GCC_EXEC_PREFIX} is
26591 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26592 the installed compiler. In many cases @var{prefix} is the value
26593 of @code{prefix} when you ran the @file{configure} script.
26595 Other prefixes specified with @option{-B} take precedence over this prefix.
26597 This prefix is also used for finding files such as @file{crt0.o} that are
26598 used for linking.
26600 In addition, the prefix is used in an unusual way in finding the
26601 directories to search for header files.  For each of the standard
26602 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26603 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26604 replacing that beginning with the specified prefix to produce an
26605 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26606 @file{foo/bar} just before it searches the standard directory 
26607 @file{/usr/local/lib/bar}.
26608 If a standard directory begins with the configured
26609 @var{prefix} then the value of @var{prefix} is replaced by
26610 @env{GCC_EXEC_PREFIX} when looking for header files.
26612 @item COMPILER_PATH
26613 @findex COMPILER_PATH
26614 The value of @env{COMPILER_PATH} is a colon-separated list of
26615 directories, much like @env{PATH}.  GCC tries the directories thus
26616 specified when searching for subprograms, if it can't find the
26617 subprograms using @env{GCC_EXEC_PREFIX}.
26619 @item LIBRARY_PATH
26620 @findex LIBRARY_PATH
26621 The value of @env{LIBRARY_PATH} is a colon-separated list of
26622 directories, much like @env{PATH}.  When configured as a native compiler,
26623 GCC tries the directories thus specified when searching for special
26624 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
26625 using GCC also uses these directories when searching for ordinary
26626 libraries for the @option{-l} option (but directories specified with
26627 @option{-L} come first).
26629 @item LANG
26630 @findex LANG
26631 @cindex locale definition
26632 This variable is used to pass locale information to the compiler.  One way in
26633 which this information is used is to determine the character set to be used
26634 when character literals, string literals and comments are parsed in C and C++.
26635 When the compiler is configured to allow multibyte characters,
26636 the following values for @env{LANG} are recognized:
26638 @table @samp
26639 @item C-JIS
26640 Recognize JIS characters.
26641 @item C-SJIS
26642 Recognize SJIS characters.
26643 @item C-EUCJP
26644 Recognize EUCJP characters.
26645 @end table
26647 If @env{LANG} is not defined, or if it has some other value, then the
26648 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26649 recognize and translate multibyte characters.
26650 @end table
26652 @noindent
26653 Some additional environment variables affect the behavior of the
26654 preprocessor.
26656 @include cppenv.texi
26658 @c man end
26660 @node Precompiled Headers
26661 @section Using Precompiled Headers
26662 @cindex precompiled headers
26663 @cindex speed of compilation
26665 Often large projects have many header files that are included in every
26666 source file.  The time the compiler takes to process these header files
26667 over and over again can account for nearly all of the time required to
26668 build the project.  To make builds faster, GCC allows you to
26669 @dfn{precompile} a header file.
26671 To create a precompiled header file, simply compile it as you would any
26672 other file, if necessary using the @option{-x} option to make the driver
26673 treat it as a C or C++ header file.  You may want to use a
26674 tool like @command{make} to keep the precompiled header up-to-date when
26675 the headers it contains change.
26677 A precompiled header file is searched for when @code{#include} is
26678 seen in the compilation.  As it searches for the included file
26679 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26680 compiler looks for a precompiled header in each directory just before it
26681 looks for the include file in that directory.  The name searched for is
26682 the name specified in the @code{#include} with @samp{.gch} appended.  If
26683 the precompiled header file can't be used, it is ignored.
26685 For instance, if you have @code{#include "all.h"}, and you have
26686 @file{all.h.gch} in the same directory as @file{all.h}, then the
26687 precompiled header file is used if possible, and the original
26688 header is used otherwise.
26690 Alternatively, you might decide to put the precompiled header file in a
26691 directory and use @option{-I} to ensure that directory is searched
26692 before (or instead of) the directory containing the original header.
26693 Then, if you want to check that the precompiled header file is always
26694 used, you can put a file of the same name as the original header in this
26695 directory containing an @code{#error} command.
26697 This also works with @option{-include}.  So yet another way to use
26698 precompiled headers, good for projects not designed with precompiled
26699 header files in mind, is to simply take most of the header files used by
26700 a project, include them from another header file, precompile that header
26701 file, and @option{-include} the precompiled header.  If the header files
26702 have guards against multiple inclusion, they are skipped because
26703 they've already been included (in the precompiled header).
26705 If you need to precompile the same header file for different
26706 languages, targets, or compiler options, you can instead make a
26707 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26708 header in the directory, perhaps using @option{-o}.  It doesn't matter
26709 what you call the files in the directory; every precompiled header in
26710 the directory is considered.  The first precompiled header
26711 encountered in the directory that is valid for this compilation is
26712 used; they're searched in no particular order.
26714 There are many other possibilities, limited only by your imagination,
26715 good sense, and the constraints of your build system.
26717 A precompiled header file can be used only when these conditions apply:
26719 @itemize
26720 @item
26721 Only one precompiled header can be used in a particular compilation.
26723 @item
26724 A precompiled header can't be used once the first C token is seen.  You
26725 can have preprocessor directives before a precompiled header; you cannot
26726 include a precompiled header from inside another header.
26728 @item
26729 The precompiled header file must be produced for the same language as
26730 the current compilation.  You can't use a C precompiled header for a C++
26731 compilation.
26733 @item
26734 The precompiled header file must have been produced by the same compiler
26735 binary as the current compilation is using.
26737 @item
26738 Any macros defined before the precompiled header is included must
26739 either be defined in the same way as when the precompiled header was
26740 generated, or must not affect the precompiled header, which usually
26741 means that they don't appear in the precompiled header at all.
26743 The @option{-D} option is one way to define a macro before a
26744 precompiled header is included; using a @code{#define} can also do it.
26745 There are also some options that define macros implicitly, like
26746 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26747 defined this way.
26749 @item If debugging information is output when using the precompiled
26750 header, using @option{-g} or similar, the same kind of debugging information
26751 must have been output when building the precompiled header.  However,
26752 a precompiled header built using @option{-g} can be used in a compilation
26753 when no debugging information is being output.
26755 @item The same @option{-m} options must generally be used when building
26756 and using the precompiled header.  @xref{Submodel Options},
26757 for any cases where this rule is relaxed.
26759 @item Each of the following options must be the same when building and using
26760 the precompiled header:
26762 @gccoptlist{-fexceptions}
26764 @item
26765 Some other command-line options starting with @option{-f},
26766 @option{-p}, or @option{-O} must be defined in the same way as when
26767 the precompiled header was generated.  At present, it's not clear
26768 which options are safe to change and which are not; the safest choice
26769 is to use exactly the same options when generating and using the
26770 precompiled header.  The following are known to be safe:
26772 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26773 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26774 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26775 -pedantic-errors}
26777 @end itemize
26779 For all of these except the last, the compiler automatically
26780 ignores the precompiled header if the conditions aren't met.  If you
26781 find an option combination that doesn't work and doesn't cause the
26782 precompiled header to be ignored, please consider filing a bug report,
26783 see @ref{Bugs}.
26785 If you do use differing options when generating and using the
26786 precompiled header, the actual behavior is a mixture of the
26787 behavior for the options.  For instance, if you use @option{-g} to
26788 generate the precompiled header but not when using it, you may or may
26789 not get debugging information for routines in the precompiled header.