Fix 2 typos in documentation (PR other/80589).
[official-gcc.git] / gcc / doc / invoke.texi
blob1f780640e0c893955e4ce1166e259e3fd71d76a3
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
219 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
220 -Wno-non-template-friend  -Wold-style-cast @gol
221 -Woverloaded-virtual  -Wno-pmf-conversions @gol
222 -Wsign-promo  -Wvirtual-inheritance}
224 @item Objective-C and Objective-C++ Language Options
225 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
226 Objective-C and Objective-C++ Dialects}.
227 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
228 -fgnu-runtime  -fnext-runtime @gol
229 -fno-nil-receivers @gol
230 -fobjc-abi-version=@var{n} @gol
231 -fobjc-call-cxx-cdtors @gol
232 -fobjc-direct-dispatch @gol
233 -fobjc-exceptions @gol
234 -fobjc-gc @gol
235 -fobjc-nilcheck @gol
236 -fobjc-std=objc1 @gol
237 -fno-local-ivars @gol
238 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
239 -freplace-objc-classes @gol
240 -fzero-link @gol
241 -gen-decls @gol
242 -Wassign-intercept @gol
243 -Wno-protocol  -Wselector @gol
244 -Wstrict-selector-match @gol
245 -Wundeclared-selector}
247 @item Diagnostic Message Formatting Options
248 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
249 @gccoptlist{-fmessage-length=@var{n}  @gol
250 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
251 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
252 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
253 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
254 -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 -Wchkp  -Wclobbered  -Wcomment  @gol
269 -Wconditionally-supported  @gol
270 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
271 -Wdelete-incomplete @gol
272 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
273 -Wdisabled-optimization @gol
274 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
275 -Wno-div-by-zero  -Wdouble-promotion  -Wduplicated-cond @gol
276 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
277 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
278 -Wfloat-equal  -Wformat  -Wformat=2 @gol
279 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
280 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
281 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
282 -Wformat-y2k  -Wframe-address @gol
283 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
284 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
285 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
286 -Wimplicit-function-declaration  -Wimplicit-int @gol
287 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
288 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
289 -Winvalid-pch  -Wlarger-than=@var{len} @gol
290 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
291 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
292 -Wmisleading-indentation  -Wmissing-braces @gol
293 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
294 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
295 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
296 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
297 -Woverride-init-side-effects  -Woverlength-strings @gol
298 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
299 -Wparentheses  -Wno-pedantic-ms-format @gol
300 -Wplacement-new  -Wplacement-new=@var{n} @gol
301 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
302 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
303 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
304 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
305 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
306 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
307 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
308 -Wno-scalar-storage-order @gol
309 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
310 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
311 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
312 -Wstringop-overflow=@var{n} @gol
313 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
314 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
315 -Wmissing-format-attribute  -Wsubobject-linkage @gol
316 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
317 -Wswitch-unreachable  -Wsync-nand @gol
318 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
319 -Wtype-limits  -Wundef @gol
320 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
321 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
322 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
323 -Wunused-parameter  -Wno-unused-result @gol
324 -Wunused-value  -Wunused-variable @gol
325 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
326 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
327 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
328 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
329 -Wzero-as-null-pointer-constant  -Whsa}
331 @item C and Objective-C-only Warning Options
332 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
333 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
334 -Wold-style-declaration  -Wold-style-definition @gol
335 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
336 -Wdeclaration-after-statement  -Wpointer-sign}
338 @item Debugging Options
339 @xref{Debugging Options,,Options for Debugging Your Program}.
340 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
341 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
342 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
343 -gcolumn-info  -gno-column-info @gol
344 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
345 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
346 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
347 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
348 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
349 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
350 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
351 -fvar-tracking  -fvar-tracking-assignments}
353 @item Optimization Options
354 @xref{Optimize Options,,Options that Control Optimization}.
355 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
356 -falign-jumps[=@var{n}] @gol
357 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
358 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
359 -fauto-inc-dec  -fbranch-probabilities @gol
360 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
361 -fbtr-bb-exclusive  -fcaller-saves @gol
362 -fcombine-stack-adjustments  -fconserve-stack @gol
363 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
364 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
365 -fcx-limited-range @gol
366 -fdata-sections  -fdce  -fdelayed-branch @gol
367 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
368 -fdevirtualize-at-ltrans  -fdse @gol
369 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
370 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
371 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
372 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
373 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
374 -fif-conversion2  -findirect-inlining @gol
375 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
376 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
377 -fipa-bit-cp -fipa-vrp @gol
378 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
379 -fira-algorithm=@var{algorithm} @gol
380 -fira-region=@var{region}  -fira-hoist-pressure @gol
381 -fira-loop-pressure  -fno-ira-share-save-slots @gol
382 -fno-ira-share-spill-slots @gol
383 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
384 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
385 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
386 -floop-block  -floop-interchange  -floop-strip-mine @gol
387 -floop-unroll-and-jam  -floop-nest-optimize @gol
388 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
389 -flto-partition=@var{alg}  -fmerge-all-constants @gol
390 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
391 -fmove-loop-invariants  -fno-branch-count-reg @gol
392 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
393 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
394 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
395 -fno-sched-spec  -fno-signed-zeros @gol
396 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
397 -fomit-frame-pointer  -foptimize-sibling-calls @gol
398 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
399 -fprefetch-loop-arrays @gol
400 -fprofile-correction @gol
401 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
402 -fprofile-reorder-functions @gol
403 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
404 -freorder-blocks-algorithm=@var{algorithm} @gol
405 -freorder-blocks-and-partition  -freorder-functions @gol
406 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
407 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
408 -fsched-spec-load  -fsched-spec-load-dangerous @gol
409 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
410 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
411 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
412 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
413 -fschedule-fusion @gol
414 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
415 -fselective-scheduling  -fselective-scheduling2 @gol
416 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
417 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
418 -fsignaling-nans @gol
419 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
420 -fsplit-paths @gol
421 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
422 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
423 -fstrict-overflow  -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
424 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
425 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
426 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
427 -ftree-loop-if-convert  -ftree-loop-im @gol
428 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
429 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
430 -ftree-loop-vectorize @gol
431 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
432 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
433 -ftree-switch-conversion  -ftree-tail-merge @gol
434 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
435 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
436 -funsafe-math-optimizations  -funswitch-loops @gol
437 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
438 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
439 --param @var{name}=@var{value}
440 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
442 @item Program Instrumentation Options
443 @xref{Instrumentation Options,,Program Instrumentation Options}.
444 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
445 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
446 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
447 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
448 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
449 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
450 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
451 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
452 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
453 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
454 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
455 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
456 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
457 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
458 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
459 -fstack-protector-explicit  -fstack-check @gol
460 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
461 -fno-stack-limit  -fsplit-stack @gol
462 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
463 -fvtv-counts  -fvtv-debug @gol
464 -finstrument-functions @gol
465 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
466 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
468 @item Preprocessor Options
469 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
470 @gccoptlist{-A@var{question}=@var{answer} @gol
471 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
472 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
473 -dD  -dI  -dM  -dN  -dU @gol
474 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
475 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
476 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
477 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
478 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
479 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
480 -H  -imacros @var{file}  -include @var{file} @gol
481 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
482 -no-integrated-cpp  -P  -pthread  -remap @gol
483 -traditional  -traditional-cpp  -trigraphs @gol
484 -U@var{macro}  -undef  @gol
485 -Wp,@var{option}  -Xpreprocessor @var{option}}
487 @item Assembler Options
488 @xref{Assembler Options,,Passing Options to the Assembler}.
489 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
491 @item Linker Options
492 @xref{Link Options,,Options for Linking}.
493 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
494 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
495 -s  -static  -static-libgcc  -static-libstdc++ @gol
496 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
497 -static-libmpx  -static-libmpxwrappers @gol
498 -shared  -shared-libgcc  -symbolic @gol
499 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
500 -u @var{symbol}  -z @var{keyword}}
502 @item Directory Options
503 @xref{Directory Options,,Options for Directory Search}.
504 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
505 -idirafter @var{dir} @gol
506 -imacros @var{file}  -imultilib @var{dir} @gol
507 -iplugindir=@var{dir}  -iprefix @var{file} @gol
508 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
509 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
510 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
511 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
513 @item Code Generation Options
514 @xref{Code Gen Options,,Options for Code Generation Conventions}.
515 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
516 -ffixed-@var{reg}  -fexceptions @gol
517 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
518 -fasynchronous-unwind-tables @gol
519 -fno-gnu-unique @gol
520 -finhibit-size-directive  -fno-common  -fno-ident @gol
521 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
522 -fno-jump-tables @gol
523 -frecord-gcc-switches @gol
524 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
525 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
526 -fleading-underscore  -ftls-model=@var{model} @gol
527 -fstack-reuse=@var{reuse_level} @gol
528 -ftrampolines  -ftrapv  -fwrapv @gol
529 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
530 -fstrict-volatile-bitfields  -fsync-libcalls}
532 @item Developer Options
533 @xref{Developer Options,,GCC Developer Options}.
534 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
535 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
536 -fdbg-cnt=@var{counter-value-list} @gol
537 -fdisable-ipa-@var{pass_name} @gol
538 -fdisable-rtl-@var{pass_name} @gol
539 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
540 -fdisable-tree-@var{pass_name} @gol
541 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
542 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
543 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
544 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
545 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
546 -fdump-passes @gol
547 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
548 -fdump-statistics @gol
549 -fdump-final-insns@r{[}=@var{file}@r{]}
550 -fdump-tree-all @gol
551 -fdump-tree-@var{switch} @gol
552 -fdump-tree-@var{switch}-@var{options} @gol
553 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
554 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
555 -fenable-@var{kind}-@var{pass} @gol
556 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
557 -fira-verbose=@var{n} @gol
558 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
559 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
560 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
561 -fprofile-report @gol
562 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
563 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
564 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
565 -fvar-tracking-assignments-toggle  -gtoggle @gol
566 -print-file-name=@var{library}  -print-libgcc-file-name @gol
567 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
568 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
569 -print-sysroot  -print-sysroot-headers-suffix @gol
570 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
572 @item Machine-Dependent Options
573 @xref{Submodel Options,,Machine-Dependent Options}.
574 @c This list is ordered alphanumerically by subsection name.
575 @c Try and put the significant identifier (CPU or system) first,
576 @c so users have a clue at guessing where the ones they want will be.
578 @emph{AArch64 Options}
579 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
580 -mgeneral-regs-only @gol
581 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
582 -mstrict-align @gol
583 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
584 -mtls-dialect=desc  -mtls-dialect=traditional @gol
585 -mtls-size=@var{size} @gol
586 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
587 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
588 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
589 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
590 -mlow-precision-div  -mno-low-precision-div @gol
591 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
593 @emph{Adapteva Epiphany Options}
594 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
595 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
596 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
597 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
598 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
599 -msplit-vecmove-early  -m1reg-@var{reg}}
601 @emph{ARC Options}
602 @gccoptlist{-mbarrel-shifter @gol
603 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
604 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
605 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
606 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
607 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
608 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
609 -mlong-calls  -mmedium-calls  -msdata @gol
610 -mvolatile-cache  -mtp-regno=@var{regno} @gol
611 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
612 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
613 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
614 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
615 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
616 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
617 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
618 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
620 @emph{ARM Options}
621 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
622 -mabi=@var{name} @gol
623 -mapcs-stack-check  -mno-apcs-stack-check @gol
624 -mapcs-reentrant  -mno-apcs-reentrant @gol
625 -msched-prolog  -mno-sched-prolog @gol
626 -mlittle-endian  -mbig-endian @gol
627 -mfloat-abi=@var{name} @gol
628 -mfp16-format=@var{name}
629 -mthumb-interwork  -mno-thumb-interwork @gol
630 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
631 -mtune=@var{name}  -mprint-tune-info @gol
632 -mstructure-size-boundary=@var{n} @gol
633 -mabort-on-noreturn @gol
634 -mlong-calls  -mno-long-calls @gol
635 -msingle-pic-base  -mno-single-pic-base @gol
636 -mpic-register=@var{reg} @gol
637 -mnop-fun-dllimport @gol
638 -mpoke-function-name @gol
639 -mthumb  -marm @gol
640 -mtpcs-frame  -mtpcs-leaf-frame @gol
641 -mcaller-super-interworking  -mcallee-super-interworking @gol
642 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
643 -mword-relocations @gol
644 -mfix-cortex-m3-ldrd @gol
645 -munaligned-access @gol
646 -mneon-for-64bits @gol
647 -mslow-flash-data @gol
648 -masm-syntax-unified @gol
649 -mrestrict-it @gol
650 -mpure-code @gol
651 -mcmse}
653 @emph{AVR Options}
654 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
655 -mbranch-cost=@var{cost} @gol
656 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
657 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
658 -nodevicelib @gol
659 -Waddr-space-convert  -Wmisspelled-isr}
661 @emph{Blackfin Options}
662 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
663 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
664 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
665 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
666 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
667 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
668 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
669 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
670 -micplb}
672 @emph{C6X Options}
673 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
674 -msim  -msdata=@var{sdata-type}}
676 @emph{CRIS Options}
677 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
678 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
679 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
680 -mstack-align  -mdata-align  -mconst-align @gol
681 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
682 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
683 -mmul-bug-workaround  -mno-mul-bug-workaround}
685 @emph{CR16 Options}
686 @gccoptlist{-mmac @gol
687 -mcr16cplus  -mcr16c @gol
688 -msim  -mint32  -mbit-ops
689 -mdata-model=@var{model}}
691 @emph{Darwin Options}
692 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
693 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
694 -client_name  -compatibility_version  -current_version @gol
695 -dead_strip @gol
696 -dependency-file  -dylib_file  -dylinker_install_name @gol
697 -dynamic  -dynamiclib  -exported_symbols_list @gol
698 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
699 -force_flat_namespace  -headerpad_max_install_names @gol
700 -iframework @gol
701 -image_base  -init  -install_name  -keep_private_externs @gol
702 -multi_module  -multiply_defined  -multiply_defined_unused @gol
703 -noall_load   -no_dead_strip_inits_and_terms @gol
704 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
705 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
706 -private_bundle  -read_only_relocs  -sectalign @gol
707 -sectobjectsymbols  -whyload  -seg1addr @gol
708 -sectcreate  -sectobjectsymbols  -sectorder @gol
709 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
710 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
711 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
712 -single_module  -static  -sub_library  -sub_umbrella @gol
713 -twolevel_namespace  -umbrella  -undefined @gol
714 -unexported_symbols_list  -weak_reference_mismatches @gol
715 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
716 -mkernel  -mone-byte-bool}
718 @emph{DEC Alpha Options}
719 @gccoptlist{-mno-fp-regs  -msoft-float @gol
720 -mieee  -mieee-with-inexact  -mieee-conformant @gol
721 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
722 -mtrap-precision=@var{mode}  -mbuild-constants @gol
723 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
724 -mbwx  -mmax  -mfix  -mcix @gol
725 -mfloat-vax  -mfloat-ieee @gol
726 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
727 -msmall-text  -mlarge-text @gol
728 -mmemory-latency=@var{time}}
730 @emph{FR30 Options}
731 @gccoptlist{-msmall-model  -mno-lsim}
733 @emph{FT32 Options}
734 @gccoptlist{-msim  -mlra  -mnodiv}
736 @emph{FRV Options}
737 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
738 -mhard-float  -msoft-float @gol
739 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
740 -mdouble  -mno-double @gol
741 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
742 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
743 -mlinked-fp  -mlong-calls  -malign-labels @gol
744 -mlibrary-pic  -macc-4  -macc-8 @gol
745 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
746 -moptimize-membar  -mno-optimize-membar @gol
747 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
748 -mvliw-branch  -mno-vliw-branch @gol
749 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
750 -mno-nested-cond-exec  -mtomcat-stats @gol
751 -mTLS  -mtls @gol
752 -mcpu=@var{cpu}}
754 @emph{GNU/Linux Options}
755 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
756 -tno-android-cc  -tno-android-ld}
758 @emph{H8/300 Options}
759 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
761 @emph{HPPA Options}
762 @gccoptlist{-march=@var{architecture-type} @gol
763 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
764 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
765 -mfixed-range=@var{register-range} @gol
766 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
767 -mlong-load-store  -mno-disable-fpregs @gol
768 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
769 -mno-jump-in-delay  -mno-long-load-store @gol
770 -mno-portable-runtime  -mno-soft-float @gol
771 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
772 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
773 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
774 -munix=@var{unix-std}  -nolibdld  -static  -threads}
776 @emph{IA-64 Options}
777 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
778 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
779 -mconstant-gp  -mauto-pic  -mfused-madd @gol
780 -minline-float-divide-min-latency @gol
781 -minline-float-divide-max-throughput @gol
782 -mno-inline-float-divide @gol
783 -minline-int-divide-min-latency @gol
784 -minline-int-divide-max-throughput  @gol
785 -mno-inline-int-divide @gol
786 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
787 -mno-inline-sqrt @gol
788 -mdwarf2-asm  -mearly-stop-bits @gol
789 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
790 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
791 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
792 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
793 -msched-spec-ldc  -msched-spec-control-ldc @gol
794 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
795 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
796 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
797 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
799 @emph{LM32 Options}
800 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
801 -msign-extend-enabled  -muser-enabled}
803 @emph{M32R/D Options}
804 @gccoptlist{-m32r2  -m32rx  -m32r @gol
805 -mdebug @gol
806 -malign-loops  -mno-align-loops @gol
807 -missue-rate=@var{number} @gol
808 -mbranch-cost=@var{number} @gol
809 -mmodel=@var{code-size-model-type} @gol
810 -msdata=@var{sdata-type} @gol
811 -mno-flush-func  -mflush-func=@var{name} @gol
812 -mno-flush-trap  -mflush-trap=@var{number} @gol
813 -G @var{num}}
815 @emph{M32C Options}
816 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
818 @emph{M680x0 Options}
819 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
820 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
821 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
822 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
823 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
824 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
825 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
826 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
827 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
829 @emph{MCore Options}
830 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
831 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
832 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
833 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
834 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
836 @emph{MeP Options}
837 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
838 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
839 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
840 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
841 -mtiny=@var{n}}
843 @emph{MicroBlaze Options}
844 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
845 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
846 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
847 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
848 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
850 @emph{MIPS Options}
851 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
852 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
853 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
854 -mips16  -mno-mips16  -mflip-mips16 @gol
855 -minterlink-compressed  -mno-interlink-compressed @gol
856 -minterlink-mips16  -mno-interlink-mips16 @gol
857 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
858 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
859 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
860 -mno-float  -msingle-float  -mdouble-float @gol
861 -modd-spreg  -mno-odd-spreg @gol
862 -mabs=@var{mode}  -mnan=@var{encoding} @gol
863 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
864 -mmcu  -mmno-mcu @gol
865 -meva  -mno-eva @gol
866 -mvirt  -mno-virt @gol
867 -mxpa  -mno-xpa @gol
868 -mmicromips  -mno-micromips @gol
869 -mmsa  -mno-msa @gol
870 -mfpu=@var{fpu-type} @gol
871 -msmartmips  -mno-smartmips @gol
872 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
873 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
874 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
875 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
876 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
877 -membedded-data  -mno-embedded-data @gol
878 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
879 -mcode-readable=@var{setting} @gol
880 -msplit-addresses  -mno-split-addresses @gol
881 -mexplicit-relocs  -mno-explicit-relocs @gol
882 -mcheck-zero-division  -mno-check-zero-division @gol
883 -mdivide-traps  -mdivide-breaks @gol
884 -mload-store-pairs  -mno-load-store-pairs @gol
885 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
886 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
887 -mfix-24k  -mno-fix-24k @gol
888 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
889 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
890 -mfix-vr4120  -mno-fix-vr4120 @gol
891 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
892 -mflush-func=@var{func}  -mno-flush-func @gol
893 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
894 -mcompact-branches=@var{policy} @gol
895 -mfp-exceptions  -mno-fp-exceptions @gol
896 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
897 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
898 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
899 -mframe-header-opt  -mno-frame-header-opt}
901 @emph{MMIX Options}
902 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
903 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
904 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
905 -mno-base-addresses  -msingle-exit  -mno-single-exit}
907 @emph{MN10300 Options}
908 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
909 -mno-am33  -mam33  -mam33-2  -mam34 @gol
910 -mtune=@var{cpu-type} @gol
911 -mreturn-pointer-on-d0 @gol
912 -mno-crt0  -mrelax  -mliw  -msetlb}
914 @emph{Moxie Options}
915 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
917 @emph{MSP430 Options}
918 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
919 -mwarn-mcu @gol
920 -mcode-region=  -mdata-region= @gol
921 -msilicon-errata=  -msilicon-errata-warn= @gol
922 -mhwmult=  -minrt}
924 @emph{NDS32 Options}
925 @gccoptlist{-mbig-endian  -mlittle-endian @gol
926 -mreduced-regs  -mfull-regs @gol
927 -mcmov  -mno-cmov @gol
928 -mperf-ext  -mno-perf-ext @gol
929 -mv3push  -mno-v3push @gol
930 -m16bit  -mno-16bit @gol
931 -misr-vector-size=@var{num} @gol
932 -mcache-block-size=@var{num} @gol
933 -march=@var{arch} @gol
934 -mcmodel=@var{code-model} @gol
935 -mctor-dtor  -mrelax}
937 @emph{Nios II Options}
938 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
939 -mel  -meb @gol
940 -mno-bypass-cache  -mbypass-cache @gol
941 -mno-cache-volatile  -mcache-volatile @gol
942 -mno-fast-sw-div  -mfast-sw-div @gol
943 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
944 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
945 -mcustom-fpu-cfg=@var{name} @gol
946 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
947 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
949 @emph{Nvidia PTX Options}
950 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
952 @emph{PDP-11 Options}
953 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
954 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
955 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
956 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
957 -mbranch-expensive  -mbranch-cheap @gol
958 -munix-asm  -mdec-asm}
960 @emph{picoChip Options}
961 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
962 -msymbol-as-address  -mno-inefficient-warnings}
964 @emph{PowerPC Options}
965 See RS/6000 and PowerPC Options.
967 @emph{RISC-V Options}
968 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
969 -mmemcpy  -mno-memcpy @gol
970 -mplt  -mno-plt @gol
971 -mabi=@var{ABI-string} @gol
972 -mfdiv  -mno-fdiv @gol
973 -mdiv  -mno-div @gol
974 -march=@var{ISA-string} @gol
975 -mtune=@var{processor-string} @gol
976 -msmall-data-limit=@var{N-bytes} @gol
977 -msave-restore  -mno-save-restore @gol
978 -mcmodel=@var{code-model} @gol
979 -mexplicit-relocs  -mno-explicit-relocs @gol}
981 @emph{RL78 Options}
982 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
983 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
984 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
986 @emph{RS/6000 and PowerPC Options}
987 @gccoptlist{-mcpu=@var{cpu-type} @gol
988 -mtune=@var{cpu-type} @gol
989 -mcmodel=@var{code-model} @gol
990 -mpowerpc64 @gol
991 -maltivec  -mno-altivec @gol
992 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
993 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
994 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
995 -mfprnd  -mno-fprnd @gol
996 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
997 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
998 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
999 -malign-power  -malign-natural @gol
1000 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1001 -msingle-float  -mdouble-float  -msimple-fpu @gol
1002 -mstring  -mno-string  -mupdate  -mno-update @gol
1003 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1004 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1005 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1006 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1007 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1008 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1009 -mprioritize-restricted-insns=@var{priority} @gol
1010 -msched-costly-dep=@var{dependence_type} @gol
1011 -minsert-sched-nops=@var{scheme} @gol
1012 -mcall-sysv  -mcall-netbsd @gol
1013 -maix-struct-return  -msvr4-struct-return @gol
1014 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1015 -mblock-move-inline-limit=@var{num} @gol
1016 -misel  -mno-isel @gol
1017 -misel=yes  -misel=no @gol
1018 -mspe  -mno-spe @gol
1019 -mspe=yes  -mspe=no @gol
1020 -mpaired @gol
1021 -mgen-cell-microcode  -mwarn-cell-microcode @gol
1022 -mvrsave  -mno-vrsave @gol
1023 -mmulhw  -mno-mulhw @gol
1024 -mdlmzb  -mno-dlmzb @gol
1025 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1026 -mprototype  -mno-prototype @gol
1027 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1028 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1029 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1030 -mno-recip-precision @gol
1031 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1032 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1033 -msave-toc-indirect  -mno-save-toc-indirect @gol
1034 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1035 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1036 -mquad-memory  -mno-quad-memory @gol
1037 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1038 -mcompat-align-parm  -mno-compat-align-parm @gol
1039 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1040 -mupper-regs-di  -mno-upper-regs-di @gol
1041 -mupper-regs  -mno-upper-regs @gol
1042 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1043 -mgnu-attribute  -mno-gnu-attribute @gol
1044 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1045 -mstack-protector-guard-offset=@var{offset} @gol
1046 -mlra  -mno-lra}
1048 @emph{RX Options}
1049 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1050 -mcpu=@gol
1051 -mbig-endian-data  -mlittle-endian-data @gol
1052 -msmall-data @gol
1053 -msim  -mno-sim@gol
1054 -mas100-syntax  -mno-as100-syntax@gol
1055 -mrelax@gol
1056 -mmax-constant-size=@gol
1057 -mint-register=@gol
1058 -mpid@gol
1059 -mallow-string-insns  -mno-allow-string-insns@gol
1060 -mjsr@gol
1061 -mno-warn-multiple-fast-interrupts@gol
1062 -msave-acc-in-interrupts}
1064 @emph{S/390 and zSeries Options}
1065 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1066 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1067 -mlong-double-64  -mlong-double-128 @gol
1068 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1069 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1070 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1071 -mhtm  -mvx  -mzvector @gol
1072 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1073 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1074 -mhotpatch=@var{halfwords},@var{halfwords}}
1076 @emph{Score Options}
1077 @gccoptlist{-meb  -mel @gol
1078 -mnhwloop @gol
1079 -muls @gol
1080 -mmac @gol
1081 -mscore5  -mscore5u  -mscore7  -mscore7d}
1083 @emph{SH Options}
1084 @gccoptlist{-m1  -m2  -m2e @gol
1085 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1086 -m3  -m3e @gol
1087 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1088 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1089 -mb  -ml  -mdalign  -mrelax @gol
1090 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1091 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1092 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1093 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1094 -maccumulate-outgoing-args @gol
1095 -matomic-model=@var{atomic-model} @gol
1096 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1097 -mcbranch-force-delay-slot @gol
1098 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1099 -mpretend-cmove  -mtas}
1101 @emph{Solaris 2 Options}
1102 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1103 -pthreads}
1105 @emph{SPARC Options}
1106 @gccoptlist{-mcpu=@var{cpu-type} @gol
1107 -mtune=@var{cpu-type} @gol
1108 -mcmodel=@var{code-model} @gol
1109 -mmemory-model=@var{mem-model} @gol
1110 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1111 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1112 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1113 -mhard-quad-float  -msoft-quad-float @gol
1114 -mstack-bias  -mno-stack-bias @gol
1115 -mstd-struct-return  -mno-std-struct-return @gol
1116 -munaligned-doubles  -mno-unaligned-doubles @gol
1117 -muser-mode  -mno-user-mode @gol
1118 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1119 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1120 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1121 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1122 -mfix-at697f  -mfix-ut699 @gol
1123 -mlra  -mno-lra}
1125 @emph{SPU Options}
1126 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1127 -msafe-dma  -munsafe-dma @gol
1128 -mbranch-hints @gol
1129 -msmall-mem  -mlarge-mem  -mstdmain @gol
1130 -mfixed-range=@var{register-range} @gol
1131 -mea32  -mea64 @gol
1132 -maddress-space-conversion  -mno-address-space-conversion @gol
1133 -mcache-size=@var{cache-size} @gol
1134 -matomic-updates  -mno-atomic-updates}
1136 @emph{System V Options}
1137 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1139 @emph{TILE-Gx Options}
1140 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1141 -mcmodel=@var{code-model}}
1143 @emph{TILEPro Options}
1144 @gccoptlist{-mcpu=@var{cpu}  -m32}
1146 @emph{V850 Options}
1147 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1148 -mprolog-function  -mno-prolog-function  -mspace @gol
1149 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1150 -mapp-regs  -mno-app-regs @gol
1151 -mdisable-callt  -mno-disable-callt @gol
1152 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1153 -mv850e  -mv850  -mv850e3v5 @gol
1154 -mloop @gol
1155 -mrelax @gol
1156 -mlong-jumps @gol
1157 -msoft-float @gol
1158 -mhard-float @gol
1159 -mgcc-abi @gol
1160 -mrh850-abi @gol
1161 -mbig-switch}
1163 @emph{VAX Options}
1164 @gccoptlist{-mg  -mgnu  -munix}
1166 @emph{Visium Options}
1167 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1168 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1170 @emph{VMS Options}
1171 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1172 -mpointer-size=@var{size}}
1174 @emph{VxWorks Options}
1175 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1176 -Xbind-lazy  -Xbind-now}
1178 @emph{x86 Options}
1179 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1180 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1181 -mfpmath=@var{unit} @gol
1182 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1183 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1184 -mno-wide-multiply  -mrtd  -malign-double @gol
1185 -mpreferred-stack-boundary=@var{num} @gol
1186 -mincoming-stack-boundary=@var{num} @gol
1187 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1188 -mrecip  -mrecip=@var{opt} @gol
1189 -mvzeroupper  -mprefer-avx128 @gol
1190 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1191 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1192 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1193 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1194 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1195 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1196 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1197 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1198 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1199 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1200 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1201 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1202 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1203 -mregparm=@var{num}  -msseregparm @gol
1204 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1205 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1206 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1207 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1208 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1209 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1210 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1211 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1212 -mmitigate-rop  -mgeneral-regs-only}
1214 @emph{x86 Windows Options}
1215 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1216 -mnop-fun-dllimport  -mthread @gol
1217 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1219 @emph{Xstormy16 Options}
1220 @gccoptlist{-msim}
1222 @emph{Xtensa Options}
1223 @gccoptlist{-mconst16  -mno-const16 @gol
1224 -mfused-madd  -mno-fused-madd @gol
1225 -mforce-no-pic @gol
1226 -mserialize-volatile  -mno-serialize-volatile @gol
1227 -mtext-section-literals  -mno-text-section-literals @gol
1228 -mauto-litpools  -mno-auto-litpools @gol
1229 -mtarget-align  -mno-target-align @gol
1230 -mlongcalls  -mno-longcalls}
1232 @emph{zSeries Options}
1233 See S/390 and zSeries Options.
1234 @end table
1237 @node Overall Options
1238 @section Options Controlling the Kind of Output
1240 Compilation can involve up to four stages: preprocessing, compilation
1241 proper, assembly and linking, always in that order.  GCC is capable of
1242 preprocessing and compiling several files either into several
1243 assembler input files, or into one assembler input file; then each
1244 assembler input file produces an object file, and linking combines all
1245 the object files (those newly compiled, and those specified as input)
1246 into an executable file.
1248 @cindex file name suffix
1249 For any given input file, the file name suffix determines what kind of
1250 compilation is done:
1252 @table @gcctabopt
1253 @item @var{file}.c
1254 C source code that must be preprocessed.
1256 @item @var{file}.i
1257 C source code that should not be preprocessed.
1259 @item @var{file}.ii
1260 C++ source code that should not be preprocessed.
1262 @item @var{file}.m
1263 Objective-C source code.  Note that you must link with the @file{libobjc}
1264 library to make an Objective-C program work.
1266 @item @var{file}.mi
1267 Objective-C source code that should not be preprocessed.
1269 @item @var{file}.mm
1270 @itemx @var{file}.M
1271 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1272 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1273 to a literal capital M@.
1275 @item @var{file}.mii
1276 Objective-C++ source code that should not be preprocessed.
1278 @item @var{file}.h
1279 C, C++, Objective-C or Objective-C++ header file to be turned into a
1280 precompiled header (default), or C, C++ header file to be turned into an
1281 Ada spec (via the @option{-fdump-ada-spec} switch).
1283 @item @var{file}.cc
1284 @itemx @var{file}.cp
1285 @itemx @var{file}.cxx
1286 @itemx @var{file}.cpp
1287 @itemx @var{file}.CPP
1288 @itemx @var{file}.c++
1289 @itemx @var{file}.C
1290 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1291 the last two letters must both be literally @samp{x}.  Likewise,
1292 @samp{.C} refers to a literal capital C@.
1294 @item @var{file}.mm
1295 @itemx @var{file}.M
1296 Objective-C++ source code that must be preprocessed.
1298 @item @var{file}.mii
1299 Objective-C++ source code that should not be preprocessed.
1301 @item @var{file}.hh
1302 @itemx @var{file}.H
1303 @itemx @var{file}.hp
1304 @itemx @var{file}.hxx
1305 @itemx @var{file}.hpp
1306 @itemx @var{file}.HPP
1307 @itemx @var{file}.h++
1308 @itemx @var{file}.tcc
1309 C++ header file to be turned into a precompiled header or Ada spec.
1311 @item @var{file}.f
1312 @itemx @var{file}.for
1313 @itemx @var{file}.ftn
1314 Fixed form Fortran source code that should not be preprocessed.
1316 @item @var{file}.F
1317 @itemx @var{file}.FOR
1318 @itemx @var{file}.fpp
1319 @itemx @var{file}.FPP
1320 @itemx @var{file}.FTN
1321 Fixed form Fortran source code that must be preprocessed (with the traditional
1322 preprocessor).
1324 @item @var{file}.f90
1325 @itemx @var{file}.f95
1326 @itemx @var{file}.f03
1327 @itemx @var{file}.f08
1328 Free form Fortran source code that should not be preprocessed.
1330 @item @var{file}.F90
1331 @itemx @var{file}.F95
1332 @itemx @var{file}.F03
1333 @itemx @var{file}.F08
1334 Free form Fortran source code that must be preprocessed (with the
1335 traditional preprocessor).
1337 @item @var{file}.go
1338 Go source code.
1340 @item @var{file}.brig
1341 BRIG files (binary representation of HSAIL).
1343 @item @var{file}.ads
1344 Ada source code file that contains a library unit declaration (a
1345 declaration of a package, subprogram, or generic, or a generic
1346 instantiation), or a library unit renaming declaration (a package,
1347 generic, or subprogram renaming declaration).  Such files are also
1348 called @dfn{specs}.
1350 @item @var{file}.adb
1351 Ada source code file containing a library unit body (a subprogram or
1352 package body).  Such files are also called @dfn{bodies}.
1354 @c GCC also knows about some suffixes for languages not yet included:
1355 @c Pascal:
1356 @c @var{file}.p
1357 @c @var{file}.pas
1358 @c Ratfor:
1359 @c @var{file}.r
1361 @item @var{file}.s
1362 Assembler code.
1364 @item @var{file}.S
1365 @itemx @var{file}.sx
1366 Assembler code that must be preprocessed.
1368 @item @var{other}
1369 An object file to be fed straight into linking.
1370 Any file name with no recognized suffix is treated this way.
1371 @end table
1373 @opindex x
1374 You can specify the input language explicitly with the @option{-x} option:
1376 @table @gcctabopt
1377 @item -x @var{language}
1378 Specify explicitly the @var{language} for the following input files
1379 (rather than letting the compiler choose a default based on the file
1380 name suffix).  This option applies to all following input files until
1381 the next @option{-x} option.  Possible values for @var{language} are:
1382 @smallexample
1383 c  c-header  cpp-output
1384 c++  c++-header  c++-cpp-output
1385 objective-c  objective-c-header  objective-c-cpp-output
1386 objective-c++ objective-c++-header objective-c++-cpp-output
1387 assembler  assembler-with-cpp
1389 f77  f77-cpp-input f95  f95-cpp-input
1391 brig
1392 @end smallexample
1394 @item -x none
1395 Turn off any specification of a language, so that subsequent files are
1396 handled according to their file name suffixes (as they are if @option{-x}
1397 has not been used at all).
1398 @end table
1400 If you only want some of the stages of compilation, you can use
1401 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1402 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1403 @command{gcc} is to stop.  Note that some combinations (for example,
1404 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1406 @table @gcctabopt
1407 @item -c
1408 @opindex c
1409 Compile or assemble the source files, but do not link.  The linking
1410 stage simply is not done.  The ultimate output is in the form of an
1411 object file for each source file.
1413 By default, the object file name for a source file is made by replacing
1414 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1416 Unrecognized input files, not requiring compilation or assembly, are
1417 ignored.
1419 @item -S
1420 @opindex S
1421 Stop after the stage of compilation proper; do not assemble.  The output
1422 is in the form of an assembler code file for each non-assembler input
1423 file specified.
1425 By default, the assembler file name for a source file is made by
1426 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1428 Input files that don't require compilation are ignored.
1430 @item -E
1431 @opindex E
1432 Stop after the preprocessing stage; do not run the compiler proper.  The
1433 output is in the form of preprocessed source code, which is sent to the
1434 standard output.
1436 Input files that don't require preprocessing are ignored.
1438 @cindex output file option
1439 @item -o @var{file}
1440 @opindex o
1441 Place output in file @var{file}.  This applies to whatever
1442 sort of output is being produced, whether it be an executable file,
1443 an object file, an assembler file or preprocessed C code.
1445 If @option{-o} is not specified, the default is to put an executable
1446 file in @file{a.out}, the object file for
1447 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1448 assembler file in @file{@var{source}.s}, a precompiled header file in
1449 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1450 standard output.
1452 @item -v
1453 @opindex v
1454 Print (on standard error output) the commands executed to run the stages
1455 of compilation.  Also print the version number of the compiler driver
1456 program and of the preprocessor and the compiler proper.
1458 @item -###
1459 @opindex ###
1460 Like @option{-v} except the commands are not executed and arguments
1461 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1462 This is useful for shell scripts to capture the driver-generated command lines.
1464 @item --help
1465 @opindex help
1466 Print (on the standard output) a description of the command-line options
1467 understood by @command{gcc}.  If the @option{-v} option is also specified
1468 then @option{--help} is also passed on to the various processes
1469 invoked by @command{gcc}, so that they can display the command-line options
1470 they accept.  If the @option{-Wextra} option has also been specified
1471 (prior to the @option{--help} option), then command-line options that
1472 have no documentation associated with them are also displayed.
1474 @item --target-help
1475 @opindex target-help
1476 Print (on the standard output) a description of target-specific command-line
1477 options for each tool.  For some targets extra target-specific
1478 information may also be printed.
1480 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1481 Print (on the standard output) a description of the command-line
1482 options understood by the compiler that fit into all specified classes
1483 and qualifiers.  These are the supported classes:
1485 @table @asis
1486 @item @samp{optimizers}
1487 Display all of the optimization options supported by the
1488 compiler.
1490 @item @samp{warnings}
1491 Display all of the options controlling warning messages
1492 produced by the compiler.
1494 @item @samp{target}
1495 Display target-specific options.  Unlike the
1496 @option{--target-help} option however, target-specific options of the
1497 linker and assembler are not displayed.  This is because those
1498 tools do not currently support the extended @option{--help=} syntax.
1500 @item @samp{params}
1501 Display the values recognized by the @option{--param}
1502 option.
1504 @item @var{language}
1505 Display the options supported for @var{language}, where
1506 @var{language} is the name of one of the languages supported in this
1507 version of GCC@.
1509 @item @samp{common}
1510 Display the options that are common to all languages.
1511 @end table
1513 These are the supported qualifiers:
1515 @table @asis
1516 @item @samp{undocumented}
1517 Display only those options that are undocumented.
1519 @item @samp{joined}
1520 Display options taking an argument that appears after an equal
1521 sign in the same continuous piece of text, such as:
1522 @samp{--help=target}.
1524 @item @samp{separate}
1525 Display options taking an argument that appears as a separate word
1526 following the original option, such as: @samp{-o output-file}.
1527 @end table
1529 Thus for example to display all the undocumented target-specific
1530 switches supported by the compiler, use:
1532 @smallexample
1533 --help=target,undocumented
1534 @end smallexample
1536 The sense of a qualifier can be inverted by prefixing it with the
1537 @samp{^} character, so for example to display all binary warning
1538 options (i.e., ones that are either on or off and that do not take an
1539 argument) that have a description, use:
1541 @smallexample
1542 --help=warnings,^joined,^undocumented
1543 @end smallexample
1545 The argument to @option{--help=} should not consist solely of inverted
1546 qualifiers.
1548 Combining several classes is possible, although this usually
1549 restricts the output so much that there is nothing to display.  One
1550 case where it does work, however, is when one of the classes is
1551 @var{target}.  For example, to display all the target-specific
1552 optimization options, use:
1554 @smallexample
1555 --help=target,optimizers
1556 @end smallexample
1558 The @option{--help=} option can be repeated on the command line.  Each
1559 successive use displays its requested class of options, skipping
1560 those that have already been displayed.
1562 If the @option{-Q} option appears on the command line before the
1563 @option{--help=} option, then the descriptive text displayed by
1564 @option{--help=} is changed.  Instead of describing the displayed
1565 options, an indication is given as to whether the option is enabled,
1566 disabled or set to a specific value (assuming that the compiler
1567 knows this at the point where the @option{--help=} option is used).
1569 Here is a truncated example from the ARM port of @command{gcc}:
1571 @smallexample
1572   % gcc -Q -mabi=2 --help=target -c
1573   The following options are target specific:
1574   -mabi=                                2
1575   -mabort-on-noreturn                   [disabled]
1576   -mapcs                                [disabled]
1577 @end smallexample
1579 The output is sensitive to the effects of previous command-line
1580 options, so for example it is possible to find out which optimizations
1581 are enabled at @option{-O2} by using:
1583 @smallexample
1584 -Q -O2 --help=optimizers
1585 @end smallexample
1587 Alternatively you can discover which binary optimizations are enabled
1588 by @option{-O3} by using:
1590 @smallexample
1591 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1592 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1593 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1594 @end smallexample
1596 @item --version
1597 @opindex version
1598 Display the version number and copyrights of the invoked GCC@.
1600 @item -pass-exit-codes
1601 @opindex pass-exit-codes
1602 Normally the @command{gcc} program exits with the code of 1 if any
1603 phase of the compiler returns a non-success return code.  If you specify
1604 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1605 the numerically highest error produced by any phase returning an error
1606 indication.  The C, C++, and Fortran front ends return 4 if an internal
1607 compiler error is encountered.
1609 @item -pipe
1610 @opindex pipe
1611 Use pipes rather than temporary files for communication between the
1612 various stages of compilation.  This fails to work on some systems where
1613 the assembler is unable to read from a pipe; but the GNU assembler has
1614 no trouble.
1616 @item -specs=@var{file}
1617 @opindex specs
1618 Process @var{file} after the compiler reads in the standard @file{specs}
1619 file, in order to override the defaults which the @command{gcc} driver
1620 program uses when determining what switches to pass to @command{cc1},
1621 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1622 @option{-specs=@var{file}} can be specified on the command line, and they
1623 are processed in order, from left to right.  @xref{Spec Files}, for
1624 information about the format of the @var{file}.
1626 @item -wrapper
1627 @opindex wrapper
1628 Invoke all subcommands under a wrapper program.  The name of the
1629 wrapper program and its parameters are passed as a comma separated
1630 list.
1632 @smallexample
1633 gcc -c t.c -wrapper gdb,--args
1634 @end smallexample
1636 @noindent
1637 This invokes all subprograms of @command{gcc} under
1638 @samp{gdb --args}, thus the invocation of @command{cc1} is
1639 @samp{gdb --args cc1 @dots{}}.
1641 @item -fplugin=@var{name}.so
1642 @opindex fplugin
1643 Load the plugin code in file @var{name}.so, assumed to be a
1644 shared object to be dlopen'd by the compiler.  The base name of
1645 the shared object file is used to identify the plugin for the
1646 purposes of argument parsing (See
1647 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1648 Each plugin should define the callback functions specified in the
1649 Plugins API.
1651 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1652 @opindex fplugin-arg
1653 Define an argument called @var{key} with a value of @var{value}
1654 for the plugin called @var{name}.
1656 @item -fdump-ada-spec@r{[}-slim@r{]}
1657 @opindex fdump-ada-spec
1658 For C and C++ source and include files, generate corresponding Ada specs.
1659 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1660 GNAT User's Guide}, which provides detailed documentation on this feature.
1662 @item -fada-spec-parent=@var{unit}
1663 @opindex fada-spec-parent
1664 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1665 Ada specs as child units of parent @var{unit}.
1667 @item -fdump-go-spec=@var{file}
1668 @opindex fdump-go-spec
1669 For input files in any language, generate corresponding Go
1670 declarations in @var{file}.  This generates Go @code{const},
1671 @code{type}, @code{var}, and @code{func} declarations which may be a
1672 useful way to start writing a Go interface to code written in some
1673 other language.
1675 @include @value{srcdir}/../libiberty/at-file.texi
1676 @end table
1678 @node Invoking G++
1679 @section Compiling C++ Programs
1681 @cindex suffixes for C++ source
1682 @cindex C++ source file suffixes
1683 C++ source files conventionally use one of the suffixes @samp{.C},
1684 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1685 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1686 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1687 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1688 files with these names and compiles them as C++ programs even if you
1689 call the compiler the same way as for compiling C programs (usually
1690 with the name @command{gcc}).
1692 @findex g++
1693 @findex c++
1694 However, the use of @command{gcc} does not add the C++ library.
1695 @command{g++} is a program that calls GCC and automatically specifies linking
1696 against the C++ library.  It treats @samp{.c},
1697 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1698 files unless @option{-x} is used.  This program is also useful when
1699 precompiling a C header file with a @samp{.h} extension for use in C++
1700 compilations.  On many systems, @command{g++} is also installed with
1701 the name @command{c++}.
1703 @cindex invoking @command{g++}
1704 When you compile C++ programs, you may specify many of the same
1705 command-line options that you use for compiling programs in any
1706 language; or command-line options meaningful for C and related
1707 languages; or options that are meaningful only for C++ programs.
1708 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1709 explanations of options for languages related to C@.
1710 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1711 explanations of options that are meaningful only for C++ programs.
1713 @node C Dialect Options
1714 @section Options Controlling C Dialect
1715 @cindex dialect options
1716 @cindex language dialect options
1717 @cindex options, dialect
1719 The following options control the dialect of C (or languages derived
1720 from C, such as C++, Objective-C and Objective-C++) that the compiler
1721 accepts:
1723 @table @gcctabopt
1724 @cindex ANSI support
1725 @cindex ISO support
1726 @item -ansi
1727 @opindex ansi
1728 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1729 equivalent to @option{-std=c++98}.
1731 This turns off certain features of GCC that are incompatible with ISO
1732 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1733 such as the @code{asm} and @code{typeof} keywords, and
1734 predefined macros such as @code{unix} and @code{vax} that identify the
1735 type of system you are using.  It also enables the undesirable and
1736 rarely used ISO trigraph feature.  For the C compiler,
1737 it disables recognition of C++ style @samp{//} comments as well as
1738 the @code{inline} keyword.
1740 The alternate keywords @code{__asm__}, @code{__extension__},
1741 @code{__inline__} and @code{__typeof__} continue to work despite
1742 @option{-ansi}.  You would not want to use them in an ISO C program, of
1743 course, but it is useful to put them in header files that might be included
1744 in compilations done with @option{-ansi}.  Alternate predefined macros
1745 such as @code{__unix__} and @code{__vax__} are also available, with or
1746 without @option{-ansi}.
1748 The @option{-ansi} option does not cause non-ISO programs to be
1749 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1750 addition to @option{-ansi}.  @xref{Warning Options}.
1752 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1753 option is used.  Some header files may notice this macro and refrain
1754 from declaring certain functions or defining certain macros that the
1755 ISO standard doesn't call for; this is to avoid interfering with any
1756 programs that might use these names for other things.
1758 Functions that are normally built in but do not have semantics
1759 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1760 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1761 built-in functions provided by GCC}, for details of the functions
1762 affected.
1764 @item -std=
1765 @opindex std
1766 Determine the language standard. @xref{Standards,,Language Standards
1767 Supported by GCC}, for details of these standard versions.  This option
1768 is currently only supported when compiling C or C++.
1770 The compiler can accept several base standards, such as @samp{c90} or
1771 @samp{c++98}, and GNU dialects of those standards, such as
1772 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1773 compiler accepts all programs following that standard plus those
1774 using GNU extensions that do not contradict it.  For example,
1775 @option{-std=c90} turns off certain features of GCC that are
1776 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1777 keywords, but not other GNU extensions that do not have a meaning in
1778 ISO C90, such as omitting the middle term of a @code{?:}
1779 expression. On the other hand, when a GNU dialect of a standard is
1780 specified, all features supported by the compiler are enabled, even when
1781 those features change the meaning of the base standard.  As a result, some
1782 strict-conforming programs may be rejected.  The particular standard
1783 is used by @option{-Wpedantic} to identify which features are GNU
1784 extensions given that version of the standard. For example
1785 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1786 comments, while @option{-std=gnu99 -Wpedantic} does not.
1788 A value for this option must be provided; possible values are
1790 @table @samp
1791 @item c90
1792 @itemx c89
1793 @itemx iso9899:1990
1794 Support all ISO C90 programs (certain GNU extensions that conflict
1795 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1797 @item iso9899:199409
1798 ISO C90 as modified in amendment 1.
1800 @item c99
1801 @itemx c9x
1802 @itemx iso9899:1999
1803 @itemx iso9899:199x
1804 ISO C99.  This standard is substantially completely supported, modulo
1805 bugs and floating-point issues
1806 (mainly but not entirely relating to optional C99 features from
1807 Annexes F and G).  See
1808 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1809 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1811 @item c11
1812 @itemx c1x
1813 @itemx iso9899:2011
1814 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1815 substantially completely supported, modulo bugs, floating-point issues
1816 (mainly but not entirely relating to optional C11 features from
1817 Annexes F and G) and the optional Annexes K (Bounds-checking
1818 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1820 @item gnu90
1821 @itemx gnu89
1822 GNU dialect of ISO C90 (including some C99 features).
1824 @item gnu99
1825 @itemx gnu9x
1826 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1828 @item gnu11
1829 @itemx gnu1x
1830 GNU dialect of ISO C11.  This is the default for C code.
1831 The name @samp{gnu1x} is deprecated.
1833 @item c++98
1834 @itemx c++03
1835 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1836 additional defect reports. Same as @option{-ansi} for C++ code.
1838 @item gnu++98
1839 @itemx gnu++03
1840 GNU dialect of @option{-std=c++98}.
1842 @item c++11
1843 @itemx c++0x
1844 The 2011 ISO C++ standard plus amendments.
1845 The name @samp{c++0x} is deprecated.
1847 @item gnu++11
1848 @itemx gnu++0x
1849 GNU dialect of @option{-std=c++11}.
1850 The name @samp{gnu++0x} is deprecated.
1852 @item c++14
1853 @itemx c++1y
1854 The 2014 ISO C++ standard plus amendments.
1855 The name @samp{c++1y} is deprecated.
1857 @item gnu++14
1858 @itemx gnu++1y
1859 GNU dialect of @option{-std=c++14}.
1860 This is the default for C++ code.
1861 The name @samp{gnu++1y} is deprecated.
1863 @item c++1z
1864 The next revision of the ISO C++ standard, tentatively planned for
1865 2017.  Support is highly experimental, and will almost certainly
1866 change in incompatible ways in future releases.
1868 @item gnu++1z
1869 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1870 and will almost certainly change in incompatible ways in future
1871 releases.
1872 @end table
1874 @item -fgnu89-inline
1875 @opindex fgnu89-inline
1876 The option @option{-fgnu89-inline} tells GCC to use the traditional
1877 GNU semantics for @code{inline} functions when in C99 mode.
1878 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1879 Using this option is roughly equivalent to adding the
1880 @code{gnu_inline} function attribute to all inline functions
1881 (@pxref{Function Attributes}).
1883 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1884 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1885 specifies the default behavior).
1886 This option is not supported in @option{-std=c90} or
1887 @option{-std=gnu90} mode.
1889 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1890 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1891 in effect for @code{inline} functions.  @xref{Common Predefined
1892 Macros,,,cpp,The C Preprocessor}.
1894 @item -fpermitted-flt-eval-methods=@var{style}
1895 @opindex fpermitted-flt-eval-methods
1896 @opindex fpermitted-flt-eval-methods=c11
1897 @opindex fpermitted-flt-eval-methods=ts-18661-3
1898 ISO/IEC TS 18661-3 defines new permissible values for
1899 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1900 a semantic type that is an interchange or extended format should be
1901 evaluated to the precision and range of that type.  These new values are
1902 a superset of those permitted under C99/C11, which does not specify the
1903 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1904 conforming to C11 may not have been written expecting the possibility of
1905 the new values.
1907 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1908 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1909 or the extended set of values specified in ISO/IEC TS 18661-3.
1911 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1913 The default when in a standards compliant mode (@option{-std=c11} or similar)
1914 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1915 dialect (@option{-std=gnu11} or similar) is
1916 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1918 @item -aux-info @var{filename}
1919 @opindex aux-info
1920 Output to the given filename prototyped declarations for all functions
1921 declared and/or defined in a translation unit, including those in header
1922 files.  This option is silently ignored in any language other than C@.
1924 Besides declarations, the file indicates, in comments, the origin of
1925 each declaration (source file and line), whether the declaration was
1926 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1927 @samp{O} for old, respectively, in the first character after the line
1928 number and the colon), and whether it came from a declaration or a
1929 definition (@samp{C} or @samp{F}, respectively, in the following
1930 character).  In the case of function definitions, a K&R-style list of
1931 arguments followed by their declarations is also provided, inside
1932 comments, after the declaration.
1934 @item -fallow-parameterless-variadic-functions
1935 @opindex fallow-parameterless-variadic-functions
1936 Accept variadic functions without named parameters.
1938 Although it is possible to define such a function, this is not very
1939 useful as it is not possible to read the arguments.  This is only
1940 supported for C as this construct is allowed by C++.
1942 @item -fno-asm
1943 @opindex fno-asm
1944 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1945 keyword, so that code can use these words as identifiers.  You can use
1946 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1947 instead.  @option{-ansi} implies @option{-fno-asm}.
1949 In C++, this switch only affects the @code{typeof} keyword, since
1950 @code{asm} and @code{inline} are standard keywords.  You may want to
1951 use the @option{-fno-gnu-keywords} flag instead, which has the same
1952 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1953 switch only affects the @code{asm} and @code{typeof} keywords, since
1954 @code{inline} is a standard keyword in ISO C99.
1956 @item -fno-builtin
1957 @itemx -fno-builtin-@var{function}
1958 @opindex fno-builtin
1959 @cindex built-in functions
1960 Don't recognize built-in functions that do not begin with
1961 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1962 functions provided by GCC}, for details of the functions affected,
1963 including those which are not built-in functions when @option{-ansi} or
1964 @option{-std} options for strict ISO C conformance are used because they
1965 do not have an ISO standard meaning.
1967 GCC normally generates special code to handle certain built-in functions
1968 more efficiently; for instance, calls to @code{alloca} may become single
1969 instructions which adjust the stack directly, and calls to @code{memcpy}
1970 may become inline copy loops.  The resulting code is often both smaller
1971 and faster, but since the function calls no longer appear as such, you
1972 cannot set a breakpoint on those calls, nor can you change the behavior
1973 of the functions by linking with a different library.  In addition,
1974 when a function is recognized as a built-in function, GCC may use
1975 information about that function to warn about problems with calls to
1976 that function, or to generate more efficient code, even if the
1977 resulting code still contains calls to that function.  For example,
1978 warnings are given with @option{-Wformat} for bad calls to
1979 @code{printf} when @code{printf} is built in and @code{strlen} is
1980 known not to modify global memory.
1982 With the @option{-fno-builtin-@var{function}} option
1983 only the built-in function @var{function} is
1984 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1985 function is named that is not built-in in this version of GCC, this
1986 option is ignored.  There is no corresponding
1987 @option{-fbuiltin-@var{function}} option; if you wish to enable
1988 built-in functions selectively when using @option{-fno-builtin} or
1989 @option{-ffreestanding}, you may define macros such as:
1991 @smallexample
1992 #define abs(n)          __builtin_abs ((n))
1993 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1994 @end smallexample
1996 @item -fgimple
1997 @opindex fgimple
1999 Enable parsing of function definitions marked with @code{__GIMPLE}.
2000 This is an experimental feature that allows unit testing of GIMPLE
2001 passes.
2003 @item -fhosted
2004 @opindex fhosted
2005 @cindex hosted environment
2007 Assert that compilation targets a hosted environment.  This implies
2008 @option{-fbuiltin}.  A hosted environment is one in which the
2009 entire standard library is available, and in which @code{main} has a return
2010 type of @code{int}.  Examples are nearly everything except a kernel.
2011 This is equivalent to @option{-fno-freestanding}.
2013 @item -ffreestanding
2014 @opindex ffreestanding
2015 @cindex hosted environment
2017 Assert that compilation targets a freestanding environment.  This
2018 implies @option{-fno-builtin}.  A freestanding environment
2019 is one in which the standard library may not exist, and program startup may
2020 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2021 This is equivalent to @option{-fno-hosted}.
2023 @xref{Standards,,Language Standards Supported by GCC}, for details of
2024 freestanding and hosted environments.
2026 @item -fopenacc
2027 @opindex fopenacc
2028 @cindex OpenACC accelerator programming
2029 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2030 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2031 compiler generates accelerated code according to the OpenACC Application
2032 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2033 implies @option{-pthread}, and thus is only supported on targets that
2034 have support for @option{-pthread}.
2036 @item -fopenacc-dim=@var{geom}
2037 @opindex fopenacc-dim
2038 @cindex OpenACC accelerator programming
2039 Specify default compute dimensions for parallel offload regions that do
2040 not explicitly specify.  The @var{geom} value is a triple of
2041 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2042 can be omitted, to use a target-specific default value.
2044 @item -fopenmp
2045 @opindex fopenmp
2046 @cindex OpenMP parallel
2047 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2048 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2049 compiler generates parallel code according to the OpenMP Application
2050 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2051 implies @option{-pthread}, and thus is only supported on targets that
2052 have support for @option{-pthread}. @option{-fopenmp} implies
2053 @option{-fopenmp-simd}.
2055 @item -fopenmp-simd
2056 @opindex fopenmp-simd
2057 @cindex OpenMP SIMD
2058 @cindex SIMD
2059 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2060 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2061 are ignored.
2063 @item -fcilkplus
2064 @opindex fcilkplus
2065 @cindex Enable Cilk Plus
2066 Enable the usage of Cilk Plus language extension features for C/C++.
2067 When the option @option{-fcilkplus} is specified, enable the usage of
2068 the Cilk Plus Language extension features for C/C++.  The present
2069 implementation follows ABI version 1.2.  This is an experimental
2070 feature that is only partially complete, and whose interface may
2071 change in future versions of GCC as the official specification
2072 changes.  Currently, all features but @code{_Cilk_for} have been
2073 implemented.
2075 @item -fgnu-tm
2076 @opindex fgnu-tm
2077 When the option @option{-fgnu-tm} is specified, the compiler
2078 generates code for the Linux variant of Intel's current Transactional
2079 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2080 an experimental feature whose interface may change in future versions
2081 of GCC, as the official specification changes.  Please note that not
2082 all architectures are supported for this feature.
2084 For more information on GCC's support for transactional memory,
2085 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2086 Transactional Memory Library}.
2088 Note that the transactional memory feature is not supported with
2089 non-call exceptions (@option{-fnon-call-exceptions}).
2091 @item -fms-extensions
2092 @opindex fms-extensions
2093 Accept some non-standard constructs used in Microsoft header files.
2095 In C++ code, this allows member names in structures to be similar
2096 to previous types declarations.
2098 @smallexample
2099 typedef int UOW;
2100 struct ABC @{
2101   UOW UOW;
2103 @end smallexample
2105 Some cases of unnamed fields in structures and unions are only
2106 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2107 fields within structs/unions}, for details.
2109 Note that this option is off for all targets but x86 
2110 targets using ms-abi.
2112 @item -fplan9-extensions
2113 @opindex fplan9-extensions
2114 Accept some non-standard constructs used in Plan 9 code.
2116 This enables @option{-fms-extensions}, permits passing pointers to
2117 structures with anonymous fields to functions that expect pointers to
2118 elements of the type of the field, and permits referring to anonymous
2119 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2120 struct/union fields within structs/unions}, for details.  This is only
2121 supported for C, not C++.
2123 @item -fcond-mismatch
2124 @opindex fcond-mismatch
2125 Allow conditional expressions with mismatched types in the second and
2126 third arguments.  The value of such an expression is void.  This option
2127 is not supported for C++.
2129 @item -flax-vector-conversions
2130 @opindex flax-vector-conversions
2131 Allow implicit conversions between vectors with differing numbers of
2132 elements and/or incompatible element types.  This option should not be
2133 used for new code.
2135 @item -funsigned-char
2136 @opindex funsigned-char
2137 Let the type @code{char} be unsigned, like @code{unsigned char}.
2139 Each kind of machine has a default for what @code{char} should
2140 be.  It is either like @code{unsigned char} by default or like
2141 @code{signed char} by default.
2143 Ideally, a portable program should always use @code{signed char} or
2144 @code{unsigned char} when it depends on the signedness of an object.
2145 But many programs have been written to use plain @code{char} and
2146 expect it to be signed, or expect it to be unsigned, depending on the
2147 machines they were written for.  This option, and its inverse, let you
2148 make such a program work with the opposite default.
2150 The type @code{char} is always a distinct type from each of
2151 @code{signed char} or @code{unsigned char}, even though its behavior
2152 is always just like one of those two.
2154 @item -fsigned-char
2155 @opindex fsigned-char
2156 Let the type @code{char} be signed, like @code{signed char}.
2158 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2159 the negative form of @option{-funsigned-char}.  Likewise, the option
2160 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2162 @item -fsigned-bitfields
2163 @itemx -funsigned-bitfields
2164 @itemx -fno-signed-bitfields
2165 @itemx -fno-unsigned-bitfields
2166 @opindex fsigned-bitfields
2167 @opindex funsigned-bitfields
2168 @opindex fno-signed-bitfields
2169 @opindex fno-unsigned-bitfields
2170 These options control whether a bit-field is signed or unsigned, when the
2171 declaration does not use either @code{signed} or @code{unsigned}.  By
2172 default, such a bit-field is signed, because this is consistent: the
2173 basic integer types such as @code{int} are signed types.
2175 @item -fsso-struct=@var{endianness}
2176 @opindex fsso-struct
2177 Set the default scalar storage order of structures and unions to the
2178 specified endianness.  The accepted values are @samp{big-endian},
2179 @samp{little-endian} and @samp{native} for the native endianness of
2180 the target (the default).  This option is not supported for C++.
2182 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2183 code that is not binary compatible with code generated without it if the
2184 specified endianness is not the native endianness of the target.
2185 @end table
2187 @node C++ Dialect Options
2188 @section Options Controlling C++ Dialect
2190 @cindex compiler options, C++
2191 @cindex C++ options, command-line
2192 @cindex options, C++
2193 This section describes the command-line options that are only meaningful
2194 for C++ programs.  You can also use most of the GNU compiler options
2195 regardless of what language your program is in.  For example, you
2196 might compile a file @file{firstClass.C} like this:
2198 @smallexample
2199 g++ -g -fstrict-enums -O -c firstClass.C
2200 @end smallexample
2202 @noindent
2203 In this example, only @option{-fstrict-enums} is an option meant
2204 only for C++ programs; you can use the other options with any
2205 language supported by GCC@.
2207 Some options for compiling C programs, such as @option{-std}, are also
2208 relevant for C++ programs.
2209 @xref{C Dialect Options,,Options Controlling C Dialect}.
2211 Here is a list of options that are @emph{only} for compiling C++ programs:
2213 @table @gcctabopt
2215 @item -fabi-version=@var{n}
2216 @opindex fabi-version
2217 Use version @var{n} of the C++ ABI@.  The default is version 0.
2219 Version 0 refers to the version conforming most closely to
2220 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2221 will change in different versions of G++ as ABI bugs are fixed.
2223 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2225 Version 2 is the version of the C++ ABI that first appeared in G++
2226 3.4, and was the default through G++ 4.9.
2228 Version 3 corrects an error in mangling a constant address as a
2229 template argument.
2231 Version 4, which first appeared in G++ 4.5, implements a standard
2232 mangling for vector types.
2234 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2235 attribute const/volatile on function pointer types, decltype of a
2236 plain decl, and use of a function parameter in the declaration of
2237 another parameter.
2239 Version 6, which first appeared in G++ 4.7, corrects the promotion
2240 behavior of C++11 scoped enums and the mangling of template argument
2241 packs, const/static_cast, prefix ++ and --, and a class scope function
2242 used as a template argument.
2244 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2245 builtin type and corrects the mangling of lambdas in default argument
2246 scope.
2248 Version 8, which first appeared in G++ 4.9, corrects the substitution
2249 behavior of function types with function-cv-qualifiers.
2251 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2252 @code{nullptr_t}.
2254 Version 10, which first appeared in G++ 6.1, adds mangling of
2255 attributes that affect type identity, such as ia32 calling convention
2256 attributes (e.g. @samp{stdcall}).
2258 Version 11, which first appeared in G++ 7, corrects the mangling of
2259 sizeof... expressions and operator names.  For multiple entities with
2260 the same name within a function, that are declared in different scopes,
2261 the mangling now changes starting with the twelfth occurrence.  It also
2262 implies @option{-fnew-inheriting-ctors}.
2264 See also @option{-Wabi}.
2266 @item -fabi-compat-version=@var{n}
2267 @opindex fabi-compat-version
2268 On targets that support strong aliases, G++
2269 works around mangling changes by creating an alias with the correct
2270 mangled name when defining a symbol with an incorrect mangled name.
2271 This switch specifies which ABI version to use for the alias.
2273 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2274 compatibility).  If another ABI version is explicitly selected, this
2275 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2276 use @option{-fabi-compat-version=2}.
2278 If this option is not provided but @option{-Wabi=@var{n}} is, that
2279 version is used for compatibility aliases.  If this option is provided
2280 along with @option{-Wabi} (without the version), the version from this
2281 option is used for the warning.
2283 @item -fno-access-control
2284 @opindex fno-access-control
2285 Turn off all access checking.  This switch is mainly useful for working
2286 around bugs in the access control code.
2288 @item -faligned-new
2289 @opindex faligned-new
2290 Enable support for C++17 @code{new} of types that require more
2291 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2292 numeric argument such as @code{-faligned-new=32} can be used to
2293 specify how much alignment (in bytes) is provided by that function,
2294 but few users will need to override the default of
2295 @code{alignof(std::max_align_t)}.
2297 @item -fcheck-new
2298 @opindex fcheck-new
2299 Check that the pointer returned by @code{operator new} is non-null
2300 before attempting to modify the storage allocated.  This check is
2301 normally unnecessary because the C++ standard specifies that
2302 @code{operator new} only returns @code{0} if it is declared
2303 @code{throw()}, in which case the compiler always checks the
2304 return value even without this option.  In all other cases, when
2305 @code{operator new} has a non-empty exception specification, memory
2306 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2307 @samp{new (nothrow)}.
2309 @item -fconcepts
2310 @opindex fconcepts
2311 Enable support for the C++ Extensions for Concepts Technical
2312 Specification, ISO 19217 (2015), which allows code like
2314 @smallexample
2315 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2316 template <Addable T> T add (T a, T b) @{ return a + b; @}
2317 @end smallexample
2319 @item -fconstexpr-depth=@var{n}
2320 @opindex fconstexpr-depth
2321 Set the maximum nested evaluation depth for C++11 constexpr functions
2322 to @var{n}.  A limit is needed to detect endless recursion during
2323 constant expression evaluation.  The minimum specified by the standard
2324 is 512.
2326 @item -fconstexpr-loop-limit=@var{n}
2327 @opindex fconstexpr-loop-limit
2328 Set the maximum number of iterations for a loop in C++14 constexpr functions
2329 to @var{n}.  A limit is needed to detect infinite loops during
2330 constant expression evaluation.  The default is 262144 (1<<18).
2332 @item -fdeduce-init-list
2333 @opindex fdeduce-init-list
2334 Enable deduction of a template type parameter as
2335 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2337 @smallexample
2338 template <class T> auto forward(T t) -> decltype (realfn (t))
2340   return realfn (t);
2343 void f()
2345   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2347 @end smallexample
2349 This deduction was implemented as a possible extension to the
2350 originally proposed semantics for the C++11 standard, but was not part
2351 of the final standard, so it is disabled by default.  This option is
2352 deprecated, and may be removed in a future version of G++.
2354 @item -ffriend-injection
2355 @opindex ffriend-injection
2356 Inject friend functions into the enclosing namespace, so that they are
2357 visible outside the scope of the class in which they are declared.
2358 Friend functions were documented to work this way in the old Annotated
2359 C++ Reference Manual.  
2360 However, in ISO C++ a friend function that is not declared
2361 in an enclosing scope can only be found using argument dependent
2362 lookup.  GCC defaults to the standard behavior.
2364 This option is for compatibility, and may be removed in a future
2365 release of G++.
2367 @item -fno-elide-constructors
2368 @opindex fno-elide-constructors
2369 The C++ standard allows an implementation to omit creating a temporary
2370 that is only used to initialize another object of the same type.
2371 Specifying this option disables that optimization, and forces G++ to
2372 call the copy constructor in all cases.  This option also causes G++
2373 to call trivial member functions which otherwise would be expanded inline.
2375 In C++17, the compiler is required to omit these temporaries, but this
2376 option still affects trivial member functions.
2378 @item -fno-enforce-eh-specs
2379 @opindex fno-enforce-eh-specs
2380 Don't generate code to check for violation of exception specifications
2381 at run time.  This option violates the C++ standard, but may be useful
2382 for reducing code size in production builds, much like defining
2383 @code{NDEBUG}.  This does not give user code permission to throw
2384 exceptions in violation of the exception specifications; the compiler
2385 still optimizes based on the specifications, so throwing an
2386 unexpected exception results in undefined behavior at run time.
2388 @item -fextern-tls-init
2389 @itemx -fno-extern-tls-init
2390 @opindex fextern-tls-init
2391 @opindex fno-extern-tls-init
2392 The C++11 and OpenMP standards allow @code{thread_local} and
2393 @code{threadprivate} variables to have dynamic (runtime)
2394 initialization.  To support this, any use of such a variable goes
2395 through a wrapper function that performs any necessary initialization.
2396 When the use and definition of the variable are in the same
2397 translation unit, this overhead can be optimized away, but when the
2398 use is in a different translation unit there is significant overhead
2399 even if the variable doesn't actually need dynamic initialization.  If
2400 the programmer can be sure that no use of the variable in a
2401 non-defining TU needs to trigger dynamic initialization (either
2402 because the variable is statically initialized, or a use of the
2403 variable in the defining TU will be executed before any uses in
2404 another TU), they can avoid this overhead with the
2405 @option{-fno-extern-tls-init} option.
2407 On targets that support symbol aliases, the default is
2408 @option{-fextern-tls-init}.  On targets that do not support symbol
2409 aliases, the default is @option{-fno-extern-tls-init}.
2411 @item -ffor-scope
2412 @itemx -fno-for-scope
2413 @opindex ffor-scope
2414 @opindex fno-for-scope
2415 If @option{-ffor-scope} is specified, the scope of variables declared in
2416 a @i{for-init-statement} is limited to the @code{for} loop itself,
2417 as specified by the C++ standard.
2418 If @option{-fno-for-scope} is specified, the scope of variables declared in
2419 a @i{for-init-statement} extends to the end of the enclosing scope,
2420 as was the case in old versions of G++, and other (traditional)
2421 implementations of C++.
2423 If neither flag is given, the default is to follow the standard,
2424 but to allow and give a warning for old-style code that would
2425 otherwise be invalid, or have different behavior.
2427 @item -fno-gnu-keywords
2428 @opindex fno-gnu-keywords
2429 Do not recognize @code{typeof} as a keyword, so that code can use this
2430 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2431 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2432 @option{-std=c++98}, @option{-std=c++11}, etc.
2434 @item -fno-implicit-templates
2435 @opindex fno-implicit-templates
2436 Never emit code for non-inline templates that are instantiated
2437 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2438 @xref{Template Instantiation}, for more information.
2440 @item -fno-implicit-inline-templates
2441 @opindex fno-implicit-inline-templates
2442 Don't emit code for implicit instantiations of inline templates, either.
2443 The default is to handle inlines differently so that compiles with and
2444 without optimization need the same set of explicit instantiations.
2446 @item -fno-implement-inlines
2447 @opindex fno-implement-inlines
2448 To save space, do not emit out-of-line copies of inline functions
2449 controlled by @code{#pragma implementation}.  This causes linker
2450 errors if these functions are not inlined everywhere they are called.
2452 @item -fms-extensions
2453 @opindex fms-extensions
2454 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2455 int and getting a pointer to member function via non-standard syntax.
2457 @item -fnew-inheriting-ctors
2458 @opindex fnew-inheriting-ctors
2459 Enable the P0136 adjustment to the semantics of C++11 constructor
2460 inheritance.  This is part of C++17 but also considered to be a Defect
2461 Report against C++11 and C++14.  This flag is enabled by default
2462 unless @option{-fabi-version=10} or lower is specified.
2464 @item -fnew-ttp-matching
2465 @opindex fnew-ttp-matching
2466 Enable the P0522 resolution to Core issue 150, template template
2467 parameters and default arguments: this allows a template with default
2468 template arguments as an argument for a template template parameter
2469 with fewer template parameters.  This flag is enabled by default for
2470 @option{-std=c++1z}.
2472 @item -fno-nonansi-builtins
2473 @opindex fno-nonansi-builtins
2474 Disable built-in declarations of functions that are not mandated by
2475 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2476 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2478 @item -fnothrow-opt
2479 @opindex fnothrow-opt
2480 Treat a @code{throw()} exception specification as if it were a
2481 @code{noexcept} specification to reduce or eliminate the text size
2482 overhead relative to a function with no exception specification.  If
2483 the function has local variables of types with non-trivial
2484 destructors, the exception specification actually makes the
2485 function smaller because the EH cleanups for those variables can be
2486 optimized away.  The semantic effect is that an exception thrown out of
2487 a function with such an exception specification results in a call
2488 to @code{terminate} rather than @code{unexpected}.
2490 @item -fno-operator-names
2491 @opindex fno-operator-names
2492 Do not treat the operator name keywords @code{and}, @code{bitand},
2493 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2494 synonyms as keywords.
2496 @item -fno-optional-diags
2497 @opindex fno-optional-diags
2498 Disable diagnostics that the standard says a compiler does not need to
2499 issue.  Currently, the only such diagnostic issued by G++ is the one for
2500 a name having multiple meanings within a class.
2502 @item -fpermissive
2503 @opindex fpermissive
2504 Downgrade some diagnostics about nonconformant code from errors to
2505 warnings.  Thus, using @option{-fpermissive} allows some
2506 nonconforming code to compile.
2508 @item -fno-pretty-templates
2509 @opindex fno-pretty-templates
2510 When an error message refers to a specialization of a function
2511 template, the compiler normally prints the signature of the
2512 template followed by the template arguments and any typedefs or
2513 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2514 rather than @code{void f(int)}) so that it's clear which template is
2515 involved.  When an error message refers to a specialization of a class
2516 template, the compiler omits any template arguments that match
2517 the default template arguments for that template.  If either of these
2518 behaviors make it harder to understand the error message rather than
2519 easier, you can use @option{-fno-pretty-templates} to disable them.
2521 @item -frepo
2522 @opindex frepo
2523 Enable automatic template instantiation at link time.  This option also
2524 implies @option{-fno-implicit-templates}.  @xref{Template
2525 Instantiation}, for more information.
2527 @item -fno-rtti
2528 @opindex fno-rtti
2529 Disable generation of information about every class with virtual
2530 functions for use by the C++ run-time type identification features
2531 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2532 of the language, you can save some space by using this flag.  Note that
2533 exception handling uses the same information, but G++ generates it as
2534 needed. The @code{dynamic_cast} operator can still be used for casts that
2535 do not require run-time type information, i.e.@: casts to @code{void *} or to
2536 unambiguous base classes.
2538 @item -fsized-deallocation
2539 @opindex fsized-deallocation
2540 Enable the built-in global declarations
2541 @smallexample
2542 void operator delete (void *, std::size_t) noexcept;
2543 void operator delete[] (void *, std::size_t) noexcept;
2544 @end smallexample
2545 as introduced in C++14.  This is useful for user-defined replacement
2546 deallocation functions that, for example, use the size of the object
2547 to make deallocation faster.  Enabled by default under
2548 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2549 warns about places that might want to add a definition.
2551 @item -fstrict-enums
2552 @opindex fstrict-enums
2553 Allow the compiler to optimize using the assumption that a value of
2554 enumerated type can only be one of the values of the enumeration (as
2555 defined in the C++ standard; basically, a value that can be
2556 represented in the minimum number of bits needed to represent all the
2557 enumerators).  This assumption may not be valid if the program uses a
2558 cast to convert an arbitrary integer value to the enumerated type.
2560 @item -fstrong-eval-order
2561 @opindex fstrong-eval-order
2562 Evaluate member access, array subscripting, and shift expressions in
2563 left-to-right order, and evaluate assignment in right-to-left order,
2564 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2565 @option{-fstrong-eval-order=some} enables just the ordering of member
2566 access and shift expressions, and is the default without
2567 @option{-std=c++1z}.
2569 @item -ftemplate-backtrace-limit=@var{n}
2570 @opindex ftemplate-backtrace-limit
2571 Set the maximum number of template instantiation notes for a single
2572 warning or error to @var{n}.  The default value is 10.
2574 @item -ftemplate-depth=@var{n}
2575 @opindex ftemplate-depth
2576 Set the maximum instantiation depth for template classes to @var{n}.
2577 A limit on the template instantiation depth is needed to detect
2578 endless recursions during template class instantiation.  ANSI/ISO C++
2579 conforming programs must not rely on a maximum depth greater than 17
2580 (changed to 1024 in C++11).  The default value is 900, as the compiler
2581 can run out of stack space before hitting 1024 in some situations.
2583 @item -fno-threadsafe-statics
2584 @opindex fno-threadsafe-statics
2585 Do not emit the extra code to use the routines specified in the C++
2586 ABI for thread-safe initialization of local statics.  You can use this
2587 option to reduce code size slightly in code that doesn't need to be
2588 thread-safe.
2590 @item -fuse-cxa-atexit
2591 @opindex fuse-cxa-atexit
2592 Register destructors for objects with static storage duration with the
2593 @code{__cxa_atexit} function rather than the @code{atexit} function.
2594 This option is required for fully standards-compliant handling of static
2595 destructors, but only works if your C library supports
2596 @code{__cxa_atexit}.
2598 @item -fno-use-cxa-get-exception-ptr
2599 @opindex fno-use-cxa-get-exception-ptr
2600 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2601 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2602 if the runtime routine is not available.
2604 @item -fvisibility-inlines-hidden
2605 @opindex fvisibility-inlines-hidden
2606 This switch declares that the user does not attempt to compare
2607 pointers to inline functions or methods where the addresses of the two functions
2608 are taken in different shared objects.
2610 The effect of this is that GCC may, effectively, mark inline methods with
2611 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2612 appear in the export table of a DSO and do not require a PLT indirection
2613 when used within the DSO@.  Enabling this option can have a dramatic effect
2614 on load and link times of a DSO as it massively reduces the size of the
2615 dynamic export table when the library makes heavy use of templates.
2617 The behavior of this switch is not quite the same as marking the
2618 methods as hidden directly, because it does not affect static variables
2619 local to the function or cause the compiler to deduce that
2620 the function is defined in only one shared object.
2622 You may mark a method as having a visibility explicitly to negate the
2623 effect of the switch for that method.  For example, if you do want to
2624 compare pointers to a particular inline method, you might mark it as
2625 having default visibility.  Marking the enclosing class with explicit
2626 visibility has no effect.
2628 Explicitly instantiated inline methods are unaffected by this option
2629 as their linkage might otherwise cross a shared library boundary.
2630 @xref{Template Instantiation}.
2632 @item -fvisibility-ms-compat
2633 @opindex fvisibility-ms-compat
2634 This flag attempts to use visibility settings to make GCC's C++
2635 linkage model compatible with that of Microsoft Visual Studio.
2637 The flag makes these changes to GCC's linkage model:
2639 @enumerate
2640 @item
2641 It sets the default visibility to @code{hidden}, like
2642 @option{-fvisibility=hidden}.
2644 @item
2645 Types, but not their members, are not hidden by default.
2647 @item
2648 The One Definition Rule is relaxed for types without explicit
2649 visibility specifications that are defined in more than one
2650 shared object: those declarations are permitted if they are
2651 permitted when this option is not used.
2652 @end enumerate
2654 In new code it is better to use @option{-fvisibility=hidden} and
2655 export those classes that are intended to be externally visible.
2656 Unfortunately it is possible for code to rely, perhaps accidentally,
2657 on the Visual Studio behavior.
2659 Among the consequences of these changes are that static data members
2660 of the same type with the same name but defined in different shared
2661 objects are different, so changing one does not change the other;
2662 and that pointers to function members defined in different shared
2663 objects may not compare equal.  When this flag is given, it is a
2664 violation of the ODR to define types with the same name differently.
2666 @item -fno-weak
2667 @opindex fno-weak
2668 Do not use weak symbol support, even if it is provided by the linker.
2669 By default, G++ uses weak symbols if they are available.  This
2670 option exists only for testing, and should not be used by end-users;
2671 it results in inferior code and has no benefits.  This option may
2672 be removed in a future release of G++.
2674 @item -nostdinc++
2675 @opindex nostdinc++
2676 Do not search for header files in the standard directories specific to
2677 C++, but do still search the other standard directories.  (This option
2678 is used when building the C++ library.)
2679 @end table
2681 In addition, these optimization, warning, and code generation options
2682 have meanings only for C++ programs:
2684 @table @gcctabopt
2685 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2686 @opindex Wabi
2687 @opindex Wno-abi
2688 Warn when G++ it generates code that is probably not compatible with
2689 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2690 ABI with each major release, normally @option{-Wabi} will warn only if
2691 there is a check added later in a release series for an ABI issue
2692 discovered since the initial release.  @option{-Wabi} will warn about
2693 more things if an older ABI version is selected (with
2694 @option{-fabi-version=@var{n}}).
2696 @option{-Wabi} can also be used with an explicit version number to
2697 warn about compatibility with a particular @option{-fabi-version}
2698 level, e.g. @option{-Wabi=2} to warn about changes relative to
2699 @option{-fabi-version=2}.
2701 If an explicit version number is provided and
2702 @option{-fabi-compat-version} is not specified, the version number
2703 from this option is used for compatibility aliases.  If no explicit
2704 version number is provided with this option, but
2705 @option{-fabi-compat-version} is specified, that version number is
2706 used for ABI warnings.
2708 Although an effort has been made to warn about
2709 all such cases, there are probably some cases that are not warned about,
2710 even though G++ is generating incompatible code.  There may also be
2711 cases where warnings are emitted even though the code that is generated
2712 is compatible.
2714 You should rewrite your code to avoid these warnings if you are
2715 concerned about the fact that code generated by G++ may not be binary
2716 compatible with code generated by other compilers.
2718 Known incompatibilities in @option{-fabi-version=2} (which was the
2719 default from GCC 3.4 to 4.9) include:
2721 @itemize @bullet
2723 @item
2724 A template with a non-type template parameter of reference type was
2725 mangled incorrectly:
2726 @smallexample
2727 extern int N;
2728 template <int &> struct S @{@};
2729 void n (S<N>) @{2@}
2730 @end smallexample
2732 This was fixed in @option{-fabi-version=3}.
2734 @item
2735 SIMD vector types declared using @code{__attribute ((vector_size))} were
2736 mangled in a non-standard way that does not allow for overloading of
2737 functions taking vectors of different sizes.
2739 The mangling was changed in @option{-fabi-version=4}.
2741 @item
2742 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2743 qualifiers, and @code{decltype} of a plain declaration was folded away.
2745 These mangling issues were fixed in @option{-fabi-version=5}.
2747 @item
2748 Scoped enumerators passed as arguments to a variadic function are
2749 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2750 On most targets this does not actually affect the parameter passing
2751 ABI, as there is no way to pass an argument smaller than @code{int}.
2753 Also, the ABI changed the mangling of template argument packs,
2754 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2755 a class scope function used as a template argument.
2757 These issues were corrected in @option{-fabi-version=6}.
2759 @item
2760 Lambdas in default argument scope were mangled incorrectly, and the
2761 ABI changed the mangling of @code{nullptr_t}.
2763 These issues were corrected in @option{-fabi-version=7}.
2765 @item
2766 When mangling a function type with function-cv-qualifiers, the
2767 un-qualified function type was incorrectly treated as a substitution
2768 candidate.
2770 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2772 @item
2773 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2774 unaligned accesses.  Note that this did not affect the ABI of a
2775 function with a @code{nullptr_t} parameter, as parameters have a
2776 minimum alignment.
2778 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2780 @item
2781 Target-specific attributes that affect the identity of a type, such as
2782 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2783 did not affect the mangled name, leading to name collisions when
2784 function pointers were used as template arguments.
2786 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2788 @end itemize
2790 It also warns about psABI-related changes.  The known psABI changes at this
2791 point include:
2793 @itemize @bullet
2795 @item
2796 For SysV/x86-64, unions with @code{long double} members are 
2797 passed in memory as specified in psABI.  For example:
2799 @smallexample
2800 union U @{
2801   long double ld;
2802   int i;
2804 @end smallexample
2806 @noindent
2807 @code{union U} is always passed in memory.
2809 @end itemize
2811 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2812 @opindex Wabi-tag
2813 @opindex -Wabi-tag
2814 Warn when a type with an ABI tag is used in a context that does not
2815 have that ABI tag.  See @ref{C++ Attributes} for more information
2816 about ABI tags.
2818 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2819 @opindex Wctor-dtor-privacy
2820 @opindex Wno-ctor-dtor-privacy
2821 Warn when a class seems unusable because all the constructors or
2822 destructors in that class are private, and it has neither friends nor
2823 public static member functions.  Also warn if there are no non-private
2824 methods, and there's at least one private member function that isn't
2825 a constructor or destructor.
2827 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2828 @opindex Wdelete-non-virtual-dtor
2829 @opindex Wno-delete-non-virtual-dtor
2830 Warn when @code{delete} is used to destroy an instance of a class that
2831 has virtual functions and non-virtual destructor. It is unsafe to delete
2832 an instance of a derived class through a pointer to a base class if the
2833 base class does not have a virtual destructor.  This warning is enabled
2834 by @option{-Wall}.
2836 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2837 @opindex Wliteral-suffix
2838 @opindex Wno-literal-suffix
2839 Warn when a string or character literal is followed by a ud-suffix which does
2840 not begin with an underscore.  As a conforming extension, GCC treats such
2841 suffixes as separate preprocessing tokens in order to maintain backwards
2842 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2843 For example:
2845 @smallexample
2846 #define __STDC_FORMAT_MACROS
2847 #include <inttypes.h>
2848 #include <stdio.h>
2850 int main() @{
2851   int64_t i64 = 123;
2852   printf("My int64: %" PRId64"\n", i64);
2854 @end smallexample
2856 In this case, @code{PRId64} is treated as a separate preprocessing token.
2858 Additionally, warn when a user-defined literal operator is declared with
2859 a literal suffix identifier that doesn't begin with an underscore. Literal
2860 suffix identifiers that don't begin with an underscore are reserved for
2861 future standardization.
2863 This warning is enabled by default.
2865 @item -Wlto-type-mismatch
2866 @opindex Wlto-type-mismatch
2867 @opindex Wno-lto-type-mismatch
2869 During the link-time optimization warn about type mismatches in
2870 global declarations from different compilation units.
2871 Requires @option{-flto} to be enabled.  Enabled by default.
2873 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2874 @opindex Wnarrowing
2875 @opindex Wno-narrowing
2876 For C++11 and later standards, narrowing conversions are diagnosed by default,
2877 as required by the standard.  A narrowing conversion from a constant produces
2878 an error, and a narrowing conversion from a non-constant produces a warning,
2879 but @option{-Wno-narrowing} suppresses the diagnostic.
2880 Note that this does not affect the meaning of well-formed code;
2881 narrowing conversions are still considered ill-formed in SFINAE contexts.
2883 With @option{-Wnarrowing} in C++98, warn when a narrowing
2884 conversion prohibited by C++11 occurs within
2885 @samp{@{ @}}, e.g.
2887 @smallexample
2888 int i = @{ 2.2 @}; // error: narrowing from double to int
2889 @end smallexample
2891 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2893 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2894 @opindex Wnoexcept
2895 @opindex Wno-noexcept
2896 Warn when a noexcept-expression evaluates to false because of a call
2897 to a function that does not have a non-throwing exception
2898 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2899 the compiler to never throw an exception.
2901 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2902 @opindex Wnoexcept-type
2903 @opindex Wno-noexcept-type
2904 Warn if the C++1z feature making @code{noexcept} part of a function
2905 type changes the mangled name of a symbol relative to C++14.  Enabled
2906 by @option{-Wabi} and @option{-Wc++1z-compat}.
2908 @smallexample
2909 template <class T> void f(T t) @{ t(); @};
2910 void g() noexcept;
2911 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2912 @end smallexample
2915 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2916 @opindex Wnon-virtual-dtor
2917 @opindex Wno-non-virtual-dtor
2918 Warn when a class has virtual functions and an accessible non-virtual
2919 destructor itself or in an accessible polymorphic base class, in which
2920 case it is possible but unsafe to delete an instance of a derived
2921 class through a pointer to the class itself or base class.  This
2922 warning is automatically enabled if @option{-Weffc++} is specified.
2924 @item -Wregister @r{(C++ and Objective-C++ only)}
2925 @opindex Wregister
2926 @opindex Wno-register
2927 Warn on uses of the @code{register} storage class specifier, except
2928 when it is part of the GNU @ref{Explicit Register Variables} extension.
2929 The use of the @code{register} keyword as storage class specifier has
2930 been deprecated in C++11 and removed in C++17.
2931 Enabled by default with @option{-std=c++1z}.
2933 @item -Wreorder @r{(C++ and Objective-C++ only)}
2934 @opindex Wreorder
2935 @opindex Wno-reorder
2936 @cindex reordering, warning
2937 @cindex warning for reordering of member initializers
2938 Warn when the order of member initializers given in the code does not
2939 match the order in which they must be executed.  For instance:
2941 @smallexample
2942 struct A @{
2943   int i;
2944   int j;
2945   A(): j (0), i (1) @{ @}
2947 @end smallexample
2949 @noindent
2950 The compiler rearranges the member initializers for @code{i}
2951 and @code{j} to match the declaration order of the members, emitting
2952 a warning to that effect.  This warning is enabled by @option{-Wall}.
2954 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2955 @opindex fext-numeric-literals
2956 @opindex fno-ext-numeric-literals
2957 Accept imaginary, fixed-point, or machine-defined
2958 literal number suffixes as GNU extensions.
2959 When this option is turned off these suffixes are treated
2960 as C++11 user-defined literal numeric suffixes.
2961 This is on by default for all pre-C++11 dialects and all GNU dialects:
2962 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2963 @option{-std=gnu++14}.
2964 This option is off by default
2965 for ISO C++11 onwards (@option{-std=c++11}, ...).
2966 @end table
2968 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2970 @table @gcctabopt
2971 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2972 @opindex Weffc++
2973 @opindex Wno-effc++
2974 Warn about violations of the following style guidelines from Scott Meyers'
2975 @cite{Effective C++} series of books:
2977 @itemize @bullet
2978 @item
2979 Define a copy constructor and an assignment operator for classes
2980 with dynamically-allocated memory.
2982 @item
2983 Prefer initialization to assignment in constructors.
2985 @item
2986 Have @code{operator=} return a reference to @code{*this}.
2988 @item
2989 Don't try to return a reference when you must return an object.
2991 @item
2992 Distinguish between prefix and postfix forms of increment and
2993 decrement operators.
2995 @item
2996 Never overload @code{&&}, @code{||}, or @code{,}.
2998 @end itemize
3000 This option also enables @option{-Wnon-virtual-dtor}, which is also
3001 one of the effective C++ recommendations.  However, the check is
3002 extended to warn about the lack of virtual destructor in accessible
3003 non-polymorphic bases classes too.
3005 When selecting this option, be aware that the standard library
3006 headers do not obey all of these guidelines; use @samp{grep -v}
3007 to filter out those warnings.
3009 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3010 @opindex Wstrict-null-sentinel
3011 @opindex Wno-strict-null-sentinel
3012 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3013 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3014 to @code{__null}.  Although it is a null pointer constant rather than a
3015 null pointer, it is guaranteed to be of the same size as a pointer.
3016 But this use is not portable across different compilers.
3018 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3019 @opindex Wno-non-template-friend
3020 @opindex Wnon-template-friend
3021 Disable warnings when non-template friend functions are declared
3022 within a template.  In very old versions of GCC that predate implementation
3023 of the ISO standard, declarations such as 
3024 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3025 could be interpreted as a particular specialization of a template
3026 function; the warning exists to diagnose compatibility problems, 
3027 and is enabled by default.
3029 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3030 @opindex Wold-style-cast
3031 @opindex Wno-old-style-cast
3032 Warn if an old-style (C-style) cast to a non-void type is used within
3033 a C++ program.  The new-style casts (@code{dynamic_cast},
3034 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3035 less vulnerable to unintended effects and much easier to search for.
3037 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3038 @opindex Woverloaded-virtual
3039 @opindex Wno-overloaded-virtual
3040 @cindex overloaded virtual function, warning
3041 @cindex warning for overloaded virtual function
3042 Warn when a function declaration hides virtual functions from a
3043 base class.  For example, in:
3045 @smallexample
3046 struct A @{
3047   virtual void f();
3050 struct B: public A @{
3051   void f(int);
3053 @end smallexample
3055 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3056 like:
3058 @smallexample
3059 B* b;
3060 b->f();
3061 @end smallexample
3063 @noindent
3064 fails to compile.
3066 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3067 @opindex Wno-pmf-conversions
3068 @opindex Wpmf-conversions
3069 Disable the diagnostic for converting a bound pointer to member function
3070 to a plain pointer.
3072 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3073 @opindex Wsign-promo
3074 @opindex Wno-sign-promo
3075 Warn when overload resolution chooses a promotion from unsigned or
3076 enumerated type to a signed type, over a conversion to an unsigned type of
3077 the same size.  Previous versions of G++ tried to preserve
3078 unsignedness, but the standard mandates the current behavior.
3080 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3081 @opindex Wtemplates
3082 Warn when a primary template declaration is encountered.  Some coding
3083 rules disallow templates, and this may be used to enforce that rule.
3084 The warning is inactive inside a system header file, such as the STL, so
3085 one can still use the STL.  One may also instantiate or specialize
3086 templates.
3088 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3089 @opindex Wmultiple-inheritance
3090 Warn when a class is defined with multiple direct base classes.  Some
3091 coding rules disallow multiple inheritance, and this may be used to
3092 enforce that rule.  The warning is inactive inside a system header file,
3093 such as the STL, so one can still use the STL.  One may also define
3094 classes that indirectly use multiple inheritance.
3096 @item -Wvirtual-inheritance
3097 @opindex Wvirtual-inheritance
3098 Warn when a class is defined with a virtual direct base class.  Some
3099 coding rules disallow multiple inheritance, and this may be used to
3100 enforce that rule.  The warning is inactive inside a system header file,
3101 such as the STL, so one can still use the STL.  One may also define
3102 classes that indirectly use virtual inheritance.
3104 @item -Wnamespaces
3105 @opindex Wnamespaces
3106 Warn when a namespace definition is opened.  Some coding rules disallow
3107 namespaces, and this may be used to enforce that rule.  The warning is
3108 inactive inside a system header file, such as the STL, so one can still
3109 use the STL.  One may also use using directives and qualified names.
3111 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3112 @opindex Wterminate
3113 @opindex Wno-terminate
3114 Disable the warning about a throw-expression that will immediately
3115 result in a call to @code{terminate}.
3116 @end table
3118 @node Objective-C and Objective-C++ Dialect Options
3119 @section Options Controlling Objective-C and Objective-C++ Dialects
3121 @cindex compiler options, Objective-C and Objective-C++
3122 @cindex Objective-C and Objective-C++ options, command-line
3123 @cindex options, Objective-C and Objective-C++
3124 (NOTE: This manual does not describe the Objective-C and Objective-C++
3125 languages themselves.  @xref{Standards,,Language Standards
3126 Supported by GCC}, for references.)
3128 This section describes the command-line options that are only meaningful
3129 for Objective-C and Objective-C++ programs.  You can also use most of
3130 the language-independent GNU compiler options.
3131 For example, you might compile a file @file{some_class.m} like this:
3133 @smallexample
3134 gcc -g -fgnu-runtime -O -c some_class.m
3135 @end smallexample
3137 @noindent
3138 In this example, @option{-fgnu-runtime} is an option meant only for
3139 Objective-C and Objective-C++ programs; you can use the other options with
3140 any language supported by GCC@.
3142 Note that since Objective-C is an extension of the C language, Objective-C
3143 compilations may also use options specific to the C front-end (e.g.,
3144 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3145 C++-specific options (e.g., @option{-Wabi}).
3147 Here is a list of options that are @emph{only} for compiling Objective-C
3148 and Objective-C++ programs:
3150 @table @gcctabopt
3151 @item -fconstant-string-class=@var{class-name}
3152 @opindex fconstant-string-class
3153 Use @var{class-name} as the name of the class to instantiate for each
3154 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3155 class name is @code{NXConstantString} if the GNU runtime is being used, and
3156 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3157 @option{-fconstant-cfstrings} option, if also present, overrides the
3158 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3159 to be laid out as constant CoreFoundation strings.
3161 @item -fgnu-runtime
3162 @opindex fgnu-runtime
3163 Generate object code compatible with the standard GNU Objective-C
3164 runtime.  This is the default for most types of systems.
3166 @item -fnext-runtime
3167 @opindex fnext-runtime
3168 Generate output compatible with the NeXT runtime.  This is the default
3169 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3170 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3171 used.
3173 @item -fno-nil-receivers
3174 @opindex fno-nil-receivers
3175 Assume that all Objective-C message dispatches (@code{[receiver
3176 message:arg]}) in this translation unit ensure that the receiver is
3177 not @code{nil}.  This allows for more efficient entry points in the
3178 runtime to be used.  This option is only available in conjunction with
3179 the NeXT runtime and ABI version 0 or 1.
3181 @item -fobjc-abi-version=@var{n}
3182 @opindex fobjc-abi-version
3183 Use version @var{n} of the Objective-C ABI for the selected runtime.
3184 This option is currently supported only for the NeXT runtime.  In that
3185 case, Version 0 is the traditional (32-bit) ABI without support for
3186 properties and other Objective-C 2.0 additions.  Version 1 is the
3187 traditional (32-bit) ABI with support for properties and other
3188 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3189 nothing is specified, the default is Version 0 on 32-bit target
3190 machines, and Version 2 on 64-bit target machines.
3192 @item -fobjc-call-cxx-cdtors
3193 @opindex fobjc-call-cxx-cdtors
3194 For each Objective-C class, check if any of its instance variables is a
3195 C++ object with a non-trivial default constructor.  If so, synthesize a
3196 special @code{- (id) .cxx_construct} instance method which runs
3197 non-trivial default constructors on any such instance variables, in order,
3198 and then return @code{self}.  Similarly, check if any instance variable
3199 is a C++ object with a non-trivial destructor, and if so, synthesize a
3200 special @code{- (void) .cxx_destruct} method which runs
3201 all such default destructors, in reverse order.
3203 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3204 methods thusly generated only operate on instance variables
3205 declared in the current Objective-C class, and not those inherited
3206 from superclasses.  It is the responsibility of the Objective-C
3207 runtime to invoke all such methods in an object's inheritance
3208 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3209 by the runtime immediately after a new object instance is allocated;
3210 the @code{- (void) .cxx_destruct} methods are invoked immediately
3211 before the runtime deallocates an object instance.
3213 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3214 support for invoking the @code{- (id) .cxx_construct} and
3215 @code{- (void) .cxx_destruct} methods.
3217 @item -fobjc-direct-dispatch
3218 @opindex fobjc-direct-dispatch
3219 Allow fast jumps to the message dispatcher.  On Darwin this is
3220 accomplished via the comm page.
3222 @item -fobjc-exceptions
3223 @opindex fobjc-exceptions
3224 Enable syntactic support for structured exception handling in
3225 Objective-C, similar to what is offered by C++.  This option
3226 is required to use the Objective-C keywords @code{@@try},
3227 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3228 @code{@@synchronized}.  This option is available with both the GNU
3229 runtime and the NeXT runtime (but not available in conjunction with
3230 the NeXT runtime on Mac OS X 10.2 and earlier).
3232 @item -fobjc-gc
3233 @opindex fobjc-gc
3234 Enable garbage collection (GC) in Objective-C and Objective-C++
3235 programs.  This option is only available with the NeXT runtime; the
3236 GNU runtime has a different garbage collection implementation that
3237 does not require special compiler flags.
3239 @item -fobjc-nilcheck
3240 @opindex fobjc-nilcheck
3241 For the NeXT runtime with version 2 of the ABI, check for a nil
3242 receiver in method invocations before doing the actual method call.
3243 This is the default and can be disabled using
3244 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3245 checked for nil in this way no matter what this flag is set to.
3246 Currently this flag does nothing when the GNU runtime, or an older
3247 version of the NeXT runtime ABI, is used.
3249 @item -fobjc-std=objc1
3250 @opindex fobjc-std
3251 Conform to the language syntax of Objective-C 1.0, the language
3252 recognized by GCC 4.0.  This only affects the Objective-C additions to
3253 the C/C++ language; it does not affect conformance to C/C++ standards,
3254 which is controlled by the separate C/C++ dialect option flags.  When
3255 this option is used with the Objective-C or Objective-C++ compiler,
3256 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3257 This is useful if you need to make sure that your Objective-C code can
3258 be compiled with older versions of GCC@.
3260 @item -freplace-objc-classes
3261 @opindex freplace-objc-classes
3262 Emit a special marker instructing @command{ld(1)} not to statically link in
3263 the resulting object file, and allow @command{dyld(1)} to load it in at
3264 run time instead.  This is used in conjunction with the Fix-and-Continue
3265 debugging mode, where the object file in question may be recompiled and
3266 dynamically reloaded in the course of program execution, without the need
3267 to restart the program itself.  Currently, Fix-and-Continue functionality
3268 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3269 and later.
3271 @item -fzero-link
3272 @opindex fzero-link
3273 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3274 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3275 compile time) with static class references that get initialized at load time,
3276 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3277 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3278 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3279 for individual class implementations to be modified during program execution.
3280 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3281 regardless of command-line options.
3283 @item -fno-local-ivars
3284 @opindex fno-local-ivars
3285 @opindex flocal-ivars
3286 By default instance variables in Objective-C can be accessed as if
3287 they were local variables from within the methods of the class they're
3288 declared in.  This can lead to shadowing between instance variables
3289 and other variables declared either locally inside a class method or
3290 globally with the same name.  Specifying the @option{-fno-local-ivars}
3291 flag disables this behavior thus avoiding variable shadowing issues.
3293 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3294 @opindex fivar-visibility
3295 Set the default instance variable visibility to the specified option
3296 so that instance variables declared outside the scope of any access
3297 modifier directives default to the specified visibility.
3299 @item -gen-decls
3300 @opindex gen-decls
3301 Dump interface declarations for all classes seen in the source file to a
3302 file named @file{@var{sourcename}.decl}.
3304 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3305 @opindex Wassign-intercept
3306 @opindex Wno-assign-intercept
3307 Warn whenever an Objective-C assignment is being intercepted by the
3308 garbage collector.
3310 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3311 @opindex Wno-protocol
3312 @opindex Wprotocol
3313 If a class is declared to implement a protocol, a warning is issued for
3314 every method in the protocol that is not implemented by the class.  The
3315 default behavior is to issue a warning for every method not explicitly
3316 implemented in the class, even if a method implementation is inherited
3317 from the superclass.  If you use the @option{-Wno-protocol} option, then
3318 methods inherited from the superclass are considered to be implemented,
3319 and no warning is issued for them.
3321 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3322 @opindex Wselector
3323 @opindex Wno-selector
3324 Warn if multiple methods of different types for the same selector are
3325 found during compilation.  The check is performed on the list of methods
3326 in the final stage of compilation.  Additionally, a check is performed
3327 for each selector appearing in a @code{@@selector(@dots{})}
3328 expression, and a corresponding method for that selector has been found
3329 during compilation.  Because these checks scan the method table only at
3330 the end of compilation, these warnings are not produced if the final
3331 stage of compilation is not reached, for example because an error is
3332 found during compilation, or because the @option{-fsyntax-only} option is
3333 being used.
3335 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3336 @opindex Wstrict-selector-match
3337 @opindex Wno-strict-selector-match
3338 Warn if multiple methods with differing argument and/or return types are
3339 found for a given selector when attempting to send a message using this
3340 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3341 is off (which is the default behavior), the compiler omits such warnings
3342 if any differences found are confined to types that share the same size
3343 and alignment.
3345 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3346 @opindex Wundeclared-selector
3347 @opindex Wno-undeclared-selector
3348 Warn if a @code{@@selector(@dots{})} expression referring to an
3349 undeclared selector is found.  A selector is considered undeclared if no
3350 method with that name has been declared before the
3351 @code{@@selector(@dots{})} expression, either explicitly in an
3352 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3353 an @code{@@implementation} section.  This option always performs its
3354 checks as soon as a @code{@@selector(@dots{})} expression is found,
3355 while @option{-Wselector} only performs its checks in the final stage of
3356 compilation.  This also enforces the coding style convention
3357 that methods and selectors must be declared before being used.
3359 @item -print-objc-runtime-info
3360 @opindex print-objc-runtime-info
3361 Generate C header describing the largest structure that is passed by
3362 value, if any.
3364 @end table
3366 @node Diagnostic Message Formatting Options
3367 @section Options to Control Diagnostic Messages Formatting
3368 @cindex options to control diagnostics formatting
3369 @cindex diagnostic messages
3370 @cindex message formatting
3372 Traditionally, diagnostic messages have been formatted irrespective of
3373 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3374 options described below
3375 to control the formatting algorithm for diagnostic messages, 
3376 e.g.@: how many characters per line, how often source location
3377 information should be reported.  Note that some language front ends may not
3378 honor these options.
3380 @table @gcctabopt
3381 @item -fmessage-length=@var{n}
3382 @opindex fmessage-length
3383 Try to format error messages so that they fit on lines of about
3384 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3385 done; each error message appears on a single line.  This is the
3386 default for all front ends.
3388 @item -fdiagnostics-show-location=once
3389 @opindex fdiagnostics-show-location
3390 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3391 reporter to emit source location information @emph{once}; that is, in
3392 case the message is too long to fit on a single physical line and has to
3393 be wrapped, the source location won't be emitted (as prefix) again,
3394 over and over, in subsequent continuation lines.  This is the default
3395 behavior.
3397 @item -fdiagnostics-show-location=every-line
3398 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3399 messages reporter to emit the same source location information (as
3400 prefix) for physical lines that result from the process of breaking
3401 a message which is too long to fit on a single line.
3403 @item -fdiagnostics-color[=@var{WHEN}]
3404 @itemx -fno-diagnostics-color
3405 @opindex fdiagnostics-color
3406 @cindex highlight, color
3407 @vindex GCC_COLORS @r{environment variable}
3408 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3409 or @samp{auto}.  The default depends on how the compiler has been configured,
3410 it can be any of the above @var{WHEN} options or also @samp{never}
3411 if @env{GCC_COLORS} environment variable isn't present in the environment,
3412 and @samp{auto} otherwise.
3413 @samp{auto} means to use color only when the standard error is a terminal.
3414 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3415 aliases for @option{-fdiagnostics-color=always} and
3416 @option{-fdiagnostics-color=never}, respectively.
3418 The colors are defined by the environment variable @env{GCC_COLORS}.
3419 Its value is a colon-separated list of capabilities and Select Graphic
3420 Rendition (SGR) substrings. SGR commands are interpreted by the
3421 terminal or terminal emulator.  (See the section in the documentation
3422 of your text terminal for permitted values and their meanings as
3423 character attributes.)  These substring values are integers in decimal
3424 representation and can be concatenated with semicolons.
3425 Common values to concatenate include
3426 @samp{1} for bold,
3427 @samp{4} for underline,
3428 @samp{5} for blink,
3429 @samp{7} for inverse,
3430 @samp{39} for default foreground color,
3431 @samp{30} to @samp{37} for foreground colors,
3432 @samp{90} to @samp{97} for 16-color mode foreground colors,
3433 @samp{38;5;0} to @samp{38;5;255}
3434 for 88-color and 256-color modes foreground colors,
3435 @samp{49} for default background color,
3436 @samp{40} to @samp{47} for background colors,
3437 @samp{100} to @samp{107} for 16-color mode background colors,
3438 and @samp{48;5;0} to @samp{48;5;255}
3439 for 88-color and 256-color modes background colors.
3441 The default @env{GCC_COLORS} is
3442 @smallexample
3443 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3444 quote=01:fixit-insert=32:fixit-delete=31:\
3445 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
3446 @end smallexample
3447 @noindent
3448 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3449 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3450 @samp{01} is bold, and @samp{31} is red.
3451 Setting @env{GCC_COLORS} to the empty string disables colors.
3452 Supported capabilities are as follows.
3454 @table @code
3455 @item error=
3456 @vindex error GCC_COLORS @r{capability}
3457 SGR substring for error: markers.
3459 @item warning=
3460 @vindex warning GCC_COLORS @r{capability}
3461 SGR substring for warning: markers.
3463 @item note=
3464 @vindex note GCC_COLORS @r{capability}
3465 SGR substring for note: markers.
3467 @item range1=
3468 @vindex range1 GCC_COLORS @r{capability}
3469 SGR substring for first additional range.
3471 @item range2=
3472 @vindex range2 GCC_COLORS @r{capability}
3473 SGR substring for second additional range.
3475 @item locus=
3476 @vindex locus GCC_COLORS @r{capability}
3477 SGR substring for location information, @samp{file:line} or
3478 @samp{file:line:column} etc.
3480 @item quote=
3481 @vindex quote GCC_COLORS @r{capability}
3482 SGR substring for information printed within quotes.
3484 @item fixit-insert=
3485 @vindex fixit-insert GCC_COLORS @r{capability}
3486 SGR substring for fix-it hints suggesting text to
3487 be inserted or replaced.
3489 @item fixit-delete=
3490 @vindex fixit-delete GCC_COLORS @r{capability}
3491 SGR substring for fix-it hints suggesting text to
3492 be deleted.
3494 @item diff-filename=
3495 @vindex diff-filename GCC_COLORS @r{capability}
3496 SGR substring for filename headers within generated patches.
3498 @item diff-hunk=
3499 @vindex diff-hunk GCC_COLORS @r{capability}
3500 SGR substring for the starts of hunks within generated patches.
3502 @item diff-delete=
3503 @vindex diff-delete GCC_COLORS @r{capability}
3504 SGR substring for deleted lines within generated patches.
3506 @item diff-insert=
3507 @vindex diff-insert GCC_COLORS @r{capability}
3508 SGR substring for inserted lines within generated patches.
3509 @end table
3511 @item -fno-diagnostics-show-option
3512 @opindex fno-diagnostics-show-option
3513 @opindex fdiagnostics-show-option
3514 By default, each diagnostic emitted includes text indicating the
3515 command-line option that directly controls the diagnostic (if such an
3516 option is known to the diagnostic machinery).  Specifying the
3517 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3519 @item -fno-diagnostics-show-caret
3520 @opindex fno-diagnostics-show-caret
3521 @opindex fdiagnostics-show-caret
3522 By default, each diagnostic emitted includes the original source line
3523 and a caret @samp{^} indicating the column.  This option suppresses this
3524 information.  The source line is truncated to @var{n} characters, if
3525 the @option{-fmessage-length=n} option is given.  When the output is done
3526 to the terminal, the width is limited to the width given by the
3527 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3529 @item -fdiagnostics-parseable-fixits
3530 @opindex fdiagnostics-parseable-fixits
3531 Emit fix-it hints in a machine-parseable format, suitable for consumption
3532 by IDEs.  For each fix-it, a line will be printed after the relevant
3533 diagnostic, starting with the string ``fix-it:''.  For example:
3535 @smallexample
3536 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3537 @end smallexample
3539 The location is expressed as a half-open range, expressed as a count of
3540 bytes, starting at byte 1 for the initial column.  In the above example,
3541 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3542 given string:
3544 @smallexample
3545 00000000011111111112222222222
3546 12345678901234567890123456789
3547   gtk_widget_showall (dlg);
3548   ^^^^^^^^^^^^^^^^^^
3549   gtk_widget_show_all
3550 @end smallexample
3552 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3553 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3554 (e.g. vertical tab as ``\013'').
3556 An empty replacement string indicates that the given range is to be removed.
3557 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3558 be inserted at the given position.
3560 @item -fdiagnostics-generate-patch
3561 @opindex fdiagnostics-generate-patch
3562 Print fix-it hints to stderr in unified diff format, after any diagnostics
3563 are printed.  For example:
3565 @smallexample
3566 --- test.c
3567 +++ test.c
3568 @@ -42,5 +42,5 @@
3570  void show_cb(GtkDialog *dlg)
3571  @{
3572 -  gtk_widget_showall(dlg);
3573 +  gtk_widget_show_all(dlg);
3574  @}
3576 @end smallexample
3578 The diff may or may not be colorized, following the same rules
3579 as for diagnostics (see @option{-fdiagnostics-color}).
3581 @item -fno-show-column
3582 @opindex fno-show-column
3583 Do not print column numbers in diagnostics.  This may be necessary if
3584 diagnostics are being scanned by a program that does not understand the
3585 column numbers, such as @command{dejagnu}.
3587 @end table
3589 @node Warning Options
3590 @section Options to Request or Suppress Warnings
3591 @cindex options to control warnings
3592 @cindex warning messages
3593 @cindex messages, warning
3594 @cindex suppressing warnings
3596 Warnings are diagnostic messages that report constructions that
3597 are not inherently erroneous but that are risky or suggest there
3598 may have been an error.
3600 The following language-independent options do not enable specific
3601 warnings but control the kinds of diagnostics produced by GCC@.
3603 @table @gcctabopt
3604 @cindex syntax checking
3605 @item -fsyntax-only
3606 @opindex fsyntax-only
3607 Check the code for syntax errors, but don't do anything beyond that.
3609 @item -fmax-errors=@var{n}
3610 @opindex fmax-errors
3611 Limits the maximum number of error messages to @var{n}, at which point
3612 GCC bails out rather than attempting to continue processing the source
3613 code.  If @var{n} is 0 (the default), there is no limit on the number
3614 of error messages produced.  If @option{-Wfatal-errors} is also
3615 specified, then @option{-Wfatal-errors} takes precedence over this
3616 option.
3618 @item -w
3619 @opindex w
3620 Inhibit all warning messages.
3622 @item -Werror
3623 @opindex Werror
3624 @opindex Wno-error
3625 Make all warnings into errors.
3627 @item -Werror=
3628 @opindex Werror=
3629 @opindex Wno-error=
3630 Make the specified warning into an error.  The specifier for a warning
3631 is appended; for example @option{-Werror=switch} turns the warnings
3632 controlled by @option{-Wswitch} into errors.  This switch takes a
3633 negative form, to be used to negate @option{-Werror} for specific
3634 warnings; for example @option{-Wno-error=switch} makes
3635 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3636 is in effect.
3638 The warning message for each controllable warning includes the
3639 option that controls the warning.  That option can then be used with
3640 @option{-Werror=} and @option{-Wno-error=} as described above.
3641 (Printing of the option in the warning message can be disabled using the
3642 @option{-fno-diagnostics-show-option} flag.)
3644 Note that specifying @option{-Werror=}@var{foo} automatically implies
3645 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3646 imply anything.
3648 @item -Wfatal-errors
3649 @opindex Wfatal-errors
3650 @opindex Wno-fatal-errors
3651 This option causes the compiler to abort compilation on the first error
3652 occurred rather than trying to keep going and printing further error
3653 messages.
3655 @end table
3657 You can request many specific warnings with options beginning with
3658 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3659 implicit declarations.  Each of these specific warning options also
3660 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3661 example, @option{-Wno-implicit}.  This manual lists only one of the
3662 two forms, whichever is not the default.  For further
3663 language-specific options also refer to @ref{C++ Dialect Options} and
3664 @ref{Objective-C and Objective-C++ Dialect Options}.
3666 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3667 options, such as @option{-Wunused}, which may turn on further options,
3668 such as @option{-Wunused-value}. The combined effect of positive and
3669 negative forms is that more specific options have priority over less
3670 specific ones, independently of their position in the command-line. For
3671 options of the same specificity, the last one takes effect. Options
3672 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3673 as if they appeared at the end of the command-line.
3675 When an unrecognized warning option is requested (e.g.,
3676 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3677 that the option is not recognized.  However, if the @option{-Wno-} form
3678 is used, the behavior is slightly different: no diagnostic is
3679 produced for @option{-Wno-unknown-warning} unless other diagnostics
3680 are being produced.  This allows the use of new @option{-Wno-} options
3681 with old compilers, but if something goes wrong, the compiler
3682 warns that an unrecognized option is present.
3684 @table @gcctabopt
3685 @item -Wpedantic
3686 @itemx -pedantic
3687 @opindex pedantic
3688 @opindex Wpedantic
3689 Issue all the warnings demanded by strict ISO C and ISO C++;
3690 reject all programs that use forbidden extensions, and some other
3691 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3692 version of the ISO C standard specified by any @option{-std} option used.
3694 Valid ISO C and ISO C++ programs should compile properly with or without
3695 this option (though a rare few require @option{-ansi} or a
3696 @option{-std} option specifying the required version of ISO C)@.  However,
3697 without this option, certain GNU extensions and traditional C and C++
3698 features are supported as well.  With this option, they are rejected.
3700 @option{-Wpedantic} does not cause warning messages for use of the
3701 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3702 warnings are also disabled in the expression that follows
3703 @code{__extension__}.  However, only system header files should use
3704 these escape routes; application programs should avoid them.
3705 @xref{Alternate Keywords}.
3707 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3708 C conformance.  They soon find that it does not do quite what they want:
3709 it finds some non-ISO practices, but not all---only those for which
3710 ISO C @emph{requires} a diagnostic, and some others for which
3711 diagnostics have been added.
3713 A feature to report any failure to conform to ISO C might be useful in
3714 some instances, but would require considerable additional work and would
3715 be quite different from @option{-Wpedantic}.  We don't have plans to
3716 support such a feature in the near future.
3718 Where the standard specified with @option{-std} represents a GNU
3719 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3720 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3721 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3722 where they are required by the base standard.  (It does not make sense
3723 for such warnings to be given only for features not in the specified GNU
3724 C dialect, since by definition the GNU dialects of C include all
3725 features the compiler supports with the given option, and there would be
3726 nothing to warn about.)
3728 @item -pedantic-errors
3729 @opindex pedantic-errors
3730 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3731 requires a diagnostic, in some cases where there is undefined behavior
3732 at compile-time and in some other cases that do not prevent compilation
3733 of programs that are valid according to the standard. This is not
3734 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3735 by this option and not enabled by the latter and vice versa.
3737 @item -Wall
3738 @opindex Wall
3739 @opindex Wno-all
3740 This enables all the warnings about constructions that some users
3741 consider questionable, and that are easy to avoid (or modify to
3742 prevent the warning), even in conjunction with macros.  This also
3743 enables some language-specific warnings described in @ref{C++ Dialect
3744 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3746 @option{-Wall} turns on the following warning flags:
3748 @gccoptlist{-Waddress   @gol
3749 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3750 -Wbool-compare  @gol
3751 -Wbool-operation  @gol
3752 -Wc++11-compat  -Wc++14-compat  @gol
3753 -Wchar-subscripts  @gol
3754 -Wcomment  @gol
3755 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3756 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3757 -Wformat   @gol
3758 -Wint-in-bool-context  @gol
3759 -Wimplicit @r{(C and Objective-C only)} @gol
3760 -Wimplicit-int @r{(C and Objective-C only)} @gol
3761 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3762 -Winit-self @r{(only for C++)} @gol
3763 -Wlogical-not-parentheses @gol
3764 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3765 -Wmaybe-uninitialized @gol
3766 -Wmemset-elt-size @gol
3767 -Wmemset-transposed-args @gol
3768 -Wmisleading-indentation @r{(only for C/C++)} @gol
3769 -Wmissing-braces @r{(only for C/ObjC)} @gol
3770 -Wnarrowing @r{(only for C++)}  @gol
3771 -Wnonnull  @gol
3772 -Wnonnull-compare  @gol
3773 -Wopenmp-simd @gol
3774 -Wparentheses  @gol
3775 -Wpointer-sign  @gol
3776 -Wreorder   @gol
3777 -Wreturn-type  @gol
3778 -Wsequence-point  @gol
3779 -Wsign-compare @r{(only in C++)}  @gol
3780 -Wsizeof-pointer-memaccess @gol
3781 -Wstrict-aliasing  @gol
3782 -Wstrict-overflow=1  @gol
3783 -Wswitch  @gol
3784 -Wtautological-compare  @gol
3785 -Wtrigraphs  @gol
3786 -Wuninitialized  @gol
3787 -Wunknown-pragmas  @gol
3788 -Wunused-function  @gol
3789 -Wunused-label     @gol
3790 -Wunused-value     @gol
3791 -Wunused-variable  @gol
3792 -Wvolatile-register-var @gol
3795 Note that some warning flags are not implied by @option{-Wall}.  Some of
3796 them warn about constructions that users generally do not consider
3797 questionable, but which occasionally you might wish to check for;
3798 others warn about constructions that are necessary or hard to avoid in
3799 some cases, and there is no simple way to modify the code to suppress
3800 the warning. Some of them are enabled by @option{-Wextra} but many of
3801 them must be enabled individually.
3803 @item -Wextra
3804 @opindex W
3805 @opindex Wextra
3806 @opindex Wno-extra
3807 This enables some extra warning flags that are not enabled by
3808 @option{-Wall}. (This option used to be called @option{-W}.  The older
3809 name is still supported, but the newer name is more descriptive.)
3811 @gccoptlist{-Wclobbered  @gol
3812 -Wempty-body  @gol
3813 -Wignored-qualifiers @gol
3814 -Wimplicit-fallthrough=3 @gol
3815 -Wmissing-field-initializers  @gol
3816 -Wmissing-parameter-type @r{(C only)}  @gol
3817 -Wold-style-declaration @r{(C only)}  @gol
3818 -Woverride-init  @gol
3819 -Wsign-compare @r{(C only)} @gol
3820 -Wtype-limits  @gol
3821 -Wuninitialized  @gol
3822 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3823 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3824 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3827 The option @option{-Wextra} also prints warning messages for the
3828 following cases:
3830 @itemize @bullet
3832 @item
3833 A pointer is compared against integer zero with @code{<}, @code{<=},
3834 @code{>}, or @code{>=}.
3836 @item
3837 (C++ only) An enumerator and a non-enumerator both appear in a
3838 conditional expression.
3840 @item
3841 (C++ only) Ambiguous virtual bases.
3843 @item
3844 (C++ only) Subscripting an array that has been declared @code{register}.
3846 @item
3847 (C++ only) Taking the address of a variable that has been declared
3848 @code{register}.
3850 @item
3851 (C++ only) A base class is not initialized in the copy constructor
3852 of a derived class.
3854 @end itemize
3856 @item -Wchar-subscripts
3857 @opindex Wchar-subscripts
3858 @opindex Wno-char-subscripts
3859 Warn if an array subscript has type @code{char}.  This is a common cause
3860 of error, as programmers often forget that this type is signed on some
3861 machines.
3862 This warning is enabled by @option{-Wall}.
3864 @item -Wchkp
3865 @opindex Wchkp
3866 Warn about an invalid memory access that is found by Pointer Bounds Checker
3867 (@option{-fcheck-pointer-bounds}).
3869 @item -Wno-coverage-mismatch
3870 @opindex Wno-coverage-mismatch
3871 Warn if feedback profiles do not match when using the
3872 @option{-fprofile-use} option.
3873 If a source file is changed between compiling with @option{-fprofile-gen} and
3874 with @option{-fprofile-use}, the files with the profile feedback can fail
3875 to match the source file and GCC cannot use the profile feedback
3876 information.  By default, this warning is enabled and is treated as an
3877 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3878 warning or @option{-Wno-error=coverage-mismatch} can be used to
3879 disable the error.  Disabling the error for this warning can result in
3880 poorly optimized code and is useful only in the
3881 case of very minor changes such as bug fixes to an existing code-base.
3882 Completely disabling the warning is not recommended.
3884 @item -Wno-cpp
3885 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3887 Suppress warning messages emitted by @code{#warning} directives.
3889 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3890 @opindex Wdouble-promotion
3891 @opindex Wno-double-promotion
3892 Give a warning when a value of type @code{float} is implicitly
3893 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3894 floating-point unit implement @code{float} in hardware, but emulate
3895 @code{double} in software.  On such a machine, doing computations
3896 using @code{double} values is much more expensive because of the
3897 overhead required for software emulation.
3899 It is easy to accidentally do computations with @code{double} because
3900 floating-point literals are implicitly of type @code{double}.  For
3901 example, in:
3902 @smallexample
3903 @group
3904 float area(float radius)
3906    return 3.14159 * radius * radius;
3908 @end group
3909 @end smallexample
3910 the compiler performs the entire computation with @code{double}
3911 because the floating-point literal is a @code{double}.
3913 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3914 @opindex Wduplicate-decl-specifier
3915 @opindex Wno-duplicate-decl-specifier
3916 Warn if a declaration has duplicate @code{const}, @code{volatile},
3917 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3918 @option{-Wall}.
3920 @item -Wformat
3921 @itemx -Wformat=@var{n}
3922 @opindex Wformat
3923 @opindex Wno-format
3924 @opindex ffreestanding
3925 @opindex fno-builtin
3926 @opindex Wformat=
3927 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3928 the arguments supplied have types appropriate to the format string
3929 specified, and that the conversions specified in the format string make
3930 sense.  This includes standard functions, and others specified by format
3931 attributes (@pxref{Function Attributes}), in the @code{printf},
3932 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3933 not in the C standard) families (or other target-specific families).
3934 Which functions are checked without format attributes having been
3935 specified depends on the standard version selected, and such checks of
3936 functions without the attribute specified are disabled by
3937 @option{-ffreestanding} or @option{-fno-builtin}.
3939 The formats are checked against the format features supported by GNU
3940 libc version 2.2.  These include all ISO C90 and C99 features, as well
3941 as features from the Single Unix Specification and some BSD and GNU
3942 extensions.  Other library implementations may not support all these
3943 features; GCC does not support warning about features that go beyond a
3944 particular library's limitations.  However, if @option{-Wpedantic} is used
3945 with @option{-Wformat}, warnings are given about format features not
3946 in the selected standard version (but not for @code{strfmon} formats,
3947 since those are not in any version of the C standard).  @xref{C Dialect
3948 Options,,Options Controlling C Dialect}.
3950 @table @gcctabopt
3951 @item -Wformat=1
3952 @itemx -Wformat
3953 @opindex Wformat
3954 @opindex Wformat=1
3955 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3956 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3957 @option{-Wformat} also checks for null format arguments for several
3958 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3959 aspects of this level of format checking can be disabled by the
3960 options: @option{-Wno-format-contains-nul},
3961 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3962 @option{-Wformat} is enabled by @option{-Wall}.
3964 @item -Wno-format-contains-nul
3965 @opindex Wno-format-contains-nul
3966 @opindex Wformat-contains-nul
3967 If @option{-Wformat} is specified, do not warn about format strings that
3968 contain NUL bytes.
3970 @item -Wno-format-extra-args
3971 @opindex Wno-format-extra-args
3972 @opindex Wformat-extra-args
3973 If @option{-Wformat} is specified, do not warn about excess arguments to a
3974 @code{printf} or @code{scanf} format function.  The C standard specifies
3975 that such arguments are ignored.
3977 Where the unused arguments lie between used arguments that are
3978 specified with @samp{$} operand number specifications, normally
3979 warnings are still given, since the implementation could not know what
3980 type to pass to @code{va_arg} to skip the unused arguments.  However,
3981 in the case of @code{scanf} formats, this option suppresses the
3982 warning if the unused arguments are all pointers, since the Single
3983 Unix Specification says that such unused arguments are allowed.
3985 @item -Wformat-overflow
3986 @itemx -Wformat-overflow=@var{level}
3987 @opindex Wformat-overflow
3988 @opindex Wno-format-overflow
3989 Warn about calls to formatted input/output functions such as @code{sprintf}
3990 and @code{vsprintf} that might overflow the destination buffer.  When the
3991 exact number of bytes written by a format directive cannot be determined
3992 at compile-time it is estimated based on heuristics that depend on the
3993 @var{level} argument and on optimization.  While enabling optimization
3994 will in most cases improve the accuracy of the warning, it may also
3995 result in false positives.
3997 @table @gcctabopt
3998 @item -Wformat-overflow
3999 @item -Wformat-overflow=1
4000 @opindex Wformat-overflow
4001 @opindex Wno-format-overflow
4002 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4003 employs a conservative approach that warns only about calls that most
4004 likely overflow the buffer.  At this level, numeric arguments to format
4005 directives with unknown values are assumed to have the value of one, and
4006 strings of unknown length to be empty.  Numeric arguments that are known
4007 to be bounded to a subrange of their type, or string arguments whose output
4008 is bounded either by their directive's precision or by a finite set of
4009 string literals, are assumed to take on the value within the range that
4010 results in the most bytes on output.  For example, the call to @code{sprintf}
4011 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4012 the terminating NUL character (@code{'\0'}) appended by the function
4013 to the destination buffer will be written past its end.  Increasing
4014 the size of the buffer by a single byte is sufficient to avoid the
4015 warning, though it may not be sufficient to avoid the overflow.
4017 @smallexample
4018 void f (int a, int b)
4020   char buf [12];
4021   sprintf (buf, "a = %i, b = %i\n", a, b);
4023 @end smallexample
4025 @item -Wformat-overflow=2
4026 Level @var{2} warns also about calls that might overflow the destination
4027 buffer given an argument of sufficient length or magnitude.  At level
4028 @var{2}, unknown numeric arguments are assumed to have the minimum
4029 representable value for signed types with a precision greater than 1, and
4030 the maximum representable value otherwise.  Unknown string arguments whose
4031 length cannot be assumed to be bounded either by the directive's precision,
4032 or by a finite set of string literals they may evaluate to, or the character
4033 array they may point to, are assumed to be 1 character long.
4035 At level @var{2}, the call in the example above is again diagnosed, but
4036 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4037 @code{%i} directive will write some of its digits beyond the end of
4038 the destination buffer.  To make the call safe regardless of the values
4039 of the two variables, the size of the destination buffer must be increased
4040 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4041 an informational note following the warning.
4043 An alternative to increasing the size of the destination buffer is to
4044 constrain the range of formatted values.  The maximum length of string
4045 arguments can be bounded by specifying the precision in the format
4046 directive.  When numeric arguments of format directives can be assumed
4047 to be bounded by less than the precision of their type, choosing
4048 an appropriate length modifier to the format specifier will reduce
4049 the required buffer size.  For example, if @var{a} and @var{b} in the
4050 example above can be assumed to be within the precision of
4051 the @code{short int} type then using either the @code{%hi} format
4052 directive or casting the argument to @code{short} reduces the maximum
4053 required size of the buffer to 24 bytes.
4055 @smallexample
4056 void f (int a, int b)
4058   char buf [23];
4059   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4061 @end smallexample
4062 @end table
4064 @item -Wno-format-zero-length
4065 @opindex Wno-format-zero-length
4066 @opindex Wformat-zero-length
4067 If @option{-Wformat} is specified, do not warn about zero-length formats.
4068 The C standard specifies that zero-length formats are allowed.
4071 @item -Wformat=2
4072 @opindex Wformat=2
4073 Enable @option{-Wformat} plus additional format checks.  Currently
4074 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4075 -Wformat-y2k}.
4077 @item -Wformat-nonliteral
4078 @opindex Wformat-nonliteral
4079 @opindex Wno-format-nonliteral
4080 If @option{-Wformat} is specified, also warn if the format string is not a
4081 string literal and so cannot be checked, unless the format function
4082 takes its format arguments as a @code{va_list}.
4084 @item -Wformat-security
4085 @opindex Wformat-security
4086 @opindex Wno-format-security
4087 If @option{-Wformat} is specified, also warn about uses of format
4088 functions that represent possible security problems.  At present, this
4089 warns about calls to @code{printf} and @code{scanf} functions where the
4090 format string is not a string literal and there are no format arguments,
4091 as in @code{printf (foo);}.  This may be a security hole if the format
4092 string came from untrusted input and contains @samp{%n}.  (This is
4093 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4094 in future warnings may be added to @option{-Wformat-security} that are not
4095 included in @option{-Wformat-nonliteral}.)
4097 @item -Wformat-signedness
4098 @opindex Wformat-signedness
4099 @opindex Wno-format-signedness
4100 If @option{-Wformat} is specified, also warn if the format string
4101 requires an unsigned argument and the argument is signed and vice versa.
4103 @item -Wformat-truncation
4104 @itemx -Wformat-truncation=@var{level}
4105 @opindex Wformat-truncation
4106 @opindex Wno-format-truncation
4107 Warn about calls to formatted input/output functions such as @code{snprintf}
4108 and @code{vsnprintf} that might result in output truncation.  When the exact
4109 number of bytes written by a format directive cannot be determined at
4110 compile-time it is estimated based on heuristics that depend on
4111 the @var{level} argument and on optimization.  While enabling optimization
4112 will in most cases improve the accuracy of the warning, it may also result
4113 in false positives.  Except as noted otherwise, the option uses the same
4114 logic @option{-Wformat-overflow}.
4116 @table @gcctabopt
4117 @item -Wformat-truncation
4118 @item -Wformat-truncation=1
4119 @opindex Wformat-truncation
4120 @opindex Wno-format-overflow
4121 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4122 employs a conservative approach that warns only about calls to bounded
4123 functions whose return value is unused and that will most likely result
4124 in output truncation.
4126 @item -Wformat-truncation=2
4127 Level @var{2} warns also about calls to bounded functions whose return
4128 value is used and that might result in truncation given an argument of
4129 sufficient length or magnitude.
4130 @end table
4132 @item -Wformat-y2k
4133 @opindex Wformat-y2k
4134 @opindex Wno-format-y2k
4135 If @option{-Wformat} is specified, also warn about @code{strftime}
4136 formats that may yield only a two-digit year.
4137 @end table
4139 @item -Wnonnull
4140 @opindex Wnonnull
4141 @opindex Wno-nonnull
4142 Warn about passing a null pointer for arguments marked as
4143 requiring a non-null value by the @code{nonnull} function attribute.
4145 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4146 can be disabled with the @option{-Wno-nonnull} option.
4148 @item -Wnonnull-compare
4149 @opindex Wnonnull-compare
4150 @opindex Wno-nonnull-compare
4151 Warn when comparing an argument marked with the @code{nonnull}
4152 function attribute against null inside the function.
4154 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4155 can be disabled with the @option{-Wno-nonnull-compare} option.
4157 @item -Wnull-dereference
4158 @opindex Wnull-dereference
4159 @opindex Wno-null-dereference
4160 Warn if the compiler detects paths that trigger erroneous or
4161 undefined behavior due to dereferencing a null pointer.  This option
4162 is only active when @option{-fdelete-null-pointer-checks} is active,
4163 which is enabled by optimizations in most targets.  The precision of
4164 the warnings depends on the optimization options used.
4166 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4167 @opindex Winit-self
4168 @opindex Wno-init-self
4169 Warn about uninitialized variables that are initialized with themselves.
4170 Note this option can only be used with the @option{-Wuninitialized} option.
4172 For example, GCC warns about @code{i} being uninitialized in the
4173 following snippet only when @option{-Winit-self} has been specified:
4174 @smallexample
4175 @group
4176 int f()
4178   int i = i;
4179   return i;
4181 @end group
4182 @end smallexample
4184 This warning is enabled by @option{-Wall} in C++.
4186 @item -Wimplicit-int @r{(C and Objective-C only)}
4187 @opindex Wimplicit-int
4188 @opindex Wno-implicit-int
4189 Warn when a declaration does not specify a type.
4190 This warning is enabled by @option{-Wall}.
4192 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4193 @opindex Wimplicit-function-declaration
4194 @opindex Wno-implicit-function-declaration
4195 Give a warning whenever a function is used before being declared. In
4196 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4197 enabled by default and it is made into an error by
4198 @option{-pedantic-errors}. This warning is also enabled by
4199 @option{-Wall}.
4201 @item -Wimplicit @r{(C and Objective-C only)}
4202 @opindex Wimplicit
4203 @opindex Wno-implicit
4204 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4205 This warning is enabled by @option{-Wall}.
4207 @item -Wimplicit-fallthrough
4208 @opindex Wimplicit-fallthrough
4209 @opindex Wno-implicit-fallthrough
4210 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4211 and @option{-Wno-implicit-fallthrough} is the same as
4212 @option{-Wimplicit-fallthrough=0}.
4214 @item -Wimplicit-fallthrough=@var{n}
4215 @opindex Wimplicit-fallthrough=
4216 Warn when a switch case falls through.  For example:
4218 @smallexample
4219 @group
4220 switch (cond)
4221   @{
4222   case 1:
4223     a = 1;
4224     break;
4225   case 2:
4226     a = 2;
4227   case 3:
4228     a = 3;
4229     break;
4230   @}
4231 @end group
4232 @end smallexample
4234 This warning does not warn when the last statement of a case cannot
4235 fall through, e.g. when there is a return statement or a call to function
4236 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4237 also takes into account control flow statements, such as ifs, and only
4238 warns when appropriate.  E.g.@:
4240 @smallexample
4241 @group
4242 switch (cond)
4243   @{
4244   case 1:
4245     if (i > 3) @{
4246       bar (5);
4247       break;
4248     @} else if (i < 1) @{
4249       bar (0);
4250     @} else
4251       return;
4252   default:
4253     @dots{}
4254   @}
4255 @end group
4256 @end smallexample
4258 Since there are occasions where a switch case fall through is desirable,
4259 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4260 to be used along with a null statement to suppress this warning that
4261 would normally occur:
4263 @smallexample
4264 @group
4265 switch (cond)
4266   @{
4267   case 1:
4268     bar (0);
4269     __attribute__ ((fallthrough));
4270   default:
4271     @dots{}
4272   @}
4273 @end group
4274 @end smallexample
4276 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4277 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4278 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4279 Instead of the these attributes, it is also possible to add a fallthrough
4280 comment to silence the warning.  The whole body of the C or C++ style comment
4281 should match the given regular expressions listed below.  The option argument
4282 @var{n} specifies what kind of comments are accepted:
4284 @itemize @bullet
4286 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4288 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4289 expression, any comment is used as fallthrough comment.
4291 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4292 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4294 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4295 following regular expressions:
4297 @itemize @bullet
4299 @item @code{-fallthrough}
4301 @item @code{@@fallthrough@@}
4303 @item @code{lint -fallthrough[ \t]*}
4305 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4307 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4309 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4311 @end itemize
4313 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4314 following regular expressions:
4316 @itemize @bullet
4318 @item @code{-fallthrough}
4320 @item @code{@@fallthrough@@}
4322 @item @code{lint -fallthrough[ \t]*}
4324 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4326 @end itemize
4328 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4329 fallthrough comments, only attributes disable the warning.
4331 @end itemize
4333 The comment needs to be followed after optional whitespace and other comments
4334 by @code{case} or @code{default} keywords or by a user label that precedes some
4335 @code{case} or @code{default} label.
4337 @smallexample
4338 @group
4339 switch (cond)
4340   @{
4341   case 1:
4342     bar (0);
4343     /* FALLTHRU */
4344   default:
4345     @dots{}
4346   @}
4347 @end group
4348 @end smallexample
4350 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4352 @item -Wignored-qualifiers @r{(C and C++ only)}
4353 @opindex Wignored-qualifiers
4354 @opindex Wno-ignored-qualifiers
4355 Warn if the return type of a function has a type qualifier
4356 such as @code{const}.  For ISO C such a type qualifier has no effect,
4357 since the value returned by a function is not an lvalue.
4358 For C++, the warning is only emitted for scalar types or @code{void}.
4359 ISO C prohibits qualified @code{void} return types on function
4360 definitions, so such return types always receive a warning
4361 even without this option.
4363 This warning is also enabled by @option{-Wextra}.
4365 @item -Wignored-attributes @r{(C and C++ only)}
4366 @opindex Wignored-attributes
4367 @opindex Wno-ignored-attributes
4368 Warn when an attribute is ignored.  This is different from the
4369 @option{-Wattributes} option in that it warns whenever the compiler decides
4370 to drop an attribute, not that the attribute is either unknown, used in a
4371 wrong place, etc.  This warning is enabled by default.
4373 @item -Wmain
4374 @opindex Wmain
4375 @opindex Wno-main
4376 Warn if the type of @code{main} is suspicious.  @code{main} should be
4377 a function with external linkage, returning int, taking either zero
4378 arguments, two, or three arguments of appropriate types.  This warning
4379 is enabled by default in C++ and is enabled by either @option{-Wall}
4380 or @option{-Wpedantic}.
4382 @item -Wmisleading-indentation @r{(C and C++ only)}
4383 @opindex Wmisleading-indentation
4384 @opindex Wno-misleading-indentation
4385 Warn when the indentation of the code does not reflect the block structure.
4386 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4387 @code{for} clauses with a guarded statement that does not use braces,
4388 followed by an unguarded statement with the same indentation.
4390 In the following example, the call to ``bar'' is misleadingly indented as
4391 if it were guarded by the ``if'' conditional.
4393 @smallexample
4394   if (some_condition ())
4395     foo ();
4396     bar ();  /* Gotcha: this is not guarded by the "if".  */
4397 @end smallexample
4399 In the case of mixed tabs and spaces, the warning uses the
4400 @option{-ftabstop=} option to determine if the statements line up
4401 (defaulting to 8).
4403 The warning is not issued for code involving multiline preprocessor logic
4404 such as the following example.
4406 @smallexample
4407   if (flagA)
4408     foo (0);
4409 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4410   if (flagB)
4411 #endif
4412     foo (1);
4413 @end smallexample
4415 The warning is not issued after a @code{#line} directive, since this
4416 typically indicates autogenerated code, and no assumptions can be made
4417 about the layout of the file that the directive references.
4419 This warning is enabled by @option{-Wall} in C and C++.
4421 @item -Wmissing-braces
4422 @opindex Wmissing-braces
4423 @opindex Wno-missing-braces
4424 Warn if an aggregate or union initializer is not fully bracketed.  In
4425 the following example, the initializer for @code{a} is not fully
4426 bracketed, but that for @code{b} is fully bracketed.  This warning is
4427 enabled by @option{-Wall} in C.
4429 @smallexample
4430 int a[2][2] = @{ 0, 1, 2, 3 @};
4431 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4432 @end smallexample
4434 This warning is enabled by @option{-Wall}.
4436 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4437 @opindex Wmissing-include-dirs
4438 @opindex Wno-missing-include-dirs
4439 Warn if a user-supplied include directory does not exist.
4441 @item -Wparentheses
4442 @opindex Wparentheses
4443 @opindex Wno-parentheses
4444 Warn if parentheses are omitted in certain contexts, such
4445 as when there is an assignment in a context where a truth value
4446 is expected, or when operators are nested whose precedence people
4447 often get confused about.
4449 Also warn if a comparison like @code{x<=y<=z} appears; this is
4450 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4451 interpretation from that of ordinary mathematical notation.
4453 Also warn for dangerous uses of the GNU extension to
4454 @code{?:} with omitted middle operand. When the condition
4455 in the @code{?}: operator is a boolean expression, the omitted value is
4456 always 1.  Often programmers expect it to be a value computed
4457 inside the conditional expression instead.
4459 This warning is enabled by @option{-Wall}.
4461 @item -Wsequence-point
4462 @opindex Wsequence-point
4463 @opindex Wno-sequence-point
4464 Warn about code that may have undefined semantics because of violations
4465 of sequence point rules in the C and C++ standards.
4467 The C and C++ standards define the order in which expressions in a C/C++
4468 program are evaluated in terms of @dfn{sequence points}, which represent
4469 a partial ordering between the execution of parts of the program: those
4470 executed before the sequence point, and those executed after it.  These
4471 occur after the evaluation of a full expression (one which is not part
4472 of a larger expression), after the evaluation of the first operand of a
4473 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4474 function is called (but after the evaluation of its arguments and the
4475 expression denoting the called function), and in certain other places.
4476 Other than as expressed by the sequence point rules, the order of
4477 evaluation of subexpressions of an expression is not specified.  All
4478 these rules describe only a partial order rather than a total order,
4479 since, for example, if two functions are called within one expression
4480 with no sequence point between them, the order in which the functions
4481 are called is not specified.  However, the standards committee have
4482 ruled that function calls do not overlap.
4484 It is not specified when between sequence points modifications to the
4485 values of objects take effect.  Programs whose behavior depends on this
4486 have undefined behavior; the C and C++ standards specify that ``Between
4487 the previous and next sequence point an object shall have its stored
4488 value modified at most once by the evaluation of an expression.
4489 Furthermore, the prior value shall be read only to determine the value
4490 to be stored.''.  If a program breaks these rules, the results on any
4491 particular implementation are entirely unpredictable.
4493 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4494 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4495 diagnosed by this option, and it may give an occasional false positive
4496 result, but in general it has been found fairly effective at detecting
4497 this sort of problem in programs.
4499 The C++17 standard will define the order of evaluation of operands in
4500 more cases: in particular it requires that the right-hand side of an
4501 assignment be evaluated before the left-hand side, so the above
4502 examples are no longer undefined.  But this warning will still warn
4503 about them, to help people avoid writing code that is undefined in C
4504 and earlier revisions of C++.
4506 The standard is worded confusingly, therefore there is some debate
4507 over the precise meaning of the sequence point rules in subtle cases.
4508 Links to discussions of the problem, including proposed formal
4509 definitions, may be found on the GCC readings page, at
4510 @uref{http://gcc.gnu.org/@/readings.html}.
4512 This warning is enabled by @option{-Wall} for C and C++.
4514 @item -Wno-return-local-addr
4515 @opindex Wno-return-local-addr
4516 @opindex Wreturn-local-addr
4517 Do not warn about returning a pointer (or in C++, a reference) to a
4518 variable that goes out of scope after the function returns.
4520 @item -Wreturn-type
4521 @opindex Wreturn-type
4522 @opindex Wno-return-type
4523 Warn whenever a function is defined with a return type that defaults
4524 to @code{int}.  Also warn about any @code{return} statement with no
4525 return value in a function whose return type is not @code{void}
4526 (falling off the end of the function body is considered returning
4527 without a value).
4529 For C only, warn about a @code{return} statement with an expression in a
4530 function whose return type is @code{void}, unless the expression type is
4531 also @code{void}.  As a GNU extension, the latter case is accepted
4532 without a warning unless @option{-Wpedantic} is used.
4534 For C++, a function without return type always produces a diagnostic
4535 message, even when @option{-Wno-return-type} is specified.  The only
4536 exceptions are @code{main} and functions defined in system headers.
4538 This warning is enabled by @option{-Wall}.
4540 @item -Wshift-count-negative
4541 @opindex Wshift-count-negative
4542 @opindex Wno-shift-count-negative
4543 Warn if shift count is negative. This warning is enabled by default.
4545 @item -Wshift-count-overflow
4546 @opindex Wshift-count-overflow
4547 @opindex Wno-shift-count-overflow
4548 Warn if shift count >= width of type. This warning is enabled by default.
4550 @item -Wshift-negative-value
4551 @opindex Wshift-negative-value
4552 @opindex Wno-shift-negative-value
4553 Warn if left shifting a negative value.  This warning is enabled by
4554 @option{-Wextra} in C99 and C++11 modes (and newer).
4556 @item -Wshift-overflow
4557 @itemx -Wshift-overflow=@var{n}
4558 @opindex Wshift-overflow
4559 @opindex Wno-shift-overflow
4560 Warn about left shift overflows.  This warning is enabled by
4561 default in C99 and C++11 modes (and newer).
4563 @table @gcctabopt
4564 @item -Wshift-overflow=1
4565 This is the warning level of @option{-Wshift-overflow} and is enabled
4566 by default in C99 and C++11 modes (and newer).  This warning level does
4567 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4568 an overflow is still rejected in contexts where an integer constant expression
4569 is required.)
4571 @item -Wshift-overflow=2
4572 This warning level also warns about left-shifting 1 into the sign bit,
4573 unless C++14 mode is active.
4574 @end table
4576 @item -Wswitch
4577 @opindex Wswitch
4578 @opindex Wno-switch
4579 Warn whenever a @code{switch} statement has an index of enumerated type
4580 and lacks a @code{case} for one or more of the named codes of that
4581 enumeration.  (The presence of a @code{default} label prevents this
4582 warning.)  @code{case} labels outside the enumeration range also
4583 provoke warnings when this option is used (even if there is a
4584 @code{default} label).
4585 This warning is enabled by @option{-Wall}.
4587 @item -Wswitch-default
4588 @opindex Wswitch-default
4589 @opindex Wno-switch-default
4590 Warn whenever a @code{switch} statement does not have a @code{default}
4591 case.
4593 @item -Wswitch-enum
4594 @opindex Wswitch-enum
4595 @opindex Wno-switch-enum
4596 Warn whenever a @code{switch} statement has an index of enumerated type
4597 and lacks a @code{case} for one or more of the named codes of that
4598 enumeration.  @code{case} labels outside the enumeration range also
4599 provoke warnings when this option is used.  The only difference
4600 between @option{-Wswitch} and this option is that this option gives a
4601 warning about an omitted enumeration code even if there is a
4602 @code{default} label.
4604 @item -Wswitch-bool
4605 @opindex Wswitch-bool
4606 @opindex Wno-switch-bool
4607 Warn whenever a @code{switch} statement has an index of boolean type
4608 and the case values are outside the range of a boolean type.
4609 It is possible to suppress this warning by casting the controlling
4610 expression to a type other than @code{bool}.  For example:
4611 @smallexample
4612 @group
4613 switch ((int) (a == 4))
4614   @{
4615   @dots{}
4616   @}
4617 @end group
4618 @end smallexample
4619 This warning is enabled by default for C and C++ programs.
4621 @item -Wswitch-unreachable
4622 @opindex Wswitch-unreachable
4623 @opindex Wno-switch-unreachable
4624 Warn whenever a @code{switch} statement contains statements between the
4625 controlling expression and the first case label, which will never be
4626 executed.  For example:
4627 @smallexample
4628 @group
4629 switch (cond)
4630   @{
4631    i = 15;
4632   @dots{}
4633    case 5:
4634   @dots{}
4635   @}
4636 @end group
4637 @end smallexample
4638 @option{-Wswitch-unreachable} does not warn if the statement between the
4639 controlling expression and the first case label is just a declaration:
4640 @smallexample
4641 @group
4642 switch (cond)
4643   @{
4644    int i;
4645   @dots{}
4646    case 5:
4647    i = 5;
4648   @dots{}
4649   @}
4650 @end group
4651 @end smallexample
4652 This warning is enabled by default for C and C++ programs.
4654 @item -Wsync-nand @r{(C and C++ only)}
4655 @opindex Wsync-nand
4656 @opindex Wno-sync-nand
4657 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4658 built-in functions are used.  These functions changed semantics in GCC 4.4.
4660 @item -Wunused-but-set-parameter
4661 @opindex Wunused-but-set-parameter
4662 @opindex Wno-unused-but-set-parameter
4663 Warn whenever a function parameter is assigned to, but otherwise unused
4664 (aside from its declaration).
4666 To suppress this warning use the @code{unused} attribute
4667 (@pxref{Variable Attributes}).
4669 This warning is also enabled by @option{-Wunused} together with
4670 @option{-Wextra}.
4672 @item -Wunused-but-set-variable
4673 @opindex Wunused-but-set-variable
4674 @opindex Wno-unused-but-set-variable
4675 Warn whenever a local variable is assigned to, but otherwise unused
4676 (aside from its declaration).
4677 This warning is enabled by @option{-Wall}.
4679 To suppress this warning use the @code{unused} attribute
4680 (@pxref{Variable Attributes}).
4682 This warning is also enabled by @option{-Wunused}, which is enabled
4683 by @option{-Wall}.
4685 @item -Wunused-function
4686 @opindex Wunused-function
4687 @opindex Wno-unused-function
4688 Warn whenever a static function is declared but not defined or a
4689 non-inline static function is unused.
4690 This warning is enabled by @option{-Wall}.
4692 @item -Wunused-label
4693 @opindex Wunused-label
4694 @opindex Wno-unused-label
4695 Warn whenever a label is declared but not used.
4696 This warning is enabled by @option{-Wall}.
4698 To suppress this warning use the @code{unused} attribute
4699 (@pxref{Variable Attributes}).
4701 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4702 @opindex Wunused-local-typedefs
4703 Warn when a typedef locally defined in a function is not used.
4704 This warning is enabled by @option{-Wall}.
4706 @item -Wunused-parameter
4707 @opindex Wunused-parameter
4708 @opindex Wno-unused-parameter
4709 Warn whenever a function parameter is unused aside from its declaration.
4711 To suppress this warning use the @code{unused} attribute
4712 (@pxref{Variable Attributes}).
4714 @item -Wno-unused-result
4715 @opindex Wunused-result
4716 @opindex Wno-unused-result
4717 Do not warn if a caller of a function marked with attribute
4718 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4719 its return value. The default is @option{-Wunused-result}.
4721 @item -Wunused-variable
4722 @opindex Wunused-variable
4723 @opindex Wno-unused-variable
4724 Warn whenever a local or static variable is unused aside from its
4725 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4726 but not for C++. This warning is enabled by @option{-Wall}.
4728 To suppress this warning use the @code{unused} attribute
4729 (@pxref{Variable Attributes}).
4731 @item -Wunused-const-variable
4732 @itemx -Wunused-const-variable=@var{n}
4733 @opindex Wunused-const-variable
4734 @opindex Wno-unused-const-variable
4735 Warn whenever a constant static variable is unused aside from its declaration.
4736 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4737 for C, but not for C++. In C this declares variable storage, but in C++ this
4738 is not an error since const variables take the place of @code{#define}s.
4740 To suppress this warning use the @code{unused} attribute
4741 (@pxref{Variable Attributes}).
4743 @table @gcctabopt
4744 @item -Wunused-const-variable=1
4745 This is the warning level that is enabled by @option{-Wunused-variable} for
4746 C.  It warns only about unused static const variables defined in the main
4747 compilation unit, but not about static const variables declared in any
4748 header included.
4750 @item -Wunused-const-variable=2
4751 This warning level also warns for unused constant static variables in
4752 headers (excluding system headers).  This is the warning level of
4753 @option{-Wunused-const-variable} and must be explicitly requested since
4754 in C++ this isn't an error and in C it might be harder to clean up all
4755 headers included.
4756 @end table
4758 @item -Wunused-value
4759 @opindex Wunused-value
4760 @opindex Wno-unused-value
4761 Warn whenever a statement computes a result that is explicitly not
4762 used. To suppress this warning cast the unused expression to
4763 @code{void}. This includes an expression-statement or the left-hand
4764 side of a comma expression that contains no side effects. For example,
4765 an expression such as @code{x[i,j]} causes a warning, while
4766 @code{x[(void)i,j]} does not.
4768 This warning is enabled by @option{-Wall}.
4770 @item -Wunused
4771 @opindex Wunused
4772 @opindex Wno-unused
4773 All the above @option{-Wunused} options combined.
4775 In order to get a warning about an unused function parameter, you must
4776 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4777 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4779 @item -Wuninitialized
4780 @opindex Wuninitialized
4781 @opindex Wno-uninitialized
4782 Warn if an automatic variable is used without first being initialized
4783 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4784 warn if a non-static reference or non-static @code{const} member
4785 appears in a class without constructors.
4787 If you want to warn about code that uses the uninitialized value of the
4788 variable in its own initializer, use the @option{-Winit-self} option.
4790 These warnings occur for individual uninitialized or clobbered
4791 elements of structure, union or array variables as well as for
4792 variables that are uninitialized or clobbered as a whole.  They do
4793 not occur for variables or elements declared @code{volatile}.  Because
4794 these warnings depend on optimization, the exact variables or elements
4795 for which there are warnings depends on the precise optimization
4796 options and version of GCC used.
4798 Note that there may be no warning about a variable that is used only
4799 to compute a value that itself is never used, because such
4800 computations may be deleted by data flow analysis before the warnings
4801 are printed.
4803 @item -Winvalid-memory-model
4804 @opindex Winvalid-memory-model
4805 @opindex Wno-invalid-memory-model
4806 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4807 and the C11 atomic generic functions with a memory consistency argument
4808 that is either invalid for the operation or outside the range of values
4809 of the @code{memory_order} enumeration.  For example, since the
4810 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4811 defined for the relaxed, release, and sequentially consistent memory
4812 orders the following code is diagnosed:
4814 @smallexample
4815 void store (int *i)
4817   __atomic_store_n (i, 0, memory_order_consume);
4819 @end smallexample
4821 @option{-Winvalid-memory-model} is enabled by default.
4823 @item -Wmaybe-uninitialized
4824 @opindex Wmaybe-uninitialized
4825 @opindex Wno-maybe-uninitialized
4826 For an automatic variable, if there exists a path from the function
4827 entry to a use of the variable that is initialized, but there exist
4828 some other paths for which the variable is not initialized, the compiler
4829 emits a warning if it cannot prove the uninitialized paths are not
4830 executed at run time. These warnings are made optional because GCC is
4831 not smart enough to see all the reasons why the code might be correct
4832 in spite of appearing to have an error.  Here is one example of how
4833 this can happen:
4835 @smallexample
4836 @group
4838   int x;
4839   switch (y)
4840     @{
4841     case 1: x = 1;
4842       break;
4843     case 2: x = 4;
4844       break;
4845     case 3: x = 5;
4846     @}
4847   foo (x);
4849 @end group
4850 @end smallexample
4852 @noindent
4853 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4854 always initialized, but GCC doesn't know this. To suppress the
4855 warning, you need to provide a default case with assert(0) or
4856 similar code.
4858 @cindex @code{longjmp} warnings
4859 This option also warns when a non-volatile automatic variable might be
4860 changed by a call to @code{longjmp}.  These warnings as well are possible
4861 only in optimizing compilation.
4863 The compiler sees only the calls to @code{setjmp}.  It cannot know
4864 where @code{longjmp} will be called; in fact, a signal handler could
4865 call it at any point in the code.  As a result, you may get a warning
4866 even when there is in fact no problem because @code{longjmp} cannot
4867 in fact be called at the place that would cause a problem.
4869 Some spurious warnings can be avoided if you declare all the functions
4870 you use that never return as @code{noreturn}.  @xref{Function
4871 Attributes}.
4873 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4875 @item -Wunknown-pragmas
4876 @opindex Wunknown-pragmas
4877 @opindex Wno-unknown-pragmas
4878 @cindex warning for unknown pragmas
4879 @cindex unknown pragmas, warning
4880 @cindex pragmas, warning of unknown
4881 Warn when a @code{#pragma} directive is encountered that is not understood by 
4882 GCC@.  If this command-line option is used, warnings are even issued
4883 for unknown pragmas in system header files.  This is not the case if
4884 the warnings are only enabled by the @option{-Wall} command-line option.
4886 @item -Wno-pragmas
4887 @opindex Wno-pragmas
4888 @opindex Wpragmas
4889 Do not warn about misuses of pragmas, such as incorrect parameters,
4890 invalid syntax, or conflicts between pragmas.  See also
4891 @option{-Wunknown-pragmas}.
4893 @item -Wstrict-aliasing
4894 @opindex Wstrict-aliasing
4895 @opindex Wno-strict-aliasing
4896 This option is only active when @option{-fstrict-aliasing} is active.
4897 It warns about code that might break the strict aliasing rules that the
4898 compiler is using for optimization.  The warning does not catch all
4899 cases, but does attempt to catch the more common pitfalls.  It is
4900 included in @option{-Wall}.
4901 It is equivalent to @option{-Wstrict-aliasing=3}
4903 @item -Wstrict-aliasing=n
4904 @opindex Wstrict-aliasing=n
4905 This option is only active when @option{-fstrict-aliasing} is active.
4906 It warns about code that might break the strict aliasing rules that the
4907 compiler is using for optimization.
4908 Higher levels correspond to higher accuracy (fewer false positives).
4909 Higher levels also correspond to more effort, similar to the way @option{-O} 
4910 works.
4911 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4913 Level 1: Most aggressive, quick, least accurate.
4914 Possibly useful when higher levels
4915 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4916 false negatives.  However, it has many false positives.
4917 Warns for all pointer conversions between possibly incompatible types,
4918 even if never dereferenced.  Runs in the front end only.
4920 Level 2: Aggressive, quick, not too precise.
4921 May still have many false positives (not as many as level 1 though),
4922 and few false negatives (but possibly more than level 1).
4923 Unlike level 1, it only warns when an address is taken.  Warns about
4924 incomplete types.  Runs in the front end only.
4926 Level 3 (default for @option{-Wstrict-aliasing}):
4927 Should have very few false positives and few false
4928 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4929 Takes care of the common pun+dereference pattern in the front end:
4930 @code{*(int*)&some_float}.
4931 If optimization is enabled, it also runs in the back end, where it deals
4932 with multiple statement cases using flow-sensitive points-to information.
4933 Only warns when the converted pointer is dereferenced.
4934 Does not warn about incomplete types.
4936 @item -Wstrict-overflow
4937 @itemx -Wstrict-overflow=@var{n}
4938 @opindex Wstrict-overflow
4939 @opindex Wno-strict-overflow
4940 This option is only active when @option{-fstrict-overflow} is active.
4941 It warns about cases where the compiler optimizes based on the
4942 assumption that signed overflow does not occur.  Note that it does not
4943 warn about all cases where the code might overflow: it only warns
4944 about cases where the compiler implements some optimization.  Thus
4945 this warning depends on the optimization level.
4947 An optimization that assumes that signed overflow does not occur is
4948 perfectly safe if the values of the variables involved are such that
4949 overflow never does, in fact, occur.  Therefore this warning can
4950 easily give a false positive: a warning about code that is not
4951 actually a problem.  To help focus on important issues, several
4952 warning levels are defined.  No warnings are issued for the use of
4953 undefined signed overflow when estimating how many iterations a loop
4954 requires, in particular when determining whether a loop will be
4955 executed at all.
4957 @table @gcctabopt
4958 @item -Wstrict-overflow=1
4959 Warn about cases that are both questionable and easy to avoid.  For
4960 example,  with @option{-fstrict-overflow}, the compiler simplifies
4961 @code{x + 1 > x} to @code{1}.  This level of
4962 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4963 are not, and must be explicitly requested.
4965 @item -Wstrict-overflow=2
4966 Also warn about other cases where a comparison is simplified to a
4967 constant.  For example: @code{abs (x) >= 0}.  This can only be
4968 simplified when @option{-fstrict-overflow} is in effect, because
4969 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4970 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4971 @option{-Wstrict-overflow=2}.
4973 @item -Wstrict-overflow=3
4974 Also warn about other cases where a comparison is simplified.  For
4975 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4977 @item -Wstrict-overflow=4
4978 Also warn about other simplifications not covered by the above cases.
4979 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4981 @item -Wstrict-overflow=5
4982 Also warn about cases where the compiler reduces the magnitude of a
4983 constant involved in a comparison.  For example: @code{x + 2 > y} is
4984 simplified to @code{x + 1 >= y}.  This is reported only at the
4985 highest warning level because this simplification applies to many
4986 comparisons, so this warning level gives a very large number of
4987 false positives.
4988 @end table
4990 @item -Wstringop-overflow
4991 @itemx -Wstringop-overflow=@var{type}
4992 @opindex Wstringop-overflow
4993 @opindex Wno-stringop-overflow
4994 Warn for calls to string manipulation functions such as @code{memcpy} and
4995 @code{strcpy} that are determined to overflow the destination buffer.  The
4996 optional argument is one greater than the type of Object Size Checking to
4997 perform to determine the size of the destination.  @xref{Object Size Checking}.
4998 The argument is meaningful only for functions that operate on character arrays
4999 but not for raw memory functions like @code{memcpy} which always make use
5000 of Object Size type-0.  The option also warns for calls that specify a size
5001 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5002 The option produces the best results with optimization enabled but can detect
5003 a small subset of simple buffer overflows even without optimization in
5004 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5005 correspond to the standard functions.  In any case, the option warns about
5006 just a subset of buffer overflows detected by the corresponding overflow
5007 checking built-ins.  For example, the option will issue a warning for
5008 the @code{strcpy} call below because it copies at least 5 characters
5009 (the string @code{"blue"} including the terminating NUL) into the buffer
5010 of size 4.
5012 @smallexample
5013 enum Color @{ blue, purple, yellow @};
5014 const char* f (enum Color clr)
5016   static char buf [4];
5017   const char *str;
5018   switch (clr)
5019     @{
5020       case blue: str = "blue"; break;
5021       case purple: str = "purple"; break;
5022       case yellow: str = "yellow"; break;
5023     @}
5025   return strcpy (buf, str);   // warning here
5027 @end smallexample
5029 Option @option{-Wstringop-overflow=2} is enabled by default.
5031 @table @gcctabopt
5032 @item -Wstringop-overflow
5033 @item -Wstringop-overflow=1
5034 @opindex Wstringop-overflow
5035 @opindex Wno-stringop-overflow
5036 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5037 to determine the sizes of destination objects.  This is the default setting
5038 of the option.  At this setting the option will not warn for writes past
5039 the end of subobjects of larger objects accessed by pointers unless the
5040 size of the largest surrounding object is known.  When the destination may
5041 be one of several objects it is assumed to be the largest one of them.  On
5042 Linux systems, when optimization is enabled at this setting the option warns
5043 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5044 a non-zero value.
5046 @item -Wstringop-overflow=2
5047 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5048 to determine the sizes of destination objects.  At this setting the option
5049 will warn about overflows when writing to members of the largest complete
5050 objects whose exact size is known.  It will, however, not warn for excessive
5051 writes to the same members of unknown objects referenced by pointers since
5052 they may point to arrays containing unknown numbers of elements.
5054 @item -Wstringop-overflow=3
5055 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5056 to determine the sizes of destination objects.  At this setting the option
5057 warns about overflowing the smallest object or data member.  This is the
5058 most restrictive setting of the option that may result in warnings for safe
5059 code.
5061 @item -Wstringop-overflow=4
5062 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5063 to determine the sizes of destination objects.  At this setting the option
5064 will warn about overflowing any data members, and when the destination is
5065 one of several objects it uses the size of the largest of them to decide
5066 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5067 setting of the option may result in warnings for benign code.
5068 @end table
5070 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5071 @opindex Wsuggest-attribute=
5072 @opindex Wno-suggest-attribute=
5073 Warn for cases where adding an attribute may be beneficial. The
5074 attributes currently supported are listed below.
5076 @table @gcctabopt
5077 @item -Wsuggest-attribute=pure
5078 @itemx -Wsuggest-attribute=const
5079 @itemx -Wsuggest-attribute=noreturn
5080 @opindex Wsuggest-attribute=pure
5081 @opindex Wno-suggest-attribute=pure
5082 @opindex Wsuggest-attribute=const
5083 @opindex Wno-suggest-attribute=const
5084 @opindex Wsuggest-attribute=noreturn
5085 @opindex Wno-suggest-attribute=noreturn
5087 Warn about functions that might be candidates for attributes
5088 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5089 functions visible in other compilation units or (in the case of @code{pure} and
5090 @code{const}) if it cannot prove that the function returns normally. A function
5091 returns normally if it doesn't contain an infinite loop or return abnormally
5092 by throwing, calling @code{abort} or trapping.  This analysis requires option
5093 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5094 higher.  Higher optimization levels improve the accuracy of the analysis.
5096 @item -Wsuggest-attribute=format
5097 @itemx -Wmissing-format-attribute
5098 @opindex Wsuggest-attribute=format
5099 @opindex Wmissing-format-attribute
5100 @opindex Wno-suggest-attribute=format
5101 @opindex Wno-missing-format-attribute
5102 @opindex Wformat
5103 @opindex Wno-format
5105 Warn about function pointers that might be candidates for @code{format}
5106 attributes.  Note these are only possible candidates, not absolute ones.
5107 GCC guesses that function pointers with @code{format} attributes that
5108 are used in assignment, initialization, parameter passing or return
5109 statements should have a corresponding @code{format} attribute in the
5110 resulting type.  I.e.@: the left-hand side of the assignment or
5111 initialization, the type of the parameter variable, or the return type
5112 of the containing function respectively should also have a @code{format}
5113 attribute to avoid the warning.
5115 GCC also warns about function definitions that might be
5116 candidates for @code{format} attributes.  Again, these are only
5117 possible candidates.  GCC guesses that @code{format} attributes
5118 might be appropriate for any function that calls a function like
5119 @code{vprintf} or @code{vscanf}, but this might not always be the
5120 case, and some functions for which @code{format} attributes are
5121 appropriate may not be detected.
5122 @end table
5124 @item -Wsuggest-final-types
5125 @opindex Wno-suggest-final-types
5126 @opindex Wsuggest-final-types
5127 Warn about types with virtual methods where code quality would be improved
5128 if the type were declared with the C++11 @code{final} specifier, 
5129 or, if possible,
5130 declared in an anonymous namespace. This allows GCC to more aggressively
5131 devirtualize the polymorphic calls. This warning is more effective with link
5132 time optimization, where the information about the class hierarchy graph is
5133 more complete.
5135 @item -Wsuggest-final-methods
5136 @opindex Wno-suggest-final-methods
5137 @opindex Wsuggest-final-methods
5138 Warn about virtual methods where code quality would be improved if the method
5139 were declared with the C++11 @code{final} specifier, 
5140 or, if possible, its type were
5141 declared in an anonymous namespace or with the @code{final} specifier.
5142 This warning is
5143 more effective with link-time optimization, where the information about the
5144 class hierarchy graph is more complete. It is recommended to first consider
5145 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5146 annotations.
5148 @item -Wsuggest-override
5149 Warn about overriding virtual functions that are not marked with the override
5150 keyword.
5152 @item -Walloc-zero
5153 @opindex Wno-alloc-zero
5154 @opindex Walloc-zero
5155 Warn about calls to allocation functions decorated with attribute
5156 @code{alloc_size} that specify zero bytes, including those to the built-in
5157 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5158 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5159 when called with a zero size differs among implementations (and in the case
5160 of @code{realloc} has been deprecated) relying on it may result in subtle
5161 portability bugs and should be avoided.
5163 @item -Walloc-size-larger-than=@var{n}
5164 Warn about calls to functions decorated with attribute @code{alloc_size}
5165 that attempt to allocate objects larger than the specified number of bytes,
5166 or where the result of the size computation in an integer type with infinite
5167 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5168 may end in one of the standard suffixes designating a multiple of bytes
5169 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5170 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5171 @xref{Function Attributes}.
5173 @item -Walloca
5174 @opindex Wno-alloca
5175 @opindex Walloca
5176 This option warns on all uses of @code{alloca} in the source.
5178 @item -Walloca-larger-than=@var{n}
5179 This option warns on calls to @code{alloca} that are not bounded by a
5180 controlling predicate limiting its argument of integer type to at most
5181 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5182 Arguments of non-integer types are considered unbounded even if they
5183 appear to be constrained to the expected range.
5185 For example, a bounded case of @code{alloca} could be:
5187 @smallexample
5188 void func (size_t n)
5190   void *p;
5191   if (n <= 1000)
5192     p = alloca (n);
5193   else
5194     p = malloc (n);
5195   f (p);
5197 @end smallexample
5199 In the above example, passing @code{-Walloca-larger-than=1000} would not
5200 issue a warning because the call to @code{alloca} is known to be at most
5201 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5202 the compiler would emit a warning.
5204 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5205 controlling predicate constraining its integer argument.  For example:
5207 @smallexample
5208 void func ()
5210   void *p = alloca (n);
5211   f (p);
5213 @end smallexample
5215 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5216 a warning, but this time because of the lack of bounds checking.
5218 Note, that even seemingly correct code involving signed integers could
5219 cause a warning:
5221 @smallexample
5222 void func (signed int n)
5224   if (n < 500)
5225     @{
5226       p = alloca (n);
5227       f (p);
5228     @}
5230 @end smallexample
5232 In the above example, @var{n} could be negative, causing a larger than
5233 expected argument to be implicitly cast into the @code{alloca} call.
5235 This option also warns when @code{alloca} is used in a loop.
5237 This warning is not enabled by @option{-Wall}, and is only active when
5238 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5240 See also @option{-Wvla-larger-than=@var{n}}.
5242 @item -Warray-bounds
5243 @itemx -Warray-bounds=@var{n}
5244 @opindex Wno-array-bounds
5245 @opindex Warray-bounds
5246 This option is only active when @option{-ftree-vrp} is active
5247 (default for @option{-O2} and above). It warns about subscripts to arrays
5248 that are always out of bounds. This warning is enabled by @option{-Wall}.
5250 @table @gcctabopt
5251 @item -Warray-bounds=1
5252 This is the warning level of @option{-Warray-bounds} and is enabled
5253 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5255 @item -Warray-bounds=2
5256 This warning level also warns about out of bounds access for
5257 arrays at the end of a struct and for arrays accessed through
5258 pointers. This warning level may give a larger number of
5259 false positives and is deactivated by default.
5260 @end table
5262 @item -Wbool-compare
5263 @opindex Wno-bool-compare
5264 @opindex Wbool-compare
5265 Warn about boolean expression compared with an integer value different from
5266 @code{true}/@code{false}.  For instance, the following comparison is
5267 always false:
5268 @smallexample
5269 int n = 5;
5270 @dots{}
5271 if ((n > 1) == 2) @{ @dots{} @}
5272 @end smallexample
5273 This warning is enabled by @option{-Wall}.
5275 @item -Wbool-operation
5276 @opindex Wno-bool-operation
5277 @opindex Wbool-operation
5278 Warn about suspicious operations on expressions of a boolean type.  For
5279 instance, bitwise negation of a boolean is very likely a bug in the program.
5280 For C, this warning also warns about incrementing or decrementing a boolean,
5281 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5282 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5284 This warning is enabled by @option{-Wall}.
5286 @item -Wduplicated-branches
5287 @opindex Wno-duplicated-branches
5288 @opindex Wduplicated-branches
5289 Warn when an if-else has identical branches.  This warning detects cases like
5290 @smallexample
5291 if (p != NULL)
5292   return 0;
5293 else
5294   return 0;
5295 @end smallexample
5296 It doesn't warn when both branches contain just a null statement.  This warning
5297 also warn for conditional operators:
5298 @smallexample
5299   int i = x ? *p : *p;
5300 @end smallexample
5302 @item -Wduplicated-cond
5303 @opindex Wno-duplicated-cond
5304 @opindex Wduplicated-cond
5305 Warn about duplicated conditions in an if-else-if chain.  For instance,
5306 warn for the following code:
5307 @smallexample
5308 if (p->q != NULL) @{ @dots{} @}
5309 else if (p->q != NULL) @{ @dots{} @}
5310 @end smallexample
5312 @item -Wframe-address
5313 @opindex Wno-frame-address
5314 @opindex Wframe-address
5315 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5316 is called with an argument greater than 0.  Such calls may return indeterminate
5317 values or crash the program.  The warning is included in @option{-Wall}.
5319 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5320 @opindex Wno-discarded-qualifiers
5321 @opindex Wdiscarded-qualifiers
5322 Do not warn if type qualifiers on pointers are being discarded.
5323 Typically, the compiler warns if a @code{const char *} variable is
5324 passed to a function that takes a @code{char *} parameter.  This option
5325 can be used to suppress such a warning.
5327 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5328 @opindex Wno-discarded-array-qualifiers
5329 @opindex Wdiscarded-array-qualifiers
5330 Do not warn if type qualifiers on arrays which are pointer targets
5331 are being discarded. Typically, the compiler warns if a
5332 @code{const int (*)[]} variable is passed to a function that
5333 takes a @code{int (*)[]} parameter.  This option can be used to
5334 suppress such a warning.
5336 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5337 @opindex Wno-incompatible-pointer-types
5338 @opindex Wincompatible-pointer-types
5339 Do not warn when there is a conversion between pointers that have incompatible
5340 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5341 which warns for pointer argument passing or assignment with different
5342 signedness.
5344 @item -Wno-int-conversion @r{(C and Objective-C only)}
5345 @opindex Wno-int-conversion
5346 @opindex Wint-conversion
5347 Do not warn about incompatible integer to pointer and pointer to integer
5348 conversions.  This warning is about implicit conversions; for explicit
5349 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5350 @option{-Wno-pointer-to-int-cast} may be used.
5352 @item -Wno-div-by-zero
5353 @opindex Wno-div-by-zero
5354 @opindex Wdiv-by-zero
5355 Do not warn about compile-time integer division by zero.  Floating-point
5356 division by zero is not warned about, as it can be a legitimate way of
5357 obtaining infinities and NaNs.
5359 @item -Wsystem-headers
5360 @opindex Wsystem-headers
5361 @opindex Wno-system-headers
5362 @cindex warnings from system headers
5363 @cindex system headers, warnings from
5364 Print warning messages for constructs found in system header files.
5365 Warnings from system headers are normally suppressed, on the assumption
5366 that they usually do not indicate real problems and would only make the
5367 compiler output harder to read.  Using this command-line option tells
5368 GCC to emit warnings from system headers as if they occurred in user
5369 code.  However, note that using @option{-Wall} in conjunction with this
5370 option does @emph{not} warn about unknown pragmas in system
5371 headers---for that, @option{-Wunknown-pragmas} must also be used.
5373 @item -Wtautological-compare
5374 @opindex Wtautological-compare
5375 @opindex Wno-tautological-compare
5376 Warn if a self-comparison always evaluates to true or false.  This
5377 warning detects various mistakes such as:
5378 @smallexample
5379 int i = 1;
5380 @dots{}
5381 if (i > i) @{ @dots{} @}
5382 @end smallexample
5383 This warning is enabled by @option{-Wall}.
5385 @item -Wtrampolines
5386 @opindex Wtrampolines
5387 @opindex Wno-trampolines
5388 Warn about trampolines generated for pointers to nested functions.
5389 A trampoline is a small piece of data or code that is created at run
5390 time on the stack when the address of a nested function is taken, and is
5391 used to call the nested function indirectly.  For some targets, it is
5392 made up of data only and thus requires no special treatment.  But, for
5393 most targets, it is made up of code and thus requires the stack to be
5394 made executable in order for the program to work properly.
5396 @item -Wfloat-equal
5397 @opindex Wfloat-equal
5398 @opindex Wno-float-equal
5399 Warn if floating-point values are used in equality comparisons.
5401 The idea behind this is that sometimes it is convenient (for the
5402 programmer) to consider floating-point values as approximations to
5403 infinitely precise real numbers.  If you are doing this, then you need
5404 to compute (by analyzing the code, or in some other way) the maximum or
5405 likely maximum error that the computation introduces, and allow for it
5406 when performing comparisons (and when producing output, but that's a
5407 different problem).  In particular, instead of testing for equality, you
5408 should check to see whether the two values have ranges that overlap; and
5409 this is done with the relational operators, so equality comparisons are
5410 probably mistaken.
5412 @item -Wtraditional @r{(C and Objective-C only)}
5413 @opindex Wtraditional
5414 @opindex Wno-traditional
5415 Warn about certain constructs that behave differently in traditional and
5416 ISO C@.  Also warn about ISO C constructs that have no traditional C
5417 equivalent, and/or problematic constructs that should be avoided.
5419 @itemize @bullet
5420 @item
5421 Macro parameters that appear within string literals in the macro body.
5422 In traditional C macro replacement takes place within string literals,
5423 but in ISO C it does not.
5425 @item
5426 In traditional C, some preprocessor directives did not exist.
5427 Traditional preprocessors only considered a line to be a directive
5428 if the @samp{#} appeared in column 1 on the line.  Therefore
5429 @option{-Wtraditional} warns about directives that traditional C
5430 understands but ignores because the @samp{#} does not appear as the
5431 first character on the line.  It also suggests you hide directives like
5432 @code{#pragma} not understood by traditional C by indenting them.  Some
5433 traditional implementations do not recognize @code{#elif}, so this option
5434 suggests avoiding it altogether.
5436 @item
5437 A function-like macro that appears without arguments.
5439 @item
5440 The unary plus operator.
5442 @item
5443 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5444 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5445 constants.)  Note, these suffixes appear in macros defined in the system
5446 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5447 Use of these macros in user code might normally lead to spurious
5448 warnings, however GCC's integrated preprocessor has enough context to
5449 avoid warning in these cases.
5451 @item
5452 A function declared external in one block and then used after the end of
5453 the block.
5455 @item
5456 A @code{switch} statement has an operand of type @code{long}.
5458 @item
5459 A non-@code{static} function declaration follows a @code{static} one.
5460 This construct is not accepted by some traditional C compilers.
5462 @item
5463 The ISO type of an integer constant has a different width or
5464 signedness from its traditional type.  This warning is only issued if
5465 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5466 typically represent bit patterns, are not warned about.
5468 @item
5469 Usage of ISO string concatenation is detected.
5471 @item
5472 Initialization of automatic aggregates.
5474 @item
5475 Identifier conflicts with labels.  Traditional C lacks a separate
5476 namespace for labels.
5478 @item
5479 Initialization of unions.  If the initializer is zero, the warning is
5480 omitted.  This is done under the assumption that the zero initializer in
5481 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5482 initializer warnings and relies on default initialization to zero in the
5483 traditional C case.
5485 @item
5486 Conversions by prototypes between fixed/floating-point values and vice
5487 versa.  The absence of these prototypes when compiling with traditional
5488 C causes serious problems.  This is a subset of the possible
5489 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5491 @item
5492 Use of ISO C style function definitions.  This warning intentionally is
5493 @emph{not} issued for prototype declarations or variadic functions
5494 because these ISO C features appear in your code when using
5495 libiberty's traditional C compatibility macros, @code{PARAMS} and
5496 @code{VPARAMS}.  This warning is also bypassed for nested functions
5497 because that feature is already a GCC extension and thus not relevant to
5498 traditional C compatibility.
5499 @end itemize
5501 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5502 @opindex Wtraditional-conversion
5503 @opindex Wno-traditional-conversion
5504 Warn if a prototype causes a type conversion that is different from what
5505 would happen to the same argument in the absence of a prototype.  This
5506 includes conversions of fixed point to floating and vice versa, and
5507 conversions changing the width or signedness of a fixed-point argument
5508 except when the same as the default promotion.
5510 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5511 @opindex Wdeclaration-after-statement
5512 @opindex Wno-declaration-after-statement
5513 Warn when a declaration is found after a statement in a block.  This
5514 construct, known from C++, was introduced with ISO C99 and is by default
5515 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5517 @item -Wshadow
5518 @opindex Wshadow
5519 @opindex Wno-shadow
5520 Warn whenever a local variable or type declaration shadows another
5521 variable, parameter, type, class member (in C++), or instance variable
5522 (in Objective-C) or whenever a built-in function is shadowed. Note
5523 that in C++, the compiler warns if a local variable shadows an
5524 explicit typedef, but not if it shadows a struct/class/enum.
5525 Same as @option{-Wshadow=global}.
5527 @item -Wno-shadow-ivar @r{(Objective-C only)}
5528 @opindex Wno-shadow-ivar
5529 @opindex Wshadow-ivar
5530 Do not warn whenever a local variable shadows an instance variable in an
5531 Objective-C method.
5533 @item -Wshadow=global
5534 @opindex Wshadow=local
5535 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5537 @item -Wshadow=local
5538 @opindex Wshadow=local
5539 Warn when a local variable shadows another local variable or parameter.
5540 This warning is enabled by @option{-Wshadow=global}.
5542 @item -Wshadow=compatible-local
5543 @opindex Wshadow=compatible-local
5544 Warn when a local variable shadows another local variable or parameter
5545 whose type is compatible with that of the shadowing variable. In C++,
5546 type compatibility here means the type of the shadowing variable can be
5547 converted to that of the shadowed variable. The creation of this flag
5548 (in addition to @option{-Wshadow=local}) is based on the idea that when
5549 a local variable shadows another one of incompatible type, it is most
5550 likely intentional, not a bug or typo, as shown in the following example:
5552 @smallexample
5553 @group
5554 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5556   for (int i = 0; i < N; ++i)
5557   @{
5558     ...
5559   @}
5560   ...
5562 @end group
5563 @end smallexample
5565 Since the two variable @code{i} in the example above have incompatible types,
5566 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5567 Because their types are incompatible, if a programmer accidentally uses one
5568 in place of the other, type checking will catch that and emit an error or
5569 warning. So not warning (about shadowing) in this case will not lead to
5570 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5571 possibly reduce the number of warnings triggered by intentional shadowing.
5573 This warning is enabled by @option{-Wshadow=local}.
5575 @item -Wlarger-than=@var{len}
5576 @opindex Wlarger-than=@var{len}
5577 @opindex Wlarger-than-@var{len}
5578 Warn whenever an object of larger than @var{len} bytes is defined.
5580 @item -Wframe-larger-than=@var{len}
5581 @opindex Wframe-larger-than
5582 Warn if the size of a function frame is larger than @var{len} bytes.
5583 The computation done to determine the stack frame size is approximate
5584 and not conservative.
5585 The actual requirements may be somewhat greater than @var{len}
5586 even if you do not get a warning.  In addition, any space allocated
5587 via @code{alloca}, variable-length arrays, or related constructs
5588 is not included by the compiler when determining
5589 whether or not to issue a warning.
5591 @item -Wno-free-nonheap-object
5592 @opindex Wno-free-nonheap-object
5593 @opindex Wfree-nonheap-object
5594 Do not warn when attempting to free an object that was not allocated
5595 on the heap.
5597 @item -Wstack-usage=@var{len}
5598 @opindex Wstack-usage
5599 Warn if the stack usage of a function might be larger than @var{len} bytes.
5600 The computation done to determine the stack usage is conservative.
5601 Any space allocated via @code{alloca}, variable-length arrays, or related
5602 constructs is included by the compiler when determining whether or not to
5603 issue a warning.
5605 The message is in keeping with the output of @option{-fstack-usage}.
5607 @itemize
5608 @item
5609 If the stack usage is fully static but exceeds the specified amount, it's:
5611 @smallexample
5612   warning: stack usage is 1120 bytes
5613 @end smallexample
5614 @item
5615 If the stack usage is (partly) dynamic but bounded, it's:
5617 @smallexample
5618   warning: stack usage might be 1648 bytes
5619 @end smallexample
5620 @item
5621 If the stack usage is (partly) dynamic and not bounded, it's:
5623 @smallexample
5624   warning: stack usage might be unbounded
5625 @end smallexample
5626 @end itemize
5628 @item -Wunsafe-loop-optimizations
5629 @opindex Wunsafe-loop-optimizations
5630 @opindex Wno-unsafe-loop-optimizations
5631 Warn if the loop cannot be optimized because the compiler cannot
5632 assume anything on the bounds of the loop indices.  With
5633 @option{-funsafe-loop-optimizations} warn if the compiler makes
5634 such assumptions.
5636 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5637 @opindex Wno-pedantic-ms-format
5638 @opindex Wpedantic-ms-format
5639 When used in combination with @option{-Wformat}
5640 and @option{-pedantic} without GNU extensions, this option
5641 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5642 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5643 which depend on the MS runtime.
5645 @item -Waligned-new
5646 @opindex Waligned-new
5647 @opindex Wno-aligned-new
5648 Warn about a new-expression of a type that requires greater alignment
5649 than the @code{alignof(std::max_align_t)} but uses an allocation
5650 function without an explicit alignment parameter. This option is
5651 enabled by @option{-Wall}.
5653 Normally this only warns about global allocation functions, but
5654 @option{-Waligned-new=all} also warns about class member allocation
5655 functions.
5657 @item -Wplacement-new
5658 @itemx -Wplacement-new=@var{n}
5659 @opindex Wplacement-new
5660 @opindex Wno-placement-new
5661 Warn about placement new expressions with undefined behavior, such as
5662 constructing an object in a buffer that is smaller than the type of
5663 the object.  For example, the placement new expression below is diagnosed
5664 because it attempts to construct an array of 64 integers in a buffer only
5665 64 bytes large.
5666 @smallexample
5667 char buf [64];
5668 new (buf) int[64];
5669 @end smallexample
5670 This warning is enabled by default.
5672 @table @gcctabopt
5673 @item -Wplacement-new=1
5674 This is the default warning level of @option{-Wplacement-new}.  At this
5675 level the warning is not issued for some strictly undefined constructs that
5676 GCC allows as extensions for compatibility with legacy code.  For example,
5677 the following @code{new} expression is not diagnosed at this level even
5678 though it has undefined behavior according to the C++ standard because
5679 it writes past the end of the one-element array.
5680 @smallexample
5681 struct S @{ int n, a[1]; @};
5682 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5683 new (s->a)int [32]();
5684 @end smallexample
5686 @item -Wplacement-new=2
5687 At this level, in addition to diagnosing all the same constructs as at level
5688 1, a diagnostic is also issued for placement new expressions that construct
5689 an object in the last member of structure whose type is an array of a single
5690 element and whose size is less than the size of the object being constructed.
5691 While the previous example would be diagnosed, the following construct makes
5692 use of the flexible member array extension to avoid the warning at level 2.
5693 @smallexample
5694 struct S @{ int n, a[]; @};
5695 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5696 new (s->a)int [32]();
5697 @end smallexample
5699 @end table
5701 @item -Wpointer-arith
5702 @opindex Wpointer-arith
5703 @opindex Wno-pointer-arith
5704 Warn about anything that depends on the ``size of'' a function type or
5705 of @code{void}.  GNU C assigns these types a size of 1, for
5706 convenience in calculations with @code{void *} pointers and pointers
5707 to functions.  In C++, warn also when an arithmetic operation involves
5708 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5710 @item -Wpointer-compare
5711 @opindex Wpointer-compare
5712 @opindex Wno-pointer-compare
5713 Warn if a pointer is compared with a zero character constant.  This usually
5714 means that the pointer was meant to be dereferenced.  For example:
5716 @smallexample
5717 const char *p = foo ();
5718 if (p == '\0')
5719   return 42;
5720 @end smallexample
5722 Note that the code above is invalid in C++11.
5724 This warning is enabled by default.
5726 @item -Wtype-limits
5727 @opindex Wtype-limits
5728 @opindex Wno-type-limits
5729 Warn if a comparison is always true or always false due to the limited
5730 range of the data type, but do not warn for constant expressions.  For
5731 example, warn if an unsigned variable is compared against zero with
5732 @code{<} or @code{>=}.  This warning is also enabled by
5733 @option{-Wextra}.
5735 @include cppwarnopts.texi
5737 @item -Wbad-function-cast @r{(C and Objective-C only)}
5738 @opindex Wbad-function-cast
5739 @opindex Wno-bad-function-cast
5740 Warn when a function call is cast to a non-matching type.
5741 For example, warn if a call to a function returning an integer type 
5742 is cast to a pointer type.
5744 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5745 @opindex Wc90-c99-compat
5746 @opindex Wno-c90-c99-compat
5747 Warn about features not present in ISO C90, but present in ISO C99.
5748 For instance, warn about use of variable length arrays, @code{long long}
5749 type, @code{bool} type, compound literals, designated initializers, and so
5750 on.  This option is independent of the standards mode.  Warnings are disabled
5751 in the expression that follows @code{__extension__}.
5753 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5754 @opindex Wc99-c11-compat
5755 @opindex Wno-c99-c11-compat
5756 Warn about features not present in ISO C99, but present in ISO C11.
5757 For instance, warn about use of anonymous structures and unions,
5758 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5759 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5760 and so on.  This option is independent of the standards mode.  Warnings are
5761 disabled in the expression that follows @code{__extension__}.
5763 @item -Wc++-compat @r{(C and Objective-C only)}
5764 @opindex Wc++-compat
5765 Warn about ISO C constructs that are outside of the common subset of
5766 ISO C and ISO C++, e.g.@: request for implicit conversion from
5767 @code{void *} to a pointer to non-@code{void} type.
5769 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5770 @opindex Wc++11-compat
5771 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5772 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5773 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5774 enabled by @option{-Wall}.
5776 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5777 @opindex Wc++14-compat
5778 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5779 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5781 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5782 @opindex Wc++1z-compat
5783 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5784 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5786 @item -Wcast-qual
5787 @opindex Wcast-qual
5788 @opindex Wno-cast-qual
5789 Warn whenever a pointer is cast so as to remove a type qualifier from
5790 the target type.  For example, warn if a @code{const char *} is cast
5791 to an ordinary @code{char *}.
5793 Also warn when making a cast that introduces a type qualifier in an
5794 unsafe way.  For example, casting @code{char **} to @code{const char **}
5795 is unsafe, as in this example:
5797 @smallexample
5798   /* p is char ** value.  */
5799   const char **q = (const char **) p;
5800   /* Assignment of readonly string to const char * is OK.  */
5801   *q = "string";
5802   /* Now char** pointer points to read-only memory.  */
5803   **p = 'b';
5804 @end smallexample
5806 @item -Wcast-align
5807 @opindex Wcast-align
5808 @opindex Wno-cast-align
5809 Warn whenever a pointer is cast such that the required alignment of the
5810 target is increased.  For example, warn if a @code{char *} is cast to
5811 an @code{int *} on machines where integers can only be accessed at
5812 two- or four-byte boundaries.
5814 @item -Wwrite-strings
5815 @opindex Wwrite-strings
5816 @opindex Wno-write-strings
5817 When compiling C, give string constants the type @code{const
5818 char[@var{length}]} so that copying the address of one into a
5819 non-@code{const} @code{char *} pointer produces a warning.  These
5820 warnings help you find at compile time code that can try to write
5821 into a string constant, but only if you have been very careful about
5822 using @code{const} in declarations and prototypes.  Otherwise, it is
5823 just a nuisance. This is why we did not make @option{-Wall} request
5824 these warnings.
5826 When compiling C++, warn about the deprecated conversion from string
5827 literals to @code{char *}.  This warning is enabled by default for C++
5828 programs.
5830 @item -Wclobbered
5831 @opindex Wclobbered
5832 @opindex Wno-clobbered
5833 Warn for variables that might be changed by @code{longjmp} or
5834 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5836 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5837 @opindex Wconditionally-supported
5838 @opindex Wno-conditionally-supported
5839 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5841 @item -Wconversion
5842 @opindex Wconversion
5843 @opindex Wno-conversion
5844 Warn for implicit conversions that may alter a value. This includes
5845 conversions between real and integer, like @code{abs (x)} when
5846 @code{x} is @code{double}; conversions between signed and unsigned,
5847 like @code{unsigned ui = -1}; and conversions to smaller types, like
5848 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5849 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5850 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5851 conversions between signed and unsigned integers can be disabled by
5852 using @option{-Wno-sign-conversion}.
5854 For C++, also warn for confusing overload resolution for user-defined
5855 conversions; and conversions that never use a type conversion
5856 operator: conversions to @code{void}, the same type, a base class or a
5857 reference to them. Warnings about conversions between signed and
5858 unsigned integers are disabled by default in C++ unless
5859 @option{-Wsign-conversion} is explicitly enabled.
5861 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5862 @opindex Wconversion-null
5863 @opindex Wno-conversion-null
5864 Do not warn for conversions between @code{NULL} and non-pointer
5865 types. @option{-Wconversion-null} is enabled by default.
5867 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5868 @opindex Wzero-as-null-pointer-constant
5869 @opindex Wno-zero-as-null-pointer-constant
5870 Warn when a literal @samp{0} is used as null pointer constant.  This can
5871 be useful to facilitate the conversion to @code{nullptr} in C++11.
5873 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5874 @opindex Wsubobject-linkage
5875 @opindex Wno-subobject-linkage
5876 Warn if a class type has a base or a field whose type uses the anonymous
5877 namespace or depends on a type with no linkage.  If a type A depends on
5878 a type B with no or internal linkage, defining it in multiple
5879 translation units would be an ODR violation because the meaning of B
5880 is different in each translation unit.  If A only appears in a single
5881 translation unit, the best way to silence the warning is to give it
5882 internal linkage by putting it in an anonymous namespace as well.  The
5883 compiler doesn't give this warning for types defined in the main .C
5884 file, as those are unlikely to have multiple definitions.
5885 @option{-Wsubobject-linkage} is enabled by default.
5887 @item -Wdangling-else
5888 @opindex Wdangling-else
5889 @opindex Wno-dangling-else
5890 Warn about constructions where there may be confusion to which
5891 @code{if} statement an @code{else} branch belongs.  Here is an example of
5892 such a case:
5894 @smallexample
5895 @group
5897   if (a)
5898     if (b)
5899       foo ();
5900   else
5901     bar ();
5903 @end group
5904 @end smallexample
5906 In C/C++, every @code{else} branch belongs to the innermost possible
5907 @code{if} statement, which in this example is @code{if (b)}.  This is
5908 often not what the programmer expected, as illustrated in the above
5909 example by indentation the programmer chose.  When there is the
5910 potential for this confusion, GCC issues a warning when this flag
5911 is specified.  To eliminate the warning, add explicit braces around
5912 the innermost @code{if} statement so there is no way the @code{else}
5913 can belong to the enclosing @code{if}.  The resulting code
5914 looks like this:
5916 @smallexample
5917 @group
5919   if (a)
5920     @{
5921       if (b)
5922         foo ();
5923       else
5924         bar ();
5925     @}
5927 @end group
5928 @end smallexample
5930 This warning is enabled by @option{-Wparentheses}.
5932 @item -Wdate-time
5933 @opindex Wdate-time
5934 @opindex Wno-date-time
5935 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5936 are encountered as they might prevent bit-wise-identical reproducible
5937 compilations.
5939 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5940 @opindex Wdelete-incomplete
5941 @opindex Wno-delete-incomplete
5942 Warn when deleting a pointer to incomplete type, which may cause
5943 undefined behavior at runtime.  This warning is enabled by default.
5945 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5946 @opindex Wuseless-cast
5947 @opindex Wno-useless-cast
5948 Warn when an expression is casted to its own type.
5950 @item -Wempty-body
5951 @opindex Wempty-body
5952 @opindex Wno-empty-body
5953 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5954 while} statement.  This warning is also enabled by @option{-Wextra}.
5956 @item -Wenum-compare
5957 @opindex Wenum-compare
5958 @opindex Wno-enum-compare
5959 Warn about a comparison between values of different enumerated types.
5960 In C++ enumerated type mismatches in conditional expressions are also
5961 diagnosed and the warning is enabled by default.  In C this warning is 
5962 enabled by @option{-Wall}.
5964 @item -Wextra-semi @r{(C++, Objective-C++ only)}
5965 @opindex Wextra-semi
5966 @opindex Wno-extra-semi
5967 Warn about redundant semicolon after in-class function definition.
5969 @item -Wjump-misses-init @r{(C, Objective-C only)}
5970 @opindex Wjump-misses-init
5971 @opindex Wno-jump-misses-init
5972 Warn if a @code{goto} statement or a @code{switch} statement jumps
5973 forward across the initialization of a variable, or jumps backward to a
5974 label after the variable has been initialized.  This only warns about
5975 variables that are initialized when they are declared.  This warning is
5976 only supported for C and Objective-C; in C++ this sort of branch is an
5977 error in any case.
5979 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5980 can be disabled with the @option{-Wno-jump-misses-init} option.
5982 @item -Wsign-compare
5983 @opindex Wsign-compare
5984 @opindex Wno-sign-compare
5985 @cindex warning for comparison of signed and unsigned values
5986 @cindex comparison of signed and unsigned values, warning
5987 @cindex signed and unsigned values, comparison warning
5988 Warn when a comparison between signed and unsigned values could produce
5989 an incorrect result when the signed value is converted to unsigned.
5990 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
5991 also enabled by @option{-Wextra}.
5993 @item -Wsign-conversion
5994 @opindex Wsign-conversion
5995 @opindex Wno-sign-conversion
5996 Warn for implicit conversions that may change the sign of an integer
5997 value, like assigning a signed integer expression to an unsigned
5998 integer variable. An explicit cast silences the warning. In C, this
5999 option is enabled also by @option{-Wconversion}.
6001 @item -Wfloat-conversion
6002 @opindex Wfloat-conversion
6003 @opindex Wno-float-conversion
6004 Warn for implicit conversions that reduce the precision of a real value.
6005 This includes conversions from real to integer, and from higher precision
6006 real to lower precision real values.  This option is also enabled by
6007 @option{-Wconversion}.
6009 @item -Wno-scalar-storage-order
6010 @opindex -Wno-scalar-storage-order
6011 @opindex -Wscalar-storage-order
6012 Do not warn on suspicious constructs involving reverse scalar storage order.
6014 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6015 @opindex Wsized-deallocation
6016 @opindex Wno-sized-deallocation
6017 Warn about a definition of an unsized deallocation function
6018 @smallexample
6019 void operator delete (void *) noexcept;
6020 void operator delete[] (void *) noexcept;
6021 @end smallexample
6022 without a definition of the corresponding sized deallocation function
6023 @smallexample
6024 void operator delete (void *, std::size_t) noexcept;
6025 void operator delete[] (void *, std::size_t) noexcept;
6026 @end smallexample
6027 or vice versa.  Enabled by @option{-Wextra} along with
6028 @option{-fsized-deallocation}.
6030 @item -Wsizeof-pointer-memaccess
6031 @opindex Wsizeof-pointer-memaccess
6032 @opindex Wno-sizeof-pointer-memaccess
6033 Warn for suspicious length parameters to certain string and memory built-in
6034 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6035 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6036 but a pointer, and suggests a possible fix, or about
6037 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6038 @option{-Wall}.
6040 @item -Wsizeof-array-argument
6041 @opindex Wsizeof-array-argument
6042 @opindex Wno-sizeof-array-argument
6043 Warn when the @code{sizeof} operator is applied to a parameter that is
6044 declared as an array in a function definition.  This warning is enabled by
6045 default for C and C++ programs.
6047 @item -Wmemset-elt-size
6048 @opindex Wmemset-elt-size
6049 @opindex Wno-memset-elt-size
6050 Warn for suspicious calls to the @code{memset} built-in function, if the
6051 first argument references an array, and the third argument is a number
6052 equal to the number of elements, but not equal to the size of the array
6053 in memory.  This indicates that the user has omitted a multiplication by
6054 the element size.  This warning is enabled by @option{-Wall}.
6056 @item -Wmemset-transposed-args
6057 @opindex Wmemset-transposed-args
6058 @opindex Wno-memset-transposed-args
6059 Warn for suspicious calls to the @code{memset} built-in function, if the
6060 second argument is not zero and the third argument is zero.  This warns e.g.@
6061 about @code{memset (buf, sizeof buf, 0)} where most probably
6062 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6063 is only emitted if the third argument is literal zero.  If it is some
6064 expression that is folded to zero, a cast of zero to some type, etc., 
6065 it is far less likely that the user has mistakenly exchanged the arguments 
6066 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6068 @item -Waddress
6069 @opindex Waddress
6070 @opindex Wno-address
6071 Warn about suspicious uses of memory addresses. These include using
6072 the address of a function in a conditional expression, such as
6073 @code{void func(void); if (func)}, and comparisons against the memory
6074 address of a string literal, such as @code{if (x == "abc")}.  Such
6075 uses typically indicate a programmer error: the address of a function
6076 always evaluates to true, so their use in a conditional usually
6077 indicate that the programmer forgot the parentheses in a function
6078 call; and comparisons against string literals result in unspecified
6079 behavior and are not portable in C, so they usually indicate that the
6080 programmer intended to use @code{strcmp}.  This warning is enabled by
6081 @option{-Wall}.
6083 @item -Wlogical-op
6084 @opindex Wlogical-op
6085 @opindex Wno-logical-op
6086 Warn about suspicious uses of logical operators in expressions.
6087 This includes using logical operators in contexts where a
6088 bit-wise operator is likely to be expected.  Also warns when
6089 the operands of a logical operator are the same:
6090 @smallexample
6091 extern int a;
6092 if (a < 0 && a < 0) @{ @dots{} @}
6093 @end smallexample
6095 @item -Wlogical-not-parentheses
6096 @opindex Wlogical-not-parentheses
6097 @opindex Wno-logical-not-parentheses
6098 Warn about logical not used on the left hand side operand of a comparison.
6099 This option does not warn if the right operand is considered to be a boolean
6100 expression.  Its purpose is to detect suspicious code like the following:
6101 @smallexample
6102 int a;
6103 @dots{}
6104 if (!a > 1) @{ @dots{} @}
6105 @end smallexample
6107 It is possible to suppress the warning by wrapping the LHS into
6108 parentheses:
6109 @smallexample
6110 if ((!a) > 1) @{ @dots{} @}
6111 @end smallexample
6113 This warning is enabled by @option{-Wall}.
6115 @item -Waggregate-return
6116 @opindex Waggregate-return
6117 @opindex Wno-aggregate-return
6118 Warn if any functions that return structures or unions are defined or
6119 called.  (In languages where you can return an array, this also elicits
6120 a warning.)
6122 @item -Wno-aggressive-loop-optimizations
6123 @opindex Wno-aggressive-loop-optimizations
6124 @opindex Waggressive-loop-optimizations
6125 Warn if in a loop with constant number of iterations the compiler detects
6126 undefined behavior in some statement during one or more of the iterations.
6128 @item -Wno-attributes
6129 @opindex Wno-attributes
6130 @opindex Wattributes
6131 Do not warn if an unexpected @code{__attribute__} is used, such as
6132 unrecognized attributes, function attributes applied to variables,
6133 etc.  This does not stop errors for incorrect use of supported
6134 attributes.
6136 @item -Wno-builtin-declaration-mismatch
6137 @opindex Wno-builtin-declaration-mismatch
6138 @opindex Wbuiltin-declaration-mismatch
6139 Warn if a built-in function is declared with the wrong signature.
6140 This warning is enabled by default.
6142 @item -Wno-builtin-macro-redefined
6143 @opindex Wno-builtin-macro-redefined
6144 @opindex Wbuiltin-macro-redefined
6145 Do not warn if certain built-in macros are redefined.  This suppresses
6146 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6147 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6149 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6150 @opindex Wstrict-prototypes
6151 @opindex Wno-strict-prototypes
6152 Warn if a function is declared or defined without specifying the
6153 argument types.  (An old-style function definition is permitted without
6154 a warning if preceded by a declaration that specifies the argument
6155 types.)
6157 @item -Wold-style-declaration @r{(C and Objective-C only)}
6158 @opindex Wold-style-declaration
6159 @opindex Wno-old-style-declaration
6160 Warn for obsolescent usages, according to the C Standard, in a
6161 declaration. For example, warn if storage-class specifiers like
6162 @code{static} are not the first things in a declaration.  This warning
6163 is also enabled by @option{-Wextra}.
6165 @item -Wold-style-definition @r{(C and Objective-C only)}
6166 @opindex Wold-style-definition
6167 @opindex Wno-old-style-definition
6168 Warn if an old-style function definition is used.  A warning is given
6169 even if there is a previous prototype.
6171 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6172 @opindex Wmissing-parameter-type
6173 @opindex Wno-missing-parameter-type
6174 A function parameter is declared without a type specifier in K&R-style
6175 functions:
6177 @smallexample
6178 void foo(bar) @{ @}
6179 @end smallexample
6181 This warning is also enabled by @option{-Wextra}.
6183 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6184 @opindex Wmissing-prototypes
6185 @opindex Wno-missing-prototypes
6186 Warn if a global function is defined without a previous prototype
6187 declaration.  This warning is issued even if the definition itself
6188 provides a prototype.  Use this option to detect global functions
6189 that do not have a matching prototype declaration in a header file.
6190 This option is not valid for C++ because all function declarations
6191 provide prototypes and a non-matching declaration declares an
6192 overload rather than conflict with an earlier declaration.
6193 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6195 @item -Wmissing-declarations
6196 @opindex Wmissing-declarations
6197 @opindex Wno-missing-declarations
6198 Warn if a global function is defined without a previous declaration.
6199 Do so even if the definition itself provides a prototype.
6200 Use this option to detect global functions that are not declared in
6201 header files.  In C, no warnings are issued for functions with previous
6202 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6203 missing prototypes.  In C++, no warnings are issued for function templates,
6204 or for inline functions, or for functions in anonymous namespaces.
6206 @item -Wmissing-field-initializers
6207 @opindex Wmissing-field-initializers
6208 @opindex Wno-missing-field-initializers
6209 @opindex W
6210 @opindex Wextra
6211 @opindex Wno-extra
6212 Warn if a structure's initializer has some fields missing.  For
6213 example, the following code causes such a warning, because
6214 @code{x.h} is implicitly zero:
6216 @smallexample
6217 struct s @{ int f, g, h; @};
6218 struct s x = @{ 3, 4 @};
6219 @end smallexample
6221 This option does not warn about designated initializers, so the following
6222 modification does not trigger a warning:
6224 @smallexample
6225 struct s @{ int f, g, h; @};
6226 struct s x = @{ .f = 3, .g = 4 @};
6227 @end smallexample
6229 In C this option does not warn about the universal zero initializer
6230 @samp{@{ 0 @}}:
6232 @smallexample
6233 struct s @{ int f, g, h; @};
6234 struct s x = @{ 0 @};
6235 @end smallexample
6237 Likewise, in C++ this option does not warn about the empty @{ @}
6238 initializer, for example:
6240 @smallexample
6241 struct s @{ int f, g, h; @};
6242 s x = @{ @};
6243 @end smallexample
6245 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6246 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6248 @item -Wno-multichar
6249 @opindex Wno-multichar
6250 @opindex Wmultichar
6251 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6252 Usually they indicate a typo in the user's code, as they have
6253 implementation-defined values, and should not be used in portable code.
6255 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6256 @opindex Wnormalized=
6257 @opindex Wnormalized
6258 @opindex Wno-normalized
6259 @cindex NFC
6260 @cindex NFKC
6261 @cindex character set, input normalization
6262 In ISO C and ISO C++, two identifiers are different if they are
6263 different sequences of characters.  However, sometimes when characters
6264 outside the basic ASCII character set are used, you can have two
6265 different character sequences that look the same.  To avoid confusion,
6266 the ISO 10646 standard sets out some @dfn{normalization rules} which
6267 when applied ensure that two sequences that look the same are turned into
6268 the same sequence.  GCC can warn you if you are using identifiers that
6269 have not been normalized; this option controls that warning.
6271 There are four levels of warning supported by GCC@.  The default is
6272 @option{-Wnormalized=nfc}, which warns about any identifier that is
6273 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6274 recommended form for most uses.  It is equivalent to
6275 @option{-Wnormalized}.
6277 Unfortunately, there are some characters allowed in identifiers by
6278 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6279 identifiers.  That is, there's no way to use these symbols in portable
6280 ISO C or C++ and have all your identifiers in NFC@.
6281 @option{-Wnormalized=id} suppresses the warning for these characters.
6282 It is hoped that future versions of the standards involved will correct
6283 this, which is why this option is not the default.
6285 You can switch the warning off for all characters by writing
6286 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6287 only do this if you are using some other normalization scheme (like
6288 ``D''), because otherwise you can easily create bugs that are
6289 literally impossible to see.
6291 Some characters in ISO 10646 have distinct meanings but look identical
6292 in some fonts or display methodologies, especially once formatting has
6293 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6294 LETTER N'', displays just like a regular @code{n} that has been
6295 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6296 normalization scheme to convert all these into a standard form as
6297 well, and GCC warns if your code is not in NFKC if you use
6298 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6299 about every identifier that contains the letter O because it might be
6300 confused with the digit 0, and so is not the default, but may be
6301 useful as a local coding convention if the programming environment 
6302 cannot be fixed to display these characters distinctly.
6304 @item -Wno-deprecated
6305 @opindex Wno-deprecated
6306 @opindex Wdeprecated
6307 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6309 @item -Wno-deprecated-declarations
6310 @opindex Wno-deprecated-declarations
6311 @opindex Wdeprecated-declarations
6312 Do not warn about uses of functions (@pxref{Function Attributes}),
6313 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6314 Attributes}) marked as deprecated by using the @code{deprecated}
6315 attribute.
6317 @item -Wno-overflow
6318 @opindex Wno-overflow
6319 @opindex Woverflow
6320 Do not warn about compile-time overflow in constant expressions.
6322 @item -Wno-odr
6323 @opindex Wno-odr
6324 @opindex Wodr
6325 Warn about One Definition Rule violations during link-time optimization.
6326 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6328 @item -Wopenmp-simd
6329 @opindex Wopenm-simd
6330 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6331 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6332 option can be used to relax the cost model.
6334 @item -Woverride-init @r{(C and Objective-C only)}
6335 @opindex Woverride-init
6336 @opindex Wno-override-init
6337 @opindex W
6338 @opindex Wextra
6339 @opindex Wno-extra
6340 Warn if an initialized field without side effects is overridden when
6341 using designated initializers (@pxref{Designated Inits, , Designated
6342 Initializers}).
6344 This warning is included in @option{-Wextra}.  To get other
6345 @option{-Wextra} warnings without this one, use @option{-Wextra
6346 -Wno-override-init}.
6348 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6349 @opindex Woverride-init-side-effects
6350 @opindex Wno-override-init-side-effects
6351 Warn if an initialized field with side effects is overridden when
6352 using designated initializers (@pxref{Designated Inits, , Designated
6353 Initializers}).  This warning is enabled by default.
6355 @item -Wpacked
6356 @opindex Wpacked
6357 @opindex Wno-packed
6358 Warn if a structure is given the packed attribute, but the packed
6359 attribute has no effect on the layout or size of the structure.
6360 Such structures may be mis-aligned for little benefit.  For
6361 instance, in this code, the variable @code{f.x} in @code{struct bar}
6362 is misaligned even though @code{struct bar} does not itself
6363 have the packed attribute:
6365 @smallexample
6366 @group
6367 struct foo @{
6368   int x;
6369   char a, b, c, d;
6370 @} __attribute__((packed));
6371 struct bar @{
6372   char z;
6373   struct foo f;
6375 @end group
6376 @end smallexample
6378 @item -Wpacked-bitfield-compat
6379 @opindex Wpacked-bitfield-compat
6380 @opindex Wno-packed-bitfield-compat
6381 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6382 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6383 the change can lead to differences in the structure layout.  GCC
6384 informs you when the offset of such a field has changed in GCC 4.4.
6385 For example there is no longer a 4-bit padding between field @code{a}
6386 and @code{b} in this structure:
6388 @smallexample
6389 struct foo
6391   char a:4;
6392   char b:8;
6393 @} __attribute__ ((packed));
6394 @end smallexample
6396 This warning is enabled by default.  Use
6397 @option{-Wno-packed-bitfield-compat} to disable this warning.
6399 @item -Wpadded
6400 @opindex Wpadded
6401 @opindex Wno-padded
6402 Warn if padding is included in a structure, either to align an element
6403 of the structure or to align the whole structure.  Sometimes when this
6404 happens it is possible to rearrange the fields of the structure to
6405 reduce the padding and so make the structure smaller.
6407 @item -Wredundant-decls
6408 @opindex Wredundant-decls
6409 @opindex Wno-redundant-decls
6410 Warn if anything is declared more than once in the same scope, even in
6411 cases where multiple declaration is valid and changes nothing.
6413 @item -Wrestrict
6414 @opindex Wrestrict
6415 @opindex Wno-restrict
6416 Warn when an argument passed to a restrict-qualified parameter
6417 aliases with another argument.
6419 @item -Wnested-externs @r{(C and Objective-C only)}
6420 @opindex Wnested-externs
6421 @opindex Wno-nested-externs
6422 Warn if an @code{extern} declaration is encountered within a function.
6424 @item -Wno-inherited-variadic-ctor
6425 @opindex Winherited-variadic-ctor
6426 @opindex Wno-inherited-variadic-ctor
6427 Suppress warnings about use of C++11 inheriting constructors when the
6428 base class inherited from has a C variadic constructor; the warning is
6429 on by default because the ellipsis is not inherited.
6431 @item -Winline
6432 @opindex Winline
6433 @opindex Wno-inline
6434 Warn if a function that is declared as inline cannot be inlined.
6435 Even with this option, the compiler does not warn about failures to
6436 inline functions declared in system headers.
6438 The compiler uses a variety of heuristics to determine whether or not
6439 to inline a function.  For example, the compiler takes into account
6440 the size of the function being inlined and the amount of inlining
6441 that has already been done in the current function.  Therefore,
6442 seemingly insignificant changes in the source program can cause the
6443 warnings produced by @option{-Winline} to appear or disappear.
6445 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6446 @opindex Wno-invalid-offsetof
6447 @opindex Winvalid-offsetof
6448 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6449 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6450 to a non-standard-layout type is undefined.  In existing C++ implementations,
6451 however, @code{offsetof} typically gives meaningful results.
6452 This flag is for users who are aware that they are
6453 writing nonportable code and who have deliberately chosen to ignore the
6454 warning about it.
6456 The restrictions on @code{offsetof} may be relaxed in a future version
6457 of the C++ standard.
6459 @item -Wint-in-bool-context
6460 @opindex Wint-in-bool-context
6461 @opindex Wno-int-in-bool-context
6462 Warn for suspicious use of integer values where boolean values are expected,
6463 such as conditional expressions (?:) using non-boolean integer constants in
6464 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6465 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6466 for all kinds of multiplications regardless of the data type.
6467 This warning is enabled by @option{-Wall}.
6469 @item -Wno-int-to-pointer-cast
6470 @opindex Wno-int-to-pointer-cast
6471 @opindex Wint-to-pointer-cast
6472 Suppress warnings from casts to pointer type of an integer of a
6473 different size. In C++, casting to a pointer type of smaller size is
6474 an error. @option{Wint-to-pointer-cast} is enabled by default.
6477 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6478 @opindex Wno-pointer-to-int-cast
6479 @opindex Wpointer-to-int-cast
6480 Suppress warnings from casts from a pointer to an integer type of a
6481 different size.
6483 @item -Winvalid-pch
6484 @opindex Winvalid-pch
6485 @opindex Wno-invalid-pch
6486 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6487 the search path but cannot be used.
6489 @item -Wlong-long
6490 @opindex Wlong-long
6491 @opindex Wno-long-long
6492 Warn if @code{long long} type is used.  This is enabled by either
6493 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6494 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6496 @item -Wvariadic-macros
6497 @opindex Wvariadic-macros
6498 @opindex Wno-variadic-macros
6499 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6500 alternate syntax is used in ISO C99 mode.  This is enabled by either
6501 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6502 messages, use @option{-Wno-variadic-macros}.
6504 @item -Wvarargs
6505 @opindex Wvarargs
6506 @opindex Wno-varargs
6507 Warn upon questionable usage of the macros used to handle variable
6508 arguments like @code{va_start}.  This is default.  To inhibit the
6509 warning messages, use @option{-Wno-varargs}.
6511 @item -Wvector-operation-performance
6512 @opindex Wvector-operation-performance
6513 @opindex Wno-vector-operation-performance
6514 Warn if vector operation is not implemented via SIMD capabilities of the
6515 architecture.  Mainly useful for the performance tuning.
6516 Vector operation can be implemented @code{piecewise}, which means that the
6517 scalar operation is performed on every vector element; 
6518 @code{in parallel}, which means that the vector operation is implemented
6519 using scalars of wider type, which normally is more performance efficient;
6520 and @code{as a single scalar}, which means that vector fits into a
6521 scalar type.
6523 @item -Wno-virtual-move-assign
6524 @opindex Wvirtual-move-assign
6525 @opindex Wno-virtual-move-assign
6526 Suppress warnings about inheriting from a virtual base with a
6527 non-trivial C++11 move assignment operator.  This is dangerous because
6528 if the virtual base is reachable along more than one path, it is
6529 moved multiple times, which can mean both objects end up in the
6530 moved-from state.  If the move assignment operator is written to avoid
6531 moving from a moved-from object, this warning can be disabled.
6533 @item -Wvla
6534 @opindex Wvla
6535 @opindex Wno-vla
6536 Warn if a variable-length array is used in the code.
6537 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6538 the variable-length array.
6540 @item -Wvla-larger-than=@var{n}
6541 If this option is used, the compiler will warn on uses of
6542 variable-length arrays where the size is either unbounded, or bounded
6543 by an argument that can be larger than @var{n} bytes.  This is similar
6544 to how @option{-Walloca-larger-than=@var{n}} works, but with
6545 variable-length arrays.
6547 Note that GCC may optimize small variable-length arrays of a known
6548 value into plain arrays, so this warning may not get triggered for
6549 such arrays.
6551 This warning is not enabled by @option{-Wall}, and is only active when
6552 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6554 See also @option{-Walloca-larger-than=@var{n}}.
6556 @item -Wvolatile-register-var
6557 @opindex Wvolatile-register-var
6558 @opindex Wno-volatile-register-var
6559 Warn if a register variable is declared volatile.  The volatile
6560 modifier does not inhibit all optimizations that may eliminate reads
6561 and/or writes to register variables.  This warning is enabled by
6562 @option{-Wall}.
6564 @item -Wdisabled-optimization
6565 @opindex Wdisabled-optimization
6566 @opindex Wno-disabled-optimization
6567 Warn if a requested optimization pass is disabled.  This warning does
6568 not generally indicate that there is anything wrong with your code; it
6569 merely indicates that GCC's optimizers are unable to handle the code
6570 effectively.  Often, the problem is that your code is too big or too
6571 complex; GCC refuses to optimize programs when the optimization
6572 itself is likely to take inordinate amounts of time.
6574 @item -Wpointer-sign @r{(C and Objective-C only)}
6575 @opindex Wpointer-sign
6576 @opindex Wno-pointer-sign
6577 Warn for pointer argument passing or assignment with different signedness.
6578 This option is only supported for C and Objective-C@.  It is implied by
6579 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6580 @option{-Wno-pointer-sign}.
6582 @item -Wstack-protector
6583 @opindex Wstack-protector
6584 @opindex Wno-stack-protector
6585 This option is only active when @option{-fstack-protector} is active.  It
6586 warns about functions that are not protected against stack smashing.
6588 @item -Woverlength-strings
6589 @opindex Woverlength-strings
6590 @opindex Wno-overlength-strings
6591 Warn about string constants that are longer than the ``minimum
6592 maximum'' length specified in the C standard.  Modern compilers
6593 generally allow string constants that are much longer than the
6594 standard's minimum limit, but very portable programs should avoid
6595 using longer strings.
6597 The limit applies @emph{after} string constant concatenation, and does
6598 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6599 C99, it was raised to 4095.  C++98 does not specify a normative
6600 minimum maximum, so we do not diagnose overlength strings in C++@.
6602 This option is implied by @option{-Wpedantic}, and can be disabled with
6603 @option{-Wno-overlength-strings}.
6605 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6606 @opindex Wunsuffixed-float-constants
6608 Issue a warning for any floating constant that does not have
6609 a suffix.  When used together with @option{-Wsystem-headers} it
6610 warns about such constants in system header files.  This can be useful
6611 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6612 from the decimal floating-point extension to C99.
6614 @item -Wno-designated-init @r{(C and Objective-C only)}
6615 Suppress warnings when a positional initializer is used to initialize
6616 a structure that has been marked with the @code{designated_init}
6617 attribute.
6619 @item -Whsa
6620 Issue a warning when HSAIL cannot be emitted for the compiled function or
6621 OpenMP construct.
6623 @end table
6625 @node Debugging Options
6626 @section Options for Debugging Your Program
6627 @cindex options, debugging
6628 @cindex debugging information options
6630 To tell GCC to emit extra information for use by a debugger, in almost 
6631 all cases you need only to add @option{-g} to your other options.
6633 GCC allows you to use @option{-g} with
6634 @option{-O}.  The shortcuts taken by optimized code may occasionally
6635 be surprising: some variables you declared may not exist
6636 at all; flow of control may briefly move where you did not expect it;
6637 some statements may not be executed because they compute constant
6638 results or their values are already at hand; some statements may
6639 execute in different places because they have been moved out of loops.
6640 Nevertheless it is possible to debug optimized output.  This makes
6641 it reasonable to use the optimizer for programs that might have bugs.
6643 If you are not using some other optimization option, consider
6644 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6645 With no @option{-O} option at all, some compiler passes that collect
6646 information useful for debugging do not run at all, so that
6647 @option{-Og} may result in a better debugging experience.
6649 @table @gcctabopt
6650 @item -g
6651 @opindex g
6652 Produce debugging information in the operating system's native format
6653 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6654 information.
6656 On most systems that use stabs format, @option{-g} enables use of extra
6657 debugging information that only GDB can use; this extra information
6658 makes debugging work better in GDB but probably makes other debuggers
6659 crash or
6660 refuse to read the program.  If you want to control for certain whether
6661 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6662 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6664 @item -ggdb
6665 @opindex ggdb
6666 Produce debugging information for use by GDB@.  This means to use the
6667 most expressive format available (DWARF, stabs, or the native format
6668 if neither of those are supported), including GDB extensions if at all
6669 possible.
6671 @item -gdwarf
6672 @itemx -gdwarf-@var{version}
6673 @opindex gdwarf
6674 Produce debugging information in DWARF format (if that is supported).
6675 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6676 for most targets is 4.  DWARF Version 5 is only experimental.
6678 Note that with DWARF Version 2, some ports require and always
6679 use some non-conflicting DWARF 3 extensions in the unwind tables.
6681 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6682 for maximum benefit.
6684 GCC no longer supports DWARF Version 1, which is substantially
6685 different than Version 2 and later.  For historical reasons, some
6686 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6687 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6688 in their names, but apply to all currently-supported versions of DWARF.
6690 @item -gstabs
6691 @opindex gstabs
6692 Produce debugging information in stabs format (if that is supported),
6693 without GDB extensions.  This is the format used by DBX on most BSD
6694 systems.  On MIPS, Alpha and System V Release 4 systems this option
6695 produces stabs debugging output that is not understood by DBX or SDB@.
6696 On System V Release 4 systems this option requires the GNU assembler.
6698 @item -gstabs+
6699 @opindex gstabs+
6700 Produce debugging information in stabs format (if that is supported),
6701 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6702 use of these extensions is likely to make other debuggers crash or
6703 refuse to read the program.
6705 @item -gcoff
6706 @opindex gcoff
6707 Produce debugging information in COFF format (if that is supported).
6708 This is the format used by SDB on most System V systems prior to
6709 System V Release 4.
6711 @item -gxcoff
6712 @opindex gxcoff
6713 Produce debugging information in XCOFF format (if that is supported).
6714 This is the format used by the DBX debugger on IBM RS/6000 systems.
6716 @item -gxcoff+
6717 @opindex gxcoff+
6718 Produce debugging information in XCOFF format (if that is supported),
6719 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6720 use of these extensions is likely to make other debuggers crash or
6721 refuse to read the program, and may cause assemblers other than the GNU
6722 assembler (GAS) to fail with an error.
6724 @item -gvms
6725 @opindex gvms
6726 Produce debugging information in Alpha/VMS debug format (if that is
6727 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6729 @item -g@var{level}
6730 @itemx -ggdb@var{level}
6731 @itemx -gstabs@var{level}
6732 @itemx -gcoff@var{level}
6733 @itemx -gxcoff@var{level}
6734 @itemx -gvms@var{level}
6735 Request debugging information and also use @var{level} to specify how
6736 much information.  The default level is 2.
6738 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6739 @option{-g}.
6741 Level 1 produces minimal information, enough for making backtraces in
6742 parts of the program that you don't plan to debug.  This includes
6743 descriptions of functions and external variables, and line number
6744 tables, but no information about local variables.
6746 Level 3 includes extra information, such as all the macro definitions
6747 present in the program.  Some debuggers support macro expansion when
6748 you use @option{-g3}.
6750 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6751 confusion with @option{-gdwarf-@var{level}}.
6752 Instead use an additional @option{-g@var{level}} option to change the
6753 debug level for DWARF.
6755 @item -feliminate-unused-debug-symbols
6756 @opindex feliminate-unused-debug-symbols
6757 Produce debugging information in stabs format (if that is supported),
6758 for only symbols that are actually used.
6760 @item -femit-class-debug-always
6761 @opindex femit-class-debug-always
6762 Instead of emitting debugging information for a C++ class in only one
6763 object file, emit it in all object files using the class.  This option
6764 should be used only with debuggers that are unable to handle the way GCC
6765 normally emits debugging information for classes because using this
6766 option increases the size of debugging information by as much as a
6767 factor of two.
6769 @item -fno-merge-debug-strings
6770 @opindex fmerge-debug-strings
6771 @opindex fno-merge-debug-strings
6772 Direct the linker to not merge together strings in the debugging
6773 information that are identical in different object files.  Merging is
6774 not supported by all assemblers or linkers.  Merging decreases the size
6775 of the debug information in the output file at the cost of increasing
6776 link processing time.  Merging is enabled by default.
6778 @item -fdebug-prefix-map=@var{old}=@var{new}
6779 @opindex fdebug-prefix-map
6780 When compiling files in directory @file{@var{old}}, record debugging
6781 information describing them as in @file{@var{new}} instead.
6783 @item -fvar-tracking
6784 @opindex fvar-tracking
6785 Run variable tracking pass.  It computes where variables are stored at each
6786 position in code.  Better debugging information is then generated
6787 (if the debugging information format supports this information).
6789 It is enabled by default when compiling with optimization (@option{-Os},
6790 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6791 the debug info format supports it.
6793 @item -fvar-tracking-assignments
6794 @opindex fvar-tracking-assignments
6795 @opindex fno-var-tracking-assignments
6796 Annotate assignments to user variables early in the compilation and
6797 attempt to carry the annotations over throughout the compilation all the
6798 way to the end, in an attempt to improve debug information while
6799 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6801 It can be enabled even if var-tracking is disabled, in which case
6802 annotations are created and maintained, but discarded at the end.
6803 By default, this flag is enabled together with @option{-fvar-tracking},
6804 except when selective scheduling is enabled.
6806 @item -gsplit-dwarf
6807 @opindex gsplit-dwarf
6808 Separate as much DWARF debugging information as possible into a
6809 separate output file with the extension @file{.dwo}.  This option allows
6810 the build system to avoid linking files with debug information.  To
6811 be useful, this option requires a debugger capable of reading @file{.dwo}
6812 files.
6814 @item -gpubnames
6815 @opindex gpubnames
6816 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6818 @item -ggnu-pubnames
6819 @opindex ggnu-pubnames
6820 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6821 suitable for conversion into a GDB@ index.  This option is only useful
6822 with a linker that can produce GDB@ index version 7.
6824 @item -fdebug-types-section
6825 @opindex fdebug-types-section
6826 @opindex fno-debug-types-section
6827 When using DWARF Version 4 or higher, type DIEs can be put into
6828 their own @code{.debug_types} section instead of making them part of the
6829 @code{.debug_info} section.  It is more efficient to put them in a separate
6830 comdat sections since the linker can then remove duplicates.
6831 But not all DWARF consumers support @code{.debug_types} sections yet
6832 and on some objects @code{.debug_types} produces larger instead of smaller
6833 debugging information.
6835 @item -grecord-gcc-switches
6836 @item -gno-record-gcc-switches
6837 @opindex grecord-gcc-switches
6838 @opindex gno-record-gcc-switches
6839 This switch causes the command-line options used to invoke the
6840 compiler that may affect code generation to be appended to the
6841 DW_AT_producer attribute in DWARF debugging information.  The options
6842 are concatenated with spaces separating them from each other and from
6843 the compiler version.  
6844 It is enabled by default.
6845 See also @option{-frecord-gcc-switches} for another
6846 way of storing compiler options into the object file.  
6848 @item -gstrict-dwarf
6849 @opindex gstrict-dwarf
6850 Disallow using extensions of later DWARF standard version than selected
6851 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6852 DWARF extensions from later standard versions is allowed.
6854 @item -gno-strict-dwarf
6855 @opindex gno-strict-dwarf
6856 Allow using extensions of later DWARF standard version than selected with
6857 @option{-gdwarf-@var{version}}.
6859 @item -gcolumn-info
6860 @item -gno-column-info
6861 @opindex gcolumn-info
6862 @opindex gno-column-info
6863 Emit location column information into DWARF debugging information, rather
6864 than just file and line.
6865 This option is disabled by default.
6867 @item -gz@r{[}=@var{type}@r{]}
6868 @opindex gz
6869 Produce compressed debug sections in DWARF format, if that is supported.
6870 If @var{type} is not given, the default type depends on the capabilities
6871 of the assembler and linker used.  @var{type} may be one of
6872 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6873 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6874 compression in traditional GNU format).  If the linker doesn't support
6875 writing compressed debug sections, the option is rejected.  Otherwise,
6876 if the assembler does not support them, @option{-gz} is silently ignored
6877 when producing object files.
6879 @item -feliminate-dwarf2-dups
6880 @opindex feliminate-dwarf2-dups
6881 Compress DWARF debugging information by eliminating duplicated
6882 information about each symbol.  This option only makes sense when
6883 generating DWARF debugging information.
6885 @item -femit-struct-debug-baseonly
6886 @opindex femit-struct-debug-baseonly
6887 Emit debug information for struct-like types
6888 only when the base name of the compilation source file
6889 matches the base name of file in which the struct is defined.
6891 This option substantially reduces the size of debugging information,
6892 but at significant potential loss in type information to the debugger.
6893 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6894 See @option{-femit-struct-debug-detailed} for more detailed control.
6896 This option works only with DWARF debug output.
6898 @item -femit-struct-debug-reduced
6899 @opindex femit-struct-debug-reduced
6900 Emit debug information for struct-like types
6901 only when the base name of the compilation source file
6902 matches the base name of file in which the type is defined,
6903 unless the struct is a template or defined in a system header.
6905 This option significantly reduces the size of debugging information,
6906 with some potential loss in type information to the debugger.
6907 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6908 See @option{-femit-struct-debug-detailed} for more detailed control.
6910 This option works only with DWARF debug output.
6912 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6913 @opindex femit-struct-debug-detailed
6914 Specify the struct-like types
6915 for which the compiler generates debug information.
6916 The intent is to reduce duplicate struct debug information
6917 between different object files within the same program.
6919 This option is a detailed version of
6920 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6921 which serves for most needs.
6923 A specification has the syntax@*
6924 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6926 The optional first word limits the specification to
6927 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6928 A struct type is used directly when it is the type of a variable, member.
6929 Indirect uses arise through pointers to structs.
6930 That is, when use of an incomplete struct is valid, the use is indirect.
6931 An example is
6932 @samp{struct one direct; struct two * indirect;}.
6934 The optional second word limits the specification to
6935 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6936 Generic structs are a bit complicated to explain.
6937 For C++, these are non-explicit specializations of template classes,
6938 or non-template classes within the above.
6939 Other programming languages have generics,
6940 but @option{-femit-struct-debug-detailed} does not yet implement them.
6942 The third word specifies the source files for those
6943 structs for which the compiler should emit debug information.
6944 The values @samp{none} and @samp{any} have the normal meaning.
6945 The value @samp{base} means that
6946 the base of name of the file in which the type declaration appears
6947 must match the base of the name of the main compilation file.
6948 In practice, this means that when compiling @file{foo.c}, debug information
6949 is generated for types declared in that file and @file{foo.h},
6950 but not other header files.
6951 The value @samp{sys} means those types satisfying @samp{base}
6952 or declared in system or compiler headers.
6954 You may need to experiment to determine the best settings for your application.
6956 The default is @option{-femit-struct-debug-detailed=all}.
6958 This option works only with DWARF debug output.
6960 @item -fno-dwarf2-cfi-asm
6961 @opindex fdwarf2-cfi-asm
6962 @opindex fno-dwarf2-cfi-asm
6963 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
6964 instead of using GAS @code{.cfi_*} directives.
6966 @item -fno-eliminate-unused-debug-types
6967 @opindex feliminate-unused-debug-types
6968 @opindex fno-eliminate-unused-debug-types
6969 Normally, when producing DWARF output, GCC avoids producing debug symbol 
6970 output for types that are nowhere used in the source file being compiled.
6971 Sometimes it is useful to have GCC emit debugging
6972 information for all types declared in a compilation
6973 unit, regardless of whether or not they are actually used
6974 in that compilation unit, for example 
6975 if, in the debugger, you want to cast a value to a type that is
6976 not actually used in your program (but is declared).  More often,
6977 however, this results in a significant amount of wasted space.
6978 @end table
6980 @node Optimize Options
6981 @section Options That Control Optimization
6982 @cindex optimize options
6983 @cindex options, optimization
6985 These options control various sorts of optimizations.
6987 Without any optimization option, the compiler's goal is to reduce the
6988 cost of compilation and to make debugging produce the expected
6989 results.  Statements are independent: if you stop the program with a
6990 breakpoint between statements, you can then assign a new value to any
6991 variable or change the program counter to any other statement in the
6992 function and get exactly the results you expect from the source
6993 code.
6995 Turning on optimization flags makes the compiler attempt to improve
6996 the performance and/or code size at the expense of compilation time
6997 and possibly the ability to debug the program.
6999 The compiler performs optimization based on the knowledge it has of the
7000 program.  Compiling multiple files at once to a single output file mode allows
7001 the compiler to use information gained from all of the files when compiling
7002 each of them.
7004 Not all optimizations are controlled directly by a flag.  Only
7005 optimizations that have a flag are listed in this section.
7007 Most optimizations are only enabled if an @option{-O} level is set on
7008 the command line.  Otherwise they are disabled, even if individual
7009 optimization flags are specified.
7011 Depending on the target and how GCC was configured, a slightly different
7012 set of optimizations may be enabled at each @option{-O} level than
7013 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7014 to find out the exact set of optimizations that are enabled at each level.
7015 @xref{Overall Options}, for examples.
7017 @table @gcctabopt
7018 @item -O
7019 @itemx -O1
7020 @opindex O
7021 @opindex O1
7022 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7023 more memory for a large function.
7025 With @option{-O}, the compiler tries to reduce code size and execution
7026 time, without performing any optimizations that take a great deal of
7027 compilation time.
7029 @option{-O} turns on the following optimization flags:
7030 @gccoptlist{
7031 -fauto-inc-dec @gol
7032 -fbranch-count-reg @gol
7033 -fcombine-stack-adjustments @gol
7034 -fcompare-elim @gol
7035 -fcprop-registers @gol
7036 -fdce @gol
7037 -fdefer-pop @gol
7038 -fdelayed-branch @gol
7039 -fdse @gol
7040 -fforward-propagate @gol
7041 -fguess-branch-probability @gol
7042 -fif-conversion2 @gol
7043 -fif-conversion @gol
7044 -finline-functions-called-once @gol
7045 -fipa-pure-const @gol
7046 -fipa-profile @gol
7047 -fipa-reference @gol
7048 -fmerge-constants @gol
7049 -fmove-loop-invariants @gol
7050 -freorder-blocks @gol
7051 -fshrink-wrap @gol
7052 -fshrink-wrap-separate @gol
7053 -fsplit-wide-types @gol
7054 -fssa-backprop @gol
7055 -fssa-phiopt @gol
7056 -ftree-bit-ccp @gol
7057 -ftree-ccp @gol
7058 -ftree-ch @gol
7059 -ftree-coalesce-vars @gol
7060 -ftree-copy-prop @gol
7061 -ftree-dce @gol
7062 -ftree-dominator-opts @gol
7063 -ftree-dse @gol
7064 -ftree-forwprop @gol
7065 -ftree-fre @gol
7066 -ftree-phiprop @gol
7067 -ftree-sink @gol
7068 -ftree-slsr @gol
7069 -ftree-sra @gol
7070 -ftree-pta @gol
7071 -ftree-ter @gol
7072 -funit-at-a-time}
7074 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7075 where doing so does not interfere with debugging.
7077 @item -O2
7078 @opindex O2
7079 Optimize even more.  GCC performs nearly all supported optimizations
7080 that do not involve a space-speed tradeoff.
7081 As compared to @option{-O}, this option increases both compilation time
7082 and the performance of the generated code.
7084 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7085 also turns on the following optimization flags:
7086 @gccoptlist{-fthread-jumps @gol
7087 -falign-functions  -falign-jumps @gol
7088 -falign-loops  -falign-labels @gol
7089 -fcaller-saves @gol
7090 -fcrossjumping @gol
7091 -fcse-follow-jumps  -fcse-skip-blocks @gol
7092 -fdelete-null-pointer-checks @gol
7093 -fdevirtualize -fdevirtualize-speculatively @gol
7094 -fexpensive-optimizations @gol
7095 -fgcse  -fgcse-lm  @gol
7096 -fhoist-adjacent-loads @gol
7097 -finline-small-functions @gol
7098 -findirect-inlining @gol
7099 -fipa-cp @gol
7100 -fipa-bit-cp @gol
7101 -fipa-vrp @gol
7102 -fipa-sra @gol
7103 -fipa-icf @gol
7104 -fisolate-erroneous-paths-dereference @gol
7105 -flra-remat @gol
7106 -foptimize-sibling-calls @gol
7107 -foptimize-strlen @gol
7108 -fpartial-inlining @gol
7109 -fpeephole2 @gol
7110 -freorder-blocks-algorithm=stc @gol
7111 -freorder-blocks-and-partition -freorder-functions @gol
7112 -frerun-cse-after-loop  @gol
7113 -fsched-interblock  -fsched-spec @gol
7114 -fschedule-insns  -fschedule-insns2 @gol
7115 -fstore-merging @gol
7116 -fstrict-aliasing -fstrict-overflow @gol
7117 -ftree-builtin-call-dce @gol
7118 -ftree-switch-conversion -ftree-tail-merge @gol
7119 -fcode-hoisting @gol
7120 -ftree-pre @gol
7121 -ftree-vrp @gol
7122 -fipa-ra}
7124 Please note the warning under @option{-fgcse} about
7125 invoking @option{-O2} on programs that use computed gotos.
7127 @item -O3
7128 @opindex O3
7129 Optimize yet more.  @option{-O3} turns on all optimizations specified
7130 by @option{-O2} and also turns on the @option{-finline-functions},
7131 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7132 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7133 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7134 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7135 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7136 and @option{-fipa-cp-clone} options.
7138 @item -O0
7139 @opindex O0
7140 Reduce compilation time and make debugging produce the expected
7141 results.  This is the default.
7143 @item -Os
7144 @opindex Os
7145 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7146 do not typically increase code size.  It also performs further
7147 optimizations designed to reduce code size.
7149 @option{-Os} disables the following optimization flags:
7150 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7151 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7152 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7154 @item -Ofast
7155 @opindex Ofast
7156 Disregard strict standards compliance.  @option{-Ofast} enables all
7157 @option{-O3} optimizations.  It also enables optimizations that are not
7158 valid for all standard-compliant programs.
7159 It turns on @option{-ffast-math} and the Fortran-specific
7160 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7162 @item -Og
7163 @opindex Og
7164 Optimize debugging experience.  @option{-Og} enables optimizations
7165 that do not interfere with debugging. It should be the optimization
7166 level of choice for the standard edit-compile-debug cycle, offering
7167 a reasonable level of optimization while maintaining fast compilation
7168 and a good debugging experience.
7169 @end table
7171 If you use multiple @option{-O} options, with or without level numbers,
7172 the last such option is the one that is effective.
7174 Options of the form @option{-f@var{flag}} specify machine-independent
7175 flags.  Most flags have both positive and negative forms; the negative
7176 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7177 below, only one of the forms is listed---the one you typically 
7178 use.  You can figure out the other form by either removing @samp{no-}
7179 or adding it.
7181 The following options control specific optimizations.  They are either
7182 activated by @option{-O} options or are related to ones that are.  You
7183 can use the following flags in the rare cases when ``fine-tuning'' of
7184 optimizations to be performed is desired.
7186 @table @gcctabopt
7187 @item -fno-defer-pop
7188 @opindex fno-defer-pop
7189 Always pop the arguments to each function call as soon as that function
7190 returns.  For machines that must pop arguments after a function call,
7191 the compiler normally lets arguments accumulate on the stack for several
7192 function calls and pops them all at once.
7194 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7196 @item -fforward-propagate
7197 @opindex fforward-propagate
7198 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7199 instructions and checks if the result can be simplified.  If loop unrolling
7200 is active, two passes are performed and the second is scheduled after
7201 loop unrolling.
7203 This option is enabled by default at optimization levels @option{-O},
7204 @option{-O2}, @option{-O3}, @option{-Os}.
7206 @item -ffp-contract=@var{style}
7207 @opindex ffp-contract
7208 @option{-ffp-contract=off} disables floating-point expression contraction.
7209 @option{-ffp-contract=fast} enables floating-point expression contraction
7210 such as forming of fused multiply-add operations if the target has
7211 native support for them.
7212 @option{-ffp-contract=on} enables floating-point expression contraction
7213 if allowed by the language standard.  This is currently not implemented
7214 and treated equal to @option{-ffp-contract=off}.
7216 The default is @option{-ffp-contract=fast}.
7218 @item -fomit-frame-pointer
7219 @opindex fomit-frame-pointer
7220 Don't keep the frame pointer in a register for functions that
7221 don't need one.  This avoids the instructions to save, set up and
7222 restore frame pointers; it also makes an extra register available
7223 in many functions.  @strong{It also makes debugging impossible on
7224 some machines.}
7226 On some machines, such as the VAX, this flag has no effect, because
7227 the standard calling sequence automatically handles the frame pointer
7228 and nothing is saved by pretending it doesn't exist.  The
7229 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7230 whether a target machine supports this flag.  @xref{Registers,,Register
7231 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7233 The default setting (when not optimizing for
7234 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7235 @option{-fomit-frame-pointer}.  You can configure GCC with the
7236 @option{--enable-frame-pointer} configure option to change the default.
7238 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7240 @item -foptimize-sibling-calls
7241 @opindex foptimize-sibling-calls
7242 Optimize sibling and tail recursive calls.
7244 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7246 @item -foptimize-strlen
7247 @opindex foptimize-strlen
7248 Optimize various standard C string functions (e.g. @code{strlen},
7249 @code{strchr} or @code{strcpy}) and
7250 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7252 Enabled at levels @option{-O2}, @option{-O3}.
7254 @item -fno-inline
7255 @opindex fno-inline
7256 Do not expand any functions inline apart from those marked with
7257 the @code{always_inline} attribute.  This is the default when not
7258 optimizing.
7260 Single functions can be exempted from inlining by marking them
7261 with the @code{noinline} attribute.
7263 @item -finline-small-functions
7264 @opindex finline-small-functions
7265 Integrate functions into their callers when their body is smaller than expected
7266 function call code (so overall size of program gets smaller).  The compiler
7267 heuristically decides which functions are simple enough to be worth integrating
7268 in this way.  This inlining applies to all functions, even those not declared
7269 inline.
7271 Enabled at level @option{-O2}.
7273 @item -findirect-inlining
7274 @opindex findirect-inlining
7275 Inline also indirect calls that are discovered to be known at compile
7276 time thanks to previous inlining.  This option has any effect only
7277 when inlining itself is turned on by the @option{-finline-functions}
7278 or @option{-finline-small-functions} options.
7280 Enabled at level @option{-O2}.
7282 @item -finline-functions
7283 @opindex finline-functions
7284 Consider all functions for inlining, even if they are not declared inline.
7285 The compiler heuristically decides which functions are worth integrating
7286 in this way.
7288 If all calls to a given function are integrated, and the function is
7289 declared @code{static}, then the function is normally not output as
7290 assembler code in its own right.
7292 Enabled at level @option{-O3}.
7294 @item -finline-functions-called-once
7295 @opindex finline-functions-called-once
7296 Consider all @code{static} functions called once for inlining into their
7297 caller even if they are not marked @code{inline}.  If a call to a given
7298 function is integrated, then the function is not output as assembler code
7299 in its own right.
7301 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7303 @item -fearly-inlining
7304 @opindex fearly-inlining
7305 Inline functions marked by @code{always_inline} and functions whose body seems
7306 smaller than the function call overhead early before doing
7307 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7308 makes profiling significantly cheaper and usually inlining faster on programs
7309 having large chains of nested wrapper functions.
7311 Enabled by default.
7313 @item -fipa-sra
7314 @opindex fipa-sra
7315 Perform interprocedural scalar replacement of aggregates, removal of
7316 unused parameters and replacement of parameters passed by reference
7317 by parameters passed by value.
7319 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7321 @item -finline-limit=@var{n}
7322 @opindex finline-limit
7323 By default, GCC limits the size of functions that can be inlined.  This flag
7324 allows coarse control of this limit.  @var{n} is the size of functions that
7325 can be inlined in number of pseudo instructions.
7327 Inlining is actually controlled by a number of parameters, which may be
7328 specified individually by using @option{--param @var{name}=@var{value}}.
7329 The @option{-finline-limit=@var{n}} option sets some of these parameters
7330 as follows:
7332 @table @gcctabopt
7333 @item max-inline-insns-single
7334 is set to @var{n}/2.
7335 @item max-inline-insns-auto
7336 is set to @var{n}/2.
7337 @end table
7339 See below for a documentation of the individual
7340 parameters controlling inlining and for the defaults of these parameters.
7342 @emph{Note:} there may be no value to @option{-finline-limit} that results
7343 in default behavior.
7345 @emph{Note:} pseudo instruction represents, in this particular context, an
7346 abstract measurement of function's size.  In no way does it represent a count
7347 of assembly instructions and as such its exact meaning might change from one
7348 release to an another.
7350 @item -fno-keep-inline-dllexport
7351 @opindex fno-keep-inline-dllexport
7352 This is a more fine-grained version of @option{-fkeep-inline-functions},
7353 which applies only to functions that are declared using the @code{dllexport}
7354 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7355 Functions}.
7357 @item -fkeep-inline-functions
7358 @opindex fkeep-inline-functions
7359 In C, emit @code{static} functions that are declared @code{inline}
7360 into the object file, even if the function has been inlined into all
7361 of its callers.  This switch does not affect functions using the
7362 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7363 inline functions into the object file.
7365 @item -fkeep-static-functions
7366 @opindex fkeep-static-functions
7367 Emit @code{static} functions into the object file, even if the function
7368 is never used.
7370 @item -fkeep-static-consts
7371 @opindex fkeep-static-consts
7372 Emit variables declared @code{static const} when optimization isn't turned
7373 on, even if the variables aren't referenced.
7375 GCC enables this option by default.  If you want to force the compiler to
7376 check if a variable is referenced, regardless of whether or not
7377 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7379 @item -fmerge-constants
7380 @opindex fmerge-constants
7381 Attempt to merge identical constants (string constants and floating-point
7382 constants) across compilation units.
7384 This option is the default for optimized compilation if the assembler and
7385 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7386 behavior.
7388 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7390 @item -fmerge-all-constants
7391 @opindex fmerge-all-constants
7392 Attempt to merge identical constants and identical variables.
7394 This option implies @option{-fmerge-constants}.  In addition to
7395 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7396 arrays or initialized constant variables with integral or floating-point
7397 types.  Languages like C or C++ require each variable, including multiple
7398 instances of the same variable in recursive calls, to have distinct locations,
7399 so using this option results in non-conforming
7400 behavior.
7402 @item -fmodulo-sched
7403 @opindex fmodulo-sched
7404 Perform swing modulo scheduling immediately before the first scheduling
7405 pass.  This pass looks at innermost loops and reorders their
7406 instructions by overlapping different iterations.
7408 @item -fmodulo-sched-allow-regmoves
7409 @opindex fmodulo-sched-allow-regmoves
7410 Perform more aggressive SMS-based modulo scheduling with register moves
7411 allowed.  By setting this flag certain anti-dependences edges are
7412 deleted, which triggers the generation of reg-moves based on the
7413 life-range analysis.  This option is effective only with
7414 @option{-fmodulo-sched} enabled.
7416 @item -fno-branch-count-reg
7417 @opindex fno-branch-count-reg
7418 Avoid running a pass scanning for opportunities to use ``decrement and
7419 branch'' instructions on a count register instead of generating sequences
7420 of instructions that decrement a register, compare it against zero, and
7421 then branch based upon the result.  This option is only meaningful on
7422 architectures that support such instructions, which include x86, PowerPC,
7423 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7424 doesn't remove the decrement and branch instructions from the generated
7425 instruction stream introduced by other optimization passes.
7427 Enabled by default at @option{-O1} and higher.
7429 The default is @option{-fbranch-count-reg}.
7431 @item -fno-function-cse
7432 @opindex fno-function-cse
7433 Do not put function addresses in registers; make each instruction that
7434 calls a constant function contain the function's address explicitly.
7436 This option results in less efficient code, but some strange hacks
7437 that alter the assembler output may be confused by the optimizations
7438 performed when this option is not used.
7440 The default is @option{-ffunction-cse}
7442 @item -fno-zero-initialized-in-bss
7443 @opindex fno-zero-initialized-in-bss
7444 If the target supports a BSS section, GCC by default puts variables that
7445 are initialized to zero into BSS@.  This can save space in the resulting
7446 code.
7448 This option turns off this behavior because some programs explicitly
7449 rely on variables going to the data section---e.g., so that the
7450 resulting executable can find the beginning of that section and/or make
7451 assumptions based on that.
7453 The default is @option{-fzero-initialized-in-bss}.
7455 @item -fthread-jumps
7456 @opindex fthread-jumps
7457 Perform optimizations that check to see if a jump branches to a
7458 location where another comparison subsumed by the first is found.  If
7459 so, the first branch is redirected to either the destination of the
7460 second branch or a point immediately following it, depending on whether
7461 the condition is known to be true or false.
7463 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7465 @item -fsplit-wide-types
7466 @opindex fsplit-wide-types
7467 When using a type that occupies multiple registers, such as @code{long
7468 long} on a 32-bit system, split the registers apart and allocate them
7469 independently.  This normally generates better code for those types,
7470 but may make debugging more difficult.
7472 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7473 @option{-Os}.
7475 @item -fcse-follow-jumps
7476 @opindex fcse-follow-jumps
7477 In common subexpression elimination (CSE), scan through jump instructions
7478 when the target of the jump is not reached by any other path.  For
7479 example, when CSE encounters an @code{if} statement with an
7480 @code{else} clause, CSE follows the jump when the condition
7481 tested is false.
7483 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7485 @item -fcse-skip-blocks
7486 @opindex fcse-skip-blocks
7487 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7488 follow jumps that conditionally skip over blocks.  When CSE
7489 encounters a simple @code{if} statement with no else clause,
7490 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7491 body of the @code{if}.
7493 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7495 @item -frerun-cse-after-loop
7496 @opindex frerun-cse-after-loop
7497 Re-run common subexpression elimination after loop optimizations are
7498 performed.
7500 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7502 @item -fgcse
7503 @opindex fgcse
7504 Perform a global common subexpression elimination pass.
7505 This pass also performs global constant and copy propagation.
7507 @emph{Note:} When compiling a program using computed gotos, a GCC
7508 extension, you may get better run-time performance if you disable
7509 the global common subexpression elimination pass by adding
7510 @option{-fno-gcse} to the command line.
7512 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7514 @item -fgcse-lm
7515 @opindex fgcse-lm
7516 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7517 attempts to move loads that are only killed by stores into themselves.  This
7518 allows a loop containing a load/store sequence to be changed to a load outside
7519 the loop, and a copy/store within the loop.
7521 Enabled by default when @option{-fgcse} is enabled.
7523 @item -fgcse-sm
7524 @opindex fgcse-sm
7525 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7526 global common subexpression elimination.  This pass attempts to move
7527 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7528 loops containing a load/store sequence can be changed to a load before
7529 the loop and a store after the loop.
7531 Not enabled at any optimization level.
7533 @item -fgcse-las
7534 @opindex fgcse-las
7535 When @option{-fgcse-las} is enabled, the global common subexpression
7536 elimination pass eliminates redundant loads that come after stores to the
7537 same memory location (both partial and full redundancies).
7539 Not enabled at any optimization level.
7541 @item -fgcse-after-reload
7542 @opindex fgcse-after-reload
7543 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7544 pass is performed after reload.  The purpose of this pass is to clean up
7545 redundant spilling.
7547 @item -faggressive-loop-optimizations
7548 @opindex faggressive-loop-optimizations
7549 This option tells the loop optimizer to use language constraints to
7550 derive bounds for the number of iterations of a loop.  This assumes that
7551 loop code does not invoke undefined behavior by for example causing signed
7552 integer overflows or out-of-bound array accesses.  The bounds for the
7553 number of iterations of a loop are used to guide loop unrolling and peeling
7554 and loop exit test optimizations.
7555 This option is enabled by default.
7557 @item -funconstrained-commons
7558 @opindex funconstrained-commons
7559 This option tells the compiler that variables declared in common blocks
7560 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7561 prevents certain optimizations that depend on knowing the array bounds.
7563 @item -fcrossjumping
7564 @opindex fcrossjumping
7565 Perform cross-jumping transformation.
7566 This transformation unifies equivalent code and saves code size.  The
7567 resulting code may or may not perform better than without cross-jumping.
7569 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7571 @item -fauto-inc-dec
7572 @opindex fauto-inc-dec
7573 Combine increments or decrements of addresses with memory accesses.
7574 This pass is always skipped on architectures that do not have
7575 instructions to support this.  Enabled by default at @option{-O} and
7576 higher on architectures that support this.
7578 @item -fdce
7579 @opindex fdce
7580 Perform dead code elimination (DCE) on RTL@.
7581 Enabled by default at @option{-O} and higher.
7583 @item -fdse
7584 @opindex fdse
7585 Perform dead store elimination (DSE) on RTL@.
7586 Enabled by default at @option{-O} and higher.
7588 @item -fif-conversion
7589 @opindex fif-conversion
7590 Attempt to transform conditional jumps into branch-less equivalents.  This
7591 includes use of conditional moves, min, max, set flags and abs instructions, and
7592 some tricks doable by standard arithmetics.  The use of conditional execution
7593 on chips where it is available is controlled by @option{-fif-conversion2}.
7595 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7597 @item -fif-conversion2
7598 @opindex fif-conversion2
7599 Use conditional execution (where available) to transform conditional jumps into
7600 branch-less equivalents.
7602 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7604 @item -fdeclone-ctor-dtor
7605 @opindex fdeclone-ctor-dtor
7606 The C++ ABI requires multiple entry points for constructors and
7607 destructors: one for a base subobject, one for a complete object, and
7608 one for a virtual destructor that calls operator delete afterwards.
7609 For a hierarchy with virtual bases, the base and complete variants are
7610 clones, which means two copies of the function.  With this option, the
7611 base and complete variants are changed to be thunks that call a common
7612 implementation.
7614 Enabled by @option{-Os}.
7616 @item -fdelete-null-pointer-checks
7617 @opindex fdelete-null-pointer-checks
7618 Assume that programs cannot safely dereference null pointers, and that
7619 no code or data element resides at address zero.
7620 This option enables simple constant
7621 folding optimizations at all optimization levels.  In addition, other
7622 optimization passes in GCC use this flag to control global dataflow
7623 analyses that eliminate useless checks for null pointers; these assume
7624 that a memory access to address zero always results in a trap, so
7625 that if a pointer is checked after it has already been dereferenced,
7626 it cannot be null.
7628 Note however that in some environments this assumption is not true.
7629 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7630 for programs that depend on that behavior.
7632 This option is enabled by default on most targets.  On Nios II ELF, it
7633 defaults to off.  On AVR and CR16, this option is completely disabled.  
7635 Passes that use the dataflow information
7636 are enabled independently at different optimization levels.
7638 @item -fdevirtualize
7639 @opindex fdevirtualize
7640 Attempt to convert calls to virtual functions to direct calls.  This
7641 is done both within a procedure and interprocedurally as part of
7642 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7643 propagation (@option{-fipa-cp}).
7644 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7646 @item -fdevirtualize-speculatively
7647 @opindex fdevirtualize-speculatively
7648 Attempt to convert calls to virtual functions to speculative direct calls.
7649 Based on the analysis of the type inheritance graph, determine for a given call
7650 the set of likely targets. If the set is small, preferably of size 1, change
7651 the call into a conditional deciding between direct and indirect calls.  The
7652 speculative calls enable more optimizations, such as inlining.  When they seem
7653 useless after further optimization, they are converted back into original form.
7655 @item -fdevirtualize-at-ltrans
7656 @opindex fdevirtualize-at-ltrans
7657 Stream extra information needed for aggressive devirtualization when running
7658 the link-time optimizer in local transformation mode.  
7659 This option enables more devirtualization but
7660 significantly increases the size of streamed data. For this reason it is
7661 disabled by default.
7663 @item -fexpensive-optimizations
7664 @opindex fexpensive-optimizations
7665 Perform a number of minor optimizations that are relatively expensive.
7667 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7669 @item -free
7670 @opindex free
7671 Attempt to remove redundant extension instructions.  This is especially
7672 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7673 registers after writing to their lower 32-bit half.
7675 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7676 @option{-O3}, @option{-Os}.
7678 @item -fno-lifetime-dse
7679 @opindex fno-lifetime-dse
7680 In C++ the value of an object is only affected by changes within its
7681 lifetime: when the constructor begins, the object has an indeterminate
7682 value, and any changes during the lifetime of the object are dead when
7683 the object is destroyed.  Normally dead store elimination will take
7684 advantage of this; if your code relies on the value of the object
7685 storage persisting beyond the lifetime of the object, you can use this
7686 flag to disable this optimization.  To preserve stores before the
7687 constructor starts (e.g. because your operator new clears the object
7688 storage) but still treat the object as dead after the destructor you,
7689 can use @option{-flifetime-dse=1}.  The default behavior can be
7690 explicitly selected with @option{-flifetime-dse=2}.
7691 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7693 @item -flive-range-shrinkage
7694 @opindex flive-range-shrinkage
7695 Attempt to decrease register pressure through register live range
7696 shrinkage.  This is helpful for fast processors with small or moderate
7697 size register sets.
7699 @item -fira-algorithm=@var{algorithm}
7700 @opindex fira-algorithm
7701 Use the specified coloring algorithm for the integrated register
7702 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7703 specifies Chow's priority coloring, or @samp{CB}, which specifies
7704 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7705 for all architectures, but for those targets that do support it, it is
7706 the default because it generates better code.
7708 @item -fira-region=@var{region}
7709 @opindex fira-region
7710 Use specified regions for the integrated register allocator.  The
7711 @var{region} argument should be one of the following:
7713 @table @samp
7715 @item all
7716 Use all loops as register allocation regions.
7717 This can give the best results for machines with a small and/or
7718 irregular register set.
7720 @item mixed
7721 Use all loops except for loops with small register pressure 
7722 as the regions.  This value usually gives
7723 the best results in most cases and for most architectures,
7724 and is enabled by default when compiling with optimization for speed
7725 (@option{-O}, @option{-O2}, @dots{}).
7727 @item one
7728 Use all functions as a single region.  
7729 This typically results in the smallest code size, and is enabled by default for
7730 @option{-Os} or @option{-O0}.
7732 @end table
7734 @item -fira-hoist-pressure
7735 @opindex fira-hoist-pressure
7736 Use IRA to evaluate register pressure in the code hoisting pass for
7737 decisions to hoist expressions.  This option usually results in smaller
7738 code, but it can slow the compiler down.
7740 This option is enabled at level @option{-Os} for all targets.
7742 @item -fira-loop-pressure
7743 @opindex fira-loop-pressure
7744 Use IRA to evaluate register pressure in loops for decisions to move
7745 loop invariants.  This option usually results in generation
7746 of faster and smaller code on machines with large register files (>= 32
7747 registers), but it can slow the compiler down.
7749 This option is enabled at level @option{-O3} for some targets.
7751 @item -fno-ira-share-save-slots
7752 @opindex fno-ira-share-save-slots
7753 Disable sharing of stack slots used for saving call-used hard
7754 registers living through a call.  Each hard register gets a
7755 separate stack slot, and as a result function stack frames are
7756 larger.
7758 @item -fno-ira-share-spill-slots
7759 @opindex fno-ira-share-spill-slots
7760 Disable sharing of stack slots allocated for pseudo-registers.  Each
7761 pseudo-register that does not get a hard register gets a separate
7762 stack slot, and as a result function stack frames are larger.
7764 @item -flra-remat
7765 @opindex flra-remat
7766 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7767 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7768 values if it is profitable.
7770 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7772 @item -fdelayed-branch
7773 @opindex fdelayed-branch
7774 If supported for the target machine, attempt to reorder instructions
7775 to exploit instruction slots available after delayed branch
7776 instructions.
7778 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7780 @item -fschedule-insns
7781 @opindex fschedule-insns
7782 If supported for the target machine, attempt to reorder instructions to
7783 eliminate execution stalls due to required data being unavailable.  This
7784 helps machines that have slow floating point or memory load instructions
7785 by allowing other instructions to be issued until the result of the load
7786 or floating-point instruction is required.
7788 Enabled at levels @option{-O2}, @option{-O3}.
7790 @item -fschedule-insns2
7791 @opindex fschedule-insns2
7792 Similar to @option{-fschedule-insns}, but requests an additional pass of
7793 instruction scheduling after register allocation has been done.  This is
7794 especially useful on machines with a relatively small number of
7795 registers and where memory load instructions take more than one cycle.
7797 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7799 @item -fno-sched-interblock
7800 @opindex fno-sched-interblock
7801 Don't schedule instructions across basic blocks.  This is normally
7802 enabled by default when scheduling before register allocation, i.e.@:
7803 with @option{-fschedule-insns} or at @option{-O2} or higher.
7805 @item -fno-sched-spec
7806 @opindex fno-sched-spec
7807 Don't allow speculative motion of non-load instructions.  This is normally
7808 enabled by default when scheduling before register allocation, i.e.@:
7809 with @option{-fschedule-insns} or at @option{-O2} or higher.
7811 @item -fsched-pressure
7812 @opindex fsched-pressure
7813 Enable register pressure sensitive insn scheduling before register
7814 allocation.  This only makes sense when scheduling before register
7815 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7816 @option{-O2} or higher.  Usage of this option can improve the
7817 generated code and decrease its size by preventing register pressure
7818 increase above the number of available hard registers and subsequent
7819 spills in register allocation.
7821 @item -fsched-spec-load
7822 @opindex fsched-spec-load
7823 Allow speculative motion of some load instructions.  This only makes
7824 sense when scheduling before register allocation, i.e.@: with
7825 @option{-fschedule-insns} or at @option{-O2} or higher.
7827 @item -fsched-spec-load-dangerous
7828 @opindex fsched-spec-load-dangerous
7829 Allow speculative motion of more load instructions.  This only makes
7830 sense when scheduling before register allocation, i.e.@: with
7831 @option{-fschedule-insns} or at @option{-O2} or higher.
7833 @item -fsched-stalled-insns
7834 @itemx -fsched-stalled-insns=@var{n}
7835 @opindex fsched-stalled-insns
7836 Define how many insns (if any) can be moved prematurely from the queue
7837 of stalled insns into the ready list during the second scheduling pass.
7838 @option{-fno-sched-stalled-insns} means that no insns are moved
7839 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7840 on how many queued insns can be moved prematurely.
7841 @option{-fsched-stalled-insns} without a value is equivalent to
7842 @option{-fsched-stalled-insns=1}.
7844 @item -fsched-stalled-insns-dep
7845 @itemx -fsched-stalled-insns-dep=@var{n}
7846 @opindex fsched-stalled-insns-dep
7847 Define how many insn groups (cycles) are examined for a dependency
7848 on a stalled insn that is a candidate for premature removal from the queue
7849 of stalled insns.  This has an effect only during the second scheduling pass,
7850 and only if @option{-fsched-stalled-insns} is used.
7851 @option{-fno-sched-stalled-insns-dep} is equivalent to
7852 @option{-fsched-stalled-insns-dep=0}.
7853 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7854 @option{-fsched-stalled-insns-dep=1}.
7856 @item -fsched2-use-superblocks
7857 @opindex fsched2-use-superblocks
7858 When scheduling after register allocation, use superblock scheduling.
7859 This allows motion across basic block boundaries,
7860 resulting in faster schedules.  This option is experimental, as not all machine
7861 descriptions used by GCC model the CPU closely enough to avoid unreliable
7862 results from the algorithm.
7864 This only makes sense when scheduling after register allocation, i.e.@: with
7865 @option{-fschedule-insns2} or at @option{-O2} or higher.
7867 @item -fsched-group-heuristic
7868 @opindex fsched-group-heuristic
7869 Enable the group heuristic in the scheduler.  This heuristic favors
7870 the instruction that belongs to a schedule group.  This is enabled
7871 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7872 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7874 @item -fsched-critical-path-heuristic
7875 @opindex fsched-critical-path-heuristic
7876 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7877 instructions on the critical path.  This is enabled by default when
7878 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7879 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7881 @item -fsched-spec-insn-heuristic
7882 @opindex fsched-spec-insn-heuristic
7883 Enable the speculative instruction heuristic in the scheduler.  This
7884 heuristic favors speculative instructions with greater dependency weakness.
7885 This is enabled by default when scheduling is enabled, i.e.@:
7886 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7887 or at @option{-O2} or higher.
7889 @item -fsched-rank-heuristic
7890 @opindex fsched-rank-heuristic
7891 Enable the rank heuristic in the scheduler.  This heuristic favors
7892 the instruction belonging to a basic block with greater size or frequency.
7893 This is enabled by default when scheduling is enabled, i.e.@:
7894 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7895 at @option{-O2} or higher.
7897 @item -fsched-last-insn-heuristic
7898 @opindex fsched-last-insn-heuristic
7899 Enable the last-instruction heuristic in the scheduler.  This heuristic
7900 favors the instruction that is less dependent on the last instruction
7901 scheduled.  This is enabled by default when scheduling is enabled,
7902 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7903 at @option{-O2} or higher.
7905 @item -fsched-dep-count-heuristic
7906 @opindex fsched-dep-count-heuristic
7907 Enable the dependent-count heuristic in the scheduler.  This heuristic
7908 favors the instruction that has more instructions depending on it.
7909 This is enabled by default when scheduling is enabled, i.e.@:
7910 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7911 at @option{-O2} or higher.
7913 @item -freschedule-modulo-scheduled-loops
7914 @opindex freschedule-modulo-scheduled-loops
7915 Modulo scheduling is performed before traditional scheduling.  If a loop
7916 is modulo scheduled, later scheduling passes may change its schedule.  
7917 Use this option to control that behavior.
7919 @item -fselective-scheduling
7920 @opindex fselective-scheduling
7921 Schedule instructions using selective scheduling algorithm.  Selective
7922 scheduling runs instead of the first scheduler pass.
7924 @item -fselective-scheduling2
7925 @opindex fselective-scheduling2
7926 Schedule instructions using selective scheduling algorithm.  Selective
7927 scheduling runs instead of the second scheduler pass.
7929 @item -fsel-sched-pipelining
7930 @opindex fsel-sched-pipelining
7931 Enable software pipelining of innermost loops during selective scheduling.
7932 This option has no effect unless one of @option{-fselective-scheduling} or
7933 @option{-fselective-scheduling2} is turned on.
7935 @item -fsel-sched-pipelining-outer-loops
7936 @opindex fsel-sched-pipelining-outer-loops
7937 When pipelining loops during selective scheduling, also pipeline outer loops.
7938 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7940 @item -fsemantic-interposition
7941 @opindex fsemantic-interposition
7942 Some object formats, like ELF, allow interposing of symbols by the 
7943 dynamic linker.
7944 This means that for symbols exported from the DSO, the compiler cannot perform
7945 interprocedural propagation, inlining and other optimizations in anticipation
7946 that the function or variable in question may change. While this feature is
7947 useful, for example, to rewrite memory allocation functions by a debugging
7948 implementation, it is expensive in the terms of code quality.
7949 With @option{-fno-semantic-interposition} the compiler assumes that 
7950 if interposition happens for functions the overwriting function will have 
7951 precisely the same semantics (and side effects). 
7952 Similarly if interposition happens
7953 for variables, the constructor of the variable will be the same. The flag
7954 has no effect for functions explicitly declared inline 
7955 (where it is never allowed for interposition to change semantics) 
7956 and for symbols explicitly declared weak.
7958 @item -fshrink-wrap
7959 @opindex fshrink-wrap
7960 Emit function prologues only before parts of the function that need it,
7961 rather than at the top of the function.  This flag is enabled by default at
7962 @option{-O} and higher.
7964 @item -fshrink-wrap-separate
7965 @opindex fshrink-wrap-separate
7966 Shrink-wrap separate parts of the prologue and epilogue separately, so that
7967 those parts are only executed when needed.
7968 This option is on by default, but has no effect unless @option{-fshrink-wrap}
7969 is also turned on and the target supports this.
7971 @item -fcaller-saves
7972 @opindex fcaller-saves
7973 Enable allocation of values to registers that are clobbered by
7974 function calls, by emitting extra instructions to save and restore the
7975 registers around such calls.  Such allocation is done only when it
7976 seems to result in better code.
7978 This option is always enabled by default on certain machines, usually
7979 those which have no call-preserved registers to use instead.
7981 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7983 @item -fcombine-stack-adjustments
7984 @opindex fcombine-stack-adjustments
7985 Tracks stack adjustments (pushes and pops) and stack memory references
7986 and then tries to find ways to combine them.
7988 Enabled by default at @option{-O1} and higher.
7990 @item -fipa-ra
7991 @opindex fipa-ra
7992 Use caller save registers for allocation if those registers are not used by
7993 any called function.  In that case it is not necessary to save and restore
7994 them around calls.  This is only possible if called functions are part of
7995 same compilation unit as current function and they are compiled before it.
7997 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
7998 is disabled if generated code will be instrumented for profiling
7999 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8000 exactly (this happens on targets that do not expose prologues
8001 and epilogues in RTL).
8003 @item -fconserve-stack
8004 @opindex fconserve-stack
8005 Attempt to minimize stack usage.  The compiler attempts to use less
8006 stack space, even if that makes the program slower.  This option
8007 implies setting the @option{large-stack-frame} parameter to 100
8008 and the @option{large-stack-frame-growth} parameter to 400.
8010 @item -ftree-reassoc
8011 @opindex ftree-reassoc
8012 Perform reassociation on trees.  This flag is enabled by default
8013 at @option{-O} and higher.
8015 @item -fcode-hoisting
8016 @opindex fcode-hoisting
8017 Perform code hoisting.  Code hoisting tries to move the
8018 evaluation of expressions executed on all paths to the function exit
8019 as early as possible.  This is especially useful as a code size
8020 optimization, but it often helps for code speed as well.
8021 This flag is enabled by default at @option{-O2} and higher.
8023 @item -ftree-pre
8024 @opindex ftree-pre
8025 Perform partial redundancy elimination (PRE) on trees.  This flag is
8026 enabled by default at @option{-O2} and @option{-O3}.
8028 @item -ftree-partial-pre
8029 @opindex ftree-partial-pre
8030 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8031 enabled by default at @option{-O3}.
8033 @item -ftree-forwprop
8034 @opindex ftree-forwprop
8035 Perform forward propagation on trees.  This flag is enabled by default
8036 at @option{-O} and higher.
8038 @item -ftree-fre
8039 @opindex ftree-fre
8040 Perform full redundancy elimination (FRE) on trees.  The difference
8041 between FRE and PRE is that FRE only considers expressions
8042 that are computed on all paths leading to the redundant computation.
8043 This analysis is faster than PRE, though it exposes fewer redundancies.
8044 This flag is enabled by default at @option{-O} and higher.
8046 @item -ftree-phiprop
8047 @opindex ftree-phiprop
8048 Perform hoisting of loads from conditional pointers on trees.  This
8049 pass is enabled by default at @option{-O} and higher.
8051 @item -fhoist-adjacent-loads
8052 @opindex fhoist-adjacent-loads
8053 Speculatively hoist loads from both branches of an if-then-else if the
8054 loads are from adjacent locations in the same structure and the target
8055 architecture has a conditional move instruction.  This flag is enabled
8056 by default at @option{-O2} and higher.
8058 @item -ftree-copy-prop
8059 @opindex ftree-copy-prop
8060 Perform copy propagation on trees.  This pass eliminates unnecessary
8061 copy operations.  This flag is enabled by default at @option{-O} and
8062 higher.
8064 @item -fipa-pure-const
8065 @opindex fipa-pure-const
8066 Discover which functions are pure or constant.
8067 Enabled by default at @option{-O} and higher.
8069 @item -fipa-reference
8070 @opindex fipa-reference
8071 Discover which static variables do not escape the
8072 compilation unit.
8073 Enabled by default at @option{-O} and higher.
8075 @item -fipa-pta
8076 @opindex fipa-pta
8077 Perform interprocedural pointer analysis and interprocedural modification
8078 and reference analysis.  This option can cause excessive memory and
8079 compile-time usage on large compilation units.  It is not enabled by
8080 default at any optimization level.
8082 @item -fipa-profile
8083 @opindex fipa-profile
8084 Perform interprocedural profile propagation.  The functions called only from
8085 cold functions are marked as cold. Also functions executed once (such as
8086 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8087 functions and loop less parts of functions executed once are then optimized for
8088 size.
8089 Enabled by default at @option{-O} and higher.
8091 @item -fipa-cp
8092 @opindex fipa-cp
8093 Perform interprocedural constant propagation.
8094 This optimization analyzes the program to determine when values passed
8095 to functions are constants and then optimizes accordingly.
8096 This optimization can substantially increase performance
8097 if the application has constants passed to functions.
8098 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8100 @item -fipa-cp-clone
8101 @opindex fipa-cp-clone
8102 Perform function cloning to make interprocedural constant propagation stronger.
8103 When enabled, interprocedural constant propagation performs function cloning
8104 when externally visible function can be called with constant arguments.
8105 Because this optimization can create multiple copies of functions,
8106 it may significantly increase code size
8107 (see @option{--param ipcp-unit-growth=@var{value}}).
8108 This flag is enabled by default at @option{-O3}.
8110 @item -fipa-bit-cp
8111 @opindex -fipa-bit-cp
8112 When enabled, perform interprocedural bitwise constant
8113 propagation. This flag is enabled by default at @option{-O2}. It
8114 requires that @option{-fipa-cp} is enabled.
8116 @item -fipa-vrp
8117 @opindex -fipa-vrp
8118 When enabled, perform interprocedural propagation of value
8119 ranges. This flag is enabled by default at @option{-O2}. It requires
8120 that @option{-fipa-cp} is enabled.
8122 @item -fipa-icf
8123 @opindex fipa-icf
8124 Perform Identical Code Folding for functions and read-only variables.
8125 The optimization reduces code size and may disturb unwind stacks by replacing
8126 a function by equivalent one with a different name. The optimization works
8127 more effectively with link-time optimization enabled.
8129 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8130 works on different levels and thus the optimizations are not same - there are
8131 equivalences that are found only by GCC and equivalences found only by Gold.
8133 This flag is enabled by default at @option{-O2} and @option{-Os}.
8135 @item -fisolate-erroneous-paths-dereference
8136 @opindex fisolate-erroneous-paths-dereference
8137 Detect paths that trigger erroneous or undefined behavior due to
8138 dereferencing a null pointer.  Isolate those paths from the main control
8139 flow and turn the statement with erroneous or undefined behavior into a trap.
8140 This flag is enabled by default at @option{-O2} and higher and depends on
8141 @option{-fdelete-null-pointer-checks} also being enabled.
8143 @item -fisolate-erroneous-paths-attribute
8144 @opindex fisolate-erroneous-paths-attribute
8145 Detect paths that trigger erroneous or undefined behavior due a null value
8146 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8147 attribute.  Isolate those paths from the main control flow and turn the
8148 statement with erroneous or undefined behavior into a trap.  This is not
8149 currently enabled, but may be enabled by @option{-O2} in the future.
8151 @item -ftree-sink
8152 @opindex ftree-sink
8153 Perform forward store motion on trees.  This flag is
8154 enabled by default at @option{-O} and higher.
8156 @item -ftree-bit-ccp
8157 @opindex ftree-bit-ccp
8158 Perform sparse conditional bit constant propagation on trees and propagate
8159 pointer alignment information.
8160 This pass only operates on local scalar variables and is enabled by default
8161 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8163 @item -ftree-ccp
8164 @opindex ftree-ccp
8165 Perform sparse conditional constant propagation (CCP) on trees.  This
8166 pass only operates on local scalar variables and is enabled by default
8167 at @option{-O} and higher.
8169 @item -fssa-backprop
8170 @opindex fssa-backprop
8171 Propagate information about uses of a value up the definition chain
8172 in order to simplify the definitions.  For example, this pass strips
8173 sign operations if the sign of a value never matters.  The flag is
8174 enabled by default at @option{-O} and higher.
8176 @item -fssa-phiopt
8177 @opindex fssa-phiopt
8178 Perform pattern matching on SSA PHI nodes to optimize conditional
8179 code.  This pass is enabled by default at @option{-O} and higher.
8181 @item -ftree-switch-conversion
8182 @opindex ftree-switch-conversion
8183 Perform conversion of simple initializations in a switch to
8184 initializations from a scalar array.  This flag is enabled by default
8185 at @option{-O2} and higher.
8187 @item -ftree-tail-merge
8188 @opindex ftree-tail-merge
8189 Look for identical code sequences.  When found, replace one with a jump to the
8190 other.  This optimization is known as tail merging or cross jumping.  This flag
8191 is enabled by default at @option{-O2} and higher.  The compilation time
8192 in this pass can
8193 be limited using @option{max-tail-merge-comparisons} parameter and
8194 @option{max-tail-merge-iterations} parameter.
8196 @item -ftree-dce
8197 @opindex ftree-dce
8198 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8199 default at @option{-O} and higher.
8201 @item -ftree-builtin-call-dce
8202 @opindex ftree-builtin-call-dce
8203 Perform conditional dead code elimination (DCE) for calls to built-in functions
8204 that may set @code{errno} but are otherwise side-effect free.  This flag is
8205 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8206 specified.
8208 @item -ftree-dominator-opts
8209 @opindex ftree-dominator-opts
8210 Perform a variety of simple scalar cleanups (constant/copy
8211 propagation, redundancy elimination, range propagation and expression
8212 simplification) based on a dominator tree traversal.  This also
8213 performs jump threading (to reduce jumps to jumps). This flag is
8214 enabled by default at @option{-O} and higher.
8216 @item -ftree-dse
8217 @opindex ftree-dse
8218 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8219 a memory location that is later overwritten by another store without
8220 any intervening loads.  In this case the earlier store can be deleted.  This
8221 flag is enabled by default at @option{-O} and higher.
8223 @item -ftree-ch
8224 @opindex ftree-ch
8225 Perform loop header copying on trees.  This is beneficial since it increases
8226 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8227 is enabled by default at @option{-O} and higher.  It is not enabled
8228 for @option{-Os}, since it usually increases code size.
8230 @item -ftree-loop-optimize
8231 @opindex ftree-loop-optimize
8232 Perform loop optimizations on trees.  This flag is enabled by default
8233 at @option{-O} and higher.
8235 @item -ftree-loop-linear
8236 @itemx -floop-interchange
8237 @itemx -floop-strip-mine
8238 @itemx -floop-block
8239 @itemx -floop-unroll-and-jam
8240 @opindex ftree-loop-linear
8241 @opindex floop-interchange
8242 @opindex floop-strip-mine
8243 @opindex floop-block
8244 @opindex floop-unroll-and-jam
8245 Perform loop nest optimizations.  Same as
8246 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8247 to be configured with @option{--with-isl} to enable the Graphite loop
8248 transformation infrastructure.
8250 @item -fgraphite-identity
8251 @opindex fgraphite-identity
8252 Enable the identity transformation for graphite.  For every SCoP we generate
8253 the polyhedral representation and transform it back to gimple.  Using
8254 @option{-fgraphite-identity} we can check the costs or benefits of the
8255 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8256 are also performed by the code generator isl, like index splitting and
8257 dead code elimination in loops.
8259 @item -floop-nest-optimize
8260 @opindex floop-nest-optimize
8261 Enable the isl based loop nest optimizer.  This is a generic loop nest
8262 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8263 structure optimized for data-locality and parallelism.  This option
8264 is experimental.
8266 @item -floop-parallelize-all
8267 @opindex floop-parallelize-all
8268 Use the Graphite data dependence analysis to identify loops that can
8269 be parallelized.  Parallelize all the loops that can be analyzed to
8270 not contain loop carried dependences without checking that it is
8271 profitable to parallelize the loops.
8273 @item -ftree-coalesce-vars
8274 @opindex ftree-coalesce-vars
8275 While transforming the program out of the SSA representation, attempt to
8276 reduce copying by coalescing versions of different user-defined
8277 variables, instead of just compiler temporaries.  This may severely
8278 limit the ability to debug an optimized program compiled with
8279 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8280 prevents SSA coalescing of user variables.  This option is enabled by
8281 default if optimization is enabled, and it does very little otherwise.
8283 @item -ftree-loop-if-convert
8284 @opindex ftree-loop-if-convert
8285 Attempt to transform conditional jumps in the innermost loops to
8286 branch-less equivalents.  The intent is to remove control-flow from
8287 the innermost loops in order to improve the ability of the
8288 vectorization pass to handle these loops.  This is enabled by default
8289 if vectorization is enabled.
8291 @item -ftree-loop-distribution
8292 @opindex ftree-loop-distribution
8293 Perform loop distribution.  This flag can improve cache performance on
8294 big loop bodies and allow further loop optimizations, like
8295 parallelization or vectorization, to take place.  For example, the loop
8296 @smallexample
8297 DO I = 1, N
8298   A(I) = B(I) + C
8299   D(I) = E(I) * F
8300 ENDDO
8301 @end smallexample
8302 is transformed to
8303 @smallexample
8304 DO I = 1, N
8305    A(I) = B(I) + C
8306 ENDDO
8307 DO I = 1, N
8308    D(I) = E(I) * F
8309 ENDDO
8310 @end smallexample
8312 @item -ftree-loop-distribute-patterns
8313 @opindex ftree-loop-distribute-patterns
8314 Perform loop distribution of patterns that can be code generated with
8315 calls to a library.  This flag is enabled by default at @option{-O3}.
8317 This pass distributes the initialization loops and generates a call to
8318 memset zero.  For example, the loop
8319 @smallexample
8320 DO I = 1, N
8321   A(I) = 0
8322   B(I) = A(I) + I
8323 ENDDO
8324 @end smallexample
8325 is transformed to
8326 @smallexample
8327 DO I = 1, N
8328    A(I) = 0
8329 ENDDO
8330 DO I = 1, N
8331    B(I) = A(I) + I
8332 ENDDO
8333 @end smallexample
8334 and the initialization loop is transformed into a call to memset zero.
8336 @item -ftree-loop-im
8337 @opindex ftree-loop-im
8338 Perform loop invariant motion on trees.  This pass moves only invariants that
8339 are hard to handle at RTL level (function calls, operations that expand to
8340 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8341 operands of conditions that are invariant out of the loop, so that we can use
8342 just trivial invariantness analysis in loop unswitching.  The pass also includes
8343 store motion.
8345 @item -ftree-loop-ivcanon
8346 @opindex ftree-loop-ivcanon
8347 Create a canonical counter for number of iterations in loops for which
8348 determining number of iterations requires complicated analysis.  Later
8349 optimizations then may determine the number easily.  Useful especially
8350 in connection with unrolling.
8352 @item -fivopts
8353 @opindex fivopts
8354 Perform induction variable optimizations (strength reduction, induction
8355 variable merging and induction variable elimination) on trees.
8357 @item -ftree-parallelize-loops=n
8358 @opindex ftree-parallelize-loops
8359 Parallelize loops, i.e., split their iteration space to run in n threads.
8360 This is only possible for loops whose iterations are independent
8361 and can be arbitrarily reordered.  The optimization is only
8362 profitable on multiprocessor machines, for loops that are CPU-intensive,
8363 rather than constrained e.g.@: by memory bandwidth.  This option
8364 implies @option{-pthread}, and thus is only supported on targets
8365 that have support for @option{-pthread}.
8367 @item -ftree-pta
8368 @opindex ftree-pta
8369 Perform function-local points-to analysis on trees.  This flag is
8370 enabled by default at @option{-O} and higher.
8372 @item -ftree-sra
8373 @opindex ftree-sra
8374 Perform scalar replacement of aggregates.  This pass replaces structure
8375 references with scalars to prevent committing structures to memory too
8376 early.  This flag is enabled by default at @option{-O} and higher.
8378 @item -fstore-merging
8379 @opindex fstore-merging
8380 Perform merging of narrow stores to consecutive memory addresses.  This pass
8381 merges contiguous stores of immediate values narrower than a word into fewer
8382 wider stores to reduce the number of instructions.  This is enabled by default
8383 at @option{-O2} and higher as well as @option{-Os}.
8385 @item -ftree-ter
8386 @opindex ftree-ter
8387 Perform temporary expression replacement during the SSA->normal phase.  Single
8388 use/single def temporaries are replaced at their use location with their
8389 defining expression.  This results in non-GIMPLE code, but gives the expanders
8390 much more complex trees to work on resulting in better RTL generation.  This is
8391 enabled by default at @option{-O} and higher.
8393 @item -ftree-slsr
8394 @opindex ftree-slsr
8395 Perform straight-line strength reduction on trees.  This recognizes related
8396 expressions involving multiplications and replaces them by less expensive
8397 calculations when possible.  This is enabled by default at @option{-O} and
8398 higher.
8400 @item -ftree-vectorize
8401 @opindex ftree-vectorize
8402 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8403 and @option{-ftree-slp-vectorize} if not explicitly specified.
8405 @item -ftree-loop-vectorize
8406 @opindex ftree-loop-vectorize
8407 Perform loop vectorization on trees. This flag is enabled by default at
8408 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8410 @item -ftree-slp-vectorize
8411 @opindex ftree-slp-vectorize
8412 Perform basic block vectorization on trees. This flag is enabled by default at
8413 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8415 @item -fvect-cost-model=@var{model}
8416 @opindex fvect-cost-model
8417 Alter the cost model used for vectorization.  The @var{model} argument
8418 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8419 With the @samp{unlimited} model the vectorized code-path is assumed
8420 to be profitable while with the @samp{dynamic} model a runtime check
8421 guards the vectorized code-path to enable it only for iteration
8422 counts that will likely execute faster than when executing the original
8423 scalar loop.  The @samp{cheap} model disables vectorization of
8424 loops where doing so would be cost prohibitive for example due to
8425 required runtime checks for data dependence or alignment but otherwise
8426 is equal to the @samp{dynamic} model.
8427 The default cost model depends on other optimization flags and is
8428 either @samp{dynamic} or @samp{cheap}.
8430 @item -fsimd-cost-model=@var{model}
8431 @opindex fsimd-cost-model
8432 Alter the cost model used for vectorization of loops marked with the OpenMP
8433 or Cilk Plus simd directive.  The @var{model} argument should be one of
8434 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8435 have the same meaning as described in @option{-fvect-cost-model} and by
8436 default a cost model defined with @option{-fvect-cost-model} is used.
8438 @item -ftree-vrp
8439 @opindex ftree-vrp
8440 Perform Value Range Propagation on trees.  This is similar to the
8441 constant propagation pass, but instead of values, ranges of values are
8442 propagated.  This allows the optimizers to remove unnecessary range
8443 checks like array bound checks and null pointer checks.  This is
8444 enabled by default at @option{-O2} and higher.  Null pointer check
8445 elimination is only done if @option{-fdelete-null-pointer-checks} is
8446 enabled.
8448 @item -fsplit-paths
8449 @opindex fsplit-paths
8450 Split paths leading to loop backedges.  This can improve dead code
8451 elimination and common subexpression elimination.  This is enabled by
8452 default at @option{-O2} and above.
8454 @item -fsplit-ivs-in-unroller
8455 @opindex fsplit-ivs-in-unroller
8456 Enables expression of values of induction variables in later iterations
8457 of the unrolled loop using the value in the first iteration.  This breaks
8458 long dependency chains, thus improving efficiency of the scheduling passes.
8460 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8461 same effect.  However, that is not reliable in cases where the loop body
8462 is more complicated than a single basic block.  It also does not work at all
8463 on some architectures due to restrictions in the CSE pass.
8465 This optimization is enabled by default.
8467 @item -fvariable-expansion-in-unroller
8468 @opindex fvariable-expansion-in-unroller
8469 With this option, the compiler creates multiple copies of some
8470 local variables when unrolling a loop, which can result in superior code.
8472 @item -fpartial-inlining
8473 @opindex fpartial-inlining
8474 Inline parts of functions.  This option has any effect only
8475 when inlining itself is turned on by the @option{-finline-functions}
8476 or @option{-finline-small-functions} options.
8478 Enabled at level @option{-O2}.
8480 @item -fpredictive-commoning
8481 @opindex fpredictive-commoning
8482 Perform predictive commoning optimization, i.e., reusing computations
8483 (especially memory loads and stores) performed in previous
8484 iterations of loops.
8486 This option is enabled at level @option{-O3}.
8488 @item -fprefetch-loop-arrays
8489 @opindex fprefetch-loop-arrays
8490 If supported by the target machine, generate instructions to prefetch
8491 memory to improve the performance of loops that access large arrays.
8493 This option may generate better or worse code; results are highly
8494 dependent on the structure of loops within the source code.
8496 Disabled at level @option{-Os}.
8498 @item -fno-printf-return-value
8499 @opindex fno-printf-return-value
8500 Do not substitute constants for known return value of formatted output
8501 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8502 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8503 transformation allows GCC to optimize or even eliminate branches based
8504 on the known return value of these functions called with arguments that
8505 are either constant, or whose values are known to be in a range that
8506 makes determining the exact return value possible.  For example, when
8507 @option{-fprintf-return-value} is in effect, both the branch and the
8508 body of the @code{if} statement (but not the call to @code{snprint})
8509 can be optimized away when @code{i} is a 32-bit or smaller integer
8510 because the return value is guaranteed to be at most 8.
8512 @smallexample
8513 char buf[9];
8514 if (snprintf (buf, "%08x", i) >= sizeof buf)
8515   @dots{}
8516 @end smallexample
8518 The @option{-fprintf-return-value} option relies on other optimizations
8519 and yields best results with @option{-O2}.  It works in tandem with the
8520 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8521 The @option{-fprintf-return-value} option is enabled by default.
8523 @item -fno-peephole
8524 @itemx -fno-peephole2
8525 @opindex fno-peephole
8526 @opindex fno-peephole2
8527 Disable any machine-specific peephole optimizations.  The difference
8528 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8529 are implemented in the compiler; some targets use one, some use the
8530 other, a few use both.
8532 @option{-fpeephole} is enabled by default.
8533 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8535 @item -fno-guess-branch-probability
8536 @opindex fno-guess-branch-probability
8537 Do not guess branch probabilities using heuristics.
8539 GCC uses heuristics to guess branch probabilities if they are
8540 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8541 heuristics are based on the control flow graph.  If some branch probabilities
8542 are specified by @code{__builtin_expect}, then the heuristics are
8543 used to guess branch probabilities for the rest of the control flow graph,
8544 taking the @code{__builtin_expect} info into account.  The interactions
8545 between the heuristics and @code{__builtin_expect} can be complex, and in
8546 some cases, it may be useful to disable the heuristics so that the effects
8547 of @code{__builtin_expect} are easier to understand.
8549 The default is @option{-fguess-branch-probability} at levels
8550 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8552 @item -freorder-blocks
8553 @opindex freorder-blocks
8554 Reorder basic blocks in the compiled function in order to reduce number of
8555 taken branches and improve code locality.
8557 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8559 @item -freorder-blocks-algorithm=@var{algorithm}
8560 @opindex freorder-blocks-algorithm
8561 Use the specified algorithm for basic block reordering.  The
8562 @var{algorithm} argument can be @samp{simple}, which does not increase
8563 code size (except sometimes due to secondary effects like alignment),
8564 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8565 put all often executed code together, minimizing the number of branches
8566 executed by making extra copies of code.
8568 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8569 @samp{stc} at levels @option{-O2}, @option{-O3}.
8571 @item -freorder-blocks-and-partition
8572 @opindex freorder-blocks-and-partition
8573 In addition to reordering basic blocks in the compiled function, in order
8574 to reduce number of taken branches, partitions hot and cold basic blocks
8575 into separate sections of the assembly and @file{.o} files, to improve
8576 paging and cache locality performance.
8578 This optimization is automatically turned off in the presence of
8579 exception handling, for linkonce sections, for functions with a user-defined
8580 section attribute and on any architecture that does not support named
8581 sections.
8583 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8585 @item -freorder-functions
8586 @opindex freorder-functions
8587 Reorder functions in the object file in order to
8588 improve code locality.  This is implemented by using special
8589 subsections @code{.text.hot} for most frequently executed functions and
8590 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8591 the linker so object file format must support named sections and linker must
8592 place them in a reasonable way.
8594 Also profile feedback must be available to make this option effective.  See
8595 @option{-fprofile-arcs} for details.
8597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8599 @item -fstrict-aliasing
8600 @opindex fstrict-aliasing
8601 Allow the compiler to assume the strictest aliasing rules applicable to
8602 the language being compiled.  For C (and C++), this activates
8603 optimizations based on the type of expressions.  In particular, an
8604 object of one type is assumed never to reside at the same address as an
8605 object of a different type, unless the types are almost the same.  For
8606 example, an @code{unsigned int} can alias an @code{int}, but not a
8607 @code{void*} or a @code{double}.  A character type may alias any other
8608 type.
8610 @anchor{Type-punning}Pay special attention to code like this:
8611 @smallexample
8612 union a_union @{
8613   int i;
8614   double d;
8617 int f() @{
8618   union a_union t;
8619   t.d = 3.0;
8620   return t.i;
8622 @end smallexample
8623 The practice of reading from a different union member than the one most
8624 recently written to (called ``type-punning'') is common.  Even with
8625 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8626 is accessed through the union type.  So, the code above works as
8627 expected.  @xref{Structures unions enumerations and bit-fields
8628 implementation}.  However, this code might not:
8629 @smallexample
8630 int f() @{
8631   union a_union t;
8632   int* ip;
8633   t.d = 3.0;
8634   ip = &t.i;
8635   return *ip;
8637 @end smallexample
8639 Similarly, access by taking the address, casting the resulting pointer
8640 and dereferencing the result has undefined behavior, even if the cast
8641 uses a union type, e.g.:
8642 @smallexample
8643 int f() @{
8644   double d = 3.0;
8645   return ((union a_union *) &d)->i;
8647 @end smallexample
8649 The @option{-fstrict-aliasing} option is enabled at levels
8650 @option{-O2}, @option{-O3}, @option{-Os}.
8652 @item -fstrict-overflow
8653 @opindex fstrict-overflow
8654 Allow the compiler to assume strict signed overflow rules, depending
8655 on the language being compiled.  For C (and C++) this means that
8656 overflow when doing arithmetic with signed numbers is undefined, which
8657 means that the compiler may assume that it does not happen.  This
8658 permits various optimizations.  For example, the compiler assumes
8659 that an expression like @code{i + 10 > i} is always true for
8660 signed @code{i}.  This assumption is only valid if signed overflow is
8661 undefined, as the expression is false if @code{i + 10} overflows when
8662 using twos complement arithmetic.  When this option is in effect any
8663 attempt to determine whether an operation on signed numbers 
8664 overflows must be written carefully to not actually involve overflow.
8666 This option also allows the compiler to assume strict pointer
8667 semantics: given a pointer to an object, if adding an offset to that
8668 pointer does not produce a pointer to the same object, the addition is
8669 undefined.  This permits the compiler to conclude that @code{p + u >
8670 p} is always true for a pointer @code{p} and unsigned integer
8671 @code{u}.  This assumption is only valid because pointer wraparound is
8672 undefined, as the expression is false if @code{p + u} overflows using
8673 twos complement arithmetic.
8675 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8676 that integer signed overflow is fully defined: it wraps.  When
8677 @option{-fwrapv} is used, there is no difference between
8678 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8679 integers.  With @option{-fwrapv} certain types of overflow are
8680 permitted.  For example, if the compiler gets an overflow when doing
8681 arithmetic on constants, the overflowed value can still be used with
8682 @option{-fwrapv}, but not otherwise.
8684 The @option{-fstrict-overflow} option is enabled at levels
8685 @option{-O2}, @option{-O3}, @option{-Os}.
8687 @item -falign-functions
8688 @itemx -falign-functions=@var{n}
8689 @opindex falign-functions
8690 Align the start of functions to the next power-of-two greater than
8691 @var{n}, skipping up to @var{n} bytes.  For instance,
8692 @option{-falign-functions=32} aligns functions to the next 32-byte
8693 boundary, but @option{-falign-functions=24} aligns to the next
8694 32-byte boundary only if this can be done by skipping 23 bytes or less.
8696 @option{-fno-align-functions} and @option{-falign-functions=1} are
8697 equivalent and mean that functions are not aligned.
8699 Some assemblers only support this flag when @var{n} is a power of two;
8700 in that case, it is rounded up.
8702 If @var{n} is not specified or is zero, use a machine-dependent default.
8704 Enabled at levels @option{-O2}, @option{-O3}.
8706 @item -flimit-function-alignment
8707 If this option is enabled, the compiler tries to avoid unnecessarily
8708 overaligning functions. It attempts to instruct the assembler to align
8709 by the amount specified by @option{-falign-functions}, but not to
8710 skip more bytes than the size of the function.
8712 @item -falign-labels
8713 @itemx -falign-labels=@var{n}
8714 @opindex falign-labels
8715 Align all branch targets to a power-of-two boundary, skipping up to
8716 @var{n} bytes like @option{-falign-functions}.  This option can easily
8717 make code slower, because it must insert dummy operations for when the
8718 branch target is reached in the usual flow of the code.
8720 @option{-fno-align-labels} and @option{-falign-labels=1} are
8721 equivalent and mean that labels are not aligned.
8723 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8724 are greater than this value, then their values are used instead.
8726 If @var{n} is not specified or is zero, use a machine-dependent default
8727 which is very likely to be @samp{1}, meaning no alignment.
8729 Enabled at levels @option{-O2}, @option{-O3}.
8731 @item -falign-loops
8732 @itemx -falign-loops=@var{n}
8733 @opindex falign-loops
8734 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8735 like @option{-falign-functions}.  If the loops are
8736 executed many times, this makes up for any execution of the dummy
8737 operations.
8739 @option{-fno-align-loops} and @option{-falign-loops=1} are
8740 equivalent and mean that loops are not aligned.
8742 If @var{n} is not specified or is zero, use a machine-dependent default.
8744 Enabled at levels @option{-O2}, @option{-O3}.
8746 @item -falign-jumps
8747 @itemx -falign-jumps=@var{n}
8748 @opindex falign-jumps
8749 Align branch targets to a power-of-two boundary, for branch targets
8750 where the targets can only be reached by jumping, skipping up to @var{n}
8751 bytes like @option{-falign-functions}.  In this case, no dummy operations
8752 need be executed.
8754 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8755 equivalent and mean that loops are not aligned.
8757 If @var{n} is not specified or is zero, use a machine-dependent default.
8759 Enabled at levels @option{-O2}, @option{-O3}.
8761 @item -funit-at-a-time
8762 @opindex funit-at-a-time
8763 This option is left for compatibility reasons. @option{-funit-at-a-time}
8764 has no effect, while @option{-fno-unit-at-a-time} implies
8765 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8767 Enabled by default.
8769 @item -fno-toplevel-reorder
8770 @opindex fno-toplevel-reorder
8771 Do not reorder top-level functions, variables, and @code{asm}
8772 statements.  Output them in the same order that they appear in the
8773 input file.  When this option is used, unreferenced static variables
8774 are not removed.  This option is intended to support existing code
8775 that relies on a particular ordering.  For new code, it is better to
8776 use attributes when possible.
8778 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8779 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8780 targets.
8782 @item -fweb
8783 @opindex fweb
8784 Constructs webs as commonly used for register allocation purposes and assign
8785 each web individual pseudo register.  This allows the register allocation pass
8786 to operate on pseudos directly, but also strengthens several other optimization
8787 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8788 however, make debugging impossible, since variables no longer stay in a
8789 ``home register''.
8791 Enabled by default with @option{-funroll-loops}.
8793 @item -fwhole-program
8794 @opindex fwhole-program
8795 Assume that the current compilation unit represents the whole program being
8796 compiled.  All public functions and variables with the exception of @code{main}
8797 and those merged by attribute @code{externally_visible} become static functions
8798 and in effect are optimized more aggressively by interprocedural optimizers.
8800 This option should not be used in combination with @option{-flto}.
8801 Instead relying on a linker plugin should provide safer and more precise
8802 information.
8804 @item -flto[=@var{n}]
8805 @opindex flto
8806 This option runs the standard link-time optimizer.  When invoked
8807 with source code, it generates GIMPLE (one of GCC's internal
8808 representations) and writes it to special ELF sections in the object
8809 file.  When the object files are linked together, all the function
8810 bodies are read from these ELF sections and instantiated as if they
8811 had been part of the same translation unit.
8813 To use the link-time optimizer, @option{-flto} and optimization
8814 options should be specified at compile time and during the final link.
8815 It is recommended that you compile all the files participating in the
8816 same link with the same options and also specify those options at
8817 link time.  
8818 For example:
8820 @smallexample
8821 gcc -c -O2 -flto foo.c
8822 gcc -c -O2 -flto bar.c
8823 gcc -o myprog -flto -O2 foo.o bar.o
8824 @end smallexample
8826 The first two invocations to GCC save a bytecode representation
8827 of GIMPLE into special ELF sections inside @file{foo.o} and
8828 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8829 @file{foo.o} and @file{bar.o}, merges the two files into a single
8830 internal image, and compiles the result as usual.  Since both
8831 @file{foo.o} and @file{bar.o} are merged into a single image, this
8832 causes all the interprocedural analyses and optimizations in GCC to
8833 work across the two files as if they were a single one.  This means,
8834 for example, that the inliner is able to inline functions in
8835 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8837 Another (simpler) way to enable link-time optimization is:
8839 @smallexample
8840 gcc -o myprog -flto -O2 foo.c bar.c
8841 @end smallexample
8843 The above generates bytecode for @file{foo.c} and @file{bar.c},
8844 merges them together into a single GIMPLE representation and optimizes
8845 them as usual to produce @file{myprog}.
8847 The only important thing to keep in mind is that to enable link-time
8848 optimizations you need to use the GCC driver to perform the link step.
8849 GCC then automatically performs link-time optimization if any of the
8850 objects involved were compiled with the @option{-flto} command-line option.  
8851 You generally
8852 should specify the optimization options to be used for link-time
8853 optimization though GCC tries to be clever at guessing an
8854 optimization level to use from the options used at compile time
8855 if you fail to specify one at link time.  You can always override
8856 the automatic decision to do link-time optimization
8857 by passing @option{-fno-lto} to the link command.
8859 To make whole program optimization effective, it is necessary to make
8860 certain whole program assumptions.  The compiler needs to know
8861 what functions and variables can be accessed by libraries and runtime
8862 outside of the link-time optimized unit.  When supported by the linker,
8863 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8864 to the compiler about used and externally visible symbols.  When
8865 the linker plugin is not available, @option{-fwhole-program} should be
8866 used to allow the compiler to make these assumptions, which leads
8867 to more aggressive optimization decisions.
8869 When @option{-fuse-linker-plugin} is not enabled, when a file is
8870 compiled with @option{-flto}, the generated object file is larger than
8871 a regular object file because it contains GIMPLE bytecodes and the usual
8872 final code (see @option{-ffat-lto-objects}.  This means that
8873 object files with LTO information can be linked as normal object
8874 files; if @option{-fno-lto} is passed to the linker, no
8875 interprocedural optimizations are applied.  Note that when
8876 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8877 but you cannot perform a regular, non-LTO link on them.
8879 Additionally, the optimization flags used to compile individual files
8880 are not necessarily related to those used at link time.  For instance,
8882 @smallexample
8883 gcc -c -O0 -ffat-lto-objects -flto foo.c
8884 gcc -c -O0 -ffat-lto-objects -flto bar.c
8885 gcc -o myprog -O3 foo.o bar.o
8886 @end smallexample
8888 This produces individual object files with unoptimized assembler
8889 code, but the resulting binary @file{myprog} is optimized at
8890 @option{-O3}.  If, instead, the final binary is generated with
8891 @option{-fno-lto}, then @file{myprog} is not optimized.
8893 When producing the final binary, GCC only
8894 applies link-time optimizations to those files that contain bytecode.
8895 Therefore, you can mix and match object files and libraries with
8896 GIMPLE bytecodes and final object code.  GCC automatically selects
8897 which files to optimize in LTO mode and which files to link without
8898 further processing.
8900 There are some code generation flags preserved by GCC when
8901 generating bytecodes, as they need to be used during the final link
8902 stage.  Generally options specified at link time override those
8903 specified at compile time.
8905 If you do not specify an optimization level option @option{-O} at
8906 link time, then GCC uses the highest optimization level 
8907 used when compiling the object files.
8909 Currently, the following options and their settings are taken from
8910 the first object file that explicitly specifies them: 
8911 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8912 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8913 and all the @option{-m} target flags.
8915 Certain ABI-changing flags are required to match in all compilation units,
8916 and trying to override this at link time with a conflicting value
8917 is ignored.  This includes options such as @option{-freg-struct-return}
8918 and @option{-fpcc-struct-return}. 
8920 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8921 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8922 are passed through to the link stage and merged conservatively for
8923 conflicting translation units.  Specifically
8924 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8925 precedence; and for example @option{-ffp-contract=off} takes precedence
8926 over @option{-ffp-contract=fast}.  You can override them at link time.
8928 If LTO encounters objects with C linkage declared with incompatible
8929 types in separate translation units to be linked together (undefined
8930 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8931 issued.  The behavior is still undefined at run time.  Similar
8932 diagnostics may be raised for other languages.
8934 Another feature of LTO is that it is possible to apply interprocedural
8935 optimizations on files written in different languages:
8937 @smallexample
8938 gcc -c -flto foo.c
8939 g++ -c -flto bar.cc
8940 gfortran -c -flto baz.f90
8941 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8942 @end smallexample
8944 Notice that the final link is done with @command{g++} to get the C++
8945 runtime libraries and @option{-lgfortran} is added to get the Fortran
8946 runtime libraries.  In general, when mixing languages in LTO mode, you
8947 should use the same link command options as when mixing languages in a
8948 regular (non-LTO) compilation.
8950 If object files containing GIMPLE bytecode are stored in a library archive, say
8951 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8952 are using a linker with plugin support.  To create static libraries suitable
8953 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8954 and @command{ranlib}; 
8955 to show the symbols of object files with GIMPLE bytecode, use
8956 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8957 and @command{nm} have been compiled with plugin support.  At link time, use the the
8958 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8959 the LTO optimization process:
8961 @smallexample
8962 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8963 @end smallexample
8965 With the linker plugin enabled, the linker extracts the needed
8966 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8967 to make them part of the aggregated GIMPLE image to be optimized.
8969 If you are not using a linker with plugin support and/or do not
8970 enable the linker plugin, then the objects inside @file{libfoo.a}
8971 are extracted and linked as usual, but they do not participate
8972 in the LTO optimization process.  In order to make a static library suitable
8973 for both LTO optimization and usual linkage, compile its object files with
8974 @option{-flto} @option{-ffat-lto-objects}.
8976 Link-time optimizations do not require the presence of the whole program to
8977 operate.  If the program does not require any symbols to be exported, it is
8978 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8979 the interprocedural optimizers to use more aggressive assumptions which may
8980 lead to improved optimization opportunities.
8981 Use of @option{-fwhole-program} is not needed when linker plugin is
8982 active (see @option{-fuse-linker-plugin}).
8984 The current implementation of LTO makes no
8985 attempt to generate bytecode that is portable between different
8986 types of hosts.  The bytecode files are versioned and there is a
8987 strict version check, so bytecode files generated in one version of
8988 GCC do not work with an older or newer version of GCC.
8990 Link-time optimization does not work well with generation of debugging
8991 information.  Combining @option{-flto} with
8992 @option{-g} is currently experimental and expected to produce unexpected
8993 results.
8995 If you specify the optional @var{n}, the optimization and code
8996 generation done at link time is executed in parallel using @var{n}
8997 parallel jobs by utilizing an installed @command{make} program.  The
8998 environment variable @env{MAKE} may be used to override the program
8999 used.  The default value for @var{n} is 1.
9001 You can also specify @option{-flto=jobserver} to use GNU make's
9002 job server mode to determine the number of parallel jobs. This
9003 is useful when the Makefile calling GCC is already executing in parallel.
9004 You must prepend a @samp{+} to the command recipe in the parent Makefile
9005 for this to work.  This option likely only works if @env{MAKE} is
9006 GNU make.
9008 @item -flto-partition=@var{alg}
9009 @opindex flto-partition
9010 Specify the partitioning algorithm used by the link-time optimizer.
9011 The value is either @samp{1to1} to specify a partitioning mirroring
9012 the original source files or @samp{balanced} to specify partitioning
9013 into equally sized chunks (whenever possible) or @samp{max} to create
9014 new partition for every symbol where possible.  Specifying @samp{none}
9015 as an algorithm disables partitioning and streaming completely. 
9016 The default value is @samp{balanced}. While @samp{1to1} can be used
9017 as an workaround for various code ordering issues, the @samp{max}
9018 partitioning is intended for internal testing only.
9019 The value @samp{one} specifies that exactly one partition should be
9020 used while the value @samp{none} bypasses partitioning and executes
9021 the link-time optimization step directly from the WPA phase.
9023 @item -flto-odr-type-merging
9024 @opindex flto-odr-type-merging
9025 Enable streaming of mangled types names of C++ types and their unification
9026 at link time.  This increases size of LTO object files, but enables
9027 diagnostics about One Definition Rule violations.
9029 @item -flto-compression-level=@var{n}
9030 @opindex flto-compression-level
9031 This option specifies the level of compression used for intermediate
9032 language written to LTO object files, and is only meaningful in
9033 conjunction with LTO mode (@option{-flto}).  Valid
9034 values are 0 (no compression) to 9 (maximum compression).  Values
9035 outside this range are clamped to either 0 or 9.  If the option is not
9036 given, a default balanced compression setting is used.
9038 @item -fuse-linker-plugin
9039 @opindex fuse-linker-plugin
9040 Enables the use of a linker plugin during link-time optimization.  This
9041 option relies on plugin support in the linker, which is available in gold
9042 or in GNU ld 2.21 or newer.
9044 This option enables the extraction of object files with GIMPLE bytecode out
9045 of library archives. This improves the quality of optimization by exposing
9046 more code to the link-time optimizer.  This information specifies what
9047 symbols can be accessed externally (by non-LTO object or during dynamic
9048 linking).  Resulting code quality improvements on binaries (and shared
9049 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9050 See @option{-flto} for a description of the effect of this flag and how to
9051 use it.
9053 This option is enabled by default when LTO support in GCC is enabled
9054 and GCC was configured for use with
9055 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9057 @item -ffat-lto-objects
9058 @opindex ffat-lto-objects
9059 Fat LTO objects are object files that contain both the intermediate language
9060 and the object code. This makes them usable for both LTO linking and normal
9061 linking. This option is effective only when compiling with @option{-flto}
9062 and is ignored at link time.
9064 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9065 requires the complete toolchain to be aware of LTO. It requires a linker with
9066 linker plugin support for basic functionality.  Additionally,
9067 @command{nm}, @command{ar} and @command{ranlib}
9068 need to support linker plugins to allow a full-featured build environment
9069 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9070 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9071 to these tools. With non fat LTO makefiles need to be modified to use them.
9073 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9074 support.
9076 @item -fcompare-elim
9077 @opindex fcompare-elim
9078 After register allocation and post-register allocation instruction splitting,
9079 identify arithmetic instructions that compute processor flags similar to a
9080 comparison operation based on that arithmetic.  If possible, eliminate the
9081 explicit comparison operation.
9083 This pass only applies to certain targets that cannot explicitly represent
9084 the comparison operation before register allocation is complete.
9086 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9088 @item -fcprop-registers
9089 @opindex fcprop-registers
9090 After register allocation and post-register allocation instruction splitting,
9091 perform a copy-propagation pass to try to reduce scheduling dependencies
9092 and occasionally eliminate the copy.
9094 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9096 @item -fprofile-correction
9097 @opindex fprofile-correction
9098 Profiles collected using an instrumented binary for multi-threaded programs may
9099 be inconsistent due to missed counter updates. When this option is specified,
9100 GCC uses heuristics to correct or smooth out such inconsistencies. By
9101 default, GCC emits an error message when an inconsistent profile is detected.
9103 @item -fprofile-use
9104 @itemx -fprofile-use=@var{path}
9105 @opindex fprofile-use
9106 Enable profile feedback-directed optimizations, 
9107 and the following optimizations
9108 which are generally profitable only with profile feedback available:
9109 @option{-fbranch-probabilities}, @option{-fvpt},
9110 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9111 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9113 Before you can use this option, you must first generate profiling information.
9114 @xref{Instrumentation Options}, for information about the
9115 @option{-fprofile-generate} option.
9117 By default, GCC emits an error message if the feedback profiles do not
9118 match the source code.  This error can be turned into a warning by using
9119 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9120 code.
9122 If @var{path} is specified, GCC looks at the @var{path} to find
9123 the profile feedback data files. See @option{-fprofile-dir}.
9125 @item -fauto-profile
9126 @itemx -fauto-profile=@var{path}
9127 @opindex fauto-profile
9128 Enable sampling-based feedback-directed optimizations, 
9129 and the following optimizations
9130 which are generally profitable only with profile feedback available:
9131 @option{-fbranch-probabilities}, @option{-fvpt},
9132 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9133 @option{-ftree-vectorize},
9134 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9135 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9136 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9138 @var{path} is the name of a file containing AutoFDO profile information.
9139 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9141 Producing an AutoFDO profile data file requires running your program
9142 with the @command{perf} utility on a supported GNU/Linux target system.
9143 For more information, see @uref{https://perf.wiki.kernel.org/}.
9145 E.g.
9146 @smallexample
9147 perf record -e br_inst_retired:near_taken -b -o perf.data \
9148     -- your_program
9149 @end smallexample
9151 Then use the @command{create_gcov} tool to convert the raw profile data
9152 to a format that can be used by GCC.@  You must also supply the 
9153 unstripped binary for your program to this tool.  
9154 See @uref{https://github.com/google/autofdo}.
9156 E.g.
9157 @smallexample
9158 create_gcov --binary=your_program.unstripped --profile=perf.data \
9159     --gcov=profile.afdo
9160 @end smallexample
9161 @end table
9163 The following options control compiler behavior regarding floating-point 
9164 arithmetic.  These options trade off between speed and
9165 correctness.  All must be specifically enabled.
9167 @table @gcctabopt
9168 @item -ffloat-store
9169 @opindex ffloat-store
9170 Do not store floating-point variables in registers, and inhibit other
9171 options that might change whether a floating-point value is taken from a
9172 register or memory.
9174 @cindex floating-point precision
9175 This option prevents undesirable excess precision on machines such as
9176 the 68000 where the floating registers (of the 68881) keep more
9177 precision than a @code{double} is supposed to have.  Similarly for the
9178 x86 architecture.  For most programs, the excess precision does only
9179 good, but a few programs rely on the precise definition of IEEE floating
9180 point.  Use @option{-ffloat-store} for such programs, after modifying
9181 them to store all pertinent intermediate computations into variables.
9183 @item -fexcess-precision=@var{style}
9184 @opindex fexcess-precision
9185 This option allows further control over excess precision on machines
9186 where floating-point operations occur in a format with more precision or
9187 range than the IEEE standard and interchange floating-point types.  By
9188 default, @option{-fexcess-precision=fast} is in effect; this means that
9189 operations may be carried out in a wider precision than the types specified
9190 in the source if that would result in faster code, and it is unpredictable
9191 when rounding to the types specified in the source code takes place.
9192 When compiling C, if @option{-fexcess-precision=standard} is specified then
9193 excess precision follows the rules specified in ISO C99; in particular,
9194 both casts and assignments cause values to be rounded to their
9195 semantic types (whereas @option{-ffloat-store} only affects
9196 assignments).  This option is enabled by default for C if a strict
9197 conformance option such as @option{-std=c99} is used.
9198 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9199 regardless of whether a strict conformance option is used.
9201 @opindex mfpmath
9202 @option{-fexcess-precision=standard} is not implemented for languages
9203 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9204 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9205 semantics apply without excess precision, and in the latter, rounding
9206 is unpredictable.
9208 @item -ffast-math
9209 @opindex ffast-math
9210 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9211 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9212 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9213 @option{-fexcess-precision=fast}.
9215 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9217 This option is not turned on by any @option{-O} option besides
9218 @option{-Ofast} since it can result in incorrect output for programs
9219 that depend on an exact implementation of IEEE or ISO rules/specifications
9220 for math functions. It may, however, yield faster code for programs
9221 that do not require the guarantees of these specifications.
9223 @item -fno-math-errno
9224 @opindex fno-math-errno
9225 Do not set @code{errno} after calling math functions that are executed
9226 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9227 IEEE exceptions for math error handling may want to use this flag
9228 for speed while maintaining IEEE arithmetic compatibility.
9230 This option is not turned on by any @option{-O} option since
9231 it can result in incorrect output for programs that depend on
9232 an exact implementation of IEEE or ISO rules/specifications for
9233 math functions. It may, however, yield faster code for programs
9234 that do not require the guarantees of these specifications.
9236 The default is @option{-fmath-errno}.
9238 On Darwin systems, the math library never sets @code{errno}.  There is
9239 therefore no reason for the compiler to consider the possibility that
9240 it might, and @option{-fno-math-errno} is the default.
9242 @item -funsafe-math-optimizations
9243 @opindex funsafe-math-optimizations
9245 Allow optimizations for floating-point arithmetic that (a) assume
9246 that arguments and results are valid and (b) may violate IEEE or
9247 ANSI standards.  When used at link time, it may include libraries
9248 or startup files that change the default FPU control word or other
9249 similar optimizations.
9251 This option is not turned on by any @option{-O} option since
9252 it can result in incorrect output for programs that depend on
9253 an exact implementation of IEEE or ISO rules/specifications for
9254 math functions. It may, however, yield faster code for programs
9255 that do not require the guarantees of these specifications.
9256 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9257 @option{-fassociative-math} and @option{-freciprocal-math}.
9259 The default is @option{-fno-unsafe-math-optimizations}.
9261 @item -fassociative-math
9262 @opindex fassociative-math
9264 Allow re-association of operands in series of floating-point operations.
9265 This violates the ISO C and C++ language standard by possibly changing
9266 computation result.  NOTE: re-ordering may change the sign of zero as
9267 well as ignore NaNs and inhibit or create underflow or overflow (and
9268 thus cannot be used on code that relies on rounding behavior like
9269 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9270 and thus may not be used when ordered comparisons are required.
9271 This option requires that both @option{-fno-signed-zeros} and
9272 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9273 much sense with @option{-frounding-math}. For Fortran the option
9274 is automatically enabled when both @option{-fno-signed-zeros} and
9275 @option{-fno-trapping-math} are in effect.
9277 The default is @option{-fno-associative-math}.
9279 @item -freciprocal-math
9280 @opindex freciprocal-math
9282 Allow the reciprocal of a value to be used instead of dividing by
9283 the value if this enables optimizations.  For example @code{x / y}
9284 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9285 is subject to common subexpression elimination.  Note that this loses
9286 precision and increases the number of flops operating on the value.
9288 The default is @option{-fno-reciprocal-math}.
9290 @item -ffinite-math-only
9291 @opindex ffinite-math-only
9292 Allow optimizations for floating-point arithmetic that assume
9293 that arguments and results are not NaNs or +-Infs.
9295 This option is not turned on by any @option{-O} option since
9296 it can result in incorrect output for programs that depend on
9297 an exact implementation of IEEE or ISO rules/specifications for
9298 math functions. It may, however, yield faster code for programs
9299 that do not require the guarantees of these specifications.
9301 The default is @option{-fno-finite-math-only}.
9303 @item -fno-signed-zeros
9304 @opindex fno-signed-zeros
9305 Allow optimizations for floating-point arithmetic that ignore the
9306 signedness of zero.  IEEE arithmetic specifies the behavior of
9307 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9308 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9309 This option implies that the sign of a zero result isn't significant.
9311 The default is @option{-fsigned-zeros}.
9313 @item -fno-trapping-math
9314 @opindex fno-trapping-math
9315 Compile code assuming that floating-point operations cannot generate
9316 user-visible traps.  These traps include division by zero, overflow,
9317 underflow, inexact result and invalid operation.  This option requires
9318 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9319 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9321 This option should never be turned on by any @option{-O} option since
9322 it can result in incorrect output for programs that depend on
9323 an exact implementation of IEEE or ISO rules/specifications for
9324 math functions.
9326 The default is @option{-ftrapping-math}.
9328 @item -frounding-math
9329 @opindex frounding-math
9330 Disable transformations and optimizations that assume default floating-point
9331 rounding behavior.  This is round-to-zero for all floating point
9332 to integer conversions, and round-to-nearest for all other arithmetic
9333 truncations.  This option should be specified for programs that change
9334 the FP rounding mode dynamically, or that may be executed with a
9335 non-default rounding mode.  This option disables constant folding of
9336 floating-point expressions at compile time (which may be affected by
9337 rounding mode) and arithmetic transformations that are unsafe in the
9338 presence of sign-dependent rounding modes.
9340 The default is @option{-fno-rounding-math}.
9342 This option is experimental and does not currently guarantee to
9343 disable all GCC optimizations that are affected by rounding mode.
9344 Future versions of GCC may provide finer control of this setting
9345 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9346 will be used to specify the default state for @code{FENV_ACCESS}.
9348 @item -fsignaling-nans
9349 @opindex fsignaling-nans
9350 Compile code assuming that IEEE signaling NaNs may generate user-visible
9351 traps during floating-point operations.  Setting this option disables
9352 optimizations that may change the number of exceptions visible with
9353 signaling NaNs.  This option implies @option{-ftrapping-math}.
9355 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9356 be defined.
9358 The default is @option{-fno-signaling-nans}.
9360 This option is experimental and does not currently guarantee to
9361 disable all GCC optimizations that affect signaling NaN behavior.
9363 @item -fno-fp-int-builtin-inexact
9364 @opindex fno-fp-int-builtin-inexact
9365 Do not allow the built-in functions @code{ceil}, @code{floor},
9366 @code{round} and @code{trunc}, and their @code{float} and @code{long
9367 double} variants, to generate code that raises the ``inexact''
9368 floating-point exception for noninteger arguments.  ISO C99 and C11
9369 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9370 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9371 functions to do so.
9373 The default is @option{-ffp-int-builtin-inexact}, allowing the
9374 exception to be raised.  This option does nothing unless
9375 @option{-ftrapping-math} is in effect.
9377 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9378 generate a call to a library function then the ``inexact'' exception
9379 may be raised if the library implementation does not follow TS 18661.
9381 @item -fsingle-precision-constant
9382 @opindex fsingle-precision-constant
9383 Treat floating-point constants as single precision instead of
9384 implicitly converting them to double-precision constants.
9386 @item -fcx-limited-range
9387 @opindex fcx-limited-range
9388 When enabled, this option states that a range reduction step is not
9389 needed when performing complex division.  Also, there is no checking
9390 whether the result of a complex multiplication or division is @code{NaN
9391 + I*NaN}, with an attempt to rescue the situation in that case.  The
9392 default is @option{-fno-cx-limited-range}, but is enabled by
9393 @option{-ffast-math}.
9395 This option controls the default setting of the ISO C99
9396 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9397 all languages.
9399 @item -fcx-fortran-rules
9400 @opindex fcx-fortran-rules
9401 Complex multiplication and division follow Fortran rules.  Range
9402 reduction is done as part of complex division, but there is no checking
9403 whether the result of a complex multiplication or division is @code{NaN
9404 + I*NaN}, with an attempt to rescue the situation in that case.
9406 The default is @option{-fno-cx-fortran-rules}.
9408 @end table
9410 The following options control optimizations that may improve
9411 performance, but are not enabled by any @option{-O} options.  This
9412 section includes experimental options that may produce broken code.
9414 @table @gcctabopt
9415 @item -fbranch-probabilities
9416 @opindex fbranch-probabilities
9417 After running a program compiled with @option{-fprofile-arcs}
9418 (@pxref{Instrumentation Options}),
9419 you can compile it a second time using
9420 @option{-fbranch-probabilities}, to improve optimizations based on
9421 the number of times each branch was taken.  When a program
9422 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9423 counts to a file called @file{@var{sourcename}.gcda} for each source
9424 file.  The information in this data file is very dependent on the
9425 structure of the generated code, so you must use the same source code
9426 and the same optimization options for both compilations.
9428 With @option{-fbranch-probabilities}, GCC puts a
9429 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9430 These can be used to improve optimization.  Currently, they are only
9431 used in one place: in @file{reorg.c}, instead of guessing which path a
9432 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9433 exactly determine which path is taken more often.
9435 @item -fprofile-values
9436 @opindex fprofile-values
9437 If combined with @option{-fprofile-arcs}, it adds code so that some
9438 data about values of expressions in the program is gathered.
9440 With @option{-fbranch-probabilities}, it reads back the data gathered
9441 from profiling values of expressions for usage in optimizations.
9443 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9445 @item -fprofile-reorder-functions
9446 @opindex fprofile-reorder-functions
9447 Function reordering based on profile instrumentation collects
9448 first time of execution of a function and orders these functions
9449 in ascending order.
9451 Enabled with @option{-fprofile-use}.
9453 @item -fvpt
9454 @opindex fvpt
9455 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9456 to add code to gather information about values of expressions.
9458 With @option{-fbranch-probabilities}, it reads back the data gathered
9459 and actually performs the optimizations based on them.
9460 Currently the optimizations include specialization of division operations
9461 using the knowledge about the value of the denominator.
9463 @item -frename-registers
9464 @opindex frename-registers
9465 Attempt to avoid false dependencies in scheduled code by making use
9466 of registers left over after register allocation.  This optimization
9467 most benefits processors with lots of registers.  Depending on the
9468 debug information format adopted by the target, however, it can
9469 make debugging impossible, since variables no longer stay in
9470 a ``home register''.
9472 Enabled by default with @option{-funroll-loops}.
9474 @item -fschedule-fusion
9475 @opindex fschedule-fusion
9476 Performs a target dependent pass over the instruction stream to schedule
9477 instructions of same type together because target machine can execute them
9478 more efficiently if they are adjacent to each other in the instruction flow.
9480 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9482 @item -ftracer
9483 @opindex ftracer
9484 Perform tail duplication to enlarge superblock size.  This transformation
9485 simplifies the control flow of the function allowing other optimizations to do
9486 a better job.
9488 Enabled with @option{-fprofile-use}.
9490 @item -funroll-loops
9491 @opindex funroll-loops
9492 Unroll loops whose number of iterations can be determined at compile time or
9493 upon entry to the loop.  @option{-funroll-loops} implies
9494 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9495 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9496 a small constant number of iterations).  This option makes code larger, and may
9497 or may not make it run faster.
9499 Enabled with @option{-fprofile-use}.
9501 @item -funroll-all-loops
9502 @opindex funroll-all-loops
9503 Unroll all loops, even if their number of iterations is uncertain when
9504 the loop is entered.  This usually makes programs run more slowly.
9505 @option{-funroll-all-loops} implies the same options as
9506 @option{-funroll-loops}.
9508 @item -fpeel-loops
9509 @opindex fpeel-loops
9510 Peels loops for which there is enough information that they do not
9511 roll much (from profile feedback or static analysis).  It also turns on
9512 complete loop peeling (i.e.@: complete removal of loops with small constant
9513 number of iterations).
9515 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9517 @item -fmove-loop-invariants
9518 @opindex fmove-loop-invariants
9519 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9520 at level @option{-O1}
9522 @item -fsplit-loops
9523 @opindex fsplit-loops
9524 Split a loop into two if it contains a condition that's always true
9525 for one side of the iteration space and false for the other.
9527 @item -funswitch-loops
9528 @opindex funswitch-loops
9529 Move branches with loop invariant conditions out of the loop, with duplicates
9530 of the loop on both branches (modified according to result of the condition).
9532 @item -ffunction-sections
9533 @itemx -fdata-sections
9534 @opindex ffunction-sections
9535 @opindex fdata-sections
9536 Place each function or data item into its own section in the output
9537 file if the target supports arbitrary sections.  The name of the
9538 function or the name of the data item determines the section's name
9539 in the output file.
9541 Use these options on systems where the linker can perform optimizations
9542 to improve locality of reference in the instruction space.  Most systems
9543 using the ELF object format and SPARC processors running Solaris 2 have
9544 linkers with such optimizations.  AIX may have these optimizations in
9545 the future.
9547 Only use these options when there are significant benefits from doing
9548 so.  When you specify these options, the assembler and linker
9549 create larger object and executable files and are also slower.
9550 You cannot use @command{gprof} on all systems if you
9551 specify this option, and you may have problems with debugging if
9552 you specify both this option and @option{-g}.
9554 @item -fbranch-target-load-optimize
9555 @opindex fbranch-target-load-optimize
9556 Perform branch target register load optimization before prologue / epilogue
9557 threading.
9558 The use of target registers can typically be exposed only during reload,
9559 thus hoisting loads out of loops and doing inter-block scheduling needs
9560 a separate optimization pass.
9562 @item -fbranch-target-load-optimize2
9563 @opindex fbranch-target-load-optimize2
9564 Perform branch target register load optimization after prologue / epilogue
9565 threading.
9567 @item -fbtr-bb-exclusive
9568 @opindex fbtr-bb-exclusive
9569 When performing branch target register load optimization, don't reuse
9570 branch target registers within any basic block.
9572 @item -fstdarg-opt
9573 @opindex fstdarg-opt
9574 Optimize the prologue of variadic argument functions with respect to usage of
9575 those arguments.
9577 @item -fsection-anchors
9578 @opindex fsection-anchors
9579 Try to reduce the number of symbolic address calculations by using
9580 shared ``anchor'' symbols to address nearby objects.  This transformation
9581 can help to reduce the number of GOT entries and GOT accesses on some
9582 targets.
9584 For example, the implementation of the following function @code{foo}:
9586 @smallexample
9587 static int a, b, c;
9588 int foo (void) @{ return a + b + c; @}
9589 @end smallexample
9591 @noindent
9592 usually calculates the addresses of all three variables, but if you
9593 compile it with @option{-fsection-anchors}, it accesses the variables
9594 from a common anchor point instead.  The effect is similar to the
9595 following pseudocode (which isn't valid C):
9597 @smallexample
9598 int foo (void)
9600   register int *xr = &x;
9601   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9603 @end smallexample
9605 Not all targets support this option.
9607 @item --param @var{name}=@var{value}
9608 @opindex param
9609 In some places, GCC uses various constants to control the amount of
9610 optimization that is done.  For example, GCC does not inline functions
9611 that contain more than a certain number of instructions.  You can
9612 control some of these constants on the command line using the
9613 @option{--param} option.
9615 The names of specific parameters, and the meaning of the values, are
9616 tied to the internals of the compiler, and are subject to change
9617 without notice in future releases.
9619 In each case, the @var{value} is an integer.  The allowable choices for
9620 @var{name} are:
9622 @table @gcctabopt
9623 @item predictable-branch-outcome
9624 When branch is predicted to be taken with probability lower than this threshold
9625 (in percent), then it is considered well predictable. The default is 10.
9627 @item max-rtl-if-conversion-insns
9628 RTL if-conversion tries to remove conditional branches around a block and
9629 replace them with conditionally executed instructions.  This parameter
9630 gives the maximum number of instructions in a block which should be
9631 considered for if-conversion.  The default is 10, though the compiler will
9632 also use other heuristics to decide whether if-conversion is likely to be
9633 profitable.
9635 @item max-rtl-if-conversion-predictable-cost
9636 @item max-rtl-if-conversion-unpredictable-cost
9637 RTL if-conversion will try to remove conditional branches around a block
9638 and replace them with conditionally executed instructions.  These parameters
9639 give the maximum permissible cost for the sequence that would be generated
9640 by if-conversion depending on whether the branch is statically determined
9641 to be predictable or not.  The units for this parameter are the same as
9642 those for the GCC internal seq_cost metric.  The compiler will try to
9643 provide a reasonable default for this parameter using the BRANCH_COST
9644 target macro.
9646 @item max-crossjump-edges
9647 The maximum number of incoming edges to consider for cross-jumping.
9648 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9649 the number of edges incoming to each block.  Increasing values mean
9650 more aggressive optimization, making the compilation time increase with
9651 probably small improvement in executable size.
9653 @item min-crossjump-insns
9654 The minimum number of instructions that must be matched at the end
9655 of two blocks before cross-jumping is performed on them.  This
9656 value is ignored in the case where all instructions in the block being
9657 cross-jumped from are matched.  The default value is 5.
9659 @item max-grow-copy-bb-insns
9660 The maximum code size expansion factor when copying basic blocks
9661 instead of jumping.  The expansion is relative to a jump instruction.
9662 The default value is 8.
9664 @item max-goto-duplication-insns
9665 The maximum number of instructions to duplicate to a block that jumps
9666 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9667 passes, GCC factors computed gotos early in the compilation process,
9668 and unfactors them as late as possible.  Only computed jumps at the
9669 end of a basic blocks with no more than max-goto-duplication-insns are
9670 unfactored.  The default value is 8.
9672 @item max-delay-slot-insn-search
9673 The maximum number of instructions to consider when looking for an
9674 instruction to fill a delay slot.  If more than this arbitrary number of
9675 instructions are searched, the time savings from filling the delay slot
9676 are minimal, so stop searching.  Increasing values mean more
9677 aggressive optimization, making the compilation time increase with probably
9678 small improvement in execution time.
9680 @item max-delay-slot-live-search
9681 When trying to fill delay slots, the maximum number of instructions to
9682 consider when searching for a block with valid live register
9683 information.  Increasing this arbitrarily chosen value means more
9684 aggressive optimization, increasing the compilation time.  This parameter
9685 should be removed when the delay slot code is rewritten to maintain the
9686 control-flow graph.
9688 @item max-gcse-memory
9689 The approximate maximum amount of memory that can be allocated in
9690 order to perform the global common subexpression elimination
9691 optimization.  If more memory than specified is required, the
9692 optimization is not done.
9694 @item max-gcse-insertion-ratio
9695 If the ratio of expression insertions to deletions is larger than this value
9696 for any expression, then RTL PRE inserts or removes the expression and thus
9697 leaves partially redundant computations in the instruction stream.  The default value is 20.
9699 @item max-pending-list-length
9700 The maximum number of pending dependencies scheduling allows
9701 before flushing the current state and starting over.  Large functions
9702 with few branches or calls can create excessively large lists which
9703 needlessly consume memory and resources.
9705 @item max-modulo-backtrack-attempts
9706 The maximum number of backtrack attempts the scheduler should make
9707 when modulo scheduling a loop.  Larger values can exponentially increase
9708 compilation time.
9710 @item max-inline-insns-single
9711 Several parameters control the tree inliner used in GCC@.
9712 This number sets the maximum number of instructions (counted in GCC's
9713 internal representation) in a single function that the tree inliner
9714 considers for inlining.  This only affects functions declared
9715 inline and methods implemented in a class declaration (C++).
9716 The default value is 400.
9718 @item max-inline-insns-auto
9719 When you use @option{-finline-functions} (included in @option{-O3}),
9720 a lot of functions that would otherwise not be considered for inlining
9721 by the compiler are investigated.  To those functions, a different
9722 (more restrictive) limit compared to functions declared inline can
9723 be applied.
9724 The default value is 40.
9726 @item inline-min-speedup
9727 When estimated performance improvement of caller + callee runtime exceeds this
9728 threshold (in percent), the function can be inlined regardless of the limit on
9729 @option{--param max-inline-insns-single} and @option{--param
9730 max-inline-insns-auto}.
9732 @item large-function-insns
9733 The limit specifying really large functions.  For functions larger than this
9734 limit after inlining, inlining is constrained by
9735 @option{--param large-function-growth}.  This parameter is useful primarily
9736 to avoid extreme compilation time caused by non-linear algorithms used by the
9737 back end.
9738 The default value is 2700.
9740 @item large-function-growth
9741 Specifies maximal growth of large function caused by inlining in percents.
9742 The default value is 100 which limits large function growth to 2.0 times
9743 the original size.
9745 @item large-unit-insns
9746 The limit specifying large translation unit.  Growth caused by inlining of
9747 units larger than this limit is limited by @option{--param inline-unit-growth}.
9748 For small units this might be too tight.
9749 For example, consider a unit consisting of function A
9750 that is inline and B that just calls A three times.  If B is small relative to
9751 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9752 large units consisting of small inlineable functions, however, the overall unit
9753 growth limit is needed to avoid exponential explosion of code size.  Thus for
9754 smaller units, the size is increased to @option{--param large-unit-insns}
9755 before applying @option{--param inline-unit-growth}.  The default is 10000.
9757 @item inline-unit-growth
9758 Specifies maximal overall growth of the compilation unit caused by inlining.
9759 The default value is 20 which limits unit growth to 1.2 times the original
9760 size. Cold functions (either marked cold via an attribute or by profile
9761 feedback) are not accounted into the unit size.
9763 @item ipcp-unit-growth
9764 Specifies maximal overall growth of the compilation unit caused by
9765 interprocedural constant propagation.  The default value is 10 which limits
9766 unit growth to 1.1 times the original size.
9768 @item large-stack-frame
9769 The limit specifying large stack frames.  While inlining the algorithm is trying
9770 to not grow past this limit too much.  The default value is 256 bytes.
9772 @item large-stack-frame-growth
9773 Specifies maximal growth of large stack frames caused by inlining in percents.
9774 The default value is 1000 which limits large stack frame growth to 11 times
9775 the original size.
9777 @item max-inline-insns-recursive
9778 @itemx max-inline-insns-recursive-auto
9779 Specifies the maximum number of instructions an out-of-line copy of a
9780 self-recursive inline
9781 function can grow into by performing recursive inlining.
9783 @option{--param max-inline-insns-recursive} applies to functions
9784 declared inline.
9785 For functions not declared inline, recursive inlining
9786 happens only when @option{-finline-functions} (included in @option{-O3}) is
9787 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9788 default value is 450.
9790 @item max-inline-recursive-depth
9791 @itemx max-inline-recursive-depth-auto
9792 Specifies the maximum recursion depth used for recursive inlining.
9794 @option{--param max-inline-recursive-depth} applies to functions
9795 declared inline.  For functions not declared inline, recursive inlining
9796 happens only when @option{-finline-functions} (included in @option{-O3}) is
9797 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9798 default value is 8.
9800 @item min-inline-recursive-probability
9801 Recursive inlining is profitable only for function having deep recursion
9802 in average and can hurt for function having little recursion depth by
9803 increasing the prologue size or complexity of function body to other
9804 optimizers.
9806 When profile feedback is available (see @option{-fprofile-generate}) the actual
9807 recursion depth can be guessed from the probability that function recurses
9808 via a given call expression.  This parameter limits inlining only to call
9809 expressions whose probability exceeds the given threshold (in percents).
9810 The default value is 10.
9812 @item early-inlining-insns
9813 Specify growth that the early inliner can make.  In effect it increases
9814 the amount of inlining for code having a large abstraction penalty.
9815 The default value is 14.
9817 @item max-early-inliner-iterations
9818 Limit of iterations of the early inliner.  This basically bounds
9819 the number of nested indirect calls the early inliner can resolve.
9820 Deeper chains are still handled by late inlining.
9822 @item comdat-sharing-probability
9823 Probability (in percent) that C++ inline function with comdat visibility
9824 are shared across multiple compilation units.  The default value is 20.
9826 @item profile-func-internal-id
9827 A parameter to control whether to use function internal id in profile
9828 database lookup. If the value is 0, the compiler uses an id that
9829 is based on function assembler name and filename, which makes old profile
9830 data more tolerant to source changes such as function reordering etc.
9831 The default value is 0.
9833 @item min-vect-loop-bound
9834 The minimum number of iterations under which loops are not vectorized
9835 when @option{-ftree-vectorize} is used.  The number of iterations after
9836 vectorization needs to be greater than the value specified by this option
9837 to allow vectorization.  The default value is 0.
9839 @item gcse-cost-distance-ratio
9840 Scaling factor in calculation of maximum distance an expression
9841 can be moved by GCSE optimizations.  This is currently supported only in the
9842 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9843 is with simple expressions, i.e., the expressions that have cost
9844 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9845 hoisting of simple expressions.  The default value is 10.
9847 @item gcse-unrestricted-cost
9848 Cost, roughly measured as the cost of a single typical machine
9849 instruction, at which GCSE optimizations do not constrain
9850 the distance an expression can travel.  This is currently
9851 supported only in the code hoisting pass.  The lesser the cost,
9852 the more aggressive code hoisting is.  Specifying 0 
9853 allows all expressions to travel unrestricted distances.
9854 The default value is 3.
9856 @item max-hoist-depth
9857 The depth of search in the dominator tree for expressions to hoist.
9858 This is used to avoid quadratic behavior in hoisting algorithm.
9859 The value of 0 does not limit on the search, but may slow down compilation
9860 of huge functions.  The default value is 30.
9862 @item max-tail-merge-comparisons
9863 The maximum amount of similar bbs to compare a bb with.  This is used to
9864 avoid quadratic behavior in tree tail merging.  The default value is 10.
9866 @item max-tail-merge-iterations
9867 The maximum amount of iterations of the pass over the function.  This is used to
9868 limit compilation time in tree tail merging.  The default value is 2.
9870 @item store-merging-allow-unaligned
9871 Allow the store merging pass to introduce unaligned stores if it is legal to
9872 do so.  The default value is 1.
9874 @item max-stores-to-merge
9875 The maximum number of stores to attempt to merge into wider stores in the store
9876 merging pass.  The minimum value is 2 and the default is 64.
9878 @item max-unrolled-insns
9879 The maximum number of instructions that a loop may have to be unrolled.
9880 If a loop is unrolled, this parameter also determines how many times
9881 the loop code is unrolled.
9883 @item max-average-unrolled-insns
9884 The maximum number of instructions biased by probabilities of their execution
9885 that a loop may have to be unrolled.  If a loop is unrolled,
9886 this parameter also determines how many times the loop code is unrolled.
9888 @item max-unroll-times
9889 The maximum number of unrollings of a single loop.
9891 @item max-peeled-insns
9892 The maximum number of instructions that a loop may have to be peeled.
9893 If a loop is peeled, this parameter also determines how many times
9894 the loop code is peeled.
9896 @item max-peel-times
9897 The maximum number of peelings of a single loop.
9899 @item max-peel-branches
9900 The maximum number of branches on the hot path through the peeled sequence.
9902 @item max-completely-peeled-insns
9903 The maximum number of insns of a completely peeled loop.
9905 @item max-completely-peel-times
9906 The maximum number of iterations of a loop to be suitable for complete peeling.
9908 @item max-completely-peel-loop-nest-depth
9909 The maximum depth of a loop nest suitable for complete peeling.
9911 @item max-unswitch-insns
9912 The maximum number of insns of an unswitched loop.
9914 @item max-unswitch-level
9915 The maximum number of branches unswitched in a single loop.
9917 @item max-loop-headers-insns
9918 The maximum number of insns in loop header duplicated by the copy loop headers
9919 pass.
9921 @item lim-expensive
9922 The minimum cost of an expensive expression in the loop invariant motion.
9924 @item iv-consider-all-candidates-bound
9925 Bound on number of candidates for induction variables, below which
9926 all candidates are considered for each use in induction variable
9927 optimizations.  If there are more candidates than this,
9928 only the most relevant ones are considered to avoid quadratic time complexity.
9930 @item iv-max-considered-uses
9931 The induction variable optimizations give up on loops that contain more
9932 induction variable uses.
9934 @item iv-always-prune-cand-set-bound
9935 If the number of candidates in the set is smaller than this value,
9936 always try to remove unnecessary ivs from the set
9937 when adding a new one.
9939 @item avg-loop-niter
9940 Average number of iterations of a loop.
9942 @item dse-max-object-size
9943 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
9944 Larger values may result in larger compilation times.
9946 @item scev-max-expr-size
9947 Bound on size of expressions used in the scalar evolutions analyzer.
9948 Large expressions slow the analyzer.
9950 @item scev-max-expr-complexity
9951 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9952 Complex expressions slow the analyzer.
9954 @item max-tree-if-conversion-phi-args
9955 Maximum number of arguments in a PHI supported by TREE if conversion
9956 unless the loop is marked with simd pragma.
9958 @item vect-max-version-for-alignment-checks
9959 The maximum number of run-time checks that can be performed when
9960 doing loop versioning for alignment in the vectorizer.
9962 @item vect-max-version-for-alias-checks
9963 The maximum number of run-time checks that can be performed when
9964 doing loop versioning for alias in the vectorizer.
9966 @item vect-max-peeling-for-alignment
9967 The maximum number of loop peels to enhance access alignment
9968 for vectorizer. Value -1 means no limit.
9970 @item max-iterations-to-track
9971 The maximum number of iterations of a loop the brute-force algorithm
9972 for analysis of the number of iterations of the loop tries to evaluate.
9974 @item hot-bb-count-ws-permille
9975 A basic block profile count is considered hot if it contributes to 
9976 the given permillage (i.e. 0...1000) of the entire profiled execution.
9978 @item hot-bb-frequency-fraction
9979 Select fraction of the entry block frequency of executions of basic block in
9980 function given basic block needs to have to be considered hot.
9982 @item max-predicted-iterations
9983 The maximum number of loop iterations we predict statically.  This is useful
9984 in cases where a function contains a single loop with known bound and
9985 another loop with unknown bound.
9986 The known number of iterations is predicted correctly, while
9987 the unknown number of iterations average to roughly 10.  This means that the
9988 loop without bounds appears artificially cold relative to the other one.
9990 @item builtin-expect-probability
9991 Control the probability of the expression having the specified value. This
9992 parameter takes a percentage (i.e. 0 ... 100) as input.
9993 The default probability of 90 is obtained empirically.
9995 @item align-threshold
9997 Select fraction of the maximal frequency of executions of a basic block in
9998 a function to align the basic block.
10000 @item align-loop-iterations
10002 A loop expected to iterate at least the selected number of iterations is
10003 aligned.
10005 @item tracer-dynamic-coverage
10006 @itemx tracer-dynamic-coverage-feedback
10008 This value is used to limit superblock formation once the given percentage of
10009 executed instructions is covered.  This limits unnecessary code size
10010 expansion.
10012 The @option{tracer-dynamic-coverage-feedback} parameter
10013 is used only when profile
10014 feedback is available.  The real profiles (as opposed to statically estimated
10015 ones) are much less balanced allowing the threshold to be larger value.
10017 @item tracer-max-code-growth
10018 Stop tail duplication once code growth has reached given percentage.  This is
10019 a rather artificial limit, as most of the duplicates are eliminated later in
10020 cross jumping, so it may be set to much higher values than is the desired code
10021 growth.
10023 @item tracer-min-branch-ratio
10025 Stop reverse growth when the reverse probability of best edge is less than this
10026 threshold (in percent).
10028 @item tracer-min-branch-probability
10029 @itemx tracer-min-branch-probability-feedback
10031 Stop forward growth if the best edge has probability lower than this
10032 threshold.
10034 Similarly to @option{tracer-dynamic-coverage} two parameters are
10035 provided.  @option{tracer-min-branch-probability-feedback} is used for
10036 compilation with profile feedback and @option{tracer-min-branch-probability}
10037 compilation without.  The value for compilation with profile feedback
10038 needs to be more conservative (higher) in order to make tracer
10039 effective.
10041 @item max-cse-path-length
10043 The maximum number of basic blocks on path that CSE considers.
10044 The default is 10.
10046 @item max-cse-insns
10047 The maximum number of instructions CSE processes before flushing.
10048 The default is 1000.
10050 @item ggc-min-expand
10052 GCC uses a garbage collector to manage its own memory allocation.  This
10053 parameter specifies the minimum percentage by which the garbage
10054 collector's heap should be allowed to expand between collections.
10055 Tuning this may improve compilation speed; it has no effect on code
10056 generation.
10058 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10059 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10060 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10061 GCC is not able to calculate RAM on a particular platform, the lower
10062 bound of 30% is used.  Setting this parameter and
10063 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10064 every opportunity.  This is extremely slow, but can be useful for
10065 debugging.
10067 @item ggc-min-heapsize
10069 Minimum size of the garbage collector's heap before it begins bothering
10070 to collect garbage.  The first collection occurs after the heap expands
10071 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10072 tuning this may improve compilation speed, and has no effect on code
10073 generation.
10075 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10076 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10077 with a lower bound of 4096 (four megabytes) and an upper bound of
10078 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10079 particular platform, the lower bound is used.  Setting this parameter
10080 very large effectively disables garbage collection.  Setting this
10081 parameter and @option{ggc-min-expand} to zero causes a full collection
10082 to occur at every opportunity.
10084 @item max-reload-search-insns
10085 The maximum number of instruction reload should look backward for equivalent
10086 register.  Increasing values mean more aggressive optimization, making the
10087 compilation time increase with probably slightly better performance.
10088 The default value is 100.
10090 @item max-cselib-memory-locations
10091 The maximum number of memory locations cselib should take into account.
10092 Increasing values mean more aggressive optimization, making the compilation time
10093 increase with probably slightly better performance.  The default value is 500.
10095 @item max-sched-ready-insns
10096 The maximum number of instructions ready to be issued the scheduler should
10097 consider at any given time during the first scheduling pass.  Increasing
10098 values mean more thorough searches, making the compilation time increase
10099 with probably little benefit.  The default value is 100.
10101 @item max-sched-region-blocks
10102 The maximum number of blocks in a region to be considered for
10103 interblock scheduling.  The default value is 10.
10105 @item max-pipeline-region-blocks
10106 The maximum number of blocks in a region to be considered for
10107 pipelining in the selective scheduler.  The default value is 15.
10109 @item max-sched-region-insns
10110 The maximum number of insns in a region to be considered for
10111 interblock scheduling.  The default value is 100.
10113 @item max-pipeline-region-insns
10114 The maximum number of insns in a region to be considered for
10115 pipelining in the selective scheduler.  The default value is 200.
10117 @item min-spec-prob
10118 The minimum probability (in percents) of reaching a source block
10119 for interblock speculative scheduling.  The default value is 40.
10121 @item max-sched-extend-regions-iters
10122 The maximum number of iterations through CFG to extend regions.
10123 A value of 0 (the default) disables region extensions.
10125 @item max-sched-insn-conflict-delay
10126 The maximum conflict delay for an insn to be considered for speculative motion.
10127 The default value is 3.
10129 @item sched-spec-prob-cutoff
10130 The minimal probability of speculation success (in percents), so that
10131 speculative insns are scheduled.
10132 The default value is 40.
10134 @item sched-state-edge-prob-cutoff
10135 The minimum probability an edge must have for the scheduler to save its
10136 state across it.
10137 The default value is 10.
10139 @item sched-mem-true-dep-cost
10140 Minimal distance (in CPU cycles) between store and load targeting same
10141 memory locations.  The default value is 1.
10143 @item selsched-max-lookahead
10144 The maximum size of the lookahead window of selective scheduling.  It is a
10145 depth of search for available instructions.
10146 The default value is 50.
10148 @item selsched-max-sched-times
10149 The maximum number of times that an instruction is scheduled during
10150 selective scheduling.  This is the limit on the number of iterations
10151 through which the instruction may be pipelined.  The default value is 2.
10153 @item selsched-insns-to-rename
10154 The maximum number of best instructions in the ready list that are considered
10155 for renaming in the selective scheduler.  The default value is 2.
10157 @item sms-min-sc
10158 The minimum value of stage count that swing modulo scheduler
10159 generates.  The default value is 2.
10161 @item max-last-value-rtl
10162 The maximum size measured as number of RTLs that can be recorded in an expression
10163 in combiner for a pseudo register as last known value of that register.  The default
10164 is 10000.
10166 @item max-combine-insns
10167 The maximum number of instructions the RTL combiner tries to combine.
10168 The default value is 2 at @option{-Og} and 4 otherwise.
10170 @item integer-share-limit
10171 Small integer constants can use a shared data structure, reducing the
10172 compiler's memory usage and increasing its speed.  This sets the maximum
10173 value of a shared integer constant.  The default value is 256.
10175 @item ssp-buffer-size
10176 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10177 protection when @option{-fstack-protection} is used.
10179 @item min-size-for-stack-sharing
10180 The minimum size of variables taking part in stack slot sharing when not
10181 optimizing. The default value is 32.
10183 @item max-jump-thread-duplication-stmts
10184 Maximum number of statements allowed in a block that needs to be
10185 duplicated when threading jumps.
10187 @item max-fields-for-field-sensitive
10188 Maximum number of fields in a structure treated in
10189 a field sensitive manner during pointer analysis.  The default is zero
10190 for @option{-O0} and @option{-O1},
10191 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10193 @item prefetch-latency
10194 Estimate on average number of instructions that are executed before
10195 prefetch finishes.  The distance prefetched ahead is proportional
10196 to this constant.  Increasing this number may also lead to less
10197 streams being prefetched (see @option{simultaneous-prefetches}).
10199 @item simultaneous-prefetches
10200 Maximum number of prefetches that can run at the same time.
10202 @item l1-cache-line-size
10203 The size of cache line in L1 cache, in bytes.
10205 @item l1-cache-size
10206 The size of L1 cache, in kilobytes.
10208 @item l2-cache-size
10209 The size of L2 cache, in kilobytes.
10211 @item min-insn-to-prefetch-ratio
10212 The minimum ratio between the number of instructions and the
10213 number of prefetches to enable prefetching in a loop.
10215 @item prefetch-min-insn-to-mem-ratio
10216 The minimum ratio between the number of instructions and the
10217 number of memory references to enable prefetching in a loop.
10219 @item use-canonical-types
10220 Whether the compiler should use the ``canonical'' type system.  By
10221 default, this should always be 1, which uses a more efficient internal
10222 mechanism for comparing types in C++ and Objective-C++.  However, if
10223 bugs in the canonical type system are causing compilation failures,
10224 set this value to 0 to disable canonical types.
10226 @item switch-conversion-max-branch-ratio
10227 Switch initialization conversion refuses to create arrays that are
10228 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10229 branches in the switch.
10231 @item max-partial-antic-length
10232 Maximum length of the partial antic set computed during the tree
10233 partial redundancy elimination optimization (@option{-ftree-pre}) when
10234 optimizing at @option{-O3} and above.  For some sorts of source code
10235 the enhanced partial redundancy elimination optimization can run away,
10236 consuming all of the memory available on the host machine.  This
10237 parameter sets a limit on the length of the sets that are computed,
10238 which prevents the runaway behavior.  Setting a value of 0 for
10239 this parameter allows an unlimited set length.
10241 @item sccvn-max-scc-size
10242 Maximum size of a strongly connected component (SCC) during SCCVN
10243 processing.  If this limit is hit, SCCVN processing for the whole
10244 function is not done and optimizations depending on it are
10245 disabled.  The default maximum SCC size is 10000.
10247 @item sccvn-max-alias-queries-per-access
10248 Maximum number of alias-oracle queries we perform when looking for
10249 redundancies for loads and stores.  If this limit is hit the search
10250 is aborted and the load or store is not considered redundant.  The
10251 number of queries is algorithmically limited to the number of
10252 stores on all paths from the load to the function entry.
10253 The default maximum number of queries is 1000.
10255 @item ira-max-loops-num
10256 IRA uses regional register allocation by default.  If a function
10257 contains more loops than the number given by this parameter, only at most
10258 the given number of the most frequently-executed loops form regions
10259 for regional register allocation.  The default value of the
10260 parameter is 100.
10262 @item ira-max-conflict-table-size 
10263 Although IRA uses a sophisticated algorithm to compress the conflict
10264 table, the table can still require excessive amounts of memory for
10265 huge functions.  If the conflict table for a function could be more
10266 than the size in MB given by this parameter, the register allocator
10267 instead uses a faster, simpler, and lower-quality
10268 algorithm that does not require building a pseudo-register conflict table.  
10269 The default value of the parameter is 2000.
10271 @item ira-loop-reserved-regs
10272 IRA can be used to evaluate more accurate register pressure in loops
10273 for decisions to move loop invariants (see @option{-O3}).  The number
10274 of available registers reserved for some other purposes is given
10275 by this parameter.  The default value of the parameter is 2, which is
10276 the minimal number of registers needed by typical instructions.
10277 This value is the best found from numerous experiments.
10279 @item lra-inheritance-ebb-probability-cutoff
10280 LRA tries to reuse values reloaded in registers in subsequent insns.
10281 This optimization is called inheritance.  EBB is used as a region to
10282 do this optimization.  The parameter defines a minimal fall-through
10283 edge probability in percentage used to add BB to inheritance EBB in
10284 LRA.  The default value of the parameter is 40.  The value was chosen
10285 from numerous runs of SPEC2000 on x86-64.
10287 @item loop-invariant-max-bbs-in-loop
10288 Loop invariant motion can be very expensive, both in compilation time and
10289 in amount of needed compile-time memory, with very large loops.  Loops
10290 with more basic blocks than this parameter won't have loop invariant
10291 motion optimization performed on them.  The default value of the
10292 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10294 @item loop-max-datarefs-for-datadeps
10295 Building data dependencies is expensive for very large loops.  This
10296 parameter limits the number of data references in loops that are
10297 considered for data dependence analysis.  These large loops are no
10298 handled by the optimizations using loop data dependencies.
10299 The default value is 1000.
10301 @item max-vartrack-size
10302 Sets a maximum number of hash table slots to use during variable
10303 tracking dataflow analysis of any function.  If this limit is exceeded
10304 with variable tracking at assignments enabled, analysis for that
10305 function is retried without it, after removing all debug insns from
10306 the function.  If the limit is exceeded even without debug insns, var
10307 tracking analysis is completely disabled for the function.  Setting
10308 the parameter to zero makes it unlimited.
10310 @item max-vartrack-expr-depth
10311 Sets a maximum number of recursion levels when attempting to map
10312 variable names or debug temporaries to value expressions.  This trades
10313 compilation time for more complete debug information.  If this is set too
10314 low, value expressions that are available and could be represented in
10315 debug information may end up not being used; setting this higher may
10316 enable the compiler to find more complex debug expressions, but compile
10317 time and memory use may grow.  The default is 12.
10319 @item min-nondebug-insn-uid
10320 Use uids starting at this parameter for nondebug insns.  The range below
10321 the parameter is reserved exclusively for debug insns created by
10322 @option{-fvar-tracking-assignments}, but debug insns may get
10323 (non-overlapping) uids above it if the reserved range is exhausted.
10325 @item ipa-sra-ptr-growth-factor
10326 IPA-SRA replaces a pointer to an aggregate with one or more new
10327 parameters only when their cumulative size is less or equal to
10328 @option{ipa-sra-ptr-growth-factor} times the size of the original
10329 pointer parameter.
10331 @item sra-max-scalarization-size-Ospeed
10332 @item sra-max-scalarization-size-Osize
10333 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10334 replace scalar parts of aggregates with uses of independent scalar
10335 variables.  These parameters control the maximum size, in storage units,
10336 of aggregate which is considered for replacement when compiling for
10337 speed
10338 (@option{sra-max-scalarization-size-Ospeed}) or size
10339 (@option{sra-max-scalarization-size-Osize}) respectively.
10341 @item tm-max-aggregate-size
10342 When making copies of thread-local variables in a transaction, this
10343 parameter specifies the size in bytes after which variables are
10344 saved with the logging functions as opposed to save/restore code
10345 sequence pairs.  This option only applies when using
10346 @option{-fgnu-tm}.
10348 @item graphite-max-nb-scop-params
10349 To avoid exponential effects in the Graphite loop transforms, the
10350 number of parameters in a Static Control Part (SCoP) is bounded.  The
10351 default value is 10 parameters.  A variable whose value is unknown at
10352 compilation time and defined outside a SCoP is a parameter of the SCoP.
10354 @item graphite-max-bbs-per-function
10355 To avoid exponential effects in the detection of SCoPs, the size of
10356 the functions analyzed by Graphite is bounded.  The default value is
10357 100 basic blocks.
10359 @item loop-block-tile-size
10360 Loop blocking or strip mining transforms, enabled with
10361 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10362 loop in the loop nest by a given number of iterations.  The strip
10363 length can be changed using the @option{loop-block-tile-size}
10364 parameter.  The default value is 51 iterations.
10366 @item loop-unroll-jam-size
10367 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10368 default value is 4.
10370 @item loop-unroll-jam-depth
10371 Specify the dimension to be unrolled (counting from the most inner loop)
10372 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10374 @item ipa-cp-value-list-size
10375 IPA-CP attempts to track all possible values and types passed to a function's
10376 parameter in order to propagate them and perform devirtualization.
10377 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10378 stores per one formal parameter of a function.
10380 @item ipa-cp-eval-threshold
10381 IPA-CP calculates its own score of cloning profitability heuristics
10382 and performs those cloning opportunities with scores that exceed
10383 @option{ipa-cp-eval-threshold}.
10385 @item ipa-cp-recursion-penalty
10386 Percentage penalty the recursive functions will receive when they
10387 are evaluated for cloning.
10389 @item ipa-cp-single-call-penalty
10390 Percentage penalty functions containing a single call to another
10391 function will receive when they are evaluated for cloning.
10394 @item ipa-max-agg-items
10395 IPA-CP is also capable to propagate a number of scalar values passed
10396 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10397 number of such values per one parameter.
10399 @item ipa-cp-loop-hint-bonus
10400 When IPA-CP determines that a cloning candidate would make the number
10401 of iterations of a loop known, it adds a bonus of
10402 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10403 the candidate.
10405 @item ipa-cp-array-index-hint-bonus
10406 When IPA-CP determines that a cloning candidate would make the index of
10407 an array access known, it adds a bonus of
10408 @option{ipa-cp-array-index-hint-bonus} to the profitability
10409 score of the candidate.
10411 @item ipa-max-aa-steps
10412 During its analysis of function bodies, IPA-CP employs alias analysis
10413 in order to track values pointed to by function parameters.  In order
10414 not spend too much time analyzing huge functions, it gives up and
10415 consider all memory clobbered after examining
10416 @option{ipa-max-aa-steps} statements modifying memory.
10418 @item lto-partitions
10419 Specify desired number of partitions produced during WHOPR compilation.
10420 The number of partitions should exceed the number of CPUs used for compilation.
10421 The default value is 32.
10423 @item lto-min-partition
10424 Size of minimal partition for WHOPR (in estimated instructions).
10425 This prevents expenses of splitting very small programs into too many
10426 partitions.
10428 @item lto-max-partition
10429 Size of max partition for WHOPR (in estimated instructions).
10430 to provide an upper bound for individual size of partition.
10431 Meant to be used only with balanced partitioning.
10433 @item cxx-max-namespaces-for-diagnostic-help
10434 The maximum number of namespaces to consult for suggestions when C++
10435 name lookup fails for an identifier.  The default is 1000.
10437 @item sink-frequency-threshold
10438 The maximum relative execution frequency (in percents) of the target block
10439 relative to a statement's original block to allow statement sinking of a
10440 statement.  Larger numbers result in more aggressive statement sinking.
10441 The default value is 75.  A small positive adjustment is applied for
10442 statements with memory operands as those are even more profitable so sink.
10444 @item max-stores-to-sink
10445 The maximum number of conditional store pairs that can be sunk.  Set to 0
10446 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10447 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10449 @item allow-store-data-races
10450 Allow optimizers to introduce new data races on stores.
10451 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10452 at optimization level @option{-Ofast}.
10454 @item case-values-threshold
10455 The smallest number of different values for which it is best to use a
10456 jump-table instead of a tree of conditional branches.  If the value is
10457 0, use the default for the machine.  The default is 0.
10459 @item tree-reassoc-width
10460 Set the maximum number of instructions executed in parallel in
10461 reassociated tree. This parameter overrides target dependent
10462 heuristics used by default if has non zero value.
10464 @item sched-pressure-algorithm
10465 Choose between the two available implementations of
10466 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10467 and is the more likely to prevent instructions from being reordered.
10468 Algorithm 2 was designed to be a compromise between the relatively
10469 conservative approach taken by algorithm 1 and the rather aggressive
10470 approach taken by the default scheduler.  It relies more heavily on
10471 having a regular register file and accurate register pressure classes.
10472 See @file{haifa-sched.c} in the GCC sources for more details.
10474 The default choice depends on the target.
10476 @item max-slsr-cand-scan
10477 Set the maximum number of existing candidates that are considered when
10478 seeking a basis for a new straight-line strength reduction candidate.
10480 @item asan-globals
10481 Enable buffer overflow detection for global objects.  This kind
10482 of protection is enabled by default if you are using
10483 @option{-fsanitize=address} option.
10484 To disable global objects protection use @option{--param asan-globals=0}.
10486 @item asan-stack
10487 Enable buffer overflow detection for stack objects.  This kind of
10488 protection is enabled by default when using @option{-fsanitize=address}.
10489 To disable stack protection use @option{--param asan-stack=0} option.
10491 @item asan-instrument-reads
10492 Enable buffer overflow detection for memory reads.  This kind of
10493 protection is enabled by default when using @option{-fsanitize=address}.
10494 To disable memory reads protection use
10495 @option{--param asan-instrument-reads=0}.
10497 @item asan-instrument-writes
10498 Enable buffer overflow detection for memory writes.  This kind of
10499 protection is enabled by default when using @option{-fsanitize=address}.
10500 To disable memory writes protection use
10501 @option{--param asan-instrument-writes=0} option.
10503 @item asan-memintrin
10504 Enable detection for built-in functions.  This kind of protection
10505 is enabled by default when using @option{-fsanitize=address}.
10506 To disable built-in functions protection use
10507 @option{--param asan-memintrin=0}.
10509 @item asan-use-after-return
10510 Enable detection of use-after-return.  This kind of protection
10511 is enabled by default when using the @option{-fsanitize=address} option.
10512 To disable it use @option{--param asan-use-after-return=0}.
10514 Note: By default the check is disabled at run time.  To enable it,
10515 add @code{detect_stack_use_after_return=1} to the environment variable
10516 @env{ASAN_OPTIONS}.
10518 @item asan-instrumentation-with-call-threshold
10519 If number of memory accesses in function being instrumented
10520 is greater or equal to this number, use callbacks instead of inline checks.
10521 E.g. to disable inline code use
10522 @option{--param asan-instrumentation-with-call-threshold=0}.
10524 @item use-after-scope-direct-emission-threshold
10525 If the size of a local variable in bytes is smaller or equal to this
10526 number, directly poison (or unpoison) shadow memory instead of using
10527 run-time callbacks.  The default value is 256.
10529 @item chkp-max-ctor-size
10530 Static constructors generated by Pointer Bounds Checker may become very
10531 large and significantly increase compile time at optimization level
10532 @option{-O1} and higher.  This parameter is a maximum number of statements
10533 in a single generated constructor.  Default value is 5000.
10535 @item max-fsm-thread-path-insns
10536 Maximum number of instructions to copy when duplicating blocks on a
10537 finite state automaton jump thread path.  The default is 100.
10539 @item max-fsm-thread-length
10540 Maximum number of basic blocks on a finite state automaton jump thread
10541 path.  The default is 10.
10543 @item max-fsm-thread-paths
10544 Maximum number of new jump thread paths to create for a finite state
10545 automaton.  The default is 50.
10547 @item parloops-chunk-size
10548 Chunk size of omp schedule for loops parallelized by parloops.  The default
10549 is 0.
10551 @item parloops-schedule
10552 Schedule type of omp schedule for loops parallelized by parloops (static,
10553 dynamic, guided, auto, runtime).  The default is static.
10555 @item max-ssa-name-query-depth
10556 Maximum depth of recursion when querying properties of SSA names in things
10557 like fold routines.  One level of recursion corresponds to following a
10558 use-def chain.
10560 @item hsa-gen-debug-stores
10561 Enable emission of special debug stores within HSA kernels which are
10562 then read and reported by libgomp plugin.  Generation of these stores
10563 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10564 enable it.
10566 @item max-speculative-devirt-maydefs
10567 The maximum number of may-defs we analyze when looking for a must-def
10568 specifying the dynamic type of an object that invokes a virtual call
10569 we may be able to devirtualize speculatively.
10571 @item max-vrp-switch-assertions
10572 The maximum number of assertions to add along the default edge of a switch
10573 statement during VRP.  The default is 10.
10574 @end table
10575 @end table
10577 @node Instrumentation Options
10578 @section Program Instrumentation Options
10579 @cindex instrumentation options
10580 @cindex program instrumentation options
10581 @cindex run-time error checking options
10582 @cindex profiling options
10583 @cindex options, program instrumentation
10584 @cindex options, run-time error checking
10585 @cindex options, profiling
10587 GCC supports a number of command-line options that control adding
10588 run-time instrumentation to the code it normally generates.  
10589 For example, one purpose of instrumentation is collect profiling
10590 statistics for use in finding program hot spots, code coverage
10591 analysis, or profile-guided optimizations.
10592 Another class of program instrumentation is adding run-time checking 
10593 to detect programming errors like invalid pointer
10594 dereferences or out-of-bounds array accesses, as well as deliberately
10595 hostile attacks such as stack smashing or C++ vtable hijacking.
10596 There is also a general hook which can be used to implement other
10597 forms of tracing or function-level instrumentation for debug or
10598 program analysis purposes.
10600 @table @gcctabopt
10601 @cindex @command{prof}
10602 @item -p
10603 @opindex p
10604 Generate extra code to write profile information suitable for the
10605 analysis program @command{prof}.  You must use this option when compiling
10606 the source files you want data about, and you must also use it when
10607 linking.
10609 @cindex @command{gprof}
10610 @item -pg
10611 @opindex pg
10612 Generate extra code to write profile information suitable for the
10613 analysis program @command{gprof}.  You must use this option when compiling
10614 the source files you want data about, and you must also use it when
10615 linking.
10617 @item -fprofile-arcs
10618 @opindex fprofile-arcs
10619 Add code so that program flow @dfn{arcs} are instrumented.  During
10620 execution the program records how many times each branch and call is
10621 executed and how many times it is taken or returns.  On targets that support
10622 constructors with priority support, profiling properly handles constructors,
10623 destructors and C++ constructors (and destructors) of classes which are used
10624 as a type of a global variable.
10626 When the compiled
10627 program exits it saves this data to a file called
10628 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10629 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10630 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10631 @var{auxname} is generated from the name of the output file, if
10632 explicitly specified and it is not the final executable, otherwise it is
10633 the basename of the source file.  In both cases any suffix is removed
10634 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10635 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10636 @xref{Cross-profiling}.
10638 @cindex @command{gcov}
10639 @item --coverage
10640 @opindex coverage
10642 This option is used to compile and link code instrumented for coverage
10643 analysis.  The option is a synonym for @option{-fprofile-arcs}
10644 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10645 linking).  See the documentation for those options for more details.
10647 @itemize
10649 @item
10650 Compile the source files with @option{-fprofile-arcs} plus optimization
10651 and code generation options.  For test coverage analysis, use the
10652 additional @option{-ftest-coverage} option.  You do not need to profile
10653 every source file in a program.
10655 @item
10656 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10657 (the latter implies the former).
10659 @item
10660 Run the program on a representative workload to generate the arc profile
10661 information.  This may be repeated any number of times.  You can run
10662 concurrent instances of your program, and provided that the file system
10663 supports locking, the data files will be correctly updated.  Also
10664 @code{fork} calls are detected and correctly handled (double counting
10665 will not happen).
10667 @item
10668 For profile-directed optimizations, compile the source files again with
10669 the same optimization and code generation options plus
10670 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10671 Control Optimization}).
10673 @item
10674 For test coverage analysis, use @command{gcov} to produce human readable
10675 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10676 @command{gcov} documentation for further information.
10678 @end itemize
10680 With @option{-fprofile-arcs}, for each function of your program GCC
10681 creates a program flow graph, then finds a spanning tree for the graph.
10682 Only arcs that are not on the spanning tree have to be instrumented: the
10683 compiler adds code to count the number of times that these arcs are
10684 executed.  When an arc is the only exit or only entrance to a block, the
10685 instrumentation code can be added to the block; otherwise, a new basic
10686 block must be created to hold the instrumentation code.
10688 @need 2000
10689 @item -ftest-coverage
10690 @opindex ftest-coverage
10691 Produce a notes file that the @command{gcov} code-coverage utility
10692 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10693 show program coverage.  Each source file's note file is called
10694 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10695 above for a description of @var{auxname} and instructions on how to
10696 generate test coverage data.  Coverage data matches the source files
10697 more closely if you do not optimize.
10699 @item -fprofile-dir=@var{path}
10700 @opindex fprofile-dir
10702 Set the directory to search for the profile data files in to @var{path}.
10703 This option affects only the profile data generated by
10704 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10705 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10706 and its related options.  Both absolute and relative paths can be used.
10707 By default, GCC uses the current directory as @var{path}, thus the
10708 profile data file appears in the same directory as the object file.
10710 @item -fprofile-generate
10711 @itemx -fprofile-generate=@var{path}
10712 @opindex fprofile-generate
10714 Enable options usually used for instrumenting application to produce
10715 profile useful for later recompilation with profile feedback based
10716 optimization.  You must use @option{-fprofile-generate} both when
10717 compiling and when linking your program.
10719 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10721 If @var{path} is specified, GCC looks at the @var{path} to find
10722 the profile feedback data files. See @option{-fprofile-dir}.
10724 To optimize the program based on the collected profile information, use
10725 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10727 @item -fprofile-update=@var{method}
10728 @opindex fprofile-update
10730 Alter the update method for an application instrumented for profile
10731 feedback based optimization.  The @var{method} argument should be one of
10732 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10733 The first one is useful for single-threaded applications,
10734 while the second one prevents profile corruption by emitting thread-safe code.
10736 @strong{Warning:} When an application does not properly join all threads
10737 (or creates an detached thread), a profile file can be still corrupted.
10739 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10740 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10741 automatically selects @samp{prefer-atomic} when @option{-pthread}
10742 is present in the command line.
10744 @item -fsanitize=address
10745 @opindex fsanitize=address
10746 Enable AddressSanitizer, a fast memory error detector.
10747 Memory access instructions are instrumented to detect
10748 out-of-bounds and use-after-free bugs.
10749 The option enables @option{-fsanitize-address-use-after-scope}.
10750 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10751 more details.  The run-time behavior can be influenced using the
10752 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10753 the available options are shown at startup of the instrumented program.  See
10754 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10755 for a list of supported options.
10756 The option cannot be combined with @option{-fsanitize=thread}
10757 and/or @option{-fcheck-pointer-bounds}.
10759 @item -fsanitize=kernel-address
10760 @opindex fsanitize=kernel-address
10761 Enable AddressSanitizer for Linux kernel.
10762 See @uref{https://github.com/google/kasan/wiki} for more details.
10763 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10765 @item -fsanitize=thread
10766 @opindex fsanitize=thread
10767 Enable ThreadSanitizer, a fast data race detector.
10768 Memory access instructions are instrumented to detect
10769 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10770 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10771 environment variable; see
10772 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10773 supported options.
10774 The option cannot be combined with @option{-fsanitize=address},
10775 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10777 Note that sanitized atomic builtins cannot throw exceptions when
10778 operating on invalid memory addresses with non-call exceptions
10779 (@option{-fnon-call-exceptions}).
10781 @item -fsanitize=leak
10782 @opindex fsanitize=leak
10783 Enable LeakSanitizer, a memory leak detector.
10784 This option only matters for linking of executables and
10785 the executable is linked against a library that overrides @code{malloc}
10786 and other allocator functions.  See
10787 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10788 details.  The run-time behavior can be influenced using the
10789 @env{LSAN_OPTIONS} environment variable.
10790 The option cannot be combined with @option{-fsanitize=thread}.
10792 @item -fsanitize=undefined
10793 @opindex fsanitize=undefined
10794 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10795 Various computations are instrumented to detect undefined behavior
10796 at runtime.  Current suboptions are:
10798 @table @gcctabopt
10800 @item -fsanitize=shift
10801 @opindex fsanitize=shift
10802 This option enables checking that the result of a shift operation is
10803 not undefined.  Note that what exactly is considered undefined differs
10804 slightly between C and C++, as well as between ISO C90 and C99, etc.
10805 This option has two suboptions, @option{-fsanitize=shift-base} and
10806 @option{-fsanitize=shift-exponent}.
10808 @item -fsanitize=shift-exponent
10809 @opindex fsanitize=shift-exponent
10810 This option enables checking that the second argument of a shift operation
10811 is not negative and is smaller than the precision of the promoted first
10812 argument.
10814 @item -fsanitize=shift-base
10815 @opindex fsanitize=shift-base
10816 If the second argument of a shift operation is within range, check that the
10817 result of a shift operation is not undefined.  Note that what exactly is
10818 considered undefined differs slightly between C and C++, as well as between
10819 ISO C90 and C99, etc.
10821 @item -fsanitize=integer-divide-by-zero
10822 @opindex fsanitize=integer-divide-by-zero
10823 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10825 @item -fsanitize=unreachable
10826 @opindex fsanitize=unreachable
10827 With this option, the compiler turns the @code{__builtin_unreachable}
10828 call into a diagnostics message call instead.  When reaching the
10829 @code{__builtin_unreachable} call, the behavior is undefined.
10831 @item -fsanitize=vla-bound
10832 @opindex fsanitize=vla-bound
10833 This option instructs the compiler to check that the size of a variable
10834 length array is positive.
10836 @item -fsanitize=null
10837 @opindex fsanitize=null
10838 This option enables pointer checking.  Particularly, the application
10839 built with this option turned on will issue an error message when it
10840 tries to dereference a NULL pointer, or if a reference (possibly an
10841 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10842 on an object pointed by a NULL pointer.
10844 @item -fsanitize=return
10845 @opindex fsanitize=return
10846 This option enables return statement checking.  Programs
10847 built with this option turned on will issue an error message
10848 when the end of a non-void function is reached without actually
10849 returning a value.  This option works in C++ only.
10851 @item -fsanitize=signed-integer-overflow
10852 @opindex fsanitize=signed-integer-overflow
10853 This option enables signed integer overflow checking.  We check that
10854 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10855 does not overflow in the signed arithmetics.  Note, integer promotion
10856 rules must be taken into account.  That is, the following is not an
10857 overflow:
10858 @smallexample
10859 signed char a = SCHAR_MAX;
10860 a++;
10861 @end smallexample
10863 @item -fsanitize=bounds
10864 @opindex fsanitize=bounds
10865 This option enables instrumentation of array bounds.  Various out of bounds
10866 accesses are detected.  Flexible array members, flexible array member-like
10867 arrays, and initializers of variables with static storage are not instrumented.
10868 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10870 @item -fsanitize=bounds-strict
10871 @opindex fsanitize=bounds-strict
10872 This option enables strict instrumentation of array bounds.  Most out of bounds
10873 accesses are detected, including flexible array members and flexible array
10874 member-like arrays.  Initializers of variables with static storage are not
10875 instrumented.  The option cannot be combined
10876 with @option{-fcheck-pointer-bounds}.
10878 @item -fsanitize=alignment
10879 @opindex fsanitize=alignment
10881 This option enables checking of alignment of pointers when they are
10882 dereferenced, or when a reference is bound to insufficiently aligned target,
10883 or when a method or constructor is invoked on insufficiently aligned object.
10885 @item -fsanitize=object-size
10886 @opindex fsanitize=object-size
10887 This option enables instrumentation of memory references using the
10888 @code{__builtin_object_size} function.  Various out of bounds pointer
10889 accesses are detected.
10891 @item -fsanitize=float-divide-by-zero
10892 @opindex fsanitize=float-divide-by-zero
10893 Detect floating-point division by zero.  Unlike other similar options,
10894 @option{-fsanitize=float-divide-by-zero} is not enabled by
10895 @option{-fsanitize=undefined}, since floating-point division by zero can
10896 be a legitimate way of obtaining infinities and NaNs.
10898 @item -fsanitize=float-cast-overflow
10899 @opindex fsanitize=float-cast-overflow
10900 This option enables floating-point type to integer conversion checking.
10901 We check that the result of the conversion does not overflow.
10902 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10903 not enabled by @option{-fsanitize=undefined}.
10904 This option does not work well with @code{FE_INVALID} exceptions enabled.
10906 @item -fsanitize=nonnull-attribute
10907 @opindex fsanitize=nonnull-attribute
10909 This option enables instrumentation of calls, checking whether null values
10910 are not passed to arguments marked as requiring a non-null value by the
10911 @code{nonnull} function attribute.
10913 @item -fsanitize=returns-nonnull-attribute
10914 @opindex fsanitize=returns-nonnull-attribute
10916 This option enables instrumentation of return statements in functions
10917 marked with @code{returns_nonnull} function attribute, to detect returning
10918 of null values from such functions.
10920 @item -fsanitize=bool
10921 @opindex fsanitize=bool
10923 This option enables instrumentation of loads from bool.  If a value other
10924 than 0/1 is loaded, a run-time error is issued.
10926 @item -fsanitize=enum
10927 @opindex fsanitize=enum
10929 This option enables instrumentation of loads from an enum type.  If
10930 a value outside the range of values for the enum type is loaded,
10931 a run-time error is issued.
10933 @item -fsanitize=vptr
10934 @opindex fsanitize=vptr
10936 This option enables instrumentation of C++ member function calls, member
10937 accesses and some conversions between pointers to base and derived classes,
10938 to verify the referenced object has the correct dynamic type.
10940 @end table
10942 While @option{-ftrapv} causes traps for signed overflows to be emitted,
10943 @option{-fsanitize=undefined} gives a diagnostic message.
10944 This currently works only for the C family of languages.
10946 @item -fno-sanitize=all
10947 @opindex fno-sanitize=all
10949 This option disables all previously enabled sanitizers.
10950 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
10951 together.
10953 @item -fasan-shadow-offset=@var{number}
10954 @opindex fasan-shadow-offset
10955 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
10956 It is useful for experimenting with different shadow memory layouts in
10957 Kernel AddressSanitizer.
10959 @item -fsanitize-sections=@var{s1},@var{s2},...
10960 @opindex fsanitize-sections
10961 Sanitize global variables in selected user-defined sections.  @var{si} may
10962 contain wildcards.
10964 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
10965 @opindex fsanitize-recover
10966 @opindex fno-sanitize-recover
10967 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
10968 mentioned in comma-separated list of @var{opts}.  Enabling this option
10969 for a sanitizer component causes it to attempt to continue
10970 running the program as if no error happened.  This means multiple
10971 runtime errors can be reported in a single program run, and the exit
10972 code of the program may indicate success even when errors
10973 have been reported.  The @option{-fno-sanitize-recover=} option
10974 can be used to alter
10975 this behavior: only the first detected error is reported
10976 and program then exits with a non-zero exit code.
10978 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
10979 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
10980 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
10981 @option{-fsanitize=bounds-strict},
10982 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
10983 For these sanitizers error recovery is turned on by default,
10984 except @option{-fsanitize=address}, for which this feature is experimental.
10985 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
10986 accepted, the former enables recovery for all sanitizers that support it,
10987 the latter disables recovery for all sanitizers that support it.
10989 Even if a recovery mode is turned on the compiler side, it needs to be also
10990 enabled on the runtime library side, otherwise the failures are still fatal.
10991 The runtime library defaults to @code{halt_on_error=0} for
10992 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
10993 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
10994 setting the @code{halt_on_error} flag in the corresponding environment variable.
10996 Syntax without an explicit @var{opts} parameter is deprecated.  It is
10997 equivalent to specifying an @var{opts} list of:
10999 @smallexample
11000 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11001 @end smallexample
11003 @item -fsanitize-address-use-after-scope
11004 @opindex fsanitize-address-use-after-scope
11005 Enable sanitization of local variables to detect use-after-scope bugs.
11006 The option sets @option{-fstack-reuse} to @samp{none}.
11008 @item -fsanitize-undefined-trap-on-error
11009 @opindex fsanitize-undefined-trap-on-error
11010 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11011 report undefined behavior using @code{__builtin_trap} rather than
11012 a @code{libubsan} library routine.  The advantage of this is that the
11013 @code{libubsan} library is not needed and is not linked in, so this
11014 is usable even in freestanding environments.
11016 @item -fsanitize-coverage=trace-pc
11017 @opindex fsanitize-coverage=trace-pc
11018 Enable coverage-guided fuzzing code instrumentation.
11019 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11021 @item -fbounds-check
11022 @opindex fbounds-check
11023 For front ends that support it, generate additional code to check that
11024 indices used to access arrays are within the declared range.  This is
11025 currently only supported by the Fortran front end, where this option
11026 defaults to false.
11028 @item -fcheck-pointer-bounds
11029 @opindex fcheck-pointer-bounds
11030 @opindex fno-check-pointer-bounds
11031 @cindex Pointer Bounds Checker options
11032 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11033 is instrumented with checks of the pointer used for memory access against
11034 bounds associated with that pointer.  
11036 Currently there
11037 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11038 and @option{-mmpx} are required to enable this feature.  
11039 MPX-based instrumentation requires
11040 a runtime library to enable MPX in hardware and handle bounds
11041 violation signals.  By default when @option{-fcheck-pointer-bounds}
11042 and @option{-mmpx} options are used to link a program, the GCC driver
11043 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11044 Bounds checking on calls to dynamic libraries requires a linker
11045 with @option{-z bndplt} support; if GCC was configured with a linker
11046 without support for this option (including the Gold linker and older
11047 versions of ld), a warning is given if you link with @option{-mmpx}
11048 without also specifying @option{-static}, since the overall effectiveness
11049 of the bounds checking protection is reduced.
11050 See also @option{-static-libmpxwrappers}.
11052 MPX-based instrumentation
11053 may be used for debugging and also may be included in production code
11054 to increase program security.  Depending on usage, you may
11055 have different requirements for the runtime library.  The current version
11056 of the MPX runtime library is more oriented for use as a debugging
11057 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11058 also @option{-static-libmpx}.  The runtime library  behavior can be
11059 influenced using various @env{CHKP_RT_*} environment variables.  See
11060 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11061 for more details.
11063 Generated instrumentation may be controlled by various
11064 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11065 structure field attribute (@pxref{Type Attributes}) and
11066 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11067 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11068 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11069 Bounds Checker builtins}, for more information.
11071 @item -fchkp-check-incomplete-type
11072 @opindex fchkp-check-incomplete-type
11073 @opindex fno-chkp-check-incomplete-type
11074 Generate pointer bounds checks for variables with incomplete type.
11075 Enabled by default.
11077 @item -fchkp-narrow-bounds
11078 @opindex fchkp-narrow-bounds
11079 @opindex fno-chkp-narrow-bounds
11080 Controls bounds used by Pointer Bounds Checker for pointers to object
11081 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11082 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11083 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11085 @item -fchkp-first-field-has-own-bounds
11086 @opindex fchkp-first-field-has-own-bounds
11087 @opindex fno-chkp-first-field-has-own-bounds
11088 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11089 first field in the structure.  By default a pointer to the first field has
11090 the same bounds as a pointer to the whole structure.
11092 @item -fchkp-flexible-struct-trailing-arrays
11093 @opindex fchkp-flexible-struct-trailing-arrays
11094 @opindex fno-chkp-flexible-struct-trailing-arrays
11095 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11096 possibly flexible.  By default only array fields with zero length or that are
11097 marked with attribute bnd_variable_size are treated as flexible.
11099 @item -fchkp-narrow-to-innermost-array
11100 @opindex fchkp-narrow-to-innermost-array
11101 @opindex fno-chkp-narrow-to-innermost-array
11102 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11103 case of nested static array access.  By default this option is disabled and
11104 bounds of the outermost array are used.
11106 @item -fchkp-optimize
11107 @opindex fchkp-optimize
11108 @opindex fno-chkp-optimize
11109 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11110 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11112 @item -fchkp-use-fast-string-functions
11113 @opindex fchkp-use-fast-string-functions
11114 @opindex fno-chkp-use-fast-string-functions
11115 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11116 by Pointer Bounds Checker.  Disabled by default.
11118 @item -fchkp-use-nochk-string-functions
11119 @opindex fchkp-use-nochk-string-functions
11120 @opindex fno-chkp-use-nochk-string-functions
11121 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11122 by Pointer Bounds Checker.  Disabled by default.
11124 @item -fchkp-use-static-bounds
11125 @opindex fchkp-use-static-bounds
11126 @opindex fno-chkp-use-static-bounds
11127 Allow Pointer Bounds Checker to generate static bounds holding
11128 bounds of static variables.  Enabled by default.
11130 @item -fchkp-use-static-const-bounds
11131 @opindex fchkp-use-static-const-bounds
11132 @opindex fno-chkp-use-static-const-bounds
11133 Use statically-initialized bounds for constant bounds instead of
11134 generating them each time they are required.  By default enabled when
11135 @option{-fchkp-use-static-bounds} is enabled.
11137 @item -fchkp-treat-zero-dynamic-size-as-infinite
11138 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11139 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11140 With this option, objects with incomplete type whose
11141 dynamically-obtained size is zero are treated as having infinite size
11142 instead by Pointer Bounds
11143 Checker.  This option may be helpful if a program is linked with a library
11144 missing size information for some symbols.  Disabled by default.
11146 @item -fchkp-check-read
11147 @opindex fchkp-check-read
11148 @opindex fno-chkp-check-read
11149 Instructs Pointer Bounds Checker to generate checks for all read
11150 accesses to memory.  Enabled by default.
11152 @item -fchkp-check-write
11153 @opindex fchkp-check-write
11154 @opindex fno-chkp-check-write
11155 Instructs Pointer Bounds Checker to generate checks for all write
11156 accesses to memory.  Enabled by default.
11158 @item -fchkp-store-bounds
11159 @opindex fchkp-store-bounds
11160 @opindex fno-chkp-store-bounds
11161 Instructs Pointer Bounds Checker to generate bounds stores for
11162 pointer writes.  Enabled by default.
11164 @item -fchkp-instrument-calls
11165 @opindex fchkp-instrument-calls
11166 @opindex fno-chkp-instrument-calls
11167 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11168 Enabled by default.
11170 @item -fchkp-instrument-marked-only
11171 @opindex fchkp-instrument-marked-only
11172 @opindex fno-chkp-instrument-marked-only
11173 Instructs Pointer Bounds Checker to instrument only functions
11174 marked with the @code{bnd_instrument} attribute
11175 (@pxref{Function Attributes}).  Disabled by default.
11177 @item -fchkp-use-wrappers
11178 @opindex fchkp-use-wrappers
11179 @opindex fno-chkp-use-wrappers
11180 Allows Pointer Bounds Checker to replace calls to built-in functions
11181 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11182 is used to link a program, the GCC driver automatically links
11183 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11184 Enabled by default.
11186 @item -fstack-protector
11187 @opindex fstack-protector
11188 Emit extra code to check for buffer overflows, such as stack smashing
11189 attacks.  This is done by adding a guard variable to functions with
11190 vulnerable objects.  This includes functions that call @code{alloca}, and
11191 functions with buffers larger than 8 bytes.  The guards are initialized
11192 when a function is entered and then checked when the function exits.
11193 If a guard check fails, an error message is printed and the program exits.
11195 @item -fstack-protector-all
11196 @opindex fstack-protector-all
11197 Like @option{-fstack-protector} except that all functions are protected.
11199 @item -fstack-protector-strong
11200 @opindex fstack-protector-strong
11201 Like @option{-fstack-protector} but includes additional functions to
11202 be protected --- those that have local array definitions, or have
11203 references to local frame addresses.
11205 @item -fstack-protector-explicit
11206 @opindex fstack-protector-explicit
11207 Like @option{-fstack-protector} but only protects those functions which
11208 have the @code{stack_protect} attribute.
11210 @item -fstack-check
11211 @opindex fstack-check
11212 Generate code to verify that you do not go beyond the boundary of the
11213 stack.  You should specify this flag if you are running in an
11214 environment with multiple threads, but you only rarely need to specify it in
11215 a single-threaded environment since stack overflow is automatically
11216 detected on nearly all systems if there is only one stack.
11218 Note that this switch does not actually cause checking to be done; the
11219 operating system or the language runtime must do that.  The switch causes
11220 generation of code to ensure that they see the stack being extended.
11222 You can additionally specify a string parameter: @samp{no} means no
11223 checking, @samp{generic} means force the use of old-style checking,
11224 @samp{specific} means use the best checking method and is equivalent
11225 to bare @option{-fstack-check}.
11227 Old-style checking is a generic mechanism that requires no specific
11228 target support in the compiler but comes with the following drawbacks:
11230 @enumerate
11231 @item
11232 Modified allocation strategy for large objects: they are always
11233 allocated dynamically if their size exceeds a fixed threshold.
11235 @item
11236 Fixed limit on the size of the static frame of functions: when it is
11237 topped by a particular function, stack checking is not reliable and
11238 a warning is issued by the compiler.
11240 @item
11241 Inefficiency: because of both the modified allocation strategy and the
11242 generic implementation, code performance is hampered.
11243 @end enumerate
11245 Note that old-style stack checking is also the fallback method for
11246 @samp{specific} if no target support has been added in the compiler.
11248 @item -fstack-limit-register=@var{reg}
11249 @itemx -fstack-limit-symbol=@var{sym}
11250 @itemx -fno-stack-limit
11251 @opindex fstack-limit-register
11252 @opindex fstack-limit-symbol
11253 @opindex fno-stack-limit
11254 Generate code to ensure that the stack does not grow beyond a certain value,
11255 either the value of a register or the address of a symbol.  If a larger
11256 stack is required, a signal is raised at run time.  For most targets,
11257 the signal is raised before the stack overruns the boundary, so
11258 it is possible to catch the signal without taking special precautions.
11260 For instance, if the stack starts at absolute address @samp{0x80000000}
11261 and grows downwards, you can use the flags
11262 @option{-fstack-limit-symbol=__stack_limit} and
11263 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11264 of 128KB@.  Note that this may only work with the GNU linker.
11266 You can locally override stack limit checking by using the
11267 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11269 @item -fsplit-stack
11270 @opindex fsplit-stack
11271 Generate code to automatically split the stack before it overflows.
11272 The resulting program has a discontiguous stack which can only
11273 overflow if the program is unable to allocate any more memory.  This
11274 is most useful when running threaded programs, as it is no longer
11275 necessary to calculate a good stack size to use for each thread.  This
11276 is currently only implemented for the x86 targets running
11277 GNU/Linux.
11279 When code compiled with @option{-fsplit-stack} calls code compiled
11280 without @option{-fsplit-stack}, there may not be much stack space
11281 available for the latter code to run.  If compiling all code,
11282 including library code, with @option{-fsplit-stack} is not an option,
11283 then the linker can fix up these calls so that the code compiled
11284 without @option{-fsplit-stack} always has a large stack.  Support for
11285 this is implemented in the gold linker in GNU binutils release 2.21
11286 and later.
11288 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11289 @opindex fvtable-verify
11290 This option is only available when compiling C++ code.
11291 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11292 feature that verifies at run time, for every virtual call, that
11293 the vtable pointer through which the call is made is valid for the type of
11294 the object, and has not been corrupted or overwritten.  If an invalid vtable
11295 pointer is detected at run time, an error is reported and execution of the
11296 program is immediately halted.
11298 This option causes run-time data structures to be built at program startup,
11299 which are used for verifying the vtable pointers.  
11300 The options @samp{std} and @samp{preinit}
11301 control the timing of when these data structures are built.  In both cases the
11302 data structures are built before execution reaches @code{main}.  Using
11303 @option{-fvtable-verify=std} causes the data structures to be built after
11304 shared libraries have been loaded and initialized.
11305 @option{-fvtable-verify=preinit} causes them to be built before shared
11306 libraries have been loaded and initialized.
11308 If this option appears multiple times in the command line with different
11309 values specified, @samp{none} takes highest priority over both @samp{std} and
11310 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11312 @item -fvtv-debug
11313 @opindex fvtv-debug
11314 When used in conjunction with @option{-fvtable-verify=std} or 
11315 @option{-fvtable-verify=preinit}, causes debug versions of the 
11316 runtime functions for the vtable verification feature to be called.  
11317 This flag also causes the compiler to log information about which 
11318 vtable pointers it finds for each class.
11319 This information is written to a file named @file{vtv_set_ptr_data.log} 
11320 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11321 if that is defined or the current working directory otherwise.
11323 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11324 file, be sure to delete any existing one.
11326 @item -fvtv-counts
11327 @opindex fvtv-counts
11328 This is a debugging flag.  When used in conjunction with
11329 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11330 causes the compiler to keep track of the total number of virtual calls
11331 it encounters and the number of verifications it inserts.  It also
11332 counts the number of calls to certain run-time library functions
11333 that it inserts and logs this information for each compilation unit.
11334 The compiler writes this information to a file named
11335 @file{vtv_count_data.log} in the directory named by the environment
11336 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11337 directory otherwise.  It also counts the size of the vtable pointer sets
11338 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11339 in the same directory.
11341 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11342 files, be sure to delete any existing ones.
11344 @item -finstrument-functions
11345 @opindex finstrument-functions
11346 Generate instrumentation calls for entry and exit to functions.  Just
11347 after function entry and just before function exit, the following
11348 profiling functions are called with the address of the current
11349 function and its call site.  (On some platforms,
11350 @code{__builtin_return_address} does not work beyond the current
11351 function, so the call site information may not be available to the
11352 profiling functions otherwise.)
11354 @smallexample
11355 void __cyg_profile_func_enter (void *this_fn,
11356                                void *call_site);
11357 void __cyg_profile_func_exit  (void *this_fn,
11358                                void *call_site);
11359 @end smallexample
11361 The first argument is the address of the start of the current function,
11362 which may be looked up exactly in the symbol table.
11364 This instrumentation is also done for functions expanded inline in other
11365 functions.  The profiling calls indicate where, conceptually, the
11366 inline function is entered and exited.  This means that addressable
11367 versions of such functions must be available.  If all your uses of a
11368 function are expanded inline, this may mean an additional expansion of
11369 code size.  If you use @code{extern inline} in your C code, an
11370 addressable version of such functions must be provided.  (This is
11371 normally the case anyway, but if you get lucky and the optimizer always
11372 expands the functions inline, you might have gotten away without
11373 providing static copies.)
11375 A function may be given the attribute @code{no_instrument_function}, in
11376 which case this instrumentation is not done.  This can be used, for
11377 example, for the profiling functions listed above, high-priority
11378 interrupt routines, and any functions from which the profiling functions
11379 cannot safely be called (perhaps signal handlers, if the profiling
11380 routines generate output or allocate memory).
11382 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11383 @opindex finstrument-functions-exclude-file-list
11385 Set the list of functions that are excluded from instrumentation (see
11386 the description of @option{-finstrument-functions}).  If the file that
11387 contains a function definition matches with one of @var{file}, then
11388 that function is not instrumented.  The match is done on substrings:
11389 if the @var{file} parameter is a substring of the file name, it is
11390 considered to be a match.
11392 For example:
11394 @smallexample
11395 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11396 @end smallexample
11398 @noindent
11399 excludes any inline function defined in files whose pathnames
11400 contain @file{/bits/stl} or @file{include/sys}.
11402 If, for some reason, you want to include letter @samp{,} in one of
11403 @var{sym}, write @samp{\,}. For example,
11404 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11405 (note the single quote surrounding the option).
11407 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11408 @opindex finstrument-functions-exclude-function-list
11410 This is similar to @option{-finstrument-functions-exclude-file-list},
11411 but this option sets the list of function names to be excluded from
11412 instrumentation.  The function name to be matched is its user-visible
11413 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11414 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11415 match is done on substrings: if the @var{sym} parameter is a substring
11416 of the function name, it is considered to be a match.  For C99 and C++
11417 extended identifiers, the function name must be given in UTF-8, not
11418 using universal character names.
11420 @end table
11423 @node Preprocessor Options
11424 @section Options Controlling the Preprocessor
11425 @cindex preprocessor options
11426 @cindex options, preprocessor
11428 These options control the C preprocessor, which is run on each C source
11429 file before actual compilation.
11431 If you use the @option{-E} option, nothing is done except preprocessing.
11432 Some of these options make sense only together with @option{-E} because
11433 they cause the preprocessor output to be unsuitable for actual
11434 compilation.
11436 In addition to the options listed here, there are a number of options 
11437 to control search paths for include files documented in 
11438 @ref{Directory Options}.  
11439 Options to control preprocessor diagnostics are listed in 
11440 @ref{Warning Options}.
11442 @table @gcctabopt
11443 @include cppopts.texi
11445 @item -Wp,@var{option}
11446 @opindex Wp
11447 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11448 and pass @var{option} directly through to the preprocessor.  If
11449 @var{option} contains commas, it is split into multiple options at the
11450 commas.  However, many options are modified, translated or interpreted
11451 by the compiler driver before being passed to the preprocessor, and
11452 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11453 interface is undocumented and subject to change, so whenever possible
11454 you should avoid using @option{-Wp} and let the driver handle the
11455 options instead.
11457 @item -Xpreprocessor @var{option}
11458 @opindex Xpreprocessor
11459 Pass @var{option} as an option to the preprocessor.  You can use this to
11460 supply system-specific preprocessor options that GCC does not 
11461 recognize.
11463 If you want to pass an option that takes an argument, you must use
11464 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11466 @item -no-integrated-cpp
11467 @opindex no-integrated-cpp
11468 Perform preprocessing as a separate pass before compilation.
11469 By default, GCC performs preprocessing as an integrated part of
11470 input tokenization and parsing.
11471 If this option is provided, the appropriate language front end
11472 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11473 and Objective-C, respectively) is instead invoked twice,
11474 once for preprocessing only and once for actual compilation
11475 of the preprocessed input.
11476 This option may be useful in conjunction with the @option{-B} or
11477 @option{-wrapper} options to specify an alternate preprocessor or
11478 perform additional processing of the program source between
11479 normal preprocessing and compilation.
11481 @end table
11483 @node Assembler Options
11484 @section Passing Options to the Assembler
11486 @c prevent bad page break with this line
11487 You can pass options to the assembler.
11489 @table @gcctabopt
11490 @item -Wa,@var{option}
11491 @opindex Wa
11492 Pass @var{option} as an option to the assembler.  If @var{option}
11493 contains commas, it is split into multiple options at the commas.
11495 @item -Xassembler @var{option}
11496 @opindex Xassembler
11497 Pass @var{option} as an option to the assembler.  You can use this to
11498 supply system-specific assembler options that GCC does not
11499 recognize.
11501 If you want to pass an option that takes an argument, you must use
11502 @option{-Xassembler} twice, once for the option and once for the argument.
11504 @end table
11506 @node Link Options
11507 @section Options for Linking
11508 @cindex link options
11509 @cindex options, linking
11511 These options come into play when the compiler links object files into
11512 an executable output file.  They are meaningless if the compiler is
11513 not doing a link step.
11515 @table @gcctabopt
11516 @cindex file names
11517 @item @var{object-file-name}
11518 A file name that does not end in a special recognized suffix is
11519 considered to name an object file or library.  (Object files are
11520 distinguished from libraries by the linker according to the file
11521 contents.)  If linking is done, these object files are used as input
11522 to the linker.
11524 @item -c
11525 @itemx -S
11526 @itemx -E
11527 @opindex c
11528 @opindex S
11529 @opindex E
11530 If any of these options is used, then the linker is not run, and
11531 object file names should not be used as arguments.  @xref{Overall
11532 Options}.
11534 @item -fuse-ld=bfd
11535 @opindex fuse-ld=bfd
11536 Use the @command{bfd} linker instead of the default linker.
11538 @item -fuse-ld=gold
11539 @opindex fuse-ld=gold
11540 Use the @command{gold} linker instead of the default linker.
11542 @cindex Libraries
11543 @item -l@var{library}
11544 @itemx -l @var{library}
11545 @opindex l
11546 Search the library named @var{library} when linking.  (The second
11547 alternative with the library as a separate argument is only for
11548 POSIX compliance and is not recommended.)
11550 It makes a difference where in the command you write this option; the
11551 linker searches and processes libraries and object files in the order they
11552 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11553 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11554 to functions in @samp{z}, those functions may not be loaded.
11556 The linker searches a standard list of directories for the library,
11557 which is actually a file named @file{lib@var{library}.a}.  The linker
11558 then uses this file as if it had been specified precisely by name.
11560 The directories searched include several standard system directories
11561 plus any that you specify with @option{-L}.
11563 Normally the files found this way are library files---archive files
11564 whose members are object files.  The linker handles an archive file by
11565 scanning through it for members which define symbols that have so far
11566 been referenced but not defined.  But if the file that is found is an
11567 ordinary object file, it is linked in the usual fashion.  The only
11568 difference between using an @option{-l} option and specifying a file name
11569 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11570 and searches several directories.
11572 @item -lobjc
11573 @opindex lobjc
11574 You need this special case of the @option{-l} option in order to
11575 link an Objective-C or Objective-C++ program.
11577 @item -nostartfiles
11578 @opindex nostartfiles
11579 Do not use the standard system startup files when linking.
11580 The standard system libraries are used normally, unless @option{-nostdlib}
11581 or @option{-nodefaultlibs} is used.
11583 @item -nodefaultlibs
11584 @opindex nodefaultlibs
11585 Do not use the standard system libraries when linking.
11586 Only the libraries you specify are passed to the linker, and options
11587 specifying linkage of the system libraries, such as @option{-static-libgcc}
11588 or @option{-shared-libgcc}, are ignored.  
11589 The standard startup files are used normally, unless @option{-nostartfiles}
11590 is used.  
11592 The compiler may generate calls to @code{memcmp},
11593 @code{memset}, @code{memcpy} and @code{memmove}.
11594 These entries are usually resolved by entries in
11595 libc.  These entry points should be supplied through some other
11596 mechanism when this option is specified.
11598 @item -nostdlib
11599 @opindex nostdlib
11600 Do not use the standard system startup files or libraries when linking.
11601 No startup files and only the libraries you specify are passed to
11602 the linker, and options specifying linkage of the system libraries, such as
11603 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11605 The compiler may generate calls to @code{memcmp}, @code{memset},
11606 @code{memcpy} and @code{memmove}.
11607 These entries are usually resolved by entries in
11608 libc.  These entry points should be supplied through some other
11609 mechanism when this option is specified.
11611 @cindex @option{-lgcc}, use with @option{-nostdlib}
11612 @cindex @option{-nostdlib} and unresolved references
11613 @cindex unresolved references and @option{-nostdlib}
11614 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11615 @cindex @option{-nodefaultlibs} and unresolved references
11616 @cindex unresolved references and @option{-nodefaultlibs}
11617 One of the standard libraries bypassed by @option{-nostdlib} and
11618 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11619 which GCC uses to overcome shortcomings of particular machines, or special
11620 needs for some languages.
11621 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11622 Collection (GCC) Internals},
11623 for more discussion of @file{libgcc.a}.)
11624 In most cases, you need @file{libgcc.a} even when you want to avoid
11625 other standard libraries.  In other words, when you specify @option{-nostdlib}
11626 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11627 This ensures that you have no unresolved references to internal GCC
11628 library subroutines.
11629 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11630 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11631 GNU Compiler Collection (GCC) Internals}.)
11633 @item -pie
11634 @opindex pie
11635 Produce a position independent executable on targets that support it.
11636 For predictable results, you must also specify the same set of options
11637 used for compilation (@option{-fpie}, @option{-fPIE},
11638 or model suboptions) when you specify this linker option.
11640 @item -no-pie
11641 @opindex no-pie
11642 Don't produce a position independent executable.
11644 @item -pthread
11645 @opindex pthread
11646 Link with the POSIX threads library.  This option is supported on 
11647 GNU/Linux targets, most other Unix derivatives, and also on 
11648 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11649 flags for the preprocessor, so it should be used consistently for both
11650 compilation and linking.
11652 @item -rdynamic
11653 @opindex rdynamic
11654 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11655 that support it. This instructs the linker to add all symbols, not
11656 only used ones, to the dynamic symbol table. This option is needed
11657 for some uses of @code{dlopen} or to allow obtaining backtraces
11658 from within a program.
11660 @item -s
11661 @opindex s
11662 Remove all symbol table and relocation information from the executable.
11664 @item -static
11665 @opindex static
11666 On systems that support dynamic linking, this prevents linking with the shared
11667 libraries.  On other systems, this option has no effect.
11669 @item -shared
11670 @opindex shared
11671 Produce a shared object which can then be linked with other objects to
11672 form an executable.  Not all systems support this option.  For predictable
11673 results, you must also specify the same set of options used for compilation
11674 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11675 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11676 needs to build supplementary stub code for constructors to work.  On
11677 multi-libbed systems, @samp{gcc -shared} must select the correct support
11678 libraries to link against.  Failing to supply the correct flags may lead
11679 to subtle defects.  Supplying them in cases where they are not necessary
11680 is innocuous.}
11682 @item -shared-libgcc
11683 @itemx -static-libgcc
11684 @opindex shared-libgcc
11685 @opindex static-libgcc
11686 On systems that provide @file{libgcc} as a shared library, these options
11687 force the use of either the shared or static version, respectively.
11688 If no shared version of @file{libgcc} was built when the compiler was
11689 configured, these options have no effect.
11691 There are several situations in which an application should use the
11692 shared @file{libgcc} instead of the static version.  The most common
11693 of these is when the application wishes to throw and catch exceptions
11694 across different shared libraries.  In that case, each of the libraries
11695 as well as the application itself should use the shared @file{libgcc}.
11697 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11698  whenever you build a shared library or a main executable, because C++
11699  programs typically use exceptions, so this is the right thing to do.
11701 If, instead, you use the GCC driver to create shared libraries, you may
11702 find that they are not always linked with the shared @file{libgcc}.
11703 If GCC finds, at its configuration time, that you have a non-GNU linker
11704 or a GNU linker that does not support option @option{--eh-frame-hdr},
11705 it links the shared version of @file{libgcc} into shared libraries
11706 by default.  Otherwise, it takes advantage of the linker and optimizes
11707 away the linking with the shared version of @file{libgcc}, linking with
11708 the static version of libgcc by default.  This allows exceptions to
11709 propagate through such shared libraries, without incurring relocation
11710 costs at library load time.
11712 However, if a library or main executable is supposed to throw or catch
11713 exceptions, you must link it using the G++ driver, as appropriate
11714 for the languages used in the program, or using the option
11715 @option{-shared-libgcc}, such that it is linked with the shared
11716 @file{libgcc}.
11718 @item -static-libasan
11719 @opindex static-libasan
11720 When the @option{-fsanitize=address} option is used to link a program,
11721 the GCC driver automatically links against @option{libasan}.  If
11722 @file{libasan} is available as a shared library, and the @option{-static}
11723 option is not used, then this links against the shared version of
11724 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11725 driver to link @file{libasan} statically, without necessarily linking
11726 other libraries statically.
11728 @item -static-libtsan
11729 @opindex static-libtsan
11730 When the @option{-fsanitize=thread} option is used to link a program,
11731 the GCC driver automatically links against @option{libtsan}.  If
11732 @file{libtsan} is available as a shared library, and the @option{-static}
11733 option is not used, then this links against the shared version of
11734 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11735 driver to link @file{libtsan} statically, without necessarily linking
11736 other libraries statically.
11738 @item -static-liblsan
11739 @opindex static-liblsan
11740 When the @option{-fsanitize=leak} option is used to link a program,
11741 the GCC driver automatically links against @option{liblsan}.  If
11742 @file{liblsan} is available as a shared library, and the @option{-static}
11743 option is not used, then this links against the shared version of
11744 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11745 driver to link @file{liblsan} statically, without necessarily linking
11746 other libraries statically.
11748 @item -static-libubsan
11749 @opindex static-libubsan
11750 When the @option{-fsanitize=undefined} option is used to link a program,
11751 the GCC driver automatically links against @option{libubsan}.  If
11752 @file{libubsan} is available as a shared library, and the @option{-static}
11753 option is not used, then this links against the shared version of
11754 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11755 driver to link @file{libubsan} statically, without necessarily linking
11756 other libraries statically.
11758 @item -static-libmpx
11759 @opindex static-libmpx
11760 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11761 used to link a program, the GCC driver automatically links against
11762 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11763 and the @option{-static} option is not used, then this links against
11764 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11765 option directs the GCC driver to link @file{libmpx} statically,
11766 without necessarily linking other libraries statically.
11768 @item -static-libmpxwrappers
11769 @opindex static-libmpxwrappers
11770 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11771 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11772 GCC driver automatically links against @file{libmpxwrappers}.  If
11773 @file{libmpxwrappers} is available as a shared library, and the
11774 @option{-static} option is not used, then this links against the shared
11775 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11776 option directs the GCC driver to link @file{libmpxwrappers} statically,
11777 without necessarily linking other libraries statically.
11779 @item -static-libstdc++
11780 @opindex static-libstdc++
11781 When the @command{g++} program is used to link a C++ program, it
11782 normally automatically links against @option{libstdc++}.  If
11783 @file{libstdc++} is available as a shared library, and the
11784 @option{-static} option is not used, then this links against the
11785 shared version of @file{libstdc++}.  That is normally fine.  However, it
11786 is sometimes useful to freeze the version of @file{libstdc++} used by
11787 the program without going all the way to a fully static link.  The
11788 @option{-static-libstdc++} option directs the @command{g++} driver to
11789 link @file{libstdc++} statically, without necessarily linking other
11790 libraries statically.
11792 @item -symbolic
11793 @opindex symbolic
11794 Bind references to global symbols when building a shared object.  Warn
11795 about any unresolved references (unless overridden by the link editor
11796 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11797 this option.
11799 @item -T @var{script}
11800 @opindex T
11801 @cindex linker script
11802 Use @var{script} as the linker script.  This option is supported by most
11803 systems using the GNU linker.  On some targets, such as bare-board
11804 targets without an operating system, the @option{-T} option may be required
11805 when linking to avoid references to undefined symbols.
11807 @item -Xlinker @var{option}
11808 @opindex Xlinker
11809 Pass @var{option} as an option to the linker.  You can use this to
11810 supply system-specific linker options that GCC does not recognize.
11812 If you want to pass an option that takes a separate argument, you must use
11813 @option{-Xlinker} twice, once for the option and once for the argument.
11814 For example, to pass @option{-assert definitions}, you must write
11815 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11816 @option{-Xlinker "-assert definitions"}, because this passes the entire
11817 string as a single argument, which is not what the linker expects.
11819 When using the GNU linker, it is usually more convenient to pass
11820 arguments to linker options using the @option{@var{option}=@var{value}}
11821 syntax than as separate arguments.  For example, you can specify
11822 @option{-Xlinker -Map=output.map} rather than
11823 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11824 this syntax for command-line options.
11826 @item -Wl,@var{option}
11827 @opindex Wl
11828 Pass @var{option} as an option to the linker.  If @var{option} contains
11829 commas, it is split into multiple options at the commas.  You can use this
11830 syntax to pass an argument to the option.
11831 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11832 linker.  When using the GNU linker, you can also get the same effect with
11833 @option{-Wl,-Map=output.map}.
11835 @item -u @var{symbol}
11836 @opindex u
11837 Pretend the symbol @var{symbol} is undefined, to force linking of
11838 library modules to define it.  You can use @option{-u} multiple times with
11839 different symbols to force loading of additional library modules.
11841 @item -z @var{keyword}
11842 @opindex z
11843 @option{-z} is passed directly on to the linker along with the keyword
11844 @var{keyword}. See the section in the documentation of your linker for
11845 permitted values and their meanings.
11846 @end table
11848 @node Directory Options
11849 @section Options for Directory Search
11850 @cindex directory options
11851 @cindex options, directory search
11852 @cindex search path
11854 These options specify directories to search for header files, for
11855 libraries and for parts of the compiler:
11857 @table @gcctabopt
11858 @include cppdiropts.texi
11860 @item -iplugindir=@var{dir}
11861 @opindex iplugindir=
11862 Set the directory to search for plugins that are passed
11863 by @option{-fplugin=@var{name}} instead of
11864 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11865 to be used by the user, but only passed by the driver.
11867 @item -L@var{dir}
11868 @opindex L
11869 Add directory @var{dir} to the list of directories to be searched
11870 for @option{-l}.
11872 @item -B@var{prefix}
11873 @opindex B
11874 This option specifies where to find the executables, libraries,
11875 include files, and data files of the compiler itself.
11877 The compiler driver program runs one or more of the subprograms
11878 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11879 @var{prefix} as a prefix for each program it tries to run, both with and
11880 without @samp{@var{machine}/@var{version}/} for the corresponding target
11881 machine and compiler version.
11883 For each subprogram to be run, the compiler driver first tries the
11884 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11885 is not specified, the driver tries two standard prefixes, 
11886 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11887 those results in a file name that is found, the unmodified program
11888 name is searched for using the directories specified in your
11889 @env{PATH} environment variable.
11891 The compiler checks to see if the path provided by @option{-B}
11892 refers to a directory, and if necessary it adds a directory
11893 separator character at the end of the path.
11895 @option{-B} prefixes that effectively specify directory names also apply
11896 to libraries in the linker, because the compiler translates these
11897 options into @option{-L} options for the linker.  They also apply to
11898 include files in the preprocessor, because the compiler translates these
11899 options into @option{-isystem} options for the preprocessor.  In this case,
11900 the compiler appends @samp{include} to the prefix.
11902 The runtime support file @file{libgcc.a} can also be searched for using
11903 the @option{-B} prefix, if needed.  If it is not found there, the two
11904 standard prefixes above are tried, and that is all.  The file is left
11905 out of the link if it is not found by those means.
11907 Another way to specify a prefix much like the @option{-B} prefix is to use
11908 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11909 Variables}.
11911 As a special kludge, if the path provided by @option{-B} is
11912 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11913 9, then it is replaced by @file{[dir/]include}.  This is to help
11914 with boot-strapping the compiler.
11916 @item -no-canonical-prefixes
11917 @opindex no-canonical-prefixes
11918 Do not expand any symbolic links, resolve references to @samp{/../}
11919 or @samp{/./}, or make the path absolute when generating a relative
11920 prefix.
11922 @item --sysroot=@var{dir}
11923 @opindex sysroot
11924 Use @var{dir} as the logical root directory for headers and libraries.
11925 For example, if the compiler normally searches for headers in
11926 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11927 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11929 If you use both this option and the @option{-isysroot} option, then
11930 the @option{--sysroot} option applies to libraries, but the
11931 @option{-isysroot} option applies to header files.
11933 The GNU linker (beginning with version 2.16) has the necessary support
11934 for this option.  If your linker does not support this option, the
11935 header file aspect of @option{--sysroot} still works, but the
11936 library aspect does not.
11938 @item --no-sysroot-suffix
11939 @opindex no-sysroot-suffix
11940 For some targets, a suffix is added to the root directory specified
11941 with @option{--sysroot}, depending on the other options used, so that
11942 headers may for example be found in
11943 @file{@var{dir}/@var{suffix}/usr/include} instead of
11944 @file{@var{dir}/usr/include}.  This option disables the addition of
11945 such a suffix.
11947 @end table
11949 @node Code Gen Options
11950 @section Options for Code Generation Conventions
11951 @cindex code generation conventions
11952 @cindex options, code generation
11953 @cindex run-time options
11955 These machine-independent options control the interface conventions
11956 used in code generation.
11958 Most of them have both positive and negative forms; the negative form
11959 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
11960 one of the forms is listed---the one that is not the default.  You
11961 can figure out the other form by either removing @samp{no-} or adding
11964 @table @gcctabopt
11965 @item -fstack-reuse=@var{reuse-level}
11966 @opindex fstack_reuse
11967 This option controls stack space reuse for user declared local/auto variables
11968 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
11969 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
11970 local variables and temporaries, @samp{named_vars} enables the reuse only for
11971 user defined local variables with names, and @samp{none} disables stack reuse
11972 completely. The default value is @samp{all}. The option is needed when the
11973 program extends the lifetime of a scoped local variable or a compiler generated
11974 temporary beyond the end point defined by the language.  When a lifetime of
11975 a variable ends, and if the variable lives in memory, the optimizing compiler
11976 has the freedom to reuse its stack space with other temporaries or scoped
11977 local variables whose live range does not overlap with it. Legacy code extending
11978 local lifetime is likely to break with the stack reuse optimization.
11980 For example,
11982 @smallexample
11983    int *p;
11984    @{
11985      int local1;
11987      p = &local1;
11988      local1 = 10;
11989      ....
11990    @}
11991    @{
11992       int local2;
11993       local2 = 20;
11994       ...
11995    @}
11997    if (*p == 10)  // out of scope use of local1
11998      @{
12000      @}
12001 @end smallexample
12003 Another example:
12004 @smallexample
12006    struct A
12007    @{
12008        A(int k) : i(k), j(k) @{ @}
12009        int i;
12010        int j;
12011    @};
12013    A *ap;
12015    void foo(const A& ar)
12016    @{
12017       ap = &ar;
12018    @}
12020    void bar()
12021    @{
12022       foo(A(10)); // temp object's lifetime ends when foo returns
12024       @{
12025         A a(20);
12026         ....
12027       @}
12028       ap->i+= 10;  // ap references out of scope temp whose space
12029                    // is reused with a. What is the value of ap->i?
12030    @}
12032 @end smallexample
12034 The lifetime of a compiler generated temporary is well defined by the C++
12035 standard. When a lifetime of a temporary ends, and if the temporary lives
12036 in memory, the optimizing compiler has the freedom to reuse its stack
12037 space with other temporaries or scoped local variables whose live range
12038 does not overlap with it. However some of the legacy code relies on
12039 the behavior of older compilers in which temporaries' stack space is
12040 not reused, the aggressive stack reuse can lead to runtime errors. This
12041 option is used to control the temporary stack reuse optimization.
12043 @item -ftrapv
12044 @opindex ftrapv
12045 This option generates traps for signed overflow on addition, subtraction,
12046 multiplication operations.
12047 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12048 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12049 @option{-fwrapv} being effective.  Note that only active options override, so
12050 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12051 results in @option{-ftrapv} being effective.
12053 @item -fwrapv
12054 @opindex fwrapv
12055 This option instructs the compiler to assume that signed arithmetic
12056 overflow of addition, subtraction and multiplication wraps around
12057 using twos-complement representation.  This flag enables some optimizations
12058 and disables others.
12059 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12060 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12061 @option{-fwrapv} being effective.  Note that only active options override, so
12062 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12063 results in @option{-ftrapv} being effective.
12065 @item -fexceptions
12066 @opindex fexceptions
12067 Enable exception handling.  Generates extra code needed to propagate
12068 exceptions.  For some targets, this implies GCC generates frame
12069 unwind information for all functions, which can produce significant data
12070 size overhead, although it does not affect execution.  If you do not
12071 specify this option, GCC enables it by default for languages like
12072 C++ that normally require exception handling, and disables it for
12073 languages like C that do not normally require it.  However, you may need
12074 to enable this option when compiling C code that needs to interoperate
12075 properly with exception handlers written in C++.  You may also wish to
12076 disable this option if you are compiling older C++ programs that don't
12077 use exception handling.
12079 @item -fnon-call-exceptions
12080 @opindex fnon-call-exceptions
12081 Generate code that allows trapping instructions to throw exceptions.
12082 Note that this requires platform-specific runtime support that does
12083 not exist everywhere.  Moreover, it only allows @emph{trapping}
12084 instructions to throw exceptions, i.e.@: memory references or floating-point
12085 instructions.  It does not allow exceptions to be thrown from
12086 arbitrary signal handlers such as @code{SIGALRM}.
12088 @item -fdelete-dead-exceptions
12089 @opindex fdelete-dead-exceptions
12090 Consider that instructions that may throw exceptions but don't otherwise
12091 contribute to the execution of the program can be optimized away.
12092 This option is enabled by default for the Ada front end, as permitted by
12093 the Ada language specification.
12094 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12096 @item -funwind-tables
12097 @opindex funwind-tables
12098 Similar to @option{-fexceptions}, except that it just generates any needed
12099 static data, but does not affect the generated code in any other way.
12100 You normally do not need to enable this option; instead, a language processor
12101 that needs this handling enables it on your behalf.
12103 @item -fasynchronous-unwind-tables
12104 @opindex fasynchronous-unwind-tables
12105 Generate unwind table in DWARF format, if supported by target machine.  The
12106 table is exact at each instruction boundary, so it can be used for stack
12107 unwinding from asynchronous events (such as debugger or garbage collector).
12109 @item -fno-gnu-unique
12110 @opindex fno-gnu-unique
12111 On systems with recent GNU assembler and C library, the C++ compiler
12112 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12113 of template static data members and static local variables in inline
12114 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12115 is necessary to avoid problems with a library used by two different
12116 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12117 therefore disagreeing with the other one about the binding of the
12118 symbol.  But this causes @code{dlclose} to be ignored for affected
12119 DSOs; if your program relies on reinitialization of a DSO via
12120 @code{dlclose} and @code{dlopen}, you can use
12121 @option{-fno-gnu-unique}.
12123 @item -fpcc-struct-return
12124 @opindex fpcc-struct-return
12125 Return ``short'' @code{struct} and @code{union} values in memory like
12126 longer ones, rather than in registers.  This convention is less
12127 efficient, but it has the advantage of allowing intercallability between
12128 GCC-compiled files and files compiled with other compilers, particularly
12129 the Portable C Compiler (pcc).
12131 The precise convention for returning structures in memory depends
12132 on the target configuration macros.
12134 Short structures and unions are those whose size and alignment match
12135 that of some integer type.
12137 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12138 switch is not binary compatible with code compiled with the
12139 @option{-freg-struct-return} switch.
12140 Use it to conform to a non-default application binary interface.
12142 @item -freg-struct-return
12143 @opindex freg-struct-return
12144 Return @code{struct} and @code{union} values in registers when possible.
12145 This is more efficient for small structures than
12146 @option{-fpcc-struct-return}.
12148 If you specify neither @option{-fpcc-struct-return} nor
12149 @option{-freg-struct-return}, GCC defaults to whichever convention is
12150 standard for the target.  If there is no standard convention, GCC
12151 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12152 the principal compiler.  In those cases, we can choose the standard, and
12153 we chose the more efficient register return alternative.
12155 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12156 switch is not binary compatible with code compiled with the
12157 @option{-fpcc-struct-return} switch.
12158 Use it to conform to a non-default application binary interface.
12160 @item -fshort-enums
12161 @opindex fshort-enums
12162 Allocate to an @code{enum} type only as many bytes as it needs for the
12163 declared range of possible values.  Specifically, the @code{enum} type
12164 is equivalent to the smallest integer type that has enough room.
12166 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12167 code that is not binary compatible with code generated without that switch.
12168 Use it to conform to a non-default application binary interface.
12170 @item -fshort-wchar
12171 @opindex fshort-wchar
12172 Override the underlying type for @code{wchar_t} to be @code{short
12173 unsigned int} instead of the default for the target.  This option is
12174 useful for building programs to run under WINE@.
12176 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12177 code that is not binary compatible with code generated without that switch.
12178 Use it to conform to a non-default application binary interface.
12180 @item -fno-common
12181 @opindex fno-common
12182 @cindex tentative definitions
12183 In C code, this option controls the placement of global variables 
12184 defined without an initializer, known as @dfn{tentative definitions} 
12185 in the C standard.  Tentative definitions are distinct from declarations 
12186 of a variable with the @code{extern} keyword, which do not allocate storage.
12188 Unix C compilers have traditionally allocated storage for
12189 uninitialized global variables in a common block.  This allows the
12190 linker to resolve all tentative definitions of the same variable
12191 in different compilation units to the same object, or to a non-tentative
12192 definition.  
12193 This is the behavior specified by @option{-fcommon}, and is the default for 
12194 GCC on most targets.  
12195 On the other hand, this behavior is not required by ISO
12196 C, and on some targets may carry a speed or code size penalty on
12197 variable references.
12199 The @option{-fno-common} option specifies that the compiler should instead
12200 place uninitialized global variables in the data section of the object file.
12201 This inhibits the merging of tentative definitions by the linker so
12202 you get a multiple-definition error if the same 
12203 variable is defined in more than one compilation unit.
12204 Compiling with @option{-fno-common} is useful on targets for which
12205 it provides better performance, or if you wish to verify that the
12206 program will work on other systems that always treat uninitialized
12207 variable definitions this way.
12209 @item -fno-ident
12210 @opindex fno-ident
12211 Ignore the @code{#ident} directive.
12213 @item -finhibit-size-directive
12214 @opindex finhibit-size-directive
12215 Don't output a @code{.size} assembler directive, or anything else that
12216 would cause trouble if the function is split in the middle, and the
12217 two halves are placed at locations far apart in memory.  This option is
12218 used when compiling @file{crtstuff.c}; you should not need to use it
12219 for anything else.
12221 @item -fverbose-asm
12222 @opindex fverbose-asm
12223 Put extra commentary information in the generated assembly code to
12224 make it more readable.  This option is generally only of use to those
12225 who actually need to read the generated assembly code (perhaps while
12226 debugging the compiler itself).
12228 @option{-fno-verbose-asm}, the default, causes the
12229 extra information to be omitted and is useful when comparing two assembler
12230 files.
12232 The added comments include:
12234 @itemize @bullet
12236 @item
12237 information on the compiler version and command-line options,
12239 @item
12240 the source code lines associated with the assembly instructions,
12241 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12243 @item
12244 hints on which high-level expressions correspond to
12245 the various assembly instruction operands.
12247 @end itemize
12249 For example, given this C source file:
12251 @smallexample
12252 int test (int n)
12254   int i;
12255   int total = 0;
12257   for (i = 0; i < n; i++)
12258     total += i * i;
12260   return total;
12262 @end smallexample
12264 compiling to (x86_64) assembly via @option{-S} and emitting the result
12265 direct to stdout via @option{-o} @option{-}
12267 @smallexample
12268 gcc -S test.c -fverbose-asm -Os -o -
12269 @end smallexample
12271 gives output similar to this:
12273 @smallexample
12274         .file   "test.c"
12275 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12276   [...snip...]
12277 # options passed:
12278   [...snip...]
12280         .text
12281         .globl  test
12282         .type   test, @@function
12283 test:
12284 .LFB0:
12285         .cfi_startproc
12286 # test.c:4:   int total = 0;
12287         xorl    %eax, %eax      # <retval>
12288 # test.c:6:   for (i = 0; i < n; i++)
12289         xorl    %edx, %edx      # i
12290 .L2:
12291 # test.c:6:   for (i = 0; i < n; i++)
12292         cmpl    %edi, %edx      # n, i
12293         jge     .L5     #,
12294 # test.c:7:     total += i * i;
12295         movl    %edx, %ecx      # i, tmp92
12296         imull   %edx, %ecx      # i, tmp92
12297 # test.c:6:   for (i = 0; i < n; i++)
12298         incl    %edx    # i
12299 # test.c:7:     total += i * i;
12300         addl    %ecx, %eax      # tmp92, <retval>
12301         jmp     .L2     #
12302 .L5:
12303 # test.c:10: @}
12304         ret
12305         .cfi_endproc
12306 .LFE0:
12307         .size   test, .-test
12308         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12309         .section        .note.GNU-stack,"",@@progbits
12310 @end smallexample
12312 The comments are intended for humans rather than machines and hence the
12313 precise format of the comments is subject to change.
12315 @item -frecord-gcc-switches
12316 @opindex frecord-gcc-switches
12317 This switch causes the command line used to invoke the
12318 compiler to be recorded into the object file that is being created.
12319 This switch is only implemented on some targets and the exact format
12320 of the recording is target and binary file format dependent, but it
12321 usually takes the form of a section containing ASCII text.  This
12322 switch is related to the @option{-fverbose-asm} switch, but that
12323 switch only records information in the assembler output file as
12324 comments, so it never reaches the object file.
12325 See also @option{-grecord-gcc-switches} for another
12326 way of storing compiler options into the object file.
12328 @item -fpic
12329 @opindex fpic
12330 @cindex global offset table
12331 @cindex PIC
12332 Generate position-independent code (PIC) suitable for use in a shared
12333 library, if supported for the target machine.  Such code accesses all
12334 constant addresses through a global offset table (GOT)@.  The dynamic
12335 loader resolves the GOT entries when the program starts (the dynamic
12336 loader is not part of GCC; it is part of the operating system).  If
12337 the GOT size for the linked executable exceeds a machine-specific
12338 maximum size, you get an error message from the linker indicating that
12339 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12340 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12341 on the m68k and RS/6000.  The x86 has no such limit.)
12343 Position-independent code requires special support, and therefore works
12344 only on certain machines.  For the x86, GCC supports PIC for System V
12345 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12346 position-independent.
12348 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12349 are defined to 1.
12351 @item -fPIC
12352 @opindex fPIC
12353 If supported for the target machine, emit position-independent code,
12354 suitable for dynamic linking and avoiding any limit on the size of the
12355 global offset table.  This option makes a difference on AArch64, m68k,
12356 PowerPC and SPARC@.
12358 Position-independent code requires special support, and therefore works
12359 only on certain machines.
12361 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12362 are defined to 2.
12364 @item -fpie
12365 @itemx -fPIE
12366 @opindex fpie
12367 @opindex fPIE
12368 These options are similar to @option{-fpic} and @option{-fPIC}, but
12369 generated position independent code can be only linked into executables.
12370 Usually these options are used when @option{-pie} GCC option is
12371 used during linking.
12373 @option{-fpie} and @option{-fPIE} both define the macros
12374 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12375 for @option{-fpie} and 2 for @option{-fPIE}.
12377 @item -fno-plt
12378 @opindex fno-plt
12379 Do not use the PLT for external function calls in position-independent code.
12380 Instead, load the callee address at call sites from the GOT and branch to it.
12381 This leads to more efficient code by eliminating PLT stubs and exposing
12382 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12383 PLT stubs expect the GOT pointer in a specific register, this gives more
12384 register allocation freedom to the compiler.
12385 Lazy binding requires use of the PLT; 
12386 with @option{-fno-plt} all external symbols are resolved at load time.
12388 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12389 through the PLT for specific external functions.
12391 In position-dependent code, a few targets also convert calls to
12392 functions that are marked to not use the PLT to use the GOT instead.
12394 @item -fno-jump-tables
12395 @opindex fno-jump-tables
12396 Do not use jump tables for switch statements even where it would be
12397 more efficient than other code generation strategies.  This option is
12398 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12399 building code that forms part of a dynamic linker and cannot
12400 reference the address of a jump table.  On some targets, jump tables
12401 do not require a GOT and this option is not needed.
12403 @item -ffixed-@var{reg}
12404 @opindex ffixed
12405 Treat the register named @var{reg} as a fixed register; generated code
12406 should never refer to it (except perhaps as a stack pointer, frame
12407 pointer or in some other fixed role).
12409 @var{reg} must be the name of a register.  The register names accepted
12410 are machine-specific and are defined in the @code{REGISTER_NAMES}
12411 macro in the machine description macro file.
12413 This flag does not have a negative form, because it specifies a
12414 three-way choice.
12416 @item -fcall-used-@var{reg}
12417 @opindex fcall-used
12418 Treat the register named @var{reg} as an allocable register that is
12419 clobbered by function calls.  It may be allocated for temporaries or
12420 variables that do not live across a call.  Functions compiled this way
12421 do not save and restore the register @var{reg}.
12423 It is an error to use this flag with the frame pointer or stack pointer.
12424 Use of this flag for other registers that have fixed pervasive roles in
12425 the machine's execution model produces disastrous results.
12427 This flag does not have a negative form, because it specifies a
12428 three-way choice.
12430 @item -fcall-saved-@var{reg}
12431 @opindex fcall-saved
12432 Treat the register named @var{reg} as an allocable register saved by
12433 functions.  It may be allocated even for temporaries or variables that
12434 live across a call.  Functions compiled this way save and restore
12435 the register @var{reg} if they use it.
12437 It is an error to use this flag with the frame pointer or stack pointer.
12438 Use of this flag for other registers that have fixed pervasive roles in
12439 the machine's execution model produces disastrous results.
12441 A different sort of disaster results from the use of this flag for
12442 a register in which function values may be returned.
12444 This flag does not have a negative form, because it specifies a
12445 three-way choice.
12447 @item -fpack-struct[=@var{n}]
12448 @opindex fpack-struct
12449 Without a value specified, pack all structure members together without
12450 holes.  When a value is specified (which must be a small power of two), pack
12451 structure members according to this value, representing the maximum
12452 alignment (that is, objects with default alignment requirements larger than
12453 this are output potentially unaligned at the next fitting location.
12455 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12456 code that is not binary compatible with code generated without that switch.
12457 Additionally, it makes the code suboptimal.
12458 Use it to conform to a non-default application binary interface.
12460 @item -fleading-underscore
12461 @opindex fleading-underscore
12462 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12463 change the way C symbols are represented in the object file.  One use
12464 is to help link with legacy assembly code.
12466 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12467 generate code that is not binary compatible with code generated without that
12468 switch.  Use it to conform to a non-default application binary interface.
12469 Not all targets provide complete support for this switch.
12471 @item -ftls-model=@var{model}
12472 @opindex ftls-model
12473 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12474 The @var{model} argument should be one of @samp{global-dynamic},
12475 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12476 Note that the choice is subject to optimization: the compiler may use
12477 a more efficient model for symbols not visible outside of the translation
12478 unit, or if @option{-fpic} is not given on the command line.
12480 The default without @option{-fpic} is @samp{initial-exec}; with
12481 @option{-fpic} the default is @samp{global-dynamic}.
12483 @item -ftrampolines
12484 @opindex ftrampolines
12485 For targets that normally need trampolines for nested functions, always
12486 generate them instead of using descriptors.  Otherwise, for targets that
12487 do not need them, like for example HP-PA or IA-64, do nothing.
12489 A trampoline is a small piece of code that is created at run time on the
12490 stack when the address of a nested function is taken, and is used to call
12491 the nested function indirectly.  Therefore, it requires the stack to be
12492 made executable in order for the program to work properly.
12494 @option{-fno-trampolines} is enabled by default on a language by language
12495 basis to let the compiler avoid generating them, if it computes that this
12496 is safe, and replace them with descriptors.  Descriptors are made up of data
12497 only, but the generated code must be prepared to deal with them.  As of this
12498 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12500 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12501 @option{-fno-trampolines} are not binary compatible if nested functions are
12502 present.  This option must therefore be used on a program-wide basis and be
12503 manipulated with extreme care.
12505 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12506 @opindex fvisibility
12507 Set the default ELF image symbol visibility to the specified option---all
12508 symbols are marked with this unless overridden within the code.
12509 Using this feature can very substantially improve linking and
12510 load times of shared object libraries, produce more optimized
12511 code, provide near-perfect API export and prevent symbol clashes.
12512 It is @strong{strongly} recommended that you use this in any shared objects
12513 you distribute.
12515 Despite the nomenclature, @samp{default} always means public; i.e.,
12516 available to be linked against from outside the shared object.
12517 @samp{protected} and @samp{internal} are pretty useless in real-world
12518 usage so the only other commonly used option is @samp{hidden}.
12519 The default if @option{-fvisibility} isn't specified is
12520 @samp{default}, i.e., make every symbol public.
12522 A good explanation of the benefits offered by ensuring ELF
12523 symbols have the correct visibility is given by ``How To Write
12524 Shared Libraries'' by Ulrich Drepper (which can be found at
12525 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12526 solution made possible by this option to marking things hidden when
12527 the default is public is to make the default hidden and mark things
12528 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12529 and @code{__attribute__ ((visibility("default")))} instead of
12530 @code{__declspec(dllexport)} you get almost identical semantics with
12531 identical syntax.  This is a great boon to those working with
12532 cross-platform projects.
12534 For those adding visibility support to existing code, you may find
12535 @code{#pragma GCC visibility} of use.  This works by you enclosing
12536 the declarations you wish to set visibility for with (for example)
12537 @code{#pragma GCC visibility push(hidden)} and
12538 @code{#pragma GCC visibility pop}.
12539 Bear in mind that symbol visibility should be viewed @strong{as
12540 part of the API interface contract} and thus all new code should
12541 always specify visibility when it is not the default; i.e., declarations
12542 only for use within the local DSO should @strong{always} be marked explicitly
12543 as hidden as so to avoid PLT indirection overheads---making this
12544 abundantly clear also aids readability and self-documentation of the code.
12545 Note that due to ISO C++ specification requirements, @code{operator new} and
12546 @code{operator delete} must always be of default visibility.
12548 Be aware that headers from outside your project, in particular system
12549 headers and headers from any other library you use, may not be
12550 expecting to be compiled with visibility other than the default.  You
12551 may need to explicitly say @code{#pragma GCC visibility push(default)}
12552 before including any such headers.
12554 @code{extern} declarations are not affected by @option{-fvisibility}, so
12555 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12556 no modifications.  However, this means that calls to @code{extern}
12557 functions with no explicit visibility use the PLT, so it is more
12558 effective to use @code{__attribute ((visibility))} and/or
12559 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12560 declarations should be treated as hidden.
12562 Note that @option{-fvisibility} does affect C++ vague linkage
12563 entities. This means that, for instance, an exception class that is
12564 be thrown between DSOs must be explicitly marked with default
12565 visibility so that the @samp{type_info} nodes are unified between
12566 the DSOs.
12568 An overview of these techniques, their benefits and how to use them
12569 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12571 @item -fstrict-volatile-bitfields
12572 @opindex fstrict-volatile-bitfields
12573 This option should be used if accesses to volatile bit-fields (or other
12574 structure fields, although the compiler usually honors those types
12575 anyway) should use a single access of the width of the
12576 field's type, aligned to a natural alignment if possible.  For
12577 example, targets with memory-mapped peripheral registers might require
12578 all such accesses to be 16 bits wide; with this flag you can
12579 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12580 is 16 bits on these targets) to force GCC to use 16-bit accesses
12581 instead of, perhaps, a more efficient 32-bit access.
12583 If this option is disabled, the compiler uses the most efficient
12584 instruction.  In the previous example, that might be a 32-bit load
12585 instruction, even though that accesses bytes that do not contain
12586 any portion of the bit-field, or memory-mapped registers unrelated to
12587 the one being updated.
12589 In some cases, such as when the @code{packed} attribute is applied to a 
12590 structure field, it may not be possible to access the field with a single
12591 read or write that is correctly aligned for the target machine.  In this
12592 case GCC falls back to generating multiple accesses rather than code that 
12593 will fault or truncate the result at run time.
12595 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12596 not allowed to touch non bit-field members.  It is therefore recommended
12597 to define all bits of the field's type as bit-field members.
12599 The default value of this option is determined by the application binary
12600 interface for the target processor.
12602 @item -fsync-libcalls
12603 @opindex fsync-libcalls
12604 This option controls whether any out-of-line instance of the @code{__sync}
12605 family of functions may be used to implement the C++11 @code{__atomic}
12606 family of functions.
12608 The default value of this option is enabled, thus the only useful form
12609 of the option is @option{-fno-sync-libcalls}.  This option is used in
12610 the implementation of the @file{libatomic} runtime library.
12612 @end table
12614 @node Developer Options
12615 @section GCC Developer Options
12616 @cindex developer options
12617 @cindex debugging GCC
12618 @cindex debug dump options
12619 @cindex dump options
12620 @cindex compilation statistics
12622 This section describes command-line options that are primarily of
12623 interest to GCC developers, including options to support compiler
12624 testing and investigation of compiler bugs and compile-time
12625 performance problems.  This includes options that produce debug dumps
12626 at various points in the compilation; that print statistics such as
12627 memory use and execution time; and that print information about GCC's
12628 configuration, such as where it searches for libraries.  You should
12629 rarely need to use any of these options for ordinary compilation and
12630 linking tasks.
12632 @table @gcctabopt
12634 @item -d@var{letters}
12635 @itemx -fdump-rtl-@var{pass}
12636 @itemx -fdump-rtl-@var{pass}=@var{filename}
12637 @opindex d
12638 @opindex fdump-rtl-@var{pass}
12639 Says to make debugging dumps during compilation at times specified by
12640 @var{letters}.  This is used for debugging the RTL-based passes of the
12641 compiler.  The file names for most of the dumps are made by appending
12642 a pass number and a word to the @var{dumpname}, and the files are
12643 created in the directory of the output file.  In case of
12644 @option{=@var{filename}} option, the dump is output on the given file
12645 instead of the pass numbered dump files.  Note that the pass number is
12646 assigned as passes are registered into the pass manager.  Most passes
12647 are registered in the order that they will execute and for these passes
12648 the number corresponds to the pass execution order.  However, passes
12649 registered by plugins, passes specific to compilation targets, or
12650 passes that are otherwise registered after all the other passes are
12651 numbered higher than a pass named "final", even if they are executed
12652 earlier.  @var{dumpname} is generated from the name of the output
12653 file if explicitly specified and not an executable, otherwise it is
12654 the basename of the source file.  
12656 Some @option{-d@var{letters}} switches have different meaning when
12657 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12658 for information about preprocessor-specific dump options.
12660 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12661 @option{-d} option @var{letters}.  Here are the possible
12662 letters for use in @var{pass} and @var{letters}, and their meanings:
12664 @table @gcctabopt
12666 @item -fdump-rtl-alignments
12667 @opindex fdump-rtl-alignments
12668 Dump after branch alignments have been computed.
12670 @item -fdump-rtl-asmcons
12671 @opindex fdump-rtl-asmcons
12672 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12674 @item -fdump-rtl-auto_inc_dec
12675 @opindex fdump-rtl-auto_inc_dec
12676 Dump after auto-inc-dec discovery.  This pass is only run on
12677 architectures that have auto inc or auto dec instructions.
12679 @item -fdump-rtl-barriers
12680 @opindex fdump-rtl-barriers
12681 Dump after cleaning up the barrier instructions.
12683 @item -fdump-rtl-bbpart
12684 @opindex fdump-rtl-bbpart
12685 Dump after partitioning hot and cold basic blocks.
12687 @item -fdump-rtl-bbro
12688 @opindex fdump-rtl-bbro
12689 Dump after block reordering.
12691 @item -fdump-rtl-btl1
12692 @itemx -fdump-rtl-btl2
12693 @opindex fdump-rtl-btl2
12694 @opindex fdump-rtl-btl2
12695 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12696 after the two branch
12697 target load optimization passes.
12699 @item -fdump-rtl-bypass
12700 @opindex fdump-rtl-bypass
12701 Dump after jump bypassing and control flow optimizations.
12703 @item -fdump-rtl-combine
12704 @opindex fdump-rtl-combine
12705 Dump after the RTL instruction combination pass.
12707 @item -fdump-rtl-compgotos
12708 @opindex fdump-rtl-compgotos
12709 Dump after duplicating the computed gotos.
12711 @item -fdump-rtl-ce1
12712 @itemx -fdump-rtl-ce2
12713 @itemx -fdump-rtl-ce3
12714 @opindex fdump-rtl-ce1
12715 @opindex fdump-rtl-ce2
12716 @opindex fdump-rtl-ce3
12717 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12718 @option{-fdump-rtl-ce3} enable dumping after the three
12719 if conversion passes.
12721 @item -fdump-rtl-cprop_hardreg
12722 @opindex fdump-rtl-cprop_hardreg
12723 Dump after hard register copy propagation.
12725 @item -fdump-rtl-csa
12726 @opindex fdump-rtl-csa
12727 Dump after combining stack adjustments.
12729 @item -fdump-rtl-cse1
12730 @itemx -fdump-rtl-cse2
12731 @opindex fdump-rtl-cse1
12732 @opindex fdump-rtl-cse2
12733 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12734 the two common subexpression elimination passes.
12736 @item -fdump-rtl-dce
12737 @opindex fdump-rtl-dce
12738 Dump after the standalone dead code elimination passes.
12740 @item -fdump-rtl-dbr
12741 @opindex fdump-rtl-dbr
12742 Dump after delayed branch scheduling.
12744 @item -fdump-rtl-dce1
12745 @itemx -fdump-rtl-dce2
12746 @opindex fdump-rtl-dce1
12747 @opindex fdump-rtl-dce2
12748 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12749 the two dead store elimination passes.
12751 @item -fdump-rtl-eh
12752 @opindex fdump-rtl-eh
12753 Dump after finalization of EH handling code.
12755 @item -fdump-rtl-eh_ranges
12756 @opindex fdump-rtl-eh_ranges
12757 Dump after conversion of EH handling range regions.
12759 @item -fdump-rtl-expand
12760 @opindex fdump-rtl-expand
12761 Dump after RTL generation.
12763 @item -fdump-rtl-fwprop1
12764 @itemx -fdump-rtl-fwprop2
12765 @opindex fdump-rtl-fwprop1
12766 @opindex fdump-rtl-fwprop2
12767 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12768 dumping after the two forward propagation passes.
12770 @item -fdump-rtl-gcse1
12771 @itemx -fdump-rtl-gcse2
12772 @opindex fdump-rtl-gcse1
12773 @opindex fdump-rtl-gcse2
12774 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12775 after global common subexpression elimination.
12777 @item -fdump-rtl-init-regs
12778 @opindex fdump-rtl-init-regs
12779 Dump after the initialization of the registers.
12781 @item -fdump-rtl-initvals
12782 @opindex fdump-rtl-initvals
12783 Dump after the computation of the initial value sets.
12785 @item -fdump-rtl-into_cfglayout
12786 @opindex fdump-rtl-into_cfglayout
12787 Dump after converting to cfglayout mode.
12789 @item -fdump-rtl-ira
12790 @opindex fdump-rtl-ira
12791 Dump after iterated register allocation.
12793 @item -fdump-rtl-jump
12794 @opindex fdump-rtl-jump
12795 Dump after the second jump optimization.
12797 @item -fdump-rtl-loop2
12798 @opindex fdump-rtl-loop2
12799 @option{-fdump-rtl-loop2} enables dumping after the rtl
12800 loop optimization passes.
12802 @item -fdump-rtl-mach
12803 @opindex fdump-rtl-mach
12804 Dump after performing the machine dependent reorganization pass, if that
12805 pass exists.
12807 @item -fdump-rtl-mode_sw
12808 @opindex fdump-rtl-mode_sw
12809 Dump after removing redundant mode switches.
12811 @item -fdump-rtl-rnreg
12812 @opindex fdump-rtl-rnreg
12813 Dump after register renumbering.
12815 @item -fdump-rtl-outof_cfglayout
12816 @opindex fdump-rtl-outof_cfglayout
12817 Dump after converting from cfglayout mode.
12819 @item -fdump-rtl-peephole2
12820 @opindex fdump-rtl-peephole2
12821 Dump after the peephole pass.
12823 @item -fdump-rtl-postreload
12824 @opindex fdump-rtl-postreload
12825 Dump after post-reload optimizations.
12827 @item -fdump-rtl-pro_and_epilogue
12828 @opindex fdump-rtl-pro_and_epilogue
12829 Dump after generating the function prologues and epilogues.
12831 @item -fdump-rtl-sched1
12832 @itemx -fdump-rtl-sched2
12833 @opindex fdump-rtl-sched1
12834 @opindex fdump-rtl-sched2
12835 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12836 after the basic block scheduling passes.
12838 @item -fdump-rtl-ree
12839 @opindex fdump-rtl-ree
12840 Dump after sign/zero extension elimination.
12842 @item -fdump-rtl-seqabstr
12843 @opindex fdump-rtl-seqabstr
12844 Dump after common sequence discovery.
12846 @item -fdump-rtl-shorten
12847 @opindex fdump-rtl-shorten
12848 Dump after shortening branches.
12850 @item -fdump-rtl-sibling
12851 @opindex fdump-rtl-sibling
12852 Dump after sibling call optimizations.
12854 @item -fdump-rtl-split1
12855 @itemx -fdump-rtl-split2
12856 @itemx -fdump-rtl-split3
12857 @itemx -fdump-rtl-split4
12858 @itemx -fdump-rtl-split5
12859 @opindex fdump-rtl-split1
12860 @opindex fdump-rtl-split2
12861 @opindex fdump-rtl-split3
12862 @opindex fdump-rtl-split4
12863 @opindex fdump-rtl-split5
12864 These options enable dumping after five rounds of
12865 instruction splitting.
12867 @item -fdump-rtl-sms
12868 @opindex fdump-rtl-sms
12869 Dump after modulo scheduling.  This pass is only run on some
12870 architectures.
12872 @item -fdump-rtl-stack
12873 @opindex fdump-rtl-stack
12874 Dump after conversion from GCC's ``flat register file'' registers to the
12875 x87's stack-like registers.  This pass is only run on x86 variants.
12877 @item -fdump-rtl-subreg1
12878 @itemx -fdump-rtl-subreg2
12879 @opindex fdump-rtl-subreg1
12880 @opindex fdump-rtl-subreg2
12881 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12882 the two subreg expansion passes.
12884 @item -fdump-rtl-unshare
12885 @opindex fdump-rtl-unshare
12886 Dump after all rtl has been unshared.
12888 @item -fdump-rtl-vartrack
12889 @opindex fdump-rtl-vartrack
12890 Dump after variable tracking.
12892 @item -fdump-rtl-vregs
12893 @opindex fdump-rtl-vregs
12894 Dump after converting virtual registers to hard registers.
12896 @item -fdump-rtl-web
12897 @opindex fdump-rtl-web
12898 Dump after live range splitting.
12900 @item -fdump-rtl-regclass
12901 @itemx -fdump-rtl-subregs_of_mode_init
12902 @itemx -fdump-rtl-subregs_of_mode_finish
12903 @itemx -fdump-rtl-dfinit
12904 @itemx -fdump-rtl-dfinish
12905 @opindex fdump-rtl-regclass
12906 @opindex fdump-rtl-subregs_of_mode_init
12907 @opindex fdump-rtl-subregs_of_mode_finish
12908 @opindex fdump-rtl-dfinit
12909 @opindex fdump-rtl-dfinish
12910 These dumps are defined but always produce empty files.
12912 @item -da
12913 @itemx -fdump-rtl-all
12914 @opindex da
12915 @opindex fdump-rtl-all
12916 Produce all the dumps listed above.
12918 @item -dA
12919 @opindex dA
12920 Annotate the assembler output with miscellaneous debugging information.
12922 @item -dD
12923 @opindex dD
12924 Dump all macro definitions, at the end of preprocessing, in addition to
12925 normal output.
12927 @item -dH
12928 @opindex dH
12929 Produce a core dump whenever an error occurs.
12931 @item -dp
12932 @opindex dp
12933 Annotate the assembler output with a comment indicating which
12934 pattern and alternative is used.  The length of each instruction is
12935 also printed.
12937 @item -dP
12938 @opindex dP
12939 Dump the RTL in the assembler output as a comment before each instruction.
12940 Also turns on @option{-dp} annotation.
12942 @item -dx
12943 @opindex dx
12944 Just generate RTL for a function instead of compiling it.  Usually used
12945 with @option{-fdump-rtl-expand}.
12946 @end table
12948 @item -fdump-noaddr
12949 @opindex fdump-noaddr
12950 When doing debugging dumps, suppress address output.  This makes it more
12951 feasible to use diff on debugging dumps for compiler invocations with
12952 different compiler binaries and/or different
12953 text / bss / data / heap / stack / dso start locations.
12955 @item -freport-bug
12956 @opindex freport-bug
12957 Collect and dump debug information into a temporary file if an
12958 internal compiler error (ICE) occurs.
12960 @item -fdump-unnumbered
12961 @opindex fdump-unnumbered
12962 When doing debugging dumps, suppress instruction numbers and address output.
12963 This makes it more feasible to use diff on debugging dumps for compiler
12964 invocations with different options, in particular with and without
12965 @option{-g}.
12967 @item -fdump-unnumbered-links
12968 @opindex fdump-unnumbered-links
12969 When doing debugging dumps (see @option{-d} option above), suppress
12970 instruction numbers for the links to the previous and next instructions
12971 in a sequence.
12973 @item -fdump-translation-unit @r{(C++ only)}
12974 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
12975 @opindex fdump-translation-unit
12976 Dump a representation of the tree structure for the entire translation
12977 unit to a file.  The file name is made by appending @file{.tu} to the
12978 source file name, and the file is created in the same directory as the
12979 output file.  If the @samp{-@var{options}} form is used, @var{options}
12980 controls the details of the dump as described for the
12981 @option{-fdump-tree} options.
12983 @item -fdump-class-hierarchy @r{(C++ only)}
12984 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
12985 @opindex fdump-class-hierarchy
12986 Dump a representation of each class's hierarchy and virtual function
12987 table layout to a file.  The file name is made by appending
12988 @file{.class} to the source file name, and the file is created in the
12989 same directory as the output file.  If the @samp{-@var{options}} form
12990 is used, @var{options} controls the details of the dump as described
12991 for the @option{-fdump-tree} options.
12993 @item -fdump-ipa-@var{switch}
12994 @opindex fdump-ipa
12995 Control the dumping at various stages of inter-procedural analysis
12996 language tree to a file.  The file name is generated by appending a
12997 switch specific suffix to the source file name, and the file is created
12998 in the same directory as the output file.  The following dumps are
12999 possible:
13001 @table @samp
13002 @item all
13003 Enables all inter-procedural analysis dumps.
13005 @item cgraph
13006 Dumps information about call-graph optimization, unused function removal,
13007 and inlining decisions.
13009 @item inline
13010 Dump after function inlining.
13012 @end table
13014 @item -fdump-passes
13015 @opindex fdump-passes
13016 Print on @file{stderr} the list of optimization passes that are turned
13017 on and off by the current command-line options.
13019 @item -fdump-statistics-@var{option}
13020 @opindex fdump-statistics
13021 Enable and control dumping of pass statistics in a separate file.  The
13022 file name is generated by appending a suffix ending in
13023 @samp{.statistics} to the source file name, and the file is created in
13024 the same directory as the output file.  If the @samp{-@var{option}}
13025 form is used, @samp{-stats} causes counters to be summed over the
13026 whole compilation unit while @samp{-details} dumps every event as
13027 the passes generate them.  The default with no option is to sum
13028 counters for each function compiled.
13030 @item -fdump-tree-all
13031 @itemx -fdump-tree-@var{switch}
13032 @itemx -fdump-tree-@var{switch}-@var{options}
13033 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13034 @opindex fdump-tree-all
13035 @opindex fdump-tree
13036 Control the dumping at various stages of processing the intermediate
13037 language tree to a file.  The file name is generated by appending a
13038 switch-specific suffix to the source file name, and the file is
13039 created in the same directory as the output file. In case of
13040 @option{=@var{filename}} option, the dump is output on the given file
13041 instead of the auto named dump files.  If the @samp{-@var{options}}
13042 form is used, @var{options} is a list of @samp{-} separated options
13043 which control the details of the dump.  Not all options are applicable
13044 to all dumps; those that are not meaningful are ignored.  The
13045 following options are available
13047 @table @samp
13048 @item address
13049 Print the address of each node.  Usually this is not meaningful as it
13050 changes according to the environment and source file.  Its primary use
13051 is for tying up a dump file with a debug environment.
13052 @item asmname
13053 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13054 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13055 use working backward from mangled names in the assembly file.
13056 @item slim
13057 When dumping front-end intermediate representations, inhibit dumping
13058 of members of a scope or body of a function merely because that scope
13059 has been reached.  Only dump such items when they are directly reachable
13060 by some other path.
13062 When dumping pretty-printed trees, this option inhibits dumping the
13063 bodies of control structures.
13065 When dumping RTL, print the RTL in slim (condensed) form instead of
13066 the default LISP-like representation.
13067 @item raw
13068 Print a raw representation of the tree.  By default, trees are
13069 pretty-printed into a C-like representation.
13070 @item details
13071 Enable more detailed dumps (not honored by every dump option). Also
13072 include information from the optimization passes.
13073 @item stats
13074 Enable dumping various statistics about the pass (not honored by every dump
13075 option).
13076 @item blocks
13077 Enable showing basic block boundaries (disabled in raw dumps).
13078 @item graph
13079 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13080 dump a representation of the control flow graph suitable for viewing with
13081 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13082 the file is pretty-printed as a subgraph, so that GraphViz can render them
13083 all in a single plot.
13085 This option currently only works for RTL dumps, and the RTL is always
13086 dumped in slim form.
13087 @item vops
13088 Enable showing virtual operands for every statement.
13089 @item lineno
13090 Enable showing line numbers for statements.
13091 @item uid
13092 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13093 @item verbose
13094 Enable showing the tree dump for each statement.
13095 @item eh
13096 Enable showing the EH region number holding each statement.
13097 @item scev
13098 Enable showing scalar evolution analysis details.
13099 @item optimized
13100 Enable showing optimization information (only available in certain
13101 passes).
13102 @item missed
13103 Enable showing missed optimization information (only available in certain
13104 passes).
13105 @item note
13106 Enable other detailed optimization information (only available in
13107 certain passes).
13108 @item =@var{filename}
13109 Instead of an auto named dump file, output into the given file
13110 name. The file names @file{stdout} and @file{stderr} are treated
13111 specially and are considered already open standard streams. For
13112 example,
13114 @smallexample
13115 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13116      -fdump-tree-pre=/dev/stderr file.c
13117 @end smallexample
13119 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13120 output on to @file{stderr}. If two conflicting dump filenames are
13121 given for the same pass, then the latter option overrides the earlier
13122 one.
13124 @item all
13125 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13126 and @option{lineno}.
13128 @item optall
13129 Turn on all optimization options, i.e., @option{optimized},
13130 @option{missed}, and @option{note}.
13131 @end table
13133 To determine what tree dumps are available or find the dump for a pass
13134 of interest follow the steps below.
13136 @enumerate
13137 @item
13138 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13139 look for a code that corresponds to the pass you are interested in.
13140 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13141 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13142 The number at the end distinguishes distinct invocations of the same pass.
13143 @item
13144 To enable the creation of the dump file, append the pass code to
13145 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13146 to enable the dump from the Early Value Range Propagation pass, invoke
13147 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13148 specify the name of the dump file.  If you don't specify one, GCC
13149 creates as described below.
13150 @item
13151 Find the pass dump in a file whose name is composed of three components
13152 separated by a period: the name of the source file GCC was invoked to
13153 compile, a numeric suffix indicating the pass number followed by the
13154 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13155 and finally the pass code.  For example, the Early VRP pass dump might
13156 be in a file named @file{myfile.c.038t.evrp} in the current working
13157 directory.  Note that the numeric codes are not stable and may change
13158 from one version of GCC to another.
13159 @end enumerate
13161 @item -fopt-info
13162 @itemx -fopt-info-@var{options}
13163 @itemx -fopt-info-@var{options}=@var{filename}
13164 @opindex fopt-info
13165 Controls optimization dumps from various optimization passes. If the
13166 @samp{-@var{options}} form is used, @var{options} is a list of
13167 @samp{-} separated option keywords to select the dump details and
13168 optimizations.  
13170 The @var{options} can be divided into two groups: options describing the
13171 verbosity of the dump, and options describing which optimizations
13172 should be included. The options from both the groups can be freely
13173 mixed as they are non-overlapping. However, in case of any conflicts,
13174 the later options override the earlier options on the command
13175 line. 
13177 The following options control the dump verbosity:
13179 @table @samp
13180 @item optimized
13181 Print information when an optimization is successfully applied. It is
13182 up to a pass to decide which information is relevant. For example, the
13183 vectorizer passes print the source location of loops which are
13184 successfully vectorized.
13185 @item missed
13186 Print information about missed optimizations. Individual passes
13187 control which information to include in the output. 
13188 @item note
13189 Print verbose information about optimizations, such as certain
13190 transformations, more detailed messages about decisions etc.
13191 @item all
13192 Print detailed optimization information. This includes
13193 @samp{optimized}, @samp{missed}, and @samp{note}.
13194 @end table
13196 One or more of the following option keywords can be used to describe a
13197 group of optimizations:
13199 @table @samp
13200 @item ipa
13201 Enable dumps from all interprocedural optimizations.
13202 @item loop
13203 Enable dumps from all loop optimizations.
13204 @item inline
13205 Enable dumps from all inlining optimizations.
13206 @item omp
13207 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13208 @item vec
13209 Enable dumps from all vectorization optimizations.
13210 @item optall
13211 Enable dumps from all optimizations. This is a superset of
13212 the optimization groups listed above.
13213 @end table
13215 If @var{options} is
13216 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13217 info about successful optimizations from all the passes.  
13219 If the @var{filename} is provided, then the dumps from all the
13220 applicable optimizations are concatenated into the @var{filename}.
13221 Otherwise the dump is output onto @file{stderr}. Though multiple
13222 @option{-fopt-info} options are accepted, only one of them can include
13223 a @var{filename}. If other filenames are provided then all but the
13224 first such option are ignored.
13226 Note that the output @var{filename} is overwritten
13227 in case of multiple translation units. If a combined output from
13228 multiple translation units is desired, @file{stderr} should be used
13229 instead.
13231 In the following example, the optimization info is output to
13232 @file{stderr}:
13234 @smallexample
13235 gcc -O3 -fopt-info
13236 @end smallexample
13238 This example:
13239 @smallexample
13240 gcc -O3 -fopt-info-missed=missed.all
13241 @end smallexample
13243 @noindent
13244 outputs missed optimization report from all the passes into
13245 @file{missed.all}, and this one:
13247 @smallexample
13248 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13249 @end smallexample
13251 @noindent
13252 prints information about missed optimization opportunities from
13253 vectorization passes on @file{stderr}.  
13254 Note that @option{-fopt-info-vec-missed} is equivalent to 
13255 @option{-fopt-info-missed-vec}.
13257 As another example,
13258 @smallexample
13259 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13260 @end smallexample
13262 @noindent
13263 outputs information about missed optimizations as well as
13264 optimized locations from all the inlining passes into
13265 @file{inline.txt}.
13267 Finally, consider:
13269 @smallexample
13270 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13271 @end smallexample
13273 @noindent
13274 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13275 in conflict since only one output file is allowed. In this case, only
13276 the first option takes effect and the subsequent options are
13277 ignored. Thus only @file{vec.miss} is produced which contains
13278 dumps from the vectorizer about missed opportunities.
13280 @item -fsched-verbose=@var{n}
13281 @opindex fsched-verbose
13282 On targets that use instruction scheduling, this option controls the
13283 amount of debugging output the scheduler prints to the dump files.
13285 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13286 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13287 For @var{n} greater than one, it also output basic block probabilities,
13288 detailed ready list information and unit/insn info.  For @var{n} greater
13289 than two, it includes RTL at abort point, control-flow and regions info.
13290 And for @var{n} over four, @option{-fsched-verbose} also includes
13291 dependence info.
13295 @item -fenable-@var{kind}-@var{pass}
13296 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13297 @opindex fdisable-
13298 @opindex fenable-
13300 This is a set of options that are used to explicitly disable/enable
13301 optimization passes.  These options are intended for use for debugging GCC.
13302 Compiler users should use regular options for enabling/disabling
13303 passes instead.
13305 @table @gcctabopt
13307 @item -fdisable-ipa-@var{pass}
13308 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13309 statically invoked in the compiler multiple times, the pass name should be
13310 appended with a sequential number starting from 1.
13312 @item -fdisable-rtl-@var{pass}
13313 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13314 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13315 statically invoked in the compiler multiple times, the pass name should be
13316 appended with a sequential number starting from 1.  @var{range-list} is a 
13317 comma-separated list of function ranges or assembler names.  Each range is a number
13318 pair separated by a colon.  The range is inclusive in both ends.  If the range
13319 is trivial, the number pair can be simplified as a single number.  If the
13320 function's call graph node's @var{uid} falls within one of the specified ranges,
13321 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13322 function header of a dump file, and the pass names can be dumped by using
13323 option @option{-fdump-passes}.
13325 @item -fdisable-tree-@var{pass}
13326 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13327 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13328 option arguments.
13330 @item -fenable-ipa-@var{pass}
13331 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13332 statically invoked in the compiler multiple times, the pass name should be
13333 appended with a sequential number starting from 1.
13335 @item -fenable-rtl-@var{pass}
13336 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13337 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13338 description and examples.
13340 @item -fenable-tree-@var{pass}
13341 @itemx -fenable-tree-@var{pass}=@var{range-list}
13342 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13343 of option arguments.
13345 @end table
13347 Here are some examples showing uses of these options.
13349 @smallexample
13351 # disable ccp1 for all functions
13352    -fdisable-tree-ccp1
13353 # disable complete unroll for function whose cgraph node uid is 1
13354    -fenable-tree-cunroll=1
13355 # disable gcse2 for functions at the following ranges [1,1],
13356 # [300,400], and [400,1000]
13357 # disable gcse2 for functions foo and foo2
13358    -fdisable-rtl-gcse2=foo,foo2
13359 # disable early inlining
13360    -fdisable-tree-einline
13361 # disable ipa inlining
13362    -fdisable-ipa-inline
13363 # enable tree full unroll
13364    -fenable-tree-unroll
13366 @end smallexample
13368 @item -fchecking
13369 @itemx -fchecking=@var{n}
13370 @opindex fchecking
13371 @opindex fno-checking
13372 Enable internal consistency checking.  The default depends on
13373 the compiler configuration.  @option{-fchecking=2} enables further
13374 internal consistency checking that might affect code generation.
13376 @item -frandom-seed=@var{string}
13377 @opindex frandom-seed
13378 This option provides a seed that GCC uses in place of
13379 random numbers in generating certain symbol names
13380 that have to be different in every compiled file.  It is also used to
13381 place unique stamps in coverage data files and the object files that
13382 produce them.  You can use the @option{-frandom-seed} option to produce
13383 reproducibly identical object files.
13385 The @var{string} can either be a number (decimal, octal or hex) or an
13386 arbitrary string (in which case it's converted to a number by
13387 computing CRC32).
13389 The @var{string} should be different for every file you compile.
13391 @item -save-temps
13392 @itemx -save-temps=cwd
13393 @opindex save-temps
13394 Store the usual ``temporary'' intermediate files permanently; place them
13395 in the current directory and name them based on the source file.  Thus,
13396 compiling @file{foo.c} with @option{-c -save-temps} produces files
13397 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13398 preprocessed @file{foo.i} output file even though the compiler now
13399 normally uses an integrated preprocessor.
13401 When used in combination with the @option{-x} command-line option,
13402 @option{-save-temps} is sensible enough to avoid over writing an
13403 input source file with the same extension as an intermediate file.
13404 The corresponding intermediate file may be obtained by renaming the
13405 source file before using @option{-save-temps}.
13407 If you invoke GCC in parallel, compiling several different source
13408 files that share a common base name in different subdirectories or the
13409 same source file compiled for multiple output destinations, it is
13410 likely that the different parallel compilers will interfere with each
13411 other, and overwrite the temporary files.  For instance:
13413 @smallexample
13414 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13415 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13416 @end smallexample
13418 may result in @file{foo.i} and @file{foo.o} being written to
13419 simultaneously by both compilers.
13421 @item -save-temps=obj
13422 @opindex save-temps=obj
13423 Store the usual ``temporary'' intermediate files permanently.  If the
13424 @option{-o} option is used, the temporary files are based on the
13425 object file.  If the @option{-o} option is not used, the
13426 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13428 For example:
13430 @smallexample
13431 gcc -save-temps=obj -c foo.c
13432 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13433 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13434 @end smallexample
13436 @noindent
13437 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13438 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13439 @file{dir2/yfoobar.o}.
13441 @item -time@r{[}=@var{file}@r{]}
13442 @opindex time
13443 Report the CPU time taken by each subprocess in the compilation
13444 sequence.  For C source files, this is the compiler proper and assembler
13445 (plus the linker if linking is done).
13447 Without the specification of an output file, the output looks like this:
13449 @smallexample
13450 # cc1 0.12 0.01
13451 # as 0.00 0.01
13452 @end smallexample
13454 The first number on each line is the ``user time'', that is time spent
13455 executing the program itself.  The second number is ``system time'',
13456 time spent executing operating system routines on behalf of the program.
13457 Both numbers are in seconds.
13459 With the specification of an output file, the output is appended to the
13460 named file, and it looks like this:
13462 @smallexample
13463 0.12 0.01 cc1 @var{options}
13464 0.00 0.01 as @var{options}
13465 @end smallexample
13467 The ``user time'' and the ``system time'' are moved before the program
13468 name, and the options passed to the program are displayed, so that one
13469 can later tell what file was being compiled, and with which options.
13471 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13472 @opindex fdump-final-insns
13473 Dump the final internal representation (RTL) to @var{file}.  If the
13474 optional argument is omitted (or if @var{file} is @code{.}), the name
13475 of the dump file is determined by appending @code{.gkd} to the
13476 compilation output file name.
13478 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13479 @opindex fcompare-debug
13480 @opindex fno-compare-debug
13481 If no error occurs during compilation, run the compiler a second time,
13482 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13483 passed to the second compilation.  Dump the final internal
13484 representation in both compilations, and print an error if they differ.
13486 If the equal sign is omitted, the default @option{-gtoggle} is used.
13488 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13489 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13490 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13491 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13492 is used.
13494 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13495 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13496 of the final representation and the second compilation, preventing even
13497 @env{GCC_COMPARE_DEBUG} from taking effect.
13499 To verify full coverage during @option{-fcompare-debug} testing, set
13500 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13501 which GCC rejects as an invalid option in any actual compilation
13502 (rather than preprocessing, assembly or linking).  To get just a
13503 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13504 not overridden} will do.
13506 @item -fcompare-debug-second
13507 @opindex fcompare-debug-second
13508 This option is implicitly passed to the compiler for the second
13509 compilation requested by @option{-fcompare-debug}, along with options to
13510 silence warnings, and omitting other options that would cause
13511 side-effect compiler outputs to files or to the standard output.  Dump
13512 files and preserved temporary files are renamed so as to contain the
13513 @code{.gk} additional extension during the second compilation, to avoid
13514 overwriting those generated by the first.
13516 When this option is passed to the compiler driver, it causes the
13517 @emph{first} compilation to be skipped, which makes it useful for little
13518 other than debugging the compiler proper.
13520 @item -gtoggle
13521 @opindex gtoggle
13522 Turn off generation of debug info, if leaving out this option
13523 generates it, or turn it on at level 2 otherwise.  The position of this
13524 argument in the command line does not matter; it takes effect after all
13525 other options are processed, and it does so only once, no matter how
13526 many times it is given.  This is mainly intended to be used with
13527 @option{-fcompare-debug}.
13529 @item -fvar-tracking-assignments-toggle
13530 @opindex fvar-tracking-assignments-toggle
13531 @opindex fno-var-tracking-assignments-toggle
13532 Toggle @option{-fvar-tracking-assignments}, in the same way that
13533 @option{-gtoggle} toggles @option{-g}.
13535 @item -Q
13536 @opindex Q
13537 Makes the compiler print out each function name as it is compiled, and
13538 print some statistics about each pass when it finishes.
13540 @item -ftime-report
13541 @opindex ftime-report
13542 Makes the compiler print some statistics about the time consumed by each
13543 pass when it finishes.
13545 @item -ftime-report-details
13546 @opindex ftime-report-details
13547 Record the time consumed by infrastructure parts separately for each pass.
13549 @item -fira-verbose=@var{n}
13550 @opindex fira-verbose
13551 Control the verbosity of the dump file for the integrated register allocator.
13552 The default value is 5.  If the value @var{n} is greater or equal to 10,
13553 the dump output is sent to stderr using the same format as @var{n} minus 10.
13555 @item -flto-report
13556 @opindex flto-report
13557 Prints a report with internal details on the workings of the link-time
13558 optimizer.  The contents of this report vary from version to version.
13559 It is meant to be useful to GCC developers when processing object
13560 files in LTO mode (via @option{-flto}).
13562 Disabled by default.
13564 @item -flto-report-wpa
13565 @opindex flto-report-wpa
13566 Like @option{-flto-report}, but only print for the WPA phase of Link
13567 Time Optimization.
13569 @item -fmem-report
13570 @opindex fmem-report
13571 Makes the compiler print some statistics about permanent memory
13572 allocation when it finishes.
13574 @item -fmem-report-wpa
13575 @opindex fmem-report-wpa
13576 Makes the compiler print some statistics about permanent memory
13577 allocation for the WPA phase only.
13579 @item -fpre-ipa-mem-report
13580 @opindex fpre-ipa-mem-report
13581 @item -fpost-ipa-mem-report
13582 @opindex fpost-ipa-mem-report
13583 Makes the compiler print some statistics about permanent memory
13584 allocation before or after interprocedural optimization.
13586 @item -fprofile-report
13587 @opindex fprofile-report
13588 Makes the compiler print some statistics about consistency of the
13589 (estimated) profile and effect of individual passes.
13591 @item -fstack-usage
13592 @opindex fstack-usage
13593 Makes the compiler output stack usage information for the program, on a
13594 per-function basis.  The filename for the dump is made by appending
13595 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13596 the output file, if explicitly specified and it is not an executable,
13597 otherwise it is the basename of the source file.  An entry is made up
13598 of three fields:
13600 @itemize
13601 @item
13602 The name of the function.
13603 @item
13604 A number of bytes.
13605 @item
13606 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13607 @end itemize
13609 The qualifier @code{static} means that the function manipulates the stack
13610 statically: a fixed number of bytes are allocated for the frame on function
13611 entry and released on function exit; no stack adjustments are otherwise made
13612 in the function.  The second field is this fixed number of bytes.
13614 The qualifier @code{dynamic} means that the function manipulates the stack
13615 dynamically: in addition to the static allocation described above, stack
13616 adjustments are made in the body of the function, for example to push/pop
13617 arguments around function calls.  If the qualifier @code{bounded} is also
13618 present, the amount of these adjustments is bounded at compile time and
13619 the second field is an upper bound of the total amount of stack used by
13620 the function.  If it is not present, the amount of these adjustments is
13621 not bounded at compile time and the second field only represents the
13622 bounded part.
13624 @item -fstats
13625 @opindex fstats
13626 Emit statistics about front-end processing at the end of the compilation.
13627 This option is supported only by the C++ front end, and
13628 the information is generally only useful to the G++ development team.
13630 @item -fdbg-cnt-list
13631 @opindex fdbg-cnt-list
13632 Print the name and the counter upper bound for all debug counters.
13635 @item -fdbg-cnt=@var{counter-value-list}
13636 @opindex fdbg-cnt
13637 Set the internal debug counter upper bound.  @var{counter-value-list}
13638 is a comma-separated list of @var{name}:@var{value} pairs
13639 which sets the upper bound of each debug counter @var{name} to @var{value}.
13640 All debug counters have the initial upper bound of @code{UINT_MAX};
13641 thus @code{dbg_cnt} returns true always unless the upper bound
13642 is set by this option.
13643 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13644 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13646 @item -print-file-name=@var{library}
13647 @opindex print-file-name
13648 Print the full absolute name of the library file @var{library} that
13649 would be used when linking---and don't do anything else.  With this
13650 option, GCC does not compile or link anything; it just prints the
13651 file name.
13653 @item -print-multi-directory
13654 @opindex print-multi-directory
13655 Print the directory name corresponding to the multilib selected by any
13656 other switches present in the command line.  This directory is supposed
13657 to exist in @env{GCC_EXEC_PREFIX}.
13659 @item -print-multi-lib
13660 @opindex print-multi-lib
13661 Print the mapping from multilib directory names to compiler switches
13662 that enable them.  The directory name is separated from the switches by
13663 @samp{;}, and each switch starts with an @samp{@@} instead of the
13664 @samp{-}, without spaces between multiple switches.  This is supposed to
13665 ease shell processing.
13667 @item -print-multi-os-directory
13668 @opindex print-multi-os-directory
13669 Print the path to OS libraries for the selected
13670 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13671 present in the @file{lib} subdirectory and no multilibs are used, this is
13672 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13673 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13674 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13675 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13677 @item -print-multiarch
13678 @opindex print-multiarch
13679 Print the path to OS libraries for the selected multiarch,
13680 relative to some @file{lib} subdirectory.
13682 @item -print-prog-name=@var{program}
13683 @opindex print-prog-name
13684 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13686 @item -print-libgcc-file-name
13687 @opindex print-libgcc-file-name
13688 Same as @option{-print-file-name=libgcc.a}.
13690 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13691 but you do want to link with @file{libgcc.a}.  You can do:
13693 @smallexample
13694 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13695 @end smallexample
13697 @item -print-search-dirs
13698 @opindex print-search-dirs
13699 Print the name of the configured installation directory and a list of
13700 program and library directories @command{gcc} searches---and don't do anything else.
13702 This is useful when @command{gcc} prints the error message
13703 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13704 To resolve this you either need to put @file{cpp0} and the other compiler
13705 components where @command{gcc} expects to find them, or you can set the environment
13706 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13707 Don't forget the trailing @samp{/}.
13708 @xref{Environment Variables}.
13710 @item -print-sysroot
13711 @opindex print-sysroot
13712 Print the target sysroot directory that is used during
13713 compilation.  This is the target sysroot specified either at configure
13714 time or using the @option{--sysroot} option, possibly with an extra
13715 suffix that depends on compilation options.  If no target sysroot is
13716 specified, the option prints nothing.
13718 @item -print-sysroot-headers-suffix
13719 @opindex print-sysroot-headers-suffix
13720 Print the suffix added to the target sysroot when searching for
13721 headers, or give an error if the compiler is not configured with such
13722 a suffix---and don't do anything else.
13724 @item -dumpmachine
13725 @opindex dumpmachine
13726 Print the compiler's target machine (for example,
13727 @samp{i686-pc-linux-gnu})---and don't do anything else.
13729 @item -dumpversion
13730 @opindex dumpversion
13731 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13732 anything else.  This is the compiler version used in filesystem paths,
13733 specs, can be depending on how the compiler has been configured just
13734 a single number (major version), two numbers separated by dot (major and
13735 minor version) or three numbers separated by dots (major, minor and patchlevel
13736 version).
13738 @item -dumpfullversion
13739 @opindex dumpfullversion
13740 Print the full compiler version, always 3 numbers separated by dots,
13741 major, minor and patchlevel version.
13743 @item -dumpspecs
13744 @opindex dumpspecs
13745 Print the compiler's built-in specs---and don't do anything else.  (This
13746 is used when GCC itself is being built.)  @xref{Spec Files}.
13747 @end table
13749 @node Submodel Options
13750 @section Machine-Dependent Options
13751 @cindex submodel options
13752 @cindex specifying hardware config
13753 @cindex hardware models and configurations, specifying
13754 @cindex target-dependent options
13755 @cindex machine-dependent options
13757 Each target machine supported by GCC can have its own options---for
13758 example, to allow you to compile for a particular processor variant or
13759 ABI, or to control optimizations specific to that machine.  By
13760 convention, the names of machine-specific options start with
13761 @samp{-m}.
13763 Some configurations of the compiler also support additional target-specific
13764 options, usually for compatibility with other compilers on the same
13765 platform.
13767 @c This list is ordered alphanumerically by subsection name.
13768 @c It should be the same order and spelling as these options are listed
13769 @c in Machine Dependent Options
13771 @menu
13772 * AArch64 Options::
13773 * Adapteva Epiphany Options::
13774 * ARC Options::
13775 * ARM Options::
13776 * AVR Options::
13777 * Blackfin Options::
13778 * C6X Options::
13779 * CRIS Options::
13780 * CR16 Options::
13781 * Darwin Options::
13782 * DEC Alpha Options::
13783 * FR30 Options::
13784 * FT32 Options::
13785 * FRV Options::
13786 * GNU/Linux Options::
13787 * H8/300 Options::
13788 * HPPA Options::
13789 * IA-64 Options::
13790 * LM32 Options::
13791 * M32C Options::
13792 * M32R/D Options::
13793 * M680x0 Options::
13794 * MCore Options::
13795 * MeP Options::
13796 * MicroBlaze Options::
13797 * MIPS Options::
13798 * MMIX Options::
13799 * MN10300 Options::
13800 * Moxie Options::
13801 * MSP430 Options::
13802 * NDS32 Options::
13803 * Nios II Options::
13804 * Nvidia PTX Options::
13805 * PDP-11 Options::
13806 * picoChip Options::
13807 * PowerPC Options::
13808 * RISC-V Options::
13809 * RL78 Options::
13810 * RS/6000 and PowerPC Options::
13811 * RX Options::
13812 * S/390 and zSeries Options::
13813 * Score Options::
13814 * SH Options::
13815 * Solaris 2 Options::
13816 * SPARC Options::
13817 * SPU Options::
13818 * System V Options::
13819 * TILE-Gx Options::
13820 * TILEPro Options::
13821 * V850 Options::
13822 * VAX Options::
13823 * Visium Options::
13824 * VMS Options::
13825 * VxWorks Options::
13826 * x86 Options::
13827 * x86 Windows Options::
13828 * Xstormy16 Options::
13829 * Xtensa Options::
13830 * zSeries Options::
13831 @end menu
13833 @node AArch64 Options
13834 @subsection AArch64 Options
13835 @cindex AArch64 Options
13837 These options are defined for AArch64 implementations:
13839 @table @gcctabopt
13841 @item -mabi=@var{name}
13842 @opindex mabi
13843 Generate code for the specified data model.  Permissible values
13844 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13845 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13846 but long int and pointers are 64 bits.
13848 The default depends on the specific target configuration.  Note that
13849 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13850 entire program with the same ABI, and link with a compatible set of libraries.
13852 @item -mbig-endian
13853 @opindex mbig-endian
13854 Generate big-endian code.  This is the default when GCC is configured for an
13855 @samp{aarch64_be-*-*} target.
13857 @item -mgeneral-regs-only
13858 @opindex mgeneral-regs-only
13859 Generate code which uses only the general-purpose registers.  This will prevent
13860 the compiler from using floating-point and Advanced SIMD registers but will not
13861 impose any restrictions on the assembler.
13863 @item -mlittle-endian
13864 @opindex mlittle-endian
13865 Generate little-endian code.  This is the default when GCC is configured for an
13866 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13868 @item -mcmodel=tiny
13869 @opindex mcmodel=tiny
13870 Generate code for the tiny code model.  The program and its statically defined
13871 symbols must be within 1MB of each other.  Programs can be statically or
13872 dynamically linked.
13874 @item -mcmodel=small
13875 @opindex mcmodel=small
13876 Generate code for the small code model.  The program and its statically defined
13877 symbols must be within 4GB of each other.  Programs can be statically or
13878 dynamically linked.  This is the default code model.
13880 @item -mcmodel=large
13881 @opindex mcmodel=large
13882 Generate code for the large code model.  This makes no assumptions about
13883 addresses and sizes of sections.  Programs can be statically linked only.
13885 @item -mstrict-align
13886 @opindex mstrict-align
13887 Avoid generating memory accesses that may not be aligned on a natural object
13888 boundary as described in the architecture specification.
13890 @item -momit-leaf-frame-pointer
13891 @itemx -mno-omit-leaf-frame-pointer
13892 @opindex momit-leaf-frame-pointer
13893 @opindex mno-omit-leaf-frame-pointer
13894 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13895 default.
13897 @item -mtls-dialect=desc
13898 @opindex mtls-dialect=desc
13899 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13900 of TLS variables.  This is the default.
13902 @item -mtls-dialect=traditional
13903 @opindex mtls-dialect=traditional
13904 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13905 of TLS variables.
13907 @item -mtls-size=@var{size}
13908 @opindex mtls-size
13909 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13910 This option requires binutils 2.26 or newer.
13912 @item -mfix-cortex-a53-835769
13913 @itemx -mno-fix-cortex-a53-835769
13914 @opindex mfix-cortex-a53-835769
13915 @opindex mno-fix-cortex-a53-835769
13916 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13917 This involves inserting a NOP instruction between memory instructions and
13918 64-bit integer multiply-accumulate instructions.
13920 @item -mfix-cortex-a53-843419
13921 @itemx -mno-fix-cortex-a53-843419
13922 @opindex mfix-cortex-a53-843419
13923 @opindex mno-fix-cortex-a53-843419
13924 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
13925 This erratum workaround is made at link time and this will only pass the
13926 corresponding flag to the linker.
13928 @item -mlow-precision-recip-sqrt
13929 @item -mno-low-precision-recip-sqrt
13930 @opindex mlow-precision-recip-sqrt
13931 @opindex mno-low-precision-recip-sqrt
13932 Enable or disable the reciprocal square root approximation.
13933 This option only has an effect if @option{-ffast-math} or
13934 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13935 precision of reciprocal square root results to about 16 bits for
13936 single precision and to 32 bits for double precision.
13938 @item -mlow-precision-sqrt
13939 @item -mno-low-precision-sqrt
13940 @opindex -mlow-precision-sqrt
13941 @opindex -mno-low-precision-sqrt
13942 Enable or disable the square root approximation.
13943 This option only has an effect if @option{-ffast-math} or
13944 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13945 precision of square root results to about 16 bits for
13946 single precision and to 32 bits for double precision.
13947 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
13949 @item -mlow-precision-div
13950 @item -mno-low-precision-div
13951 @opindex -mlow-precision-div
13952 @opindex -mno-low-precision-div
13953 Enable or disable the division approximation.
13954 This option only has an effect if @option{-ffast-math} or
13955 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
13956 precision of division results to about 16 bits for
13957 single precision and to 32 bits for double precision.
13959 @item -march=@var{name}
13960 @opindex march
13961 Specify the name of the target architecture and, optionally, one or
13962 more feature modifiers.  This option has the form
13963 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
13965 The permissible values for @var{arch} are @samp{armv8-a},
13966 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
13968 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
13969 support for the ARMv8.3-A architecture extensions.
13971 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
13972 support for the ARMv8.2-A architecture extensions.
13974 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
13975 support for the ARMv8.1-A architecture extension.  In particular, it
13976 enables the @samp{+crc} and @samp{+lse} features.
13978 The value @samp{native} is available on native AArch64 GNU/Linux and
13979 causes the compiler to pick the architecture of the host system.  This
13980 option has no effect if the compiler is unable to recognize the
13981 architecture of the host system,
13983 The permissible values for @var{feature} are listed in the sub-section
13984 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
13985 Feature Modifiers}.  Where conflicting feature modifiers are
13986 specified, the right-most feature is used.
13988 GCC uses @var{name} to determine what kind of instructions it can emit
13989 when generating assembly code.  If @option{-march} is specified
13990 without either of @option{-mtune} or @option{-mcpu} also being
13991 specified, the code is tuned to perform well across a range of target
13992 processors implementing the target architecture.
13994 @item -mtune=@var{name}
13995 @opindex mtune
13996 Specify the name of the target processor for which GCC should tune the
13997 performance of the code.  Permissible values for this option are:
13998 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
13999 @samp{cortex-a72}, @samp{cortex-a73}, @samp{exynos-m1}, @samp{falkor},
14000 @samp{qdf24xx}, @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14001 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14002 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14003 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14004 @samp{cortex-a73.cortex-a53}, @samp{native}.
14006 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14007 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}
14008 specify that GCC should tune for a big.LITTLE system.
14010 Additionally on native AArch64 GNU/Linux systems the value
14011 @samp{native} tunes performance to the host system.  This option has no effect
14012 if the compiler is unable to recognize the processor of the host system.
14014 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14015 are specified, the code is tuned to perform well across a range
14016 of target processors.
14018 This option cannot be suffixed by feature modifiers.
14020 @item -mcpu=@var{name}
14021 @opindex mcpu
14022 Specify the name of the target processor, optionally suffixed by one
14023 or more feature modifiers.  This option has the form
14024 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14025 the permissible values for @var{cpu} are the same as those available
14026 for @option{-mtune}.  The permissible values for @var{feature} are
14027 documented in the sub-section on
14028 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14029 Feature Modifiers}.  Where conflicting feature modifiers are
14030 specified, the right-most feature is used.
14032 GCC uses @var{name} to determine what kind of instructions it can emit when
14033 generating assembly code (as if by @option{-march}) and to determine
14034 the target processor for which to tune for performance (as if
14035 by @option{-mtune}).  Where this option is used in conjunction
14036 with @option{-march} or @option{-mtune}, those options take precedence
14037 over the appropriate part of this option.
14039 @item -moverride=@var{string}
14040 @opindex moverride
14041 Override tuning decisions made by the back-end in response to a
14042 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14043 for @var{string} in this option are not guaranteed to be consistent
14044 across releases.
14046 This option is only intended to be useful when developing GCC.
14048 @item -mpc-relative-literal-loads
14049 @opindex mpc-relative-literal-loads
14050 Enable PC-relative literal loads.  With this option literal pools are
14051 accessed using a single instruction and emitted after each function.  This
14052 limits the maximum size of functions to 1MB.  This is enabled by default for
14053 @option{-mcmodel=tiny}.
14055 @item -msign-return-address=@var{scope}
14056 @opindex msign-return-address
14057 Select the function scope on which return address signing will be applied.
14058 Permissible values are @samp{none}, which disables return address signing,
14059 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14060 functions, and @samp{all}, which enables pointer signing for all functions.  The
14061 default value is @samp{none}.
14063 @end table
14065 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14066 @anchor{aarch64-feature-modifiers}
14067 @cindex @option{-march} feature modifiers
14068 @cindex @option{-mcpu} feature modifiers
14069 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14070 the following and their inverses @option{no@var{feature}}:
14072 @table @samp
14073 @item crc
14074 Enable CRC extension.  This is on by default for
14075 @option{-march=armv8.1-a}.
14076 @item crypto
14077 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14078 instructions.
14079 @item fp
14080 Enable floating-point instructions.  This is on by default for all possible
14081 values for options @option{-march} and @option{-mcpu}.
14082 @item simd
14083 Enable Advanced SIMD instructions.  This also enables floating-point
14084 instructions.  This is on by default for all possible values for options
14085 @option{-march} and @option{-mcpu}.
14086 @item lse
14087 Enable Large System Extension instructions.  This is on by default for
14088 @option{-march=armv8.1-a}.
14089 @item fp16
14090 Enable FP16 extension.  This also enables floating-point instructions.
14092 @end table
14094 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14095 Conversely, @option{nofp} implies @option{nosimd}, which implies
14096 @option{nocrypto}.
14098 @node Adapteva Epiphany Options
14099 @subsection Adapteva Epiphany Options
14101 These @samp{-m} options are defined for Adapteva Epiphany:
14103 @table @gcctabopt
14104 @item -mhalf-reg-file
14105 @opindex mhalf-reg-file
14106 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14107 That allows code to run on hardware variants that lack these registers.
14109 @item -mprefer-short-insn-regs
14110 @opindex mprefer-short-insn-regs
14111 Preferentially allocate registers that allow short instruction generation.
14112 This can result in increased instruction count, so this may either reduce or
14113 increase overall code size.
14115 @item -mbranch-cost=@var{num}
14116 @opindex mbranch-cost
14117 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14118 This cost is only a heuristic and is not guaranteed to produce
14119 consistent results across releases.
14121 @item -mcmove
14122 @opindex mcmove
14123 Enable the generation of conditional moves.
14125 @item -mnops=@var{num}
14126 @opindex mnops
14127 Emit @var{num} NOPs before every other generated instruction.
14129 @item -mno-soft-cmpsf
14130 @opindex mno-soft-cmpsf
14131 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14132 and test the flags.  This is faster than a software comparison, but can
14133 get incorrect results in the presence of NaNs, or when two different small
14134 numbers are compared such that their difference is calculated as zero.
14135 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14136 software comparisons.
14138 @item -mstack-offset=@var{num}
14139 @opindex mstack-offset
14140 Set the offset between the top of the stack and the stack pointer.
14141 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14142 can be used by leaf functions without stack allocation.
14143 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14144 Note also that this option changes the ABI; compiling a program with a
14145 different stack offset than the libraries have been compiled with
14146 generally does not work.
14147 This option can be useful if you want to evaluate if a different stack
14148 offset would give you better code, but to actually use a different stack
14149 offset to build working programs, it is recommended to configure the
14150 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14152 @item -mno-round-nearest
14153 @opindex mno-round-nearest
14154 Make the scheduler assume that the rounding mode has been set to
14155 truncating.  The default is @option{-mround-nearest}.
14157 @item -mlong-calls
14158 @opindex mlong-calls
14159 If not otherwise specified by an attribute, assume all calls might be beyond
14160 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14161 function address into a register before performing a (otherwise direct) call.
14162 This is the default.
14164 @item -mshort-calls
14165 @opindex short-calls
14166 If not otherwise specified by an attribute, assume all direct calls are
14167 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14168 for direct calls.  The default is @option{-mlong-calls}.
14170 @item -msmall16
14171 @opindex msmall16
14172 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14173 apply to function addresses for which @option{-mlong-calls} semantics
14174 are in effect.
14176 @item -mfp-mode=@var{mode}
14177 @opindex mfp-mode
14178 Set the prevailing mode of the floating-point unit.
14179 This determines the floating-point mode that is provided and expected
14180 at function call and return time.  Making this mode match the mode you
14181 predominantly need at function start can make your programs smaller and
14182 faster by avoiding unnecessary mode switches.
14184 @var{mode} can be set to one the following values:
14186 @table @samp
14187 @item caller
14188 Any mode at function entry is valid, and retained or restored when
14189 the function returns, and when it calls other functions.
14190 This mode is useful for compiling libraries or other compilation units
14191 you might want to incorporate into different programs with different
14192 prevailing FPU modes, and the convenience of being able to use a single
14193 object file outweighs the size and speed overhead for any extra
14194 mode switching that might be needed, compared with what would be needed
14195 with a more specific choice of prevailing FPU mode.
14197 @item truncate
14198 This is the mode used for floating-point calculations with
14199 truncating (i.e.@: round towards zero) rounding mode.  That includes
14200 conversion from floating point to integer.
14202 @item round-nearest
14203 This is the mode used for floating-point calculations with
14204 round-to-nearest-or-even rounding mode.
14206 @item int
14207 This is the mode used to perform integer calculations in the FPU, e.g.@:
14208 integer multiply, or integer multiply-and-accumulate.
14209 @end table
14211 The default is @option{-mfp-mode=caller}
14213 @item -mnosplit-lohi
14214 @itemx -mno-postinc
14215 @itemx -mno-postmodify
14216 @opindex mnosplit-lohi
14217 @opindex mno-postinc
14218 @opindex mno-postmodify
14219 Code generation tweaks that disable, respectively, splitting of 32-bit
14220 loads, generation of post-increment addresses, and generation of
14221 post-modify addresses.  The defaults are @option{msplit-lohi},
14222 @option{-mpost-inc}, and @option{-mpost-modify}.
14224 @item -mnovect-double
14225 @opindex mno-vect-double
14226 Change the preferred SIMD mode to SImode.  The default is
14227 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14229 @item -max-vect-align=@var{num}
14230 @opindex max-vect-align
14231 The maximum alignment for SIMD vector mode types.
14232 @var{num} may be 4 or 8.  The default is 8.
14233 Note that this is an ABI change, even though many library function
14234 interfaces are unaffected if they don't use SIMD vector modes
14235 in places that affect size and/or alignment of relevant types.
14237 @item -msplit-vecmove-early
14238 @opindex msplit-vecmove-early
14239 Split vector moves into single word moves before reload.  In theory this
14240 can give better register allocation, but so far the reverse seems to be
14241 generally the case.
14243 @item -m1reg-@var{reg}
14244 @opindex m1reg-
14245 Specify a register to hold the constant @minus{}1, which makes loading small negative
14246 constants and certain bitmasks faster.
14247 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14248 which specify use of that register as a fixed register,
14249 and @samp{none}, which means that no register is used for this
14250 purpose.  The default is @option{-m1reg-none}.
14252 @end table
14254 @node ARC Options
14255 @subsection ARC Options
14256 @cindex ARC options
14258 The following options control the architecture variant for which code
14259 is being compiled:
14261 @c architecture variants
14262 @table @gcctabopt
14264 @item -mbarrel-shifter
14265 @opindex mbarrel-shifter
14266 Generate instructions supported by barrel shifter.  This is the default
14267 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14269 @item -mcpu=@var{cpu}
14270 @opindex mcpu
14271 Set architecture type, register usage, and instruction scheduling
14272 parameters for @var{cpu}.  There are also shortcut alias options
14273 available for backward compatibility and convenience.  Supported
14274 values for @var{cpu} are
14276 @table @samp
14277 @opindex mA6
14278 @opindex mARC600
14279 @item arc600
14280 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14282 @item arc601
14283 @opindex mARC601
14284 Compile for ARC601.  Alias: @option{-mARC601}.
14286 @item arc700
14287 @opindex mA7
14288 @opindex mARC700
14289 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14290 This is the default when configured with @option{--with-cpu=arc700}@.
14292 @item arcem
14293 Compile for ARC EM.
14295 @item archs
14296 Compile for ARC HS.
14298 @item em
14299 Compile for ARC EM CPU with no hardware extensions.
14301 @item em4
14302 Compile for ARC EM4 CPU.
14304 @item em4_dmips
14305 Compile for ARC EM4 DMIPS CPU.
14307 @item em4_fpus
14308 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14309 extension.
14311 @item em4_fpuda
14312 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14313 double assist instructions.
14315 @item hs
14316 Compile for ARC HS CPU with no hardware extensions except the atomic
14317 instructions.
14319 @item hs34
14320 Compile for ARC HS34 CPU.
14322 @item hs38
14323 Compile for ARC HS38 CPU.
14325 @item hs38_linux
14326 Compile for ARC HS38 CPU with all hardware extensions on.
14328 @item arc600_norm
14329 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14331 @item arc600_mul32x16
14332 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14333 instructions enabled.
14335 @item arc600_mul64
14336 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14337 instructions enabled.
14339 @item arc601_norm
14340 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14342 @item arc601_mul32x16
14343 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14344 instructions enabled.
14346 @item arc601_mul64
14347 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14348 instructions enabled.
14350 @item nps400
14351 Compile for ARC 700 on NPS400 chip.
14353 @end table
14355 @item -mdpfp
14356 @opindex mdpfp
14357 @itemx -mdpfp-compact
14358 @opindex mdpfp-compact
14359 Generate double-precision FPX instructions, tuned for the compact
14360 implementation.
14362 @item -mdpfp-fast
14363 @opindex mdpfp-fast
14364 Generate double-precision FPX instructions, tuned for the fast
14365 implementation.
14367 @item -mno-dpfp-lrsr
14368 @opindex mno-dpfp-lrsr
14369 Disable @code{lr} and @code{sr} instructions from using FPX extension
14370 aux registers.
14372 @item -mea
14373 @opindex mea
14374 Generate extended arithmetic instructions.  Currently only
14375 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14376 supported.  This is always enabled for @option{-mcpu=ARC700}.
14378 @item -mno-mpy
14379 @opindex mno-mpy
14380 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14381 deprecated.
14383 @item -mmul32x16
14384 @opindex mmul32x16
14385 Generate 32x16-bit multiply and multiply-accumulate instructions.
14387 @item -mmul64
14388 @opindex mmul64
14389 Generate @code{mul64} and @code{mulu64} instructions.  
14390 Only valid for @option{-mcpu=ARC600}.
14392 @item -mnorm
14393 @opindex mnorm
14394 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14395 is in effect.
14397 @item -mspfp
14398 @opindex mspfp
14399 @itemx -mspfp-compact
14400 @opindex mspfp-compact
14401 Generate single-precision FPX instructions, tuned for the compact
14402 implementation.
14404 @item -mspfp-fast
14405 @opindex mspfp-fast
14406 Generate single-precision FPX instructions, tuned for the fast
14407 implementation.
14409 @item -msimd
14410 @opindex msimd
14411 Enable generation of ARC SIMD instructions via target-specific
14412 builtins.  Only valid for @option{-mcpu=ARC700}.
14414 @item -msoft-float
14415 @opindex msoft-float
14416 This option ignored; it is provided for compatibility purposes only.
14417 Software floating-point code is emitted by default, and this default
14418 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14419 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14420 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14422 @item -mswap
14423 @opindex mswap
14424 Generate @code{swap} instructions.
14426 @item -matomic
14427 @opindex matomic
14428 This enables use of the locked load/store conditional extension to implement
14429 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14430 EM cores.
14432 @item -mdiv-rem
14433 @opindex mdiv-rem
14434 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14436 @item -mcode-density
14437 @opindex mcode-density
14438 Enable code density instructions for ARC EM.  
14439 This option is on by default for ARC HS.
14441 @item -mll64
14442 @opindex mll64
14443 Enable double load/store operations for ARC HS cores.
14445 @item -mtp-regno=@var{regno}
14446 @opindex mtp-regno
14447 Specify thread pointer register number.
14449 @item -mmpy-option=@var{multo}
14450 @opindex mmpy-option
14451 Compile ARCv2 code with a multiplier design option.  You can specify 
14452 the option using either a string or numeric value for @var{multo}.  
14453 @samp{wlh1} is the default value.  The recognized values are:
14455 @table @samp
14456 @item 0
14457 @itemx none
14458 No multiplier available.
14460 @item 1
14461 @itemx w
14462 16x16 multiplier, fully pipelined.
14463 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14465 @item 2
14466 @itemx wlh1
14467 32x32 multiplier, fully
14468 pipelined (1 stage).  The following instructions are additionally
14469 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14471 @item 3
14472 @itemx wlh2
14473 32x32 multiplier, fully pipelined
14474 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14475 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14477 @item 4
14478 @itemx wlh3
14479 Two 16x16 multipliers, blocking,
14480 sequential.  The following instructions are additionally enabled: @code{mpy},
14481 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14483 @item 5
14484 @itemx wlh4
14485 One 16x16 multiplier, blocking,
14486 sequential.  The following instructions are additionally enabled: @code{mpy},
14487 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14489 @item 6
14490 @itemx wlh5
14491 One 32x4 multiplier, blocking,
14492 sequential.  The following instructions are additionally enabled: @code{mpy},
14493 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14495 @item 7
14496 @itemx plus_dmpy
14497 ARC HS SIMD support.
14499 @item 8
14500 @itemx plus_macd
14501 ARC HS SIMD support.
14503 @item 9
14504 @itemx plus_qmacw
14505 ARC HS SIMD support.
14507 @end table
14509 This option is only available for ARCv2 cores@.
14511 @item -mfpu=@var{fpu}
14512 @opindex mfpu
14513 Enables support for specific floating-point hardware extensions for ARCv2
14514 cores.  Supported values for @var{fpu} are:
14516 @table @samp
14518 @item fpus
14519 Enables support for single-precision floating-point hardware
14520 extensions@.
14522 @item fpud
14523 Enables support for double-precision floating-point hardware
14524 extensions.  The single-precision floating-point extension is also
14525 enabled.  Not available for ARC EM@.
14527 @item fpuda
14528 Enables support for double-precision floating-point hardware
14529 extensions using double-precision assist instructions.  The single-precision
14530 floating-point extension is also enabled.  This option is
14531 only available for ARC EM@.
14533 @item fpuda_div
14534 Enables support for double-precision floating-point hardware
14535 extensions using double-precision assist instructions.
14536 The single-precision floating-point, square-root, and divide 
14537 extensions are also enabled.  This option is
14538 only available for ARC EM@.
14540 @item fpuda_fma
14541 Enables support for double-precision floating-point hardware
14542 extensions using double-precision assist instructions.
14543 The single-precision floating-point and fused multiply and add 
14544 hardware extensions are also enabled.  This option is
14545 only available for ARC EM@.
14547 @item fpuda_all
14548 Enables support for double-precision floating-point hardware
14549 extensions using double-precision assist instructions.
14550 All single-precision floating-point hardware extensions are also
14551 enabled.  This option is only available for ARC EM@.
14553 @item fpus_div
14554 Enables support for single-precision floating-point, square-root and divide 
14555 hardware extensions@.
14557 @item fpud_div
14558 Enables support for double-precision floating-point, square-root and divide 
14559 hardware extensions.  This option
14560 includes option @samp{fpus_div}. Not available for ARC EM@.
14562 @item fpus_fma
14563 Enables support for single-precision floating-point and 
14564 fused multiply and add hardware extensions@.
14566 @item fpud_fma
14567 Enables support for double-precision floating-point and 
14568 fused multiply and add hardware extensions.  This option
14569 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14571 @item fpus_all
14572 Enables support for all single-precision floating-point hardware
14573 extensions@.
14575 @item fpud_all
14576 Enables support for all single- and double-precision floating-point
14577 hardware extensions.  Not available for ARC EM@.
14579 @end table
14581 @end table
14583 The following options are passed through to the assembler, and also
14584 define preprocessor macro symbols.
14586 @c Flags used by the assembler, but for which we define preprocessor
14587 @c macro symbols as well.
14588 @table @gcctabopt
14589 @item -mdsp-packa
14590 @opindex mdsp-packa
14591 Passed down to the assembler to enable the DSP Pack A extensions.
14592 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14593 deprecated.
14595 @item -mdvbf
14596 @opindex mdvbf
14597 Passed down to the assembler to enable the dual Viterbi butterfly
14598 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14599 option is deprecated.
14601 @c ARC700 4.10 extension instruction
14602 @item -mlock
14603 @opindex mlock
14604 Passed down to the assembler to enable the locked load/store
14605 conditional extension.  Also sets the preprocessor symbol
14606 @code{__Xlock}.
14608 @item -mmac-d16
14609 @opindex mmac-d16
14610 Passed down to the assembler.  Also sets the preprocessor symbol
14611 @code{__Xxmac_d16}.  This option is deprecated.
14613 @item -mmac-24
14614 @opindex mmac-24
14615 Passed down to the assembler.  Also sets the preprocessor symbol
14616 @code{__Xxmac_24}.  This option is deprecated.
14618 @c ARC700 4.10 extension instruction
14619 @item -mrtsc
14620 @opindex mrtsc
14621 Passed down to the assembler to enable the 64-bit time-stamp counter
14622 extension instruction.  Also sets the preprocessor symbol
14623 @code{__Xrtsc}.  This option is deprecated.
14625 @c ARC700 4.10 extension instruction
14626 @item -mswape
14627 @opindex mswape
14628 Passed down to the assembler to enable the swap byte ordering
14629 extension instruction.  Also sets the preprocessor symbol
14630 @code{__Xswape}.
14632 @item -mtelephony
14633 @opindex mtelephony
14634 Passed down to the assembler to enable dual- and single-operand
14635 instructions for telephony.  Also sets the preprocessor symbol
14636 @code{__Xtelephony}.  This option is deprecated.
14638 @item -mxy
14639 @opindex mxy
14640 Passed down to the assembler to enable the XY memory extension.  Also
14641 sets the preprocessor symbol @code{__Xxy}.
14643 @end table
14645 The following options control how the assembly code is annotated:
14647 @c Assembly annotation options
14648 @table @gcctabopt
14649 @item -misize
14650 @opindex misize
14651 Annotate assembler instructions with estimated addresses.
14653 @item -mannotate-align
14654 @opindex mannotate-align
14655 Explain what alignment considerations lead to the decision to make an
14656 instruction short or long.
14658 @end table
14660 The following options are passed through to the linker:
14662 @c options passed through to the linker
14663 @table @gcctabopt
14664 @item -marclinux
14665 @opindex marclinux
14666 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14667 This option is enabled by default in tool chains built for
14668 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14669 when profiling is not requested.
14671 @item -marclinux_prof
14672 @opindex marclinux_prof
14673 Passed through to the linker, to specify use of the
14674 @code{arclinux_prof} emulation.  This option is enabled by default in
14675 tool chains built for @w{@code{arc-linux-uclibc}} and
14676 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14678 @end table
14680 The following options control the semantics of generated code:
14682 @c semantically relevant code generation options
14683 @table @gcctabopt
14684 @item -mlong-calls
14685 @opindex mlong-calls
14686 Generate calls as register indirect calls, thus providing access
14687 to the full 32-bit address range.
14689 @item -mmedium-calls
14690 @opindex mmedium-calls
14691 Don't use less than 25-bit addressing range for calls, which is the
14692 offset available for an unconditional branch-and-link
14693 instruction.  Conditional execution of function calls is suppressed, to
14694 allow use of the 25-bit range, rather than the 21-bit range with
14695 conditional branch-and-link.  This is the default for tool chains built
14696 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14698 @item -mno-sdata
14699 @opindex mno-sdata
14700 Do not generate sdata references.  This is the default for tool chains
14701 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14702 targets.
14704 @item -mvolatile-cache
14705 @opindex mvolatile-cache
14706 Use ordinarily cached memory accesses for volatile references.  This is the
14707 default.
14709 @item -mno-volatile-cache
14710 @opindex mno-volatile-cache
14711 Enable cache bypass for volatile references.
14713 @end table
14715 The following options fine tune code generation:
14716 @c code generation tuning options
14717 @table @gcctabopt
14718 @item -malign-call
14719 @opindex malign-call
14720 Do alignment optimizations for call instructions.
14722 @item -mauto-modify-reg
14723 @opindex mauto-modify-reg
14724 Enable the use of pre/post modify with register displacement.
14726 @item -mbbit-peephole
14727 @opindex mbbit-peephole
14728 Enable bbit peephole2.
14730 @item -mno-brcc
14731 @opindex mno-brcc
14732 This option disables a target-specific pass in @file{arc_reorg} to
14733 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14734 It has no effect on
14735 generation of these instructions driven by the combiner pass.
14737 @item -mcase-vector-pcrel
14738 @opindex mcase-vector-pcrel
14739 Use PC-relative switch case tables to enable case table shortening.
14740 This is the default for @option{-Os}.
14742 @item -mcompact-casesi
14743 @opindex mcompact-casesi
14744 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14745 and only available for ARCv1 cores.
14747 @item -mno-cond-exec
14748 @opindex mno-cond-exec
14749 Disable the ARCompact-specific pass to generate conditional 
14750 execution instructions.
14752 Due to delay slot scheduling and interactions between operand numbers,
14753 literal sizes, instruction lengths, and the support for conditional execution,
14754 the target-independent pass to generate conditional execution is often lacking,
14755 so the ARC port has kept a special pass around that tries to find more
14756 conditional execution generation opportunities after register allocation,
14757 branch shortening, and delay slot scheduling have been done.  This pass
14758 generally, but not always, improves performance and code size, at the cost of
14759 extra compilation time, which is why there is an option to switch it off.
14760 If you have a problem with call instructions exceeding their allowable
14761 offset range because they are conditionalized, you should consider using
14762 @option{-mmedium-calls} instead.
14764 @item -mearly-cbranchsi
14765 @opindex mearly-cbranchsi
14766 Enable pre-reload use of the @code{cbranchsi} pattern.
14768 @item -mexpand-adddi
14769 @opindex mexpand-adddi
14770 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14771 @code{add.f}, @code{adc} etc.
14773 @item -mindexed-loads
14774 @opindex mindexed-loads
14775 Enable the use of indexed loads.  This can be problematic because some
14776 optimizers then assume that indexed stores exist, which is not
14777 the case.
14779 @opindex mlra
14780 Enable Local Register Allocation.  This is still experimental for ARC,
14781 so by default the compiler uses standard reload
14782 (i.e. @option{-mno-lra}).
14784 @item -mlra-priority-none
14785 @opindex mlra-priority-none
14786 Don't indicate any priority for target registers.
14788 @item -mlra-priority-compact
14789 @opindex mlra-priority-compact
14790 Indicate target register priority for r0..r3 / r12..r15.
14792 @item -mlra-priority-noncompact
14793 @opindex mlra-priority-noncompact
14794 Reduce target register priority for r0..r3 / r12..r15.
14796 @item -mno-millicode
14797 @opindex mno-millicode
14798 When optimizing for size (using @option{-Os}), prologues and epilogues
14799 that have to save or restore a large number of registers are often
14800 shortened by using call to a special function in libgcc; this is
14801 referred to as a @emph{millicode} call.  As these calls can pose
14802 performance issues, and/or cause linking issues when linking in a
14803 nonstandard way, this option is provided to turn off millicode call
14804 generation.
14806 @item -mmixed-code
14807 @opindex mmixed-code
14808 Tweak register allocation to help 16-bit instruction generation.
14809 This generally has the effect of decreasing the average instruction size
14810 while increasing the instruction count.
14812 @item -mq-class
14813 @opindex mq-class
14814 Enable @samp{q} instruction alternatives.
14815 This is the default for @option{-Os}.
14817 @item -mRcq
14818 @opindex mRcq
14819 Enable @samp{Rcq} constraint handling.  
14820 Most short code generation depends on this.
14821 This is the default.
14823 @item -mRcw
14824 @opindex mRcw
14825 Enable @samp{Rcw} constraint handling.  
14826 Most ccfsm condexec mostly depends on this.
14827 This is the default.
14829 @item -msize-level=@var{level}
14830 @opindex msize-level
14831 Fine-tune size optimization with regards to instruction lengths and alignment.
14832 The recognized values for @var{level} are:
14833 @table @samp
14834 @item 0
14835 No size optimization.  This level is deprecated and treated like @samp{1}.
14837 @item 1
14838 Short instructions are used opportunistically.
14840 @item 2
14841 In addition, alignment of loops and of code after barriers are dropped.
14843 @item 3
14844 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14846 @end table
14848 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14849 the behavior when this is not set is equivalent to level @samp{1}.
14851 @item -mtune=@var{cpu}
14852 @opindex mtune
14853 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14854 by @option{-mcpu=}.
14856 Supported values for @var{cpu} are
14858 @table @samp
14859 @item ARC600
14860 Tune for ARC600 CPU.
14862 @item ARC601
14863 Tune for ARC601 CPU.
14865 @item ARC700
14866 Tune for ARC700 CPU with standard multiplier block.
14868 @item ARC700-xmac
14869 Tune for ARC700 CPU with XMAC block.
14871 @item ARC725D
14872 Tune for ARC725D CPU.
14874 @item ARC750D
14875 Tune for ARC750D CPU.
14877 @end table
14879 @item -mmultcost=@var{num}
14880 @opindex mmultcost
14881 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14882 normal instruction.
14884 @item -munalign-prob-threshold=@var{probability}
14885 @opindex munalign-prob-threshold
14886 Set probability threshold for unaligning branches.
14887 When tuning for @samp{ARC700} and optimizing for speed, branches without
14888 filled delay slot are preferably emitted unaligned and long, unless
14889 profiling indicates that the probability for the branch to be taken
14890 is below @var{probability}.  @xref{Cross-profiling}.
14891 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14893 @end table
14895 The following options are maintained for backward compatibility, but
14896 are now deprecated and will be removed in a future release:
14898 @c Deprecated options
14899 @table @gcctabopt
14901 @item -margonaut
14902 @opindex margonaut
14903 Obsolete FPX.
14905 @item -mbig-endian
14906 @opindex mbig-endian
14907 @itemx -EB
14908 @opindex EB
14909 Compile code for big-endian targets.  Use of these options is now
14910 deprecated.  Big-endian code is supported by configuring GCC to build
14911 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
14912 for which big endian is the default.
14914 @item -mlittle-endian
14915 @opindex mlittle-endian
14916 @itemx -EL
14917 @opindex EL
14918 Compile code for little-endian targets.  Use of these options is now
14919 deprecated.  Little-endian code is supported by configuring GCC to build 
14920 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
14921 for which little endian is the default.
14923 @item -mbarrel_shifter
14924 @opindex mbarrel_shifter
14925 Replaced by @option{-mbarrel-shifter}.
14927 @item -mdpfp_compact
14928 @opindex mdpfp_compact
14929 Replaced by @option{-mdpfp-compact}.
14931 @item -mdpfp_fast
14932 @opindex mdpfp_fast
14933 Replaced by @option{-mdpfp-fast}.
14935 @item -mdsp_packa
14936 @opindex mdsp_packa
14937 Replaced by @option{-mdsp-packa}.
14939 @item -mEA
14940 @opindex mEA
14941 Replaced by @option{-mea}.
14943 @item -mmac_24
14944 @opindex mmac_24
14945 Replaced by @option{-mmac-24}.
14947 @item -mmac_d16
14948 @opindex mmac_d16
14949 Replaced by @option{-mmac-d16}.
14951 @item -mspfp_compact
14952 @opindex mspfp_compact
14953 Replaced by @option{-mspfp-compact}.
14955 @item -mspfp_fast
14956 @opindex mspfp_fast
14957 Replaced by @option{-mspfp-fast}.
14959 @item -mtune=@var{cpu}
14960 @opindex mtune
14961 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
14962 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
14963 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
14965 @item -multcost=@var{num}
14966 @opindex multcost
14967 Replaced by @option{-mmultcost}.
14969 @end table
14971 @node ARM Options
14972 @subsection ARM Options
14973 @cindex ARM options
14975 These @samp{-m} options are defined for the ARM port:
14977 @table @gcctabopt
14978 @item -mabi=@var{name}
14979 @opindex mabi
14980 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
14981 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
14983 @item -mapcs-frame
14984 @opindex mapcs-frame
14985 Generate a stack frame that is compliant with the ARM Procedure Call
14986 Standard for all functions, even if this is not strictly necessary for
14987 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
14988 with this option causes the stack frames not to be generated for
14989 leaf functions.  The default is @option{-mno-apcs-frame}.
14990 This option is deprecated.
14992 @item -mapcs
14993 @opindex mapcs
14994 This is a synonym for @option{-mapcs-frame} and is deprecated.
14996 @ignore
14997 @c not currently implemented
14998 @item -mapcs-stack-check
14999 @opindex mapcs-stack-check
15000 Generate code to check the amount of stack space available upon entry to
15001 every function (that actually uses some stack space).  If there is
15002 insufficient space available then either the function
15003 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15004 called, depending upon the amount of stack space required.  The runtime
15005 system is required to provide these functions.  The default is
15006 @option{-mno-apcs-stack-check}, since this produces smaller code.
15008 @c not currently implemented
15009 @item -mapcs-reentrant
15010 @opindex mapcs-reentrant
15011 Generate reentrant, position-independent code.  The default is
15012 @option{-mno-apcs-reentrant}.
15013 @end ignore
15015 @item -mthumb-interwork
15016 @opindex mthumb-interwork
15017 Generate code that supports calling between the ARM and Thumb
15018 instruction sets.  Without this option, on pre-v5 architectures, the
15019 two instruction sets cannot be reliably used inside one program.  The
15020 default is @option{-mno-thumb-interwork}, since slightly larger code
15021 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15022 configurations this option is meaningless.
15024 @item -mno-sched-prolog
15025 @opindex mno-sched-prolog
15026 Prevent the reordering of instructions in the function prologue, or the
15027 merging of those instruction with the instructions in the function's
15028 body.  This means that all functions start with a recognizable set
15029 of instructions (or in fact one of a choice from a small set of
15030 different function prologues), and this information can be used to
15031 locate the start of functions inside an executable piece of code.  The
15032 default is @option{-msched-prolog}.
15034 @item -mfloat-abi=@var{name}
15035 @opindex mfloat-abi
15036 Specifies which floating-point ABI to use.  Permissible values
15037 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15039 Specifying @samp{soft} causes GCC to generate output containing
15040 library calls for floating-point operations.
15041 @samp{softfp} allows the generation of code using hardware floating-point
15042 instructions, but still uses the soft-float calling conventions.
15043 @samp{hard} allows generation of floating-point instructions
15044 and uses FPU-specific calling conventions.
15046 The default depends on the specific target configuration.  Note that
15047 the hard-float and soft-float ABIs are not link-compatible; you must
15048 compile your entire program with the same ABI, and link with a
15049 compatible set of libraries.
15051 @item -mlittle-endian
15052 @opindex mlittle-endian
15053 Generate code for a processor running in little-endian mode.  This is
15054 the default for all standard configurations.
15056 @item -mbig-endian
15057 @opindex mbig-endian
15058 Generate code for a processor running in big-endian mode; the default is
15059 to compile code for a little-endian processor.
15061 @item -march=@var{name}
15062 @opindex march
15063 This specifies the name of the target ARM architecture.  GCC uses this
15064 name to determine what kind of instructions it can emit when generating
15065 assembly code.  This option can be used in conjunction with or instead
15066 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
15067 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
15068 @samp{armv5}, @samp{armv5e}, @samp{armv5t}, @samp{armv5te},
15069 @samp{armv6}, @samp{armv6-m}, @samp{armv6j}, @samp{armv6k},
15070 @samp{armv6kz}, @samp{armv6s-m},
15071 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk},
15072 @samp{armv7}, @samp{armv7-a}, @samp{armv7-m}, @samp{armv7-r}, @samp{armv7e-m},
15073 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc}, @samp{armv8.1-a},
15074 @samp{armv8.1-a+crc}, @samp{armv8-m.base}, @samp{armv8-m.main},
15075 @samp{armv8-m.main+dsp}, @samp{iwmmxt}, @samp{iwmmxt2}.
15077 Architecture revisions older than @samp{armv4t} are deprecated.
15079 @option{-march=armv6s-m} is the @samp{armv6-m} architecture with support for
15080 the (now mandatory) SVC instruction.
15082 @option{-march=armv6zk} is an alias for @samp{armv6kz}, existing for backwards
15083 compatibility.
15085 @option{-march=armv7ve} is the @samp{armv7-a} architecture with virtualization
15086 extensions.
15088 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
15089 architecture together with the optional CRC32 extensions.
15091 @option{-march=armv8.1-a} enables compiler support for the ARMv8.1-A
15092 architecture.  This also enables the features provided by
15093 @option{-march=armv8-a+crc}.
15095 @option{-march=armv8.2-a} enables compiler support for the ARMv8.2-A
15096 architecture.  This also enables the features provided by
15097 @option{-march=armv8.1-a}.
15099 @option{-march=armv8.2-a+fp16} enables compiler support for the
15100 ARMv8.2-A architecture with the optional FP16 instructions extension.
15101 This also enables the features provided by @option{-march=armv8.1-a}
15102 and implies @option{-mfp16-format=ieee}.
15104 @option{-march=native} causes the compiler to auto-detect the architecture
15105 of the build computer.  At present, this feature is only supported on
15106 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15107 is unsuccessful the option has no effect.
15109 @item -mtune=@var{name}
15110 @opindex mtune
15111 This option specifies the name of the target ARM processor for
15112 which GCC should tune the performance of the code.
15113 For some ARM implementations better performance can be obtained by using
15114 this option.
15115 Permissible names are: @samp{arm2}, @samp{arm250},
15116 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15117 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15118 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15119 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15120 @samp{arm720},
15121 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15122 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15123 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15124 @samp{strongarm1110},
15125 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15126 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15127 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15128 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15129 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15130 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15131 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15132 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15133 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15134 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15135 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15136 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15137 @samp{cortex-m33},
15138 @samp{cortex-m23},
15139 @samp{cortex-m7},
15140 @samp{cortex-m4},
15141 @samp{cortex-m3},
15142 @samp{cortex-m1},
15143 @samp{cortex-m0},
15144 @samp{cortex-m0plus},
15145 @samp{cortex-m1.small-multiply},
15146 @samp{cortex-m0.small-multiply},
15147 @samp{cortex-m0plus.small-multiply},
15148 @samp{exynos-m1},
15149 @samp{falkor},
15150 @samp{qdf24xx},
15151 @samp{marvell-pj4},
15152 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15153 @samp{fa526}, @samp{fa626},
15154 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15155 @samp{xgene1}.
15157 Additionally, this option can specify that GCC should tune the performance
15158 of the code for a big.LITTLE system.  Permissible names are:
15159 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15160 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15161 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15163 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15164 performance for a blend of processors within architecture @var{arch}.
15165 The aim is to generate code that run well on the current most popular
15166 processors, balancing between optimizations that benefit some CPUs in the
15167 range, and avoiding performance pitfalls of other CPUs.  The effects of
15168 this option may change in future GCC versions as CPU models come and go.
15170 @option{-mtune=native} causes the compiler to auto-detect the CPU
15171 of the build computer.  At present, this feature is only supported on
15172 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15173 unsuccessful the option has no effect.
15175 @item -mcpu=@var{name}
15176 @opindex mcpu
15177 This specifies the name of the target ARM processor.  GCC uses this name
15178 to derive the name of the target ARM architecture (as if specified
15179 by @option{-march}) and the ARM processor type for which to tune for
15180 performance (as if specified by @option{-mtune}).  Where this option
15181 is used in conjunction with @option{-march} or @option{-mtune},
15182 those options take precedence over the appropriate part of this option.
15184 Permissible names for this option are the same as those for
15185 @option{-mtune}.
15187 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15188 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15189 See @option{-mtune} for more information.
15191 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15192 of the build computer.  At present, this feature is only supported on
15193 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15194 is unsuccessful the option has no effect.
15196 @item -mfpu=@var{name}
15197 @opindex mfpu
15198 This specifies what floating-point hardware (or hardware emulation) is
15199 available on the target.  Permissible names are: @samp{vfpv2}, @samp{vfpv3},
15200 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15201 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15202 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15203 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15204 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15205 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15206 is an alias for @samp{vfpv2}.
15208 If @option{-msoft-float} is specified this specifies the format of
15209 floating-point values.
15211 If the selected floating-point hardware includes the NEON extension
15212 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
15213 operations are not generated by GCC's auto-vectorization pass unless
15214 @option{-funsafe-math-optimizations} is also specified.  This is
15215 because NEON hardware does not fully implement the IEEE 754 standard for
15216 floating-point arithmetic (in particular denormal values are treated as
15217 zero), so the use of NEON instructions may lead to a loss of precision.
15219 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}).
15221 @item -mfp16-format=@var{name}
15222 @opindex mfp16-format
15223 Specify the format of the @code{__fp16} half-precision floating-point type.
15224 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15225 the default is @samp{none}, in which case the @code{__fp16} type is not
15226 defined.  @xref{Half-Precision}, for more information.
15228 @item -mstructure-size-boundary=@var{n}
15229 @opindex mstructure-size-boundary
15230 The sizes of all structures and unions are rounded up to a multiple
15231 of the number of bits set by this option.  Permissible values are 8, 32
15232 and 64.  The default value varies for different toolchains.  For the COFF
15233 targeted toolchain the default value is 8.  A value of 64 is only allowed
15234 if the underlying ABI supports it.
15236 Specifying a larger number can produce faster, more efficient code, but
15237 can also increase the size of the program.  Different values are potentially
15238 incompatible.  Code compiled with one value cannot necessarily expect to
15239 work with code or libraries compiled with another value, if they exchange
15240 information using structures or unions.
15242 @item -mabort-on-noreturn
15243 @opindex mabort-on-noreturn
15244 Generate a call to the function @code{abort} at the end of a
15245 @code{noreturn} function.  It is executed if the function tries to
15246 return.
15248 @item -mlong-calls
15249 @itemx -mno-long-calls
15250 @opindex mlong-calls
15251 @opindex mno-long-calls
15252 Tells the compiler to perform function calls by first loading the
15253 address of the function into a register and then performing a subroutine
15254 call on this register.  This switch is needed if the target function
15255 lies outside of the 64-megabyte addressing range of the offset-based
15256 version of subroutine call instruction.
15258 Even if this switch is enabled, not all function calls are turned
15259 into long calls.  The heuristic is that static functions, functions
15260 that have the @code{short_call} attribute, functions that are inside
15261 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15262 definitions have already been compiled within the current compilation
15263 unit are not turned into long calls.  The exceptions to this rule are
15264 that weak function definitions, functions with the @code{long_call}
15265 attribute or the @code{section} attribute, and functions that are within
15266 the scope of a @code{#pragma long_calls} directive are always
15267 turned into long calls.
15269 This feature is not enabled by default.  Specifying
15270 @option{-mno-long-calls} restores the default behavior, as does
15271 placing the function calls within the scope of a @code{#pragma
15272 long_calls_off} directive.  Note these switches have no effect on how
15273 the compiler generates code to handle function calls via function
15274 pointers.
15276 @item -msingle-pic-base
15277 @opindex msingle-pic-base
15278 Treat the register used for PIC addressing as read-only, rather than
15279 loading it in the prologue for each function.  The runtime system is
15280 responsible for initializing this register with an appropriate value
15281 before execution begins.
15283 @item -mpic-register=@var{reg}
15284 @opindex mpic-register
15285 Specify the register to be used for PIC addressing.
15286 For standard PIC base case, the default is any suitable register
15287 determined by compiler.  For single PIC base case, the default is
15288 @samp{R9} if target is EABI based or stack-checking is enabled,
15289 otherwise the default is @samp{R10}.
15291 @item -mpic-data-is-text-relative
15292 @opindex mpic-data-is-text-relative
15293 Assume that the displacement between the text and data segments is fixed
15294 at static link time.  This permits using PC-relative addressing
15295 operations to access data known to be in the data segment.  For
15296 non-VxWorks RTP targets, this option is enabled by default.  When
15297 disabled on such targets, it will enable @option{-msingle-pic-base} by
15298 default.
15300 @item -mpoke-function-name
15301 @opindex mpoke-function-name
15302 Write the name of each function into the text section, directly
15303 preceding the function prologue.  The generated code is similar to this:
15305 @smallexample
15306      t0
15307          .ascii "arm_poke_function_name", 0
15308          .align
15309      t1
15310          .word 0xff000000 + (t1 - t0)
15311      arm_poke_function_name
15312          mov     ip, sp
15313          stmfd   sp!, @{fp, ip, lr, pc@}
15314          sub     fp, ip, #4
15315 @end smallexample
15317 When performing a stack backtrace, code can inspect the value of
15318 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15319 location @code{pc - 12} and the top 8 bits are set, then we know that
15320 there is a function name embedded immediately preceding this location
15321 and has length @code{((pc[-3]) & 0xff000000)}.
15323 @item -mthumb
15324 @itemx -marm
15325 @opindex marm
15326 @opindex mthumb
15328 Select between generating code that executes in ARM and Thumb
15329 states.  The default for most configurations is to generate code
15330 that executes in ARM state, but the default can be changed by
15331 configuring GCC with the @option{--with-mode=}@var{state}
15332 configure option.
15334 You can also override the ARM and Thumb mode for each function
15335 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15336 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15338 @item -mtpcs-frame
15339 @opindex mtpcs-frame
15340 Generate a stack frame that is compliant with the Thumb Procedure Call
15341 Standard for all non-leaf functions.  (A leaf function is one that does
15342 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15344 @item -mtpcs-leaf-frame
15345 @opindex mtpcs-leaf-frame
15346 Generate a stack frame that is compliant with the Thumb Procedure Call
15347 Standard for all leaf functions.  (A leaf function is one that does
15348 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15350 @item -mcallee-super-interworking
15351 @opindex mcallee-super-interworking
15352 Gives all externally visible functions in the file being compiled an ARM
15353 instruction set header which switches to Thumb mode before executing the
15354 rest of the function.  This allows these functions to be called from
15355 non-interworking code.  This option is not valid in AAPCS configurations
15356 because interworking is enabled by default.
15358 @item -mcaller-super-interworking
15359 @opindex mcaller-super-interworking
15360 Allows calls via function pointers (including virtual functions) to
15361 execute correctly regardless of whether the target code has been
15362 compiled for interworking or not.  There is a small overhead in the cost
15363 of executing a function pointer if this option is enabled.  This option
15364 is not valid in AAPCS configurations because interworking is enabled
15365 by default.
15367 @item -mtp=@var{name}
15368 @opindex mtp
15369 Specify the access model for the thread local storage pointer.  The valid
15370 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15371 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15372 (supported in the arm6k architecture), and @samp{auto}, which uses the
15373 best available method for the selected processor.  The default setting is
15374 @samp{auto}.
15376 @item -mtls-dialect=@var{dialect}
15377 @opindex mtls-dialect
15378 Specify the dialect to use for accessing thread local storage.  Two
15379 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15380 @samp{gnu} dialect selects the original GNU scheme for supporting
15381 local and global dynamic TLS models.  The @samp{gnu2} dialect
15382 selects the GNU descriptor scheme, which provides better performance
15383 for shared libraries.  The GNU descriptor scheme is compatible with
15384 the original scheme, but does require new assembler, linker and
15385 library support.  Initial and local exec TLS models are unaffected by
15386 this option and always use the original scheme.
15388 @item -mword-relocations
15389 @opindex mword-relocations
15390 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15391 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15392 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15393 is specified.
15395 @item -mfix-cortex-m3-ldrd
15396 @opindex mfix-cortex-m3-ldrd
15397 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15398 with overlapping destination and base registers are used.  This option avoids
15399 generating these instructions.  This option is enabled by default when
15400 @option{-mcpu=cortex-m3} is specified.
15402 @item -munaligned-access
15403 @itemx -mno-unaligned-access
15404 @opindex munaligned-access
15405 @opindex mno-unaligned-access
15406 Enables (or disables) reading and writing of 16- and 32- bit values
15407 from addresses that are not 16- or 32- bit aligned.  By default
15408 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15409 ARMv8-M Baseline architectures, and enabled for all other
15410 architectures.  If unaligned access is not enabled then words in packed
15411 data structures are accessed a byte at a time.
15413 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15414 generated object file to either true or false, depending upon the
15415 setting of this option.  If unaligned access is enabled then the
15416 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15417 defined.
15419 @item -mneon-for-64bits
15420 @opindex mneon-for-64bits
15421 Enables using Neon to handle scalar 64-bits operations. This is
15422 disabled by default since the cost of moving data from core registers
15423 to Neon is high.
15425 @item -mslow-flash-data
15426 @opindex mslow-flash-data
15427 Assume loading data from flash is slower than fetching instruction.
15428 Therefore literal load is minimized for better performance.
15429 This option is only supported when compiling for ARMv7 M-profile and
15430 off by default.
15432 @item -masm-syntax-unified
15433 @opindex masm-syntax-unified
15434 Assume inline assembler is using unified asm syntax.  The default is
15435 currently off which implies divided syntax.  This option has no impact
15436 on Thumb2. However, this may change in future releases of GCC.
15437 Divided syntax should be considered deprecated.
15439 @item -mrestrict-it
15440 @opindex mrestrict-it
15441 Restricts generation of IT blocks to conform to the rules of ARMv8.
15442 IT blocks can only contain a single 16-bit instruction from a select
15443 set of instructions. This option is on by default for ARMv8 Thumb mode.
15445 @item -mprint-tune-info
15446 @opindex mprint-tune-info
15447 Print CPU tuning information as comment in assembler file.  This is
15448 an option used only for regression testing of the compiler and not
15449 intended for ordinary use in compiling code.  This option is disabled
15450 by default.
15452 @item -mpure-code
15453 @opindex mpure-code
15454 Do not allow constant data to be placed in code sections.
15455 Additionally, when compiling for ELF object format give all text sections the
15456 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15457 is only available when generating non-pic code for ARMv7-M targets.
15459 @item -mcmse
15460 @opindex mcmse
15461 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15462 Development Tools Engineering Specification", which can be found on
15463 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15464 @end table
15466 @node AVR Options
15467 @subsection AVR Options
15468 @cindex AVR Options
15470 These options are defined for AVR implementations:
15472 @table @gcctabopt
15473 @item -mmcu=@var{mcu}
15474 @opindex mmcu
15475 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15477 The default for this option is@tie{}@samp{avr2}.
15479 GCC supports the following AVR devices and ISAs:
15481 @include avr-mmcu.texi
15483 @item -mabsdata
15484 @opindex mabsdata
15486 Assume that all data in static storage can be accessed by LDS / STS
15487 instructions.  This option has only an effect on reduced Tiny devices like
15488 ATtiny40.  See also the @code{absdata}
15489 @ref{AVR Variable Attributes,variable attribute}.
15491 @item -maccumulate-args
15492 @opindex maccumulate-args
15493 Accumulate outgoing function arguments and acquire/release the needed
15494 stack space for outgoing function arguments once in function
15495 prologue/epilogue.  Without this option, outgoing arguments are pushed
15496 before calling a function and popped afterwards.
15498 Popping the arguments after the function call can be expensive on
15499 AVR so that accumulating the stack space might lead to smaller
15500 executables because arguments need not be removed from the
15501 stack after such a function call.
15503 This option can lead to reduced code size for functions that perform
15504 several calls to functions that get their arguments on the stack like
15505 calls to printf-like functions.
15507 @item -mbranch-cost=@var{cost}
15508 @opindex mbranch-cost
15509 Set the branch costs for conditional branch instructions to
15510 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15511 integers. The default branch cost is 0.
15513 @item -mcall-prologues
15514 @opindex mcall-prologues
15515 Functions prologues/epilogues are expanded as calls to appropriate
15516 subroutines.  Code size is smaller.
15518 @item -mint8
15519 @opindex mint8
15520 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15521 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15522 and @code{long long} is 4 bytes.  Please note that this option does not
15523 conform to the C standards, but it results in smaller code
15524 size.
15526 @item -mn-flash=@var{num}
15527 @opindex mn-flash
15528 Assume that the flash memory has a size of 
15529 @var{num} times 64@tie{}KiB.
15531 @item -mno-interrupts
15532 @opindex mno-interrupts
15533 Generated code is not compatible with hardware interrupts.
15534 Code size is smaller.
15536 @item -mrelax
15537 @opindex mrelax
15538 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15539 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15540 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15541 the assembler's command line and the @option{--relax} option to the
15542 linker's command line.
15544 Jump relaxing is performed by the linker because jump offsets are not
15545 known before code is located. Therefore, the assembler code generated by the
15546 compiler is the same, but the instructions in the executable may
15547 differ from instructions in the assembler code.
15549 Relaxing must be turned on if linker stubs are needed, see the
15550 section on @code{EIND} and linker stubs below.
15552 @item -mrmw
15553 @opindex mrmw
15554 Assume that the device supports the Read-Modify-Write
15555 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15557 @item -msp8
15558 @opindex msp8
15559 Treat the stack pointer register as an 8-bit register,
15560 i.e.@: assume the high byte of the stack pointer is zero.
15561 In general, you don't need to set this option by hand.
15563 This option is used internally by the compiler to select and
15564 build multilibs for architectures @code{avr2} and @code{avr25}.
15565 These architectures mix devices with and without @code{SPH}.
15566 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15567 the compiler driver adds or removes this option from the compiler
15568 proper's command line, because the compiler then knows if the device
15569 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15570 register or not.
15572 @item -mstrict-X
15573 @opindex mstrict-X
15574 Use address register @code{X} in a way proposed by the hardware.  This means
15575 that @code{X} is only used in indirect, post-increment or
15576 pre-decrement addressing.
15578 Without this option, the @code{X} register may be used in the same way
15579 as @code{Y} or @code{Z} which then is emulated by additional
15580 instructions.  
15581 For example, loading a value with @code{X+const} addressing with a
15582 small non-negative @code{const < 64} to a register @var{Rn} is
15583 performed as
15585 @example
15586 adiw r26, const   ; X += const
15587 ld   @var{Rn}, X        ; @var{Rn} = *X
15588 sbiw r26, const   ; X -= const
15589 @end example
15591 @item -mtiny-stack
15592 @opindex mtiny-stack
15593 Only change the lower 8@tie{}bits of the stack pointer.
15595 @item -mfract-convert-truncate
15596 @opindex mfract-convert-truncate
15597 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
15599 @item -nodevicelib
15600 @opindex nodevicelib
15601 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
15603 @item -Waddr-space-convert
15604 @opindex Waddr-space-convert
15605 Warn about conversions between address spaces in the case where the
15606 resulting address space is not contained in the incoming address space.
15608 @item -Wmisspelled-isr
15609 @opindex Wmisspelled-isr
15610 Warn if the ISR is misspelled, i.e. without __vector prefix.
15611 Enabled by default.
15612 @end table
15614 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
15615 @cindex @code{EIND}
15616 Pointers in the implementation are 16@tie{}bits wide.
15617 The address of a function or label is represented as word address so
15618 that indirect jumps and calls can target any code address in the
15619 range of 64@tie{}Ki words.
15621 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
15622 bytes of program memory space, there is a special function register called
15623 @code{EIND} that serves as most significant part of the target address
15624 when @code{EICALL} or @code{EIJMP} instructions are used.
15626 Indirect jumps and calls on these devices are handled as follows by
15627 the compiler and are subject to some limitations:
15629 @itemize @bullet
15631 @item
15632 The compiler never sets @code{EIND}.
15634 @item
15635 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
15636 instructions or might read @code{EIND} directly in order to emulate an
15637 indirect call/jump by means of a @code{RET} instruction.
15639 @item
15640 The compiler assumes that @code{EIND} never changes during the startup
15641 code or during the application. In particular, @code{EIND} is not
15642 saved/restored in function or interrupt service routine
15643 prologue/epilogue.
15645 @item
15646 For indirect calls to functions and computed goto, the linker
15647 generates @emph{stubs}. Stubs are jump pads sometimes also called
15648 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
15649 The stub contains a direct jump to the desired address.
15651 @item
15652 Linker relaxation must be turned on so that the linker generates
15653 the stubs correctly in all situations. See the compiler option
15654 @option{-mrelax} and the linker option @option{--relax}.
15655 There are corner cases where the linker is supposed to generate stubs
15656 but aborts without relaxation and without a helpful error message.
15658 @item
15659 The default linker script is arranged for code with @code{EIND = 0}.
15660 If code is supposed to work for a setup with @code{EIND != 0}, a custom
15661 linker script has to be used in order to place the sections whose
15662 name start with @code{.trampolines} into the segment where @code{EIND}
15663 points to.
15665 @item
15666 The startup code from libgcc never sets @code{EIND}.
15667 Notice that startup code is a blend of code from libgcc and AVR-LibC.
15668 For the impact of AVR-LibC on @code{EIND}, see the
15669 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
15671 @item
15672 It is legitimate for user-specific startup code to set up @code{EIND}
15673 early, for example by means of initialization code located in
15674 section @code{.init3}. Such code runs prior to general startup code
15675 that initializes RAM and calls constructors, but after the bit
15676 of startup code from AVR-LibC that sets @code{EIND} to the segment
15677 where the vector table is located.
15678 @example
15679 #include <avr/io.h>
15681 static void
15682 __attribute__((section(".init3"),naked,used,no_instrument_function))
15683 init3_set_eind (void)
15685   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
15686                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
15688 @end example
15690 @noindent
15691 The @code{__trampolines_start} symbol is defined in the linker script.
15693 @item
15694 Stubs are generated automatically by the linker if
15695 the following two conditions are met:
15696 @itemize @minus
15698 @item The address of a label is taken by means of the @code{gs} modifier
15699 (short for @emph{generate stubs}) like so:
15700 @example
15701 LDI r24, lo8(gs(@var{func}))
15702 LDI r25, hi8(gs(@var{func}))
15703 @end example
15704 @item The final location of that label is in a code segment
15705 @emph{outside} the segment where the stubs are located.
15706 @end itemize
15708 @item
15709 The compiler emits such @code{gs} modifiers for code labels in the
15710 following situations:
15711 @itemize @minus
15712 @item Taking address of a function or code label.
15713 @item Computed goto.
15714 @item If prologue-save function is used, see @option{-mcall-prologues}
15715 command-line option.
15716 @item Switch/case dispatch tables. If you do not want such dispatch
15717 tables you can specify the @option{-fno-jump-tables} command-line option.
15718 @item C and C++ constructors/destructors called during startup/shutdown.
15719 @item If the tools hit a @code{gs()} modifier explained above.
15720 @end itemize
15722 @item
15723 Jumping to non-symbolic addresses like so is @emph{not} supported:
15725 @example
15726 int main (void)
15728     /* Call function at word address 0x2 */
15729     return ((int(*)(void)) 0x2)();
15731 @end example
15733 Instead, a stub has to be set up, i.e.@: the function has to be called
15734 through a symbol (@code{func_4} in the example):
15736 @example
15737 int main (void)
15739     extern int func_4 (void);
15741     /* Call function at byte address 0x4 */
15742     return func_4();
15744 @end example
15746 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
15747 Alternatively, @code{func_4} can be defined in the linker script.
15748 @end itemize
15750 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
15751 @cindex @code{RAMPD}
15752 @cindex @code{RAMPX}
15753 @cindex @code{RAMPY}
15754 @cindex @code{RAMPZ}
15755 Some AVR devices support memories larger than the 64@tie{}KiB range
15756 that can be accessed with 16-bit pointers.  To access memory locations
15757 outside this 64@tie{}KiB range, the content of a @code{RAMP}
15758 register is used as high part of the address:
15759 The @code{X}, @code{Y}, @code{Z} address register is concatenated
15760 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
15761 register, respectively, to get a wide address. Similarly,
15762 @code{RAMPD} is used together with direct addressing.
15764 @itemize
15765 @item
15766 The startup code initializes the @code{RAMP} special function
15767 registers with zero.
15769 @item
15770 If a @ref{AVR Named Address Spaces,named address space} other than
15771 generic or @code{__flash} is used, then @code{RAMPZ} is set
15772 as needed before the operation.
15774 @item
15775 If the device supports RAM larger than 64@tie{}KiB and the compiler
15776 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
15777 is reset to zero after the operation.
15779 @item
15780 If the device comes with a specific @code{RAMP} register, the ISR
15781 prologue/epilogue saves/restores that SFR and initializes it with
15782 zero in case the ISR code might (implicitly) use it.
15784 @item
15785 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
15786 If you use inline assembler to read from locations outside the
15787 16-bit address range and change one of the @code{RAMP} registers,
15788 you must reset it to zero after the access.
15790 @end itemize
15792 @subsubsection AVR Built-in Macros
15794 GCC defines several built-in macros so that the user code can test
15795 for the presence or absence of features.  Almost any of the following
15796 built-in macros are deduced from device capabilities and thus
15797 triggered by the @option{-mmcu=} command-line option.
15799 For even more AVR-specific built-in macros see
15800 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
15802 @table @code
15804 @item __AVR_ARCH__
15805 Build-in macro that resolves to a decimal number that identifies the
15806 architecture and depends on the @option{-mmcu=@var{mcu}} option.
15807 Possible values are:
15809 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
15810 @code{4}, @code{5}, @code{51}, @code{6}
15812 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
15813 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
15815 respectively and
15817 @code{100}, @code{102}, @code{104},
15818 @code{105}, @code{106}, @code{107}
15820 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
15821 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
15822 If @var{mcu} specifies a device, this built-in macro is set
15823 accordingly. For example, with @option{-mmcu=atmega8} the macro is
15824 defined to @code{4}.
15826 @item __AVR_@var{Device}__
15827 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
15828 the device's name. For example, @option{-mmcu=atmega8} defines the
15829 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
15830 @code{__AVR_ATtiny261A__}, etc.
15832 The built-in macros' names follow
15833 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
15834 the device name as from the AVR user manual. The difference between
15835 @var{Device} in the built-in macro and @var{device} in
15836 @option{-mmcu=@var{device}} is that the latter is always lowercase.
15838 If @var{device} is not a device but only a core architecture like
15839 @samp{avr51}, this macro is not defined.
15841 @item __AVR_DEVICE_NAME__
15842 Setting @option{-mmcu=@var{device}} defines this built-in macro to
15843 the device's name. For example, with @option{-mmcu=atmega8} the macro
15844 is defined to @code{atmega8}.
15846 If @var{device} is not a device but only a core architecture like
15847 @samp{avr51}, this macro is not defined.
15849 @item __AVR_XMEGA__
15850 The device / architecture belongs to the XMEGA family of devices.
15852 @item __AVR_HAVE_ELPM__
15853 The device has the @code{ELPM} instruction.
15855 @item __AVR_HAVE_ELPMX__
15856 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
15857 R@var{n},Z+} instructions.
15859 @item __AVR_HAVE_MOVW__
15860 The device has the @code{MOVW} instruction to perform 16-bit
15861 register-register moves.
15863 @item __AVR_HAVE_LPMX__
15864 The device has the @code{LPM R@var{n},Z} and
15865 @code{LPM R@var{n},Z+} instructions.
15867 @item __AVR_HAVE_MUL__
15868 The device has a hardware multiplier. 
15870 @item __AVR_HAVE_JMP_CALL__
15871 The device has the @code{JMP} and @code{CALL} instructions.
15872 This is the case for devices with at least 16@tie{}KiB of program
15873 memory.
15875 @item __AVR_HAVE_EIJMP_EICALL__
15876 @itemx __AVR_3_BYTE_PC__
15877 The device has the @code{EIJMP} and @code{EICALL} instructions.
15878 This is the case for devices with more than 128@tie{}KiB of program memory.
15879 This also means that the program counter
15880 (PC) is 3@tie{}bytes wide.
15882 @item __AVR_2_BYTE_PC__
15883 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
15884 with up to 128@tie{}KiB of program memory.
15886 @item __AVR_HAVE_8BIT_SP__
15887 @itemx __AVR_HAVE_16BIT_SP__
15888 The stack pointer (SP) register is treated as 8-bit respectively
15889 16-bit register by the compiler.
15890 The definition of these macros is affected by @option{-mtiny-stack}.
15892 @item __AVR_HAVE_SPH__
15893 @itemx __AVR_SP8__
15894 The device has the SPH (high part of stack pointer) special function
15895 register or has an 8-bit stack pointer, respectively.
15896 The definition of these macros is affected by @option{-mmcu=} and
15897 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
15898 by @option{-msp8}.
15900 @item __AVR_HAVE_RAMPD__
15901 @itemx __AVR_HAVE_RAMPX__
15902 @itemx __AVR_HAVE_RAMPY__
15903 @itemx __AVR_HAVE_RAMPZ__
15904 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
15905 @code{RAMPZ} special function register, respectively.
15907 @item __NO_INTERRUPTS__
15908 This macro reflects the @option{-mno-interrupts} command-line option.
15910 @item __AVR_ERRATA_SKIP__
15911 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
15912 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
15913 instructions because of a hardware erratum.  Skip instructions are
15914 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
15915 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
15916 set.
15918 @item __AVR_ISA_RMW__
15919 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
15921 @item __AVR_SFR_OFFSET__=@var{offset}
15922 Instructions that can address I/O special function registers directly
15923 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
15924 address as if addressed by an instruction to access RAM like @code{LD}
15925 or @code{STS}. This offset depends on the device architecture and has
15926 to be subtracted from the RAM address in order to get the
15927 respective I/O@tie{}address.
15929 @item __WITH_AVRLIBC__
15930 The compiler is configured to be used together with AVR-Libc.
15931 See the @option{--with-avrlibc} configure option.
15933 @end table
15935 @node Blackfin Options
15936 @subsection Blackfin Options
15937 @cindex Blackfin Options
15939 @table @gcctabopt
15940 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
15941 @opindex mcpu=
15942 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
15943 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
15944 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
15945 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
15946 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
15947 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
15948 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
15949 @samp{bf561}, @samp{bf592}.
15951 The optional @var{sirevision} specifies the silicon revision of the target
15952 Blackfin processor.  Any workarounds available for the targeted silicon revision
15953 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
15954 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
15955 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
15956 hexadecimal digits representing the major and minor numbers in the silicon
15957 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
15958 is not defined.  If @var{sirevision} is @samp{any}, the
15959 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
15960 If this optional @var{sirevision} is not used, GCC assumes the latest known
15961 silicon revision of the targeted Blackfin processor.
15963 GCC defines a preprocessor macro for the specified @var{cpu}.
15964 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
15965 provided by libgloss to be linked in if @option{-msim} is not given.
15967 Without this option, @samp{bf532} is used as the processor by default.
15969 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
15970 only the preprocessor macro is defined.
15972 @item -msim
15973 @opindex msim
15974 Specifies that the program will be run on the simulator.  This causes
15975 the simulator BSP provided by libgloss to be linked in.  This option
15976 has effect only for @samp{bfin-elf} toolchain.
15977 Certain other options, such as @option{-mid-shared-library} and
15978 @option{-mfdpic}, imply @option{-msim}.
15980 @item -momit-leaf-frame-pointer
15981 @opindex momit-leaf-frame-pointer
15982 Don't keep the frame pointer in a register for leaf functions.  This
15983 avoids the instructions to save, set up and restore frame pointers and
15984 makes an extra register available in leaf functions.  The option
15985 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
15986 which might make debugging harder.
15988 @item -mspecld-anomaly
15989 @opindex mspecld-anomaly
15990 When enabled, the compiler ensures that the generated code does not
15991 contain speculative loads after jump instructions. If this option is used,
15992 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
15994 @item -mno-specld-anomaly
15995 @opindex mno-specld-anomaly
15996 Don't generate extra code to prevent speculative loads from occurring.
15998 @item -mcsync-anomaly
15999 @opindex mcsync-anomaly
16000 When enabled, the compiler ensures that the generated code does not
16001 contain CSYNC or SSYNC instructions too soon after conditional branches.
16002 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16004 @item -mno-csync-anomaly
16005 @opindex mno-csync-anomaly
16006 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16007 occurring too soon after a conditional branch.
16009 @item -mlow-64k
16010 @opindex mlow-64k
16011 When enabled, the compiler is free to take advantage of the knowledge that
16012 the entire program fits into the low 64k of memory.
16014 @item -mno-low-64k
16015 @opindex mno-low-64k
16016 Assume that the program is arbitrarily large.  This is the default.
16018 @item -mstack-check-l1
16019 @opindex mstack-check-l1
16020 Do stack checking using information placed into L1 scratchpad memory by the
16021 uClinux kernel.
16023 @item -mid-shared-library
16024 @opindex mid-shared-library
16025 Generate code that supports shared libraries via the library ID method.
16026 This allows for execute in place and shared libraries in an environment
16027 without virtual memory management.  This option implies @option{-fPIC}.
16028 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16030 @item -mno-id-shared-library
16031 @opindex mno-id-shared-library
16032 Generate code that doesn't assume ID-based shared libraries are being used.
16033 This is the default.
16035 @item -mleaf-id-shared-library
16036 @opindex mleaf-id-shared-library
16037 Generate code that supports shared libraries via the library ID method,
16038 but assumes that this library or executable won't link against any other
16039 ID shared libraries.  That allows the compiler to use faster code for jumps
16040 and calls.
16042 @item -mno-leaf-id-shared-library
16043 @opindex mno-leaf-id-shared-library
16044 Do not assume that the code being compiled won't link against any ID shared
16045 libraries.  Slower code is generated for jump and call insns.
16047 @item -mshared-library-id=n
16048 @opindex mshared-library-id
16049 Specifies the identification number of the ID-based shared library being
16050 compiled.  Specifying a value of 0 generates more compact code; specifying
16051 other values forces the allocation of that number to the current
16052 library but is no more space- or time-efficient than omitting this option.
16054 @item -msep-data
16055 @opindex msep-data
16056 Generate code that allows the data segment to be located in a different
16057 area of memory from the text segment.  This allows for execute in place in
16058 an environment without virtual memory management by eliminating relocations
16059 against the text section.
16061 @item -mno-sep-data
16062 @opindex mno-sep-data
16063 Generate code that assumes that the data segment follows the text segment.
16064 This is the default.
16066 @item -mlong-calls
16067 @itemx -mno-long-calls
16068 @opindex mlong-calls
16069 @opindex mno-long-calls
16070 Tells the compiler to perform function calls by first loading the
16071 address of the function into a register and then performing a subroutine
16072 call on this register.  This switch is needed if the target function
16073 lies outside of the 24-bit addressing range of the offset-based
16074 version of subroutine call instruction.
16076 This feature is not enabled by default.  Specifying
16077 @option{-mno-long-calls} restores the default behavior.  Note these
16078 switches have no effect on how the compiler generates code to handle
16079 function calls via function pointers.
16081 @item -mfast-fp
16082 @opindex mfast-fp
16083 Link with the fast floating-point library. This library relaxes some of
16084 the IEEE floating-point standard's rules for checking inputs against
16085 Not-a-Number (NAN), in the interest of performance.
16087 @item -minline-plt
16088 @opindex minline-plt
16089 Enable inlining of PLT entries in function calls to functions that are
16090 not known to bind locally.  It has no effect without @option{-mfdpic}.
16092 @item -mmulticore
16093 @opindex mmulticore
16094 Build a standalone application for multicore Blackfin processors. 
16095 This option causes proper start files and link scripts supporting 
16096 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16097 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16099 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16100 selects the one-application-per-core programming model.  Without
16101 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16102 programming model is used. In this model, the main function of Core B
16103 should be named as @code{coreb_main}.
16105 If this option is not used, the single-core application programming
16106 model is used.
16108 @item -mcorea
16109 @opindex mcorea
16110 Build a standalone application for Core A of BF561 when using
16111 the one-application-per-core programming model. Proper start files
16112 and link scripts are used to support Core A, and the macro
16113 @code{__BFIN_COREA} is defined.
16114 This option can only be used in conjunction with @option{-mmulticore}.
16116 @item -mcoreb
16117 @opindex mcoreb
16118 Build a standalone application for Core B of BF561 when using
16119 the one-application-per-core programming model. Proper start files
16120 and link scripts are used to support Core B, and the macro
16121 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16122 should be used instead of @code{main}. 
16123 This option can only be used in conjunction with @option{-mmulticore}.
16125 @item -msdram
16126 @opindex msdram
16127 Build a standalone application for SDRAM. Proper start files and
16128 link scripts are used to put the application into SDRAM, and the macro
16129 @code{__BFIN_SDRAM} is defined.
16130 The loader should initialize SDRAM before loading the application.
16132 @item -micplb
16133 @opindex micplb
16134 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16135 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16136 are enabled; for standalone applications the default is off.
16137 @end table
16139 @node C6X Options
16140 @subsection C6X Options
16141 @cindex C6X Options
16143 @table @gcctabopt
16144 @item -march=@var{name}
16145 @opindex march
16146 This specifies the name of the target architecture.  GCC uses this
16147 name to determine what kind of instructions it can emit when generating
16148 assembly code.  Permissible names are: @samp{c62x},
16149 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16151 @item -mbig-endian
16152 @opindex mbig-endian
16153 Generate code for a big-endian target.
16155 @item -mlittle-endian
16156 @opindex mlittle-endian
16157 Generate code for a little-endian target.  This is the default.
16159 @item -msim
16160 @opindex msim
16161 Choose startup files and linker script suitable for the simulator.
16163 @item -msdata=default
16164 @opindex msdata=default
16165 Put small global and static data in the @code{.neardata} section,
16166 which is pointed to by register @code{B14}.  Put small uninitialized
16167 global and static data in the @code{.bss} section, which is adjacent
16168 to the @code{.neardata} section.  Put small read-only data into the
16169 @code{.rodata} section.  The corresponding sections used for large
16170 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16172 @item -msdata=all
16173 @opindex msdata=all
16174 Put all data, not just small objects, into the sections reserved for
16175 small data, and use addressing relative to the @code{B14} register to
16176 access them.
16178 @item -msdata=none
16179 @opindex msdata=none
16180 Make no use of the sections reserved for small data, and use absolute
16181 addresses to access all data.  Put all initialized global and static
16182 data in the @code{.fardata} section, and all uninitialized data in the
16183 @code{.far} section.  Put all constant data into the @code{.const}
16184 section.
16185 @end table
16187 @node CRIS Options
16188 @subsection CRIS Options
16189 @cindex CRIS Options
16191 These options are defined specifically for the CRIS ports.
16193 @table @gcctabopt
16194 @item -march=@var{architecture-type}
16195 @itemx -mcpu=@var{architecture-type}
16196 @opindex march
16197 @opindex mcpu
16198 Generate code for the specified architecture.  The choices for
16199 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16200 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16201 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16202 @samp{v10}.
16204 @item -mtune=@var{architecture-type}
16205 @opindex mtune
16206 Tune to @var{architecture-type} everything applicable about the generated
16207 code, except for the ABI and the set of available instructions.  The
16208 choices for @var{architecture-type} are the same as for
16209 @option{-march=@var{architecture-type}}.
16211 @item -mmax-stack-frame=@var{n}
16212 @opindex mmax-stack-frame
16213 Warn when the stack frame of a function exceeds @var{n} bytes.
16215 @item -metrax4
16216 @itemx -metrax100
16217 @opindex metrax4
16218 @opindex metrax100
16219 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16220 @option{-march=v3} and @option{-march=v8} respectively.
16222 @item -mmul-bug-workaround
16223 @itemx -mno-mul-bug-workaround
16224 @opindex mmul-bug-workaround
16225 @opindex mno-mul-bug-workaround
16226 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16227 models where it applies.  This option is active by default.
16229 @item -mpdebug
16230 @opindex mpdebug
16231 Enable CRIS-specific verbose debug-related information in the assembly
16232 code.  This option also has the effect of turning off the @samp{#NO_APP}
16233 formatted-code indicator to the assembler at the beginning of the
16234 assembly file.
16236 @item -mcc-init
16237 @opindex mcc-init
16238 Do not use condition-code results from previous instruction; always emit
16239 compare and test instructions before use of condition codes.
16241 @item -mno-side-effects
16242 @opindex mno-side-effects
16243 Do not emit instructions with side effects in addressing modes other than
16244 post-increment.
16246 @item -mstack-align
16247 @itemx -mno-stack-align
16248 @itemx -mdata-align
16249 @itemx -mno-data-align
16250 @itemx -mconst-align
16251 @itemx -mno-const-align
16252 @opindex mstack-align
16253 @opindex mno-stack-align
16254 @opindex mdata-align
16255 @opindex mno-data-align
16256 @opindex mconst-align
16257 @opindex mno-const-align
16258 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16259 stack frame, individual data and constants to be aligned for the maximum
16260 single data access size for the chosen CPU model.  The default is to
16261 arrange for 32-bit alignment.  ABI details such as structure layout are
16262 not affected by these options.
16264 @item -m32-bit
16265 @itemx -m16-bit
16266 @itemx -m8-bit
16267 @opindex m32-bit
16268 @opindex m16-bit
16269 @opindex m8-bit
16270 Similar to the stack- data- and const-align options above, these options
16271 arrange for stack frame, writable data and constants to all be 32-bit,
16272 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16274 @item -mno-prologue-epilogue
16275 @itemx -mprologue-epilogue
16276 @opindex mno-prologue-epilogue
16277 @opindex mprologue-epilogue
16278 With @option{-mno-prologue-epilogue}, the normal function prologue and
16279 epilogue which set up the stack frame are omitted and no return
16280 instructions or return sequences are generated in the code.  Use this
16281 option only together with visual inspection of the compiled code: no
16282 warnings or errors are generated when call-saved registers must be saved,
16283 or storage for local variables needs to be allocated.
16285 @item -mno-gotplt
16286 @itemx -mgotplt
16287 @opindex mno-gotplt
16288 @opindex mgotplt
16289 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16290 instruction sequences that load addresses for functions from the PLT part
16291 of the GOT rather than (traditional on other architectures) calls to the
16292 PLT@.  The default is @option{-mgotplt}.
16294 @item -melf
16295 @opindex melf
16296 Legacy no-op option only recognized with the cris-axis-elf and
16297 cris-axis-linux-gnu targets.
16299 @item -mlinux
16300 @opindex mlinux
16301 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16303 @item -sim
16304 @opindex sim
16305 This option, recognized for the cris-axis-elf, arranges
16306 to link with input-output functions from a simulator library.  Code,
16307 initialized data and zero-initialized data are allocated consecutively.
16309 @item -sim2
16310 @opindex sim2
16311 Like @option{-sim}, but pass linker options to locate initialized data at
16312 0x40000000 and zero-initialized data at 0x80000000.
16313 @end table
16315 @node CR16 Options
16316 @subsection CR16 Options
16317 @cindex CR16 Options
16319 These options are defined specifically for the CR16 ports.
16321 @table @gcctabopt
16323 @item -mmac
16324 @opindex mmac
16325 Enable the use of multiply-accumulate instructions. Disabled by default.
16327 @item -mcr16cplus
16328 @itemx -mcr16c
16329 @opindex mcr16cplus
16330 @opindex mcr16c
16331 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16332 is default.
16334 @item -msim
16335 @opindex msim
16336 Links the library libsim.a which is in compatible with simulator. Applicable
16337 to ELF compiler only.
16339 @item -mint32
16340 @opindex mint32
16341 Choose integer type as 32-bit wide.
16343 @item -mbit-ops
16344 @opindex mbit-ops
16345 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16347 @item -mdata-model=@var{model}
16348 @opindex mdata-model
16349 Choose a data model. The choices for @var{model} are @samp{near},
16350 @samp{far} or @samp{medium}. @samp{medium} is default.
16351 However, @samp{far} is not valid with @option{-mcr16c}, as the
16352 CR16C architecture does not support the far data model.
16353 @end table
16355 @node Darwin Options
16356 @subsection Darwin Options
16357 @cindex Darwin options
16359 These options are defined for all architectures running the Darwin operating
16360 system.
16362 FSF GCC on Darwin does not create ``fat'' object files; it creates
16363 an object file for the single architecture that GCC was built to
16364 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16365 @option{-arch} options are used; it does so by running the compiler or
16366 linker multiple times and joining the results together with
16367 @file{lipo}.
16369 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16370 @samp{i686}) is determined by the flags that specify the ISA
16371 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16372 @option{-force_cpusubtype_ALL} option can be used to override this.
16374 The Darwin tools vary in their behavior when presented with an ISA
16375 mismatch.  The assembler, @file{as}, only permits instructions to
16376 be used that are valid for the subtype of the file it is generating,
16377 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16378 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16379 and prints an error if asked to create a shared library with a less
16380 restrictive subtype than its input files (for instance, trying to put
16381 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16382 for executables, @command{ld}, quietly gives the executable the most
16383 restrictive subtype of any of its input files.
16385 @table @gcctabopt
16386 @item -F@var{dir}
16387 @opindex F
16388 Add the framework directory @var{dir} to the head of the list of
16389 directories to be searched for header files.  These directories are
16390 interleaved with those specified by @option{-I} options and are
16391 scanned in a left-to-right order.
16393 A framework directory is a directory with frameworks in it.  A
16394 framework is a directory with a @file{Headers} and/or
16395 @file{PrivateHeaders} directory contained directly in it that ends
16396 in @file{.framework}.  The name of a framework is the name of this
16397 directory excluding the @file{.framework}.  Headers associated with
16398 the framework are found in one of those two directories, with
16399 @file{Headers} being searched first.  A subframework is a framework
16400 directory that is in a framework's @file{Frameworks} directory.
16401 Includes of subframework headers can only appear in a header of a
16402 framework that contains the subframework, or in a sibling subframework
16403 header.  Two subframeworks are siblings if they occur in the same
16404 framework.  A subframework should not have the same name as a
16405 framework; a warning is issued if this is violated.  Currently a
16406 subframework cannot have subframeworks; in the future, the mechanism
16407 may be extended to support this.  The standard frameworks can be found
16408 in @file{/System/Library/Frameworks} and
16409 @file{/Library/Frameworks}.  An example include looks like
16410 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16411 the name of the framework and @file{header.h} is found in the
16412 @file{PrivateHeaders} or @file{Headers} directory.
16414 @item -iframework@var{dir}
16415 @opindex iframework
16416 Like @option{-F} except the directory is a treated as a system
16417 directory.  The main difference between this @option{-iframework} and
16418 @option{-F} is that with @option{-iframework} the compiler does not
16419 warn about constructs contained within header files found via
16420 @var{dir}.  This option is valid only for the C family of languages.
16422 @item -gused
16423 @opindex gused
16424 Emit debugging information for symbols that are used.  For stabs
16425 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16426 This is by default ON@.
16428 @item -gfull
16429 @opindex gfull
16430 Emit debugging information for all symbols and types.
16432 @item -mmacosx-version-min=@var{version}
16433 The earliest version of MacOS X that this executable will run on
16434 is @var{version}.  Typical values of @var{version} include @code{10.1},
16435 @code{10.2}, and @code{10.3.9}.
16437 If the compiler was built to use the system's headers by default,
16438 then the default for this option is the system version on which the
16439 compiler is running, otherwise the default is to make choices that
16440 are compatible with as many systems and code bases as possible.
16442 @item -mkernel
16443 @opindex mkernel
16444 Enable kernel development mode.  The @option{-mkernel} option sets
16445 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16446 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16447 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16448 applicable.  This mode also sets @option{-mno-altivec},
16449 @option{-msoft-float}, @option{-fno-builtin} and
16450 @option{-mlong-branch} for PowerPC targets.
16452 @item -mone-byte-bool
16453 @opindex mone-byte-bool
16454 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16455 By default @code{sizeof(bool)} is @code{4} when compiling for
16456 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16457 option has no effect on x86.
16459 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16460 to generate code that is not binary compatible with code generated
16461 without that switch.  Using this switch may require recompiling all
16462 other modules in a program, including system libraries.  Use this
16463 switch to conform to a non-default data model.
16465 @item -mfix-and-continue
16466 @itemx -ffix-and-continue
16467 @itemx -findirect-data
16468 @opindex mfix-and-continue
16469 @opindex ffix-and-continue
16470 @opindex findirect-data
16471 Generate code suitable for fast turnaround development, such as to
16472 allow GDB to dynamically load @file{.o} files into already-running
16473 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16474 are provided for backwards compatibility.
16476 @item -all_load
16477 @opindex all_load
16478 Loads all members of static archive libraries.
16479 See man ld(1) for more information.
16481 @item -arch_errors_fatal
16482 @opindex arch_errors_fatal
16483 Cause the errors having to do with files that have the wrong architecture
16484 to be fatal.
16486 @item -bind_at_load
16487 @opindex bind_at_load
16488 Causes the output file to be marked such that the dynamic linker will
16489 bind all undefined references when the file is loaded or launched.
16491 @item -bundle
16492 @opindex bundle
16493 Produce a Mach-o bundle format file.
16494 See man ld(1) for more information.
16496 @item -bundle_loader @var{executable}
16497 @opindex bundle_loader
16498 This option specifies the @var{executable} that will load the build
16499 output file being linked.  See man ld(1) for more information.
16501 @item -dynamiclib
16502 @opindex dynamiclib
16503 When passed this option, GCC produces a dynamic library instead of
16504 an executable when linking, using the Darwin @file{libtool} command.
16506 @item -force_cpusubtype_ALL
16507 @opindex force_cpusubtype_ALL
16508 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16509 one controlled by the @option{-mcpu} or @option{-march} option.
16511 @item -allowable_client  @var{client_name}
16512 @itemx -client_name
16513 @itemx -compatibility_version
16514 @itemx -current_version
16515 @itemx -dead_strip
16516 @itemx -dependency-file
16517 @itemx -dylib_file
16518 @itemx -dylinker_install_name
16519 @itemx -dynamic
16520 @itemx -exported_symbols_list
16521 @itemx -filelist
16522 @need 800
16523 @itemx -flat_namespace
16524 @itemx -force_flat_namespace
16525 @itemx -headerpad_max_install_names
16526 @itemx -image_base
16527 @itemx -init
16528 @itemx -install_name
16529 @itemx -keep_private_externs
16530 @itemx -multi_module
16531 @itemx -multiply_defined
16532 @itemx -multiply_defined_unused
16533 @need 800
16534 @itemx -noall_load
16535 @itemx -no_dead_strip_inits_and_terms
16536 @itemx -nofixprebinding
16537 @itemx -nomultidefs
16538 @itemx -noprebind
16539 @itemx -noseglinkedit
16540 @itemx -pagezero_size
16541 @itemx -prebind
16542 @itemx -prebind_all_twolevel_modules
16543 @itemx -private_bundle
16544 @need 800
16545 @itemx -read_only_relocs
16546 @itemx -sectalign
16547 @itemx -sectobjectsymbols
16548 @itemx -whyload
16549 @itemx -seg1addr
16550 @itemx -sectcreate
16551 @itemx -sectobjectsymbols
16552 @itemx -sectorder
16553 @itemx -segaddr
16554 @itemx -segs_read_only_addr
16555 @need 800
16556 @itemx -segs_read_write_addr
16557 @itemx -seg_addr_table
16558 @itemx -seg_addr_table_filename
16559 @itemx -seglinkedit
16560 @itemx -segprot
16561 @itemx -segs_read_only_addr
16562 @itemx -segs_read_write_addr
16563 @itemx -single_module
16564 @itemx -static
16565 @itemx -sub_library
16566 @need 800
16567 @itemx -sub_umbrella
16568 @itemx -twolevel_namespace
16569 @itemx -umbrella
16570 @itemx -undefined
16571 @itemx -unexported_symbols_list
16572 @itemx -weak_reference_mismatches
16573 @itemx -whatsloaded
16574 @opindex allowable_client
16575 @opindex client_name
16576 @opindex compatibility_version
16577 @opindex current_version
16578 @opindex dead_strip
16579 @opindex dependency-file
16580 @opindex dylib_file
16581 @opindex dylinker_install_name
16582 @opindex dynamic
16583 @opindex exported_symbols_list
16584 @opindex filelist
16585 @opindex flat_namespace
16586 @opindex force_flat_namespace
16587 @opindex headerpad_max_install_names
16588 @opindex image_base
16589 @opindex init
16590 @opindex install_name
16591 @opindex keep_private_externs
16592 @opindex multi_module
16593 @opindex multiply_defined
16594 @opindex multiply_defined_unused
16595 @opindex noall_load
16596 @opindex no_dead_strip_inits_and_terms
16597 @opindex nofixprebinding
16598 @opindex nomultidefs
16599 @opindex noprebind
16600 @opindex noseglinkedit
16601 @opindex pagezero_size
16602 @opindex prebind
16603 @opindex prebind_all_twolevel_modules
16604 @opindex private_bundle
16605 @opindex read_only_relocs
16606 @opindex sectalign
16607 @opindex sectobjectsymbols
16608 @opindex whyload
16609 @opindex seg1addr
16610 @opindex sectcreate
16611 @opindex sectobjectsymbols
16612 @opindex sectorder
16613 @opindex segaddr
16614 @opindex segs_read_only_addr
16615 @opindex segs_read_write_addr
16616 @opindex seg_addr_table
16617 @opindex seg_addr_table_filename
16618 @opindex seglinkedit
16619 @opindex segprot
16620 @opindex segs_read_only_addr
16621 @opindex segs_read_write_addr
16622 @opindex single_module
16623 @opindex static
16624 @opindex sub_library
16625 @opindex sub_umbrella
16626 @opindex twolevel_namespace
16627 @opindex umbrella
16628 @opindex undefined
16629 @opindex unexported_symbols_list
16630 @opindex weak_reference_mismatches
16631 @opindex whatsloaded
16632 These options are passed to the Darwin linker.  The Darwin linker man page
16633 describes them in detail.
16634 @end table
16636 @node DEC Alpha Options
16637 @subsection DEC Alpha Options
16639 These @samp{-m} options are defined for the DEC Alpha implementations:
16641 @table @gcctabopt
16642 @item -mno-soft-float
16643 @itemx -msoft-float
16644 @opindex mno-soft-float
16645 @opindex msoft-float
16646 Use (do not use) the hardware floating-point instructions for
16647 floating-point operations.  When @option{-msoft-float} is specified,
16648 functions in @file{libgcc.a} are used to perform floating-point
16649 operations.  Unless they are replaced by routines that emulate the
16650 floating-point operations, or compiled in such a way as to call such
16651 emulations routines, these routines issue floating-point
16652 operations.   If you are compiling for an Alpha without floating-point
16653 operations, you must ensure that the library is built so as not to call
16654 them.
16656 Note that Alpha implementations without floating-point operations are
16657 required to have floating-point registers.
16659 @item -mfp-reg
16660 @itemx -mno-fp-regs
16661 @opindex mfp-reg
16662 @opindex mno-fp-regs
16663 Generate code that uses (does not use) the floating-point register set.
16664 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
16665 register set is not used, floating-point operands are passed in integer
16666 registers as if they were integers and floating-point results are passed
16667 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
16668 so any function with a floating-point argument or return value called by code
16669 compiled with @option{-mno-fp-regs} must also be compiled with that
16670 option.
16672 A typical use of this option is building a kernel that does not use,
16673 and hence need not save and restore, any floating-point registers.
16675 @item -mieee
16676 @opindex mieee
16677 The Alpha architecture implements floating-point hardware optimized for
16678 maximum performance.  It is mostly compliant with the IEEE floating-point
16679 standard.  However, for full compliance, software assistance is
16680 required.  This option generates code fully IEEE-compliant code
16681 @emph{except} that the @var{inexact-flag} is not maintained (see below).
16682 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
16683 defined during compilation.  The resulting code is less efficient but is
16684 able to correctly support denormalized numbers and exceptional IEEE
16685 values such as not-a-number and plus/minus infinity.  Other Alpha
16686 compilers call this option @option{-ieee_with_no_inexact}.
16688 @item -mieee-with-inexact
16689 @opindex mieee-with-inexact
16690 This is like @option{-mieee} except the generated code also maintains
16691 the IEEE @var{inexact-flag}.  Turning on this option causes the
16692 generated code to implement fully-compliant IEEE math.  In addition to
16693 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
16694 macro.  On some Alpha implementations the resulting code may execute
16695 significantly slower than the code generated by default.  Since there is
16696 very little code that depends on the @var{inexact-flag}, you should
16697 normally not specify this option.  Other Alpha compilers call this
16698 option @option{-ieee_with_inexact}.
16700 @item -mfp-trap-mode=@var{trap-mode}
16701 @opindex mfp-trap-mode
16702 This option controls what floating-point related traps are enabled.
16703 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
16704 The trap mode can be set to one of four values:
16706 @table @samp
16707 @item n
16708 This is the default (normal) setting.  The only traps that are enabled
16709 are the ones that cannot be disabled in software (e.g., division by zero
16710 trap).
16712 @item u
16713 In addition to the traps enabled by @samp{n}, underflow traps are enabled
16714 as well.
16716 @item su
16717 Like @samp{u}, but the instructions are marked to be safe for software
16718 completion (see Alpha architecture manual for details).
16720 @item sui
16721 Like @samp{su}, but inexact traps are enabled as well.
16722 @end table
16724 @item -mfp-rounding-mode=@var{rounding-mode}
16725 @opindex mfp-rounding-mode
16726 Selects the IEEE rounding mode.  Other Alpha compilers call this option
16727 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
16730 @table @samp
16731 @item n
16732 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
16733 the nearest machine number or towards the even machine number in case
16734 of a tie.
16736 @item m
16737 Round towards minus infinity.
16739 @item c
16740 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
16742 @item d
16743 Dynamic rounding mode.  A field in the floating-point control register
16744 (@var{fpcr}, see Alpha architecture reference manual) controls the
16745 rounding mode in effect.  The C library initializes this register for
16746 rounding towards plus infinity.  Thus, unless your program modifies the
16747 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
16748 @end table
16750 @item -mtrap-precision=@var{trap-precision}
16751 @opindex mtrap-precision
16752 In the Alpha architecture, floating-point traps are imprecise.  This
16753 means without software assistance it is impossible to recover from a
16754 floating trap and program execution normally needs to be terminated.
16755 GCC can generate code that can assist operating system trap handlers
16756 in determining the exact location that caused a floating-point trap.
16757 Depending on the requirements of an application, different levels of
16758 precisions can be selected:
16760 @table @samp
16761 @item p
16762 Program precision.  This option is the default and means a trap handler
16763 can only identify which program caused a floating-point exception.
16765 @item f
16766 Function precision.  The trap handler can determine the function that
16767 caused a floating-point exception.
16769 @item i
16770 Instruction precision.  The trap handler can determine the exact
16771 instruction that caused a floating-point exception.
16772 @end table
16774 Other Alpha compilers provide the equivalent options called
16775 @option{-scope_safe} and @option{-resumption_safe}.
16777 @item -mieee-conformant
16778 @opindex mieee-conformant
16779 This option marks the generated code as IEEE conformant.  You must not
16780 use this option unless you also specify @option{-mtrap-precision=i} and either
16781 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
16782 is to emit the line @samp{.eflag 48} in the function prologue of the
16783 generated assembly file.
16785 @item -mbuild-constants
16786 @opindex mbuild-constants
16787 Normally GCC examines a 32- or 64-bit integer constant to
16788 see if it can construct it from smaller constants in two or three
16789 instructions.  If it cannot, it outputs the constant as a literal and
16790 generates code to load it from the data segment at run time.
16792 Use this option to require GCC to construct @emph{all} integer constants
16793 using code, even if it takes more instructions (the maximum is six).
16795 You typically use this option to build a shared library dynamic
16796 loader.  Itself a shared library, it must relocate itself in memory
16797 before it can find the variables and constants in its own data segment.
16799 @item -mbwx
16800 @itemx -mno-bwx
16801 @itemx -mcix
16802 @itemx -mno-cix
16803 @itemx -mfix
16804 @itemx -mno-fix
16805 @itemx -mmax
16806 @itemx -mno-max
16807 @opindex mbwx
16808 @opindex mno-bwx
16809 @opindex mcix
16810 @opindex mno-cix
16811 @opindex mfix
16812 @opindex mno-fix
16813 @opindex mmax
16814 @opindex mno-max
16815 Indicate whether GCC should generate code to use the optional BWX,
16816 CIX, FIX and MAX instruction sets.  The default is to use the instruction
16817 sets supported by the CPU type specified via @option{-mcpu=} option or that
16818 of the CPU on which GCC was built if none is specified.
16820 @item -mfloat-vax
16821 @itemx -mfloat-ieee
16822 @opindex mfloat-vax
16823 @opindex mfloat-ieee
16824 Generate code that uses (does not use) VAX F and G floating-point
16825 arithmetic instead of IEEE single and double precision.
16827 @item -mexplicit-relocs
16828 @itemx -mno-explicit-relocs
16829 @opindex mexplicit-relocs
16830 @opindex mno-explicit-relocs
16831 Older Alpha assemblers provided no way to generate symbol relocations
16832 except via assembler macros.  Use of these macros does not allow
16833 optimal instruction scheduling.  GNU binutils as of version 2.12
16834 supports a new syntax that allows the compiler to explicitly mark
16835 which relocations should apply to which instructions.  This option
16836 is mostly useful for debugging, as GCC detects the capabilities of
16837 the assembler when it is built and sets the default accordingly.
16839 @item -msmall-data
16840 @itemx -mlarge-data
16841 @opindex msmall-data
16842 @opindex mlarge-data
16843 When @option{-mexplicit-relocs} is in effect, static data is
16844 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
16845 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
16846 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
16847 16-bit relocations off of the @code{$gp} register.  This limits the
16848 size of the small data area to 64KB, but allows the variables to be
16849 directly accessed via a single instruction.
16851 The default is @option{-mlarge-data}.  With this option the data area
16852 is limited to just below 2GB@.  Programs that require more than 2GB of
16853 data must use @code{malloc} or @code{mmap} to allocate the data in the
16854 heap instead of in the program's data segment.
16856 When generating code for shared libraries, @option{-fpic} implies
16857 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
16859 @item -msmall-text
16860 @itemx -mlarge-text
16861 @opindex msmall-text
16862 @opindex mlarge-text
16863 When @option{-msmall-text} is used, the compiler assumes that the
16864 code of the entire program (or shared library) fits in 4MB, and is
16865 thus reachable with a branch instruction.  When @option{-msmall-data}
16866 is used, the compiler can assume that all local symbols share the
16867 same @code{$gp} value, and thus reduce the number of instructions
16868 required for a function call from 4 to 1.
16870 The default is @option{-mlarge-text}.
16872 @item -mcpu=@var{cpu_type}
16873 @opindex mcpu
16874 Set the instruction set and instruction scheduling parameters for
16875 machine type @var{cpu_type}.  You can specify either the @samp{EV}
16876 style name or the corresponding chip number.  GCC supports scheduling
16877 parameters for the EV4, EV5 and EV6 family of processors and
16878 chooses the default values for the instruction set from the processor
16879 you specify.  If you do not specify a processor type, GCC defaults
16880 to the processor on which the compiler was built.
16882 Supported values for @var{cpu_type} are
16884 @table @samp
16885 @item ev4
16886 @itemx ev45
16887 @itemx 21064
16888 Schedules as an EV4 and has no instruction set extensions.
16890 @item ev5
16891 @itemx 21164
16892 Schedules as an EV5 and has no instruction set extensions.
16894 @item ev56
16895 @itemx 21164a
16896 Schedules as an EV5 and supports the BWX extension.
16898 @item pca56
16899 @itemx 21164pc
16900 @itemx 21164PC
16901 Schedules as an EV5 and supports the BWX and MAX extensions.
16903 @item ev6
16904 @itemx 21264
16905 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
16907 @item ev67
16908 @itemx 21264a
16909 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
16910 @end table
16912 Native toolchains also support the value @samp{native},
16913 which selects the best architecture option for the host processor.
16914 @option{-mcpu=native} has no effect if GCC does not recognize
16915 the processor.
16917 @item -mtune=@var{cpu_type}
16918 @opindex mtune
16919 Set only the instruction scheduling parameters for machine type
16920 @var{cpu_type}.  The instruction set is not changed.
16922 Native toolchains also support the value @samp{native},
16923 which selects the best architecture option for the host processor.
16924 @option{-mtune=native} has no effect if GCC does not recognize
16925 the processor.
16927 @item -mmemory-latency=@var{time}
16928 @opindex mmemory-latency
16929 Sets the latency the scheduler should assume for typical memory
16930 references as seen by the application.  This number is highly
16931 dependent on the memory access patterns used by the application
16932 and the size of the external cache on the machine.
16934 Valid options for @var{time} are
16936 @table @samp
16937 @item @var{number}
16938 A decimal number representing clock cycles.
16940 @item L1
16941 @itemx L2
16942 @itemx L3
16943 @itemx main
16944 The compiler contains estimates of the number of clock cycles for
16945 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
16946 (also called Dcache, Scache, and Bcache), as well as to main memory.
16947 Note that L3 is only valid for EV5.
16949 @end table
16950 @end table
16952 @node FR30 Options
16953 @subsection FR30 Options
16954 @cindex FR30 Options
16956 These options are defined specifically for the FR30 port.
16958 @table @gcctabopt
16960 @item -msmall-model
16961 @opindex msmall-model
16962 Use the small address space model.  This can produce smaller code, but
16963 it does assume that all symbolic values and addresses fit into a
16964 20-bit range.
16966 @item -mno-lsim
16967 @opindex mno-lsim
16968 Assume that runtime support has been provided and so there is no need
16969 to include the simulator library (@file{libsim.a}) on the linker
16970 command line.
16972 @end table
16974 @node FT32 Options
16975 @subsection FT32 Options
16976 @cindex FT32 Options
16978 These options are defined specifically for the FT32 port.
16980 @table @gcctabopt
16982 @item -msim
16983 @opindex msim
16984 Specifies that the program will be run on the simulator.  This causes
16985 an alternate runtime startup and library to be linked.
16986 You must not use this option when generating programs that will run on
16987 real hardware; you must provide your own runtime library for whatever
16988 I/O functions are needed.
16990 @item -mlra
16991 @opindex mlra
16992 Enable Local Register Allocation.  This is still experimental for FT32,
16993 so by default the compiler uses standard reload.
16995 @item -mnodiv
16996 @opindex mnodiv
16997 Do not use div and mod instructions.
16999 @end table
17001 @node FRV Options
17002 @subsection FRV Options
17003 @cindex FRV Options
17005 @table @gcctabopt
17006 @item -mgpr-32
17007 @opindex mgpr-32
17009 Only use the first 32 general-purpose registers.
17011 @item -mgpr-64
17012 @opindex mgpr-64
17014 Use all 64 general-purpose registers.
17016 @item -mfpr-32
17017 @opindex mfpr-32
17019 Use only the first 32 floating-point registers.
17021 @item -mfpr-64
17022 @opindex mfpr-64
17024 Use all 64 floating-point registers.
17026 @item -mhard-float
17027 @opindex mhard-float
17029 Use hardware instructions for floating-point operations.
17031 @item -msoft-float
17032 @opindex msoft-float
17034 Use library routines for floating-point operations.
17036 @item -malloc-cc
17037 @opindex malloc-cc
17039 Dynamically allocate condition code registers.
17041 @item -mfixed-cc
17042 @opindex mfixed-cc
17044 Do not try to dynamically allocate condition code registers, only
17045 use @code{icc0} and @code{fcc0}.
17047 @item -mdword
17048 @opindex mdword
17050 Change ABI to use double word insns.
17052 @item -mno-dword
17053 @opindex mno-dword
17055 Do not use double word instructions.
17057 @item -mdouble
17058 @opindex mdouble
17060 Use floating-point double instructions.
17062 @item -mno-double
17063 @opindex mno-double
17065 Do not use floating-point double instructions.
17067 @item -mmedia
17068 @opindex mmedia
17070 Use media instructions.
17072 @item -mno-media
17073 @opindex mno-media
17075 Do not use media instructions.
17077 @item -mmuladd
17078 @opindex mmuladd
17080 Use multiply and add/subtract instructions.
17082 @item -mno-muladd
17083 @opindex mno-muladd
17085 Do not use multiply and add/subtract instructions.
17087 @item -mfdpic
17088 @opindex mfdpic
17090 Select the FDPIC ABI, which uses function descriptors to represent
17091 pointers to functions.  Without any PIC/PIE-related options, it
17092 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17093 assumes GOT entries and small data are within a 12-bit range from the
17094 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17095 are computed with 32 bits.
17096 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17098 @item -minline-plt
17099 @opindex minline-plt
17101 Enable inlining of PLT entries in function calls to functions that are
17102 not known to bind locally.  It has no effect without @option{-mfdpic}.
17103 It's enabled by default if optimizing for speed and compiling for
17104 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17105 optimization option such as @option{-O3} or above is present in the
17106 command line.
17108 @item -mTLS
17109 @opindex mTLS
17111 Assume a large TLS segment when generating thread-local code.
17113 @item -mtls
17114 @opindex mtls
17116 Do not assume a large TLS segment when generating thread-local code.
17118 @item -mgprel-ro
17119 @opindex mgprel-ro
17121 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17122 that is known to be in read-only sections.  It's enabled by default,
17123 except for @option{-fpic} or @option{-fpie}: even though it may help
17124 make the global offset table smaller, it trades 1 instruction for 4.
17125 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17126 one of which may be shared by multiple symbols, and it avoids the need
17127 for a GOT entry for the referenced symbol, so it's more likely to be a
17128 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17130 @item -multilib-library-pic
17131 @opindex multilib-library-pic
17133 Link with the (library, not FD) pic libraries.  It's implied by
17134 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17135 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17136 it explicitly.
17138 @item -mlinked-fp
17139 @opindex mlinked-fp
17141 Follow the EABI requirement of always creating a frame pointer whenever
17142 a stack frame is allocated.  This option is enabled by default and can
17143 be disabled with @option{-mno-linked-fp}.
17145 @item -mlong-calls
17146 @opindex mlong-calls
17148 Use indirect addressing to call functions outside the current
17149 compilation unit.  This allows the functions to be placed anywhere
17150 within the 32-bit address space.
17152 @item -malign-labels
17153 @opindex malign-labels
17155 Try to align labels to an 8-byte boundary by inserting NOPs into the
17156 previous packet.  This option only has an effect when VLIW packing
17157 is enabled.  It doesn't create new packets; it merely adds NOPs to
17158 existing ones.
17160 @item -mlibrary-pic
17161 @opindex mlibrary-pic
17163 Generate position-independent EABI code.
17165 @item -macc-4
17166 @opindex macc-4
17168 Use only the first four media accumulator registers.
17170 @item -macc-8
17171 @opindex macc-8
17173 Use all eight media accumulator registers.
17175 @item -mpack
17176 @opindex mpack
17178 Pack VLIW instructions.
17180 @item -mno-pack
17181 @opindex mno-pack
17183 Do not pack VLIW instructions.
17185 @item -mno-eflags
17186 @opindex mno-eflags
17188 Do not mark ABI switches in e_flags.
17190 @item -mcond-move
17191 @opindex mcond-move
17193 Enable the use of conditional-move instructions (default).
17195 This switch is mainly for debugging the compiler and will likely be removed
17196 in a future version.
17198 @item -mno-cond-move
17199 @opindex mno-cond-move
17201 Disable the use of conditional-move instructions.
17203 This switch is mainly for debugging the compiler and will likely be removed
17204 in a future version.
17206 @item -mscc
17207 @opindex mscc
17209 Enable the use of conditional set instructions (default).
17211 This switch is mainly for debugging the compiler and will likely be removed
17212 in a future version.
17214 @item -mno-scc
17215 @opindex mno-scc
17217 Disable the use of conditional set instructions.
17219 This switch is mainly for debugging the compiler and will likely be removed
17220 in a future version.
17222 @item -mcond-exec
17223 @opindex mcond-exec
17225 Enable the use of conditional execution (default).
17227 This switch is mainly for debugging the compiler and will likely be removed
17228 in a future version.
17230 @item -mno-cond-exec
17231 @opindex mno-cond-exec
17233 Disable the use of conditional execution.
17235 This switch is mainly for debugging the compiler and will likely be removed
17236 in a future version.
17238 @item -mvliw-branch
17239 @opindex mvliw-branch
17241 Run a pass to pack branches into VLIW instructions (default).
17243 This switch is mainly for debugging the compiler and will likely be removed
17244 in a future version.
17246 @item -mno-vliw-branch
17247 @opindex mno-vliw-branch
17249 Do not run a pass to pack branches into VLIW instructions.
17251 This switch is mainly for debugging the compiler and will likely be removed
17252 in a future version.
17254 @item -mmulti-cond-exec
17255 @opindex mmulti-cond-exec
17257 Enable optimization of @code{&&} and @code{||} in conditional execution
17258 (default).
17260 This switch is mainly for debugging the compiler and will likely be removed
17261 in a future version.
17263 @item -mno-multi-cond-exec
17264 @opindex mno-multi-cond-exec
17266 Disable optimization of @code{&&} and @code{||} in conditional execution.
17268 This switch is mainly for debugging the compiler and will likely be removed
17269 in a future version.
17271 @item -mnested-cond-exec
17272 @opindex mnested-cond-exec
17274 Enable nested conditional execution optimizations (default).
17276 This switch is mainly for debugging the compiler and will likely be removed
17277 in a future version.
17279 @item -mno-nested-cond-exec
17280 @opindex mno-nested-cond-exec
17282 Disable nested conditional execution optimizations.
17284 This switch is mainly for debugging the compiler and will likely be removed
17285 in a future version.
17287 @item -moptimize-membar
17288 @opindex moptimize-membar
17290 This switch removes redundant @code{membar} instructions from the
17291 compiler-generated code.  It is enabled by default.
17293 @item -mno-optimize-membar
17294 @opindex mno-optimize-membar
17296 This switch disables the automatic removal of redundant @code{membar}
17297 instructions from the generated code.
17299 @item -mtomcat-stats
17300 @opindex mtomcat-stats
17302 Cause gas to print out tomcat statistics.
17304 @item -mcpu=@var{cpu}
17305 @opindex mcpu
17307 Select the processor type for which to generate code.  Possible values are
17308 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17309 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17311 @end table
17313 @node GNU/Linux Options
17314 @subsection GNU/Linux Options
17316 These @samp{-m} options are defined for GNU/Linux targets:
17318 @table @gcctabopt
17319 @item -mglibc
17320 @opindex mglibc
17321 Use the GNU C library.  This is the default except
17322 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17323 @samp{*-*-linux-*android*} targets.
17325 @item -muclibc
17326 @opindex muclibc
17327 Use uClibc C library.  This is the default on
17328 @samp{*-*-linux-*uclibc*} targets.
17330 @item -mmusl
17331 @opindex mmusl
17332 Use the musl C library.  This is the default on
17333 @samp{*-*-linux-*musl*} targets.
17335 @item -mbionic
17336 @opindex mbionic
17337 Use Bionic C library.  This is the default on
17338 @samp{*-*-linux-*android*} targets.
17340 @item -mandroid
17341 @opindex mandroid
17342 Compile code compatible with Android platform.  This is the default on
17343 @samp{*-*-linux-*android*} targets.
17345 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17346 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17347 this option makes the GCC driver pass Android-specific options to the linker.
17348 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17349 to be defined.
17351 @item -tno-android-cc
17352 @opindex tno-android-cc
17353 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17354 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17355 @option{-fno-rtti} by default.
17357 @item -tno-android-ld
17358 @opindex tno-android-ld
17359 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17360 linking options to the linker.
17362 @end table
17364 @node H8/300 Options
17365 @subsection H8/300 Options
17367 These @samp{-m} options are defined for the H8/300 implementations:
17369 @table @gcctabopt
17370 @item -mrelax
17371 @opindex mrelax
17372 Shorten some address references at link time, when possible; uses the
17373 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17374 ld, Using ld}, for a fuller description.
17376 @item -mh
17377 @opindex mh
17378 Generate code for the H8/300H@.
17380 @item -ms
17381 @opindex ms
17382 Generate code for the H8S@.
17384 @item -mn
17385 @opindex mn
17386 Generate code for the H8S and H8/300H in the normal mode.  This switch
17387 must be used either with @option{-mh} or @option{-ms}.
17389 @item -ms2600
17390 @opindex ms2600
17391 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17393 @item -mexr
17394 @opindex mexr
17395 Extended registers are stored on stack before execution of function
17396 with monitor attribute. Default option is @option{-mexr}.
17397 This option is valid only for H8S targets.
17399 @item -mno-exr
17400 @opindex mno-exr
17401 Extended registers are not stored on stack before execution of function 
17402 with monitor attribute. Default option is @option{-mno-exr}. 
17403 This option is valid only for H8S targets.
17405 @item -mint32
17406 @opindex mint32
17407 Make @code{int} data 32 bits by default.
17409 @item -malign-300
17410 @opindex malign-300
17411 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17412 The default for the H8/300H and H8S is to align longs and floats on
17413 4-byte boundaries.
17414 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17415 This option has no effect on the H8/300.
17416 @end table
17418 @node HPPA Options
17419 @subsection HPPA Options
17420 @cindex HPPA Options
17422 These @samp{-m} options are defined for the HPPA family of computers:
17424 @table @gcctabopt
17425 @item -march=@var{architecture-type}
17426 @opindex march
17427 Generate code for the specified architecture.  The choices for
17428 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17429 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17430 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17431 architecture option for your machine.  Code compiled for lower numbered
17432 architectures runs on higher numbered architectures, but not the
17433 other way around.
17435 @item -mpa-risc-1-0
17436 @itemx -mpa-risc-1-1
17437 @itemx -mpa-risc-2-0
17438 @opindex mpa-risc-1-0
17439 @opindex mpa-risc-1-1
17440 @opindex mpa-risc-2-0
17441 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17443 @item -mcaller-copies
17444 @opindex mcaller-copies
17445 The caller copies function arguments passed by hidden reference.  This
17446 option should be used with care as it is not compatible with the default
17447 32-bit runtime.  However, only aggregates larger than eight bytes are
17448 passed by hidden reference and the option provides better compatibility
17449 with OpenMP.
17451 @item -mjump-in-delay
17452 @opindex mjump-in-delay
17453 This option is ignored and provided for compatibility purposes only.
17455 @item -mdisable-fpregs
17456 @opindex mdisable-fpregs
17457 Prevent floating-point registers from being used in any manner.  This is
17458 necessary for compiling kernels that perform lazy context switching of
17459 floating-point registers.  If you use this option and attempt to perform
17460 floating-point operations, the compiler aborts.
17462 @item -mdisable-indexing
17463 @opindex mdisable-indexing
17464 Prevent the compiler from using indexing address modes.  This avoids some
17465 rather obscure problems when compiling MIG generated code under MACH@.
17467 @item -mno-space-regs
17468 @opindex mno-space-regs
17469 Generate code that assumes the target has no space registers.  This allows
17470 GCC to generate faster indirect calls and use unscaled index address modes.
17472 Such code is suitable for level 0 PA systems and kernels.
17474 @item -mfast-indirect-calls
17475 @opindex mfast-indirect-calls
17476 Generate code that assumes calls never cross space boundaries.  This
17477 allows GCC to emit code that performs faster indirect calls.
17479 This option does not work in the presence of shared libraries or nested
17480 functions.
17482 @item -mfixed-range=@var{register-range}
17483 @opindex mfixed-range
17484 Generate code treating the given register range as fixed registers.
17485 A fixed register is one that the register allocator cannot use.  This is
17486 useful when compiling kernel code.  A register range is specified as
17487 two registers separated by a dash.  Multiple register ranges can be
17488 specified separated by a comma.
17490 @item -mlong-load-store
17491 @opindex mlong-load-store
17492 Generate 3-instruction load and store sequences as sometimes required by
17493 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17494 the HP compilers.
17496 @item -mportable-runtime
17497 @opindex mportable-runtime
17498 Use the portable calling conventions proposed by HP for ELF systems.
17500 @item -mgas
17501 @opindex mgas
17502 Enable the use of assembler directives only GAS understands.
17504 @item -mschedule=@var{cpu-type}
17505 @opindex mschedule
17506 Schedule code according to the constraints for the machine type
17507 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17508 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17509 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17510 proper scheduling option for your machine.  The default scheduling is
17511 @samp{8000}.
17513 @item -mlinker-opt
17514 @opindex mlinker-opt
17515 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17516 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17517 linkers in which they give bogus error messages when linking some programs.
17519 @item -msoft-float
17520 @opindex msoft-float
17521 Generate output containing library calls for floating point.
17522 @strong{Warning:} the requisite libraries are not available for all HPPA
17523 targets.  Normally the facilities of the machine's usual C compiler are
17524 used, but this cannot be done directly in cross-compilation.  You must make
17525 your own arrangements to provide suitable library functions for
17526 cross-compilation.
17528 @option{-msoft-float} changes the calling convention in the output file;
17529 therefore, it is only useful if you compile @emph{all} of a program with
17530 this option.  In particular, you need to compile @file{libgcc.a}, the
17531 library that comes with GCC, with @option{-msoft-float} in order for
17532 this to work.
17534 @item -msio
17535 @opindex msio
17536 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17537 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17538 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17539 options are available under HP-UX and HI-UX@.
17541 @item -mgnu-ld
17542 @opindex mgnu-ld
17543 Use options specific to GNU @command{ld}.
17544 This passes @option{-shared} to @command{ld} when
17545 building a shared library.  It is the default when GCC is configured,
17546 explicitly or implicitly, with the GNU linker.  This option does not
17547 affect which @command{ld} is called; it only changes what parameters
17548 are passed to that @command{ld}.
17549 The @command{ld} that is called is determined by the
17550 @option{--with-ld} configure option, GCC's program search path, and
17551 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17552 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17553 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17555 @item -mhp-ld
17556 @opindex mhp-ld
17557 Use options specific to HP @command{ld}.
17558 This passes @option{-b} to @command{ld} when building
17559 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17560 links.  It is the default when GCC is configured, explicitly or
17561 implicitly, with the HP linker.  This option does not affect
17562 which @command{ld} is called; it only changes what parameters are passed to that
17563 @command{ld}.
17564 The @command{ld} that is called is determined by the @option{--with-ld}
17565 configure option, GCC's program search path, and finally by the user's
17566 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17567 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17568 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17570 @item -mlong-calls
17571 @opindex mno-long-calls
17572 Generate code that uses long call sequences.  This ensures that a call
17573 is always able to reach linker generated stubs.  The default is to generate
17574 long calls only when the distance from the call site to the beginning
17575 of the function or translation unit, as the case may be, exceeds a
17576 predefined limit set by the branch type being used.  The limits for
17577 normal calls are 7,600,000 and 240,000 bytes, respectively for the
17578 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
17579 240,000 bytes.
17581 Distances are measured from the beginning of functions when using the
17582 @option{-ffunction-sections} option, or when using the @option{-mgas}
17583 and @option{-mno-portable-runtime} options together under HP-UX with
17584 the SOM linker.
17586 It is normally not desirable to use this option as it degrades
17587 performance.  However, it may be useful in large applications,
17588 particularly when partial linking is used to build the application.
17590 The types of long calls used depends on the capabilities of the
17591 assembler and linker, and the type of code being generated.  The
17592 impact on systems that support long absolute calls, and long pic
17593 symbol-difference or pc-relative calls should be relatively small.
17594 However, an indirect call is used on 32-bit ELF systems in pic code
17595 and it is quite long.
17597 @item -munix=@var{unix-std}
17598 @opindex march
17599 Generate compiler predefines and select a startfile for the specified
17600 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
17601 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
17602 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
17603 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
17604 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
17605 and later.
17607 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
17608 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
17609 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
17610 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
17611 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
17612 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
17614 It is @emph{important} to note that this option changes the interfaces
17615 for various library routines.  It also affects the operational behavior
17616 of the C library.  Thus, @emph{extreme} care is needed in using this
17617 option.
17619 Library code that is intended to operate with more than one UNIX
17620 standard must test, set and restore the variable @code{__xpg4_extended_mask}
17621 as appropriate.  Most GNU software doesn't provide this capability.
17623 @item -nolibdld
17624 @opindex nolibdld
17625 Suppress the generation of link options to search libdld.sl when the
17626 @option{-static} option is specified on HP-UX 10 and later.
17628 @item -static
17629 @opindex static
17630 The HP-UX implementation of setlocale in libc has a dependency on
17631 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
17632 when the @option{-static} option is specified, special link options
17633 are needed to resolve this dependency.
17635 On HP-UX 10 and later, the GCC driver adds the necessary options to
17636 link with libdld.sl when the @option{-static} option is specified.
17637 This causes the resulting binary to be dynamic.  On the 64-bit port,
17638 the linkers generate dynamic binaries by default in any case.  The
17639 @option{-nolibdld} option can be used to prevent the GCC driver from
17640 adding these link options.
17642 @item -threads
17643 @opindex threads
17644 Add support for multithreading with the @dfn{dce thread} library
17645 under HP-UX@.  This option sets flags for both the preprocessor and
17646 linker.
17647 @end table
17649 @node IA-64 Options
17650 @subsection IA-64 Options
17651 @cindex IA-64 Options
17653 These are the @samp{-m} options defined for the Intel IA-64 architecture.
17655 @table @gcctabopt
17656 @item -mbig-endian
17657 @opindex mbig-endian
17658 Generate code for a big-endian target.  This is the default for HP-UX@.
17660 @item -mlittle-endian
17661 @opindex mlittle-endian
17662 Generate code for a little-endian target.  This is the default for AIX5
17663 and GNU/Linux.
17665 @item -mgnu-as
17666 @itemx -mno-gnu-as
17667 @opindex mgnu-as
17668 @opindex mno-gnu-as
17669 Generate (or don't) code for the GNU assembler.  This is the default.
17670 @c Also, this is the default if the configure option @option{--with-gnu-as}
17671 @c is used.
17673 @item -mgnu-ld
17674 @itemx -mno-gnu-ld
17675 @opindex mgnu-ld
17676 @opindex mno-gnu-ld
17677 Generate (or don't) code for the GNU linker.  This is the default.
17678 @c Also, this is the default if the configure option @option{--with-gnu-ld}
17679 @c is used.
17681 @item -mno-pic
17682 @opindex mno-pic
17683 Generate code that does not use a global pointer register.  The result
17684 is not position independent code, and violates the IA-64 ABI@.
17686 @item -mvolatile-asm-stop
17687 @itemx -mno-volatile-asm-stop
17688 @opindex mvolatile-asm-stop
17689 @opindex mno-volatile-asm-stop
17690 Generate (or don't) a stop bit immediately before and after volatile asm
17691 statements.
17693 @item -mregister-names
17694 @itemx -mno-register-names
17695 @opindex mregister-names
17696 @opindex mno-register-names
17697 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
17698 the stacked registers.  This may make assembler output more readable.
17700 @item -mno-sdata
17701 @itemx -msdata
17702 @opindex mno-sdata
17703 @opindex msdata
17704 Disable (or enable) optimizations that use the small data section.  This may
17705 be useful for working around optimizer bugs.
17707 @item -mconstant-gp
17708 @opindex mconstant-gp
17709 Generate code that uses a single constant global pointer value.  This is
17710 useful when compiling kernel code.
17712 @item -mauto-pic
17713 @opindex mauto-pic
17714 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
17715 This is useful when compiling firmware code.
17717 @item -minline-float-divide-min-latency
17718 @opindex minline-float-divide-min-latency
17719 Generate code for inline divides of floating-point values
17720 using the minimum latency algorithm.
17722 @item -minline-float-divide-max-throughput
17723 @opindex minline-float-divide-max-throughput
17724 Generate code for inline divides of floating-point values
17725 using the maximum throughput algorithm.
17727 @item -mno-inline-float-divide
17728 @opindex mno-inline-float-divide
17729 Do not generate inline code for divides of floating-point values.
17731 @item -minline-int-divide-min-latency
17732 @opindex minline-int-divide-min-latency
17733 Generate code for inline divides of integer values
17734 using the minimum latency algorithm.
17736 @item -minline-int-divide-max-throughput
17737 @opindex minline-int-divide-max-throughput
17738 Generate code for inline divides of integer values
17739 using the maximum throughput algorithm.
17741 @item -mno-inline-int-divide
17742 @opindex mno-inline-int-divide
17743 Do not generate inline code for divides of integer values.
17745 @item -minline-sqrt-min-latency
17746 @opindex minline-sqrt-min-latency
17747 Generate code for inline square roots
17748 using the minimum latency algorithm.
17750 @item -minline-sqrt-max-throughput
17751 @opindex minline-sqrt-max-throughput
17752 Generate code for inline square roots
17753 using the maximum throughput algorithm.
17755 @item -mno-inline-sqrt
17756 @opindex mno-inline-sqrt
17757 Do not generate inline code for @code{sqrt}.
17759 @item -mfused-madd
17760 @itemx -mno-fused-madd
17761 @opindex mfused-madd
17762 @opindex mno-fused-madd
17763 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
17764 instructions.  The default is to use these instructions.
17766 @item -mno-dwarf2-asm
17767 @itemx -mdwarf2-asm
17768 @opindex mno-dwarf2-asm
17769 @opindex mdwarf2-asm
17770 Don't (or do) generate assembler code for the DWARF line number debugging
17771 info.  This may be useful when not using the GNU assembler.
17773 @item -mearly-stop-bits
17774 @itemx -mno-early-stop-bits
17775 @opindex mearly-stop-bits
17776 @opindex mno-early-stop-bits
17777 Allow stop bits to be placed earlier than immediately preceding the
17778 instruction that triggered the stop bit.  This can improve instruction
17779 scheduling, but does not always do so.
17781 @item -mfixed-range=@var{register-range}
17782 @opindex mfixed-range
17783 Generate code treating the given register range as fixed registers.
17784 A fixed register is one that the register allocator cannot use.  This is
17785 useful when compiling kernel code.  A register range is specified as
17786 two registers separated by a dash.  Multiple register ranges can be
17787 specified separated by a comma.
17789 @item -mtls-size=@var{tls-size}
17790 @opindex mtls-size
17791 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
17794 @item -mtune=@var{cpu-type}
17795 @opindex mtune
17796 Tune the instruction scheduling for a particular CPU, Valid values are
17797 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
17798 and @samp{mckinley}.
17800 @item -milp32
17801 @itemx -mlp64
17802 @opindex milp32
17803 @opindex mlp64
17804 Generate code for a 32-bit or 64-bit environment.
17805 The 32-bit environment sets int, long and pointer to 32 bits.
17806 The 64-bit environment sets int to 32 bits and long and pointer
17807 to 64 bits.  These are HP-UX specific flags.
17809 @item -mno-sched-br-data-spec
17810 @itemx -msched-br-data-spec
17811 @opindex mno-sched-br-data-spec
17812 @opindex msched-br-data-spec
17813 (Dis/En)able data speculative scheduling before reload.
17814 This results in generation of @code{ld.a} instructions and
17815 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17816 The default setting is disabled.
17818 @item -msched-ar-data-spec
17819 @itemx -mno-sched-ar-data-spec
17820 @opindex msched-ar-data-spec
17821 @opindex mno-sched-ar-data-spec
17822 (En/Dis)able data speculative scheduling after reload.
17823 This results in generation of @code{ld.a} instructions and
17824 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
17825 The default setting is enabled.
17827 @item -mno-sched-control-spec
17828 @itemx -msched-control-spec
17829 @opindex mno-sched-control-spec
17830 @opindex msched-control-spec
17831 (Dis/En)able control speculative scheduling.  This feature is
17832 available only during region scheduling (i.e.@: before reload).
17833 This results in generation of the @code{ld.s} instructions and
17834 the corresponding check instructions @code{chk.s}.
17835 The default setting is disabled.
17837 @item -msched-br-in-data-spec
17838 @itemx -mno-sched-br-in-data-spec
17839 @opindex msched-br-in-data-spec
17840 @opindex mno-sched-br-in-data-spec
17841 (En/Dis)able speculative scheduling of the instructions that
17842 are dependent on the data speculative loads before reload.
17843 This is effective only with @option{-msched-br-data-spec} enabled.
17844 The default setting is enabled.
17846 @item -msched-ar-in-data-spec
17847 @itemx -mno-sched-ar-in-data-spec
17848 @opindex msched-ar-in-data-spec
17849 @opindex mno-sched-ar-in-data-spec
17850 (En/Dis)able speculative scheduling of the instructions that
17851 are dependent on the data speculative loads after reload.
17852 This is effective only with @option{-msched-ar-data-spec} enabled.
17853 The default setting is enabled.
17855 @item -msched-in-control-spec
17856 @itemx -mno-sched-in-control-spec
17857 @opindex msched-in-control-spec
17858 @opindex mno-sched-in-control-spec
17859 (En/Dis)able speculative scheduling of the instructions that
17860 are dependent on the control speculative loads.
17861 This is effective only with @option{-msched-control-spec} enabled.
17862 The default setting is enabled.
17864 @item -mno-sched-prefer-non-data-spec-insns
17865 @itemx -msched-prefer-non-data-spec-insns
17866 @opindex mno-sched-prefer-non-data-spec-insns
17867 @opindex msched-prefer-non-data-spec-insns
17868 If enabled, data-speculative instructions are chosen for schedule
17869 only if there are no other choices at the moment.  This makes
17870 the use of the data speculation much more conservative.
17871 The default setting is disabled.
17873 @item -mno-sched-prefer-non-control-spec-insns
17874 @itemx -msched-prefer-non-control-spec-insns
17875 @opindex mno-sched-prefer-non-control-spec-insns
17876 @opindex msched-prefer-non-control-spec-insns
17877 If enabled, control-speculative instructions are chosen for schedule
17878 only if there are no other choices at the moment.  This makes
17879 the use of the control speculation much more conservative.
17880 The default setting is disabled.
17882 @item -mno-sched-count-spec-in-critical-path
17883 @itemx -msched-count-spec-in-critical-path
17884 @opindex mno-sched-count-spec-in-critical-path
17885 @opindex msched-count-spec-in-critical-path
17886 If enabled, speculative dependencies are considered during
17887 computation of the instructions priorities.  This makes the use of the
17888 speculation a bit more conservative.
17889 The default setting is disabled.
17891 @item -msched-spec-ldc
17892 @opindex msched-spec-ldc
17893 Use a simple data speculation check.  This option is on by default.
17895 @item -msched-control-spec-ldc
17896 @opindex msched-spec-ldc
17897 Use a simple check for control speculation.  This option is on by default.
17899 @item -msched-stop-bits-after-every-cycle
17900 @opindex msched-stop-bits-after-every-cycle
17901 Place a stop bit after every cycle when scheduling.  This option is on
17902 by default.
17904 @item -msched-fp-mem-deps-zero-cost
17905 @opindex msched-fp-mem-deps-zero-cost
17906 Assume that floating-point stores and loads are not likely to cause a conflict
17907 when placed into the same instruction group.  This option is disabled by
17908 default.
17910 @item -msel-sched-dont-check-control-spec
17911 @opindex msel-sched-dont-check-control-spec
17912 Generate checks for control speculation in selective scheduling.
17913 This flag is disabled by default.
17915 @item -msched-max-memory-insns=@var{max-insns}
17916 @opindex msched-max-memory-insns
17917 Limit on the number of memory insns per instruction group, giving lower
17918 priority to subsequent memory insns attempting to schedule in the same
17919 instruction group. Frequently useful to prevent cache bank conflicts.
17920 The default value is 1.
17922 @item -msched-max-memory-insns-hard-limit
17923 @opindex msched-max-memory-insns-hard-limit
17924 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
17925 disallowing more than that number in an instruction group.
17926 Otherwise, the limit is ``soft'', meaning that non-memory operations
17927 are preferred when the limit is reached, but memory operations may still
17928 be scheduled.
17930 @end table
17932 @node LM32 Options
17933 @subsection LM32 Options
17934 @cindex LM32 options
17936 These @option{-m} options are defined for the LatticeMico32 architecture:
17938 @table @gcctabopt
17939 @item -mbarrel-shift-enabled
17940 @opindex mbarrel-shift-enabled
17941 Enable barrel-shift instructions.
17943 @item -mdivide-enabled
17944 @opindex mdivide-enabled
17945 Enable divide and modulus instructions.
17947 @item -mmultiply-enabled
17948 @opindex multiply-enabled
17949 Enable multiply instructions.
17951 @item -msign-extend-enabled
17952 @opindex msign-extend-enabled
17953 Enable sign extend instructions.
17955 @item -muser-enabled
17956 @opindex muser-enabled
17957 Enable user-defined instructions.
17959 @end table
17961 @node M32C Options
17962 @subsection M32C Options
17963 @cindex M32C options
17965 @table @gcctabopt
17966 @item -mcpu=@var{name}
17967 @opindex mcpu=
17968 Select the CPU for which code is generated.  @var{name} may be one of
17969 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
17970 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
17971 the M32C/80 series.
17973 @item -msim
17974 @opindex msim
17975 Specifies that the program will be run on the simulator.  This causes
17976 an alternate runtime library to be linked in which supports, for
17977 example, file I/O@.  You must not use this option when generating
17978 programs that will run on real hardware; you must provide your own
17979 runtime library for whatever I/O functions are needed.
17981 @item -memregs=@var{number}
17982 @opindex memregs=
17983 Specifies the number of memory-based pseudo-registers GCC uses
17984 during code generation.  These pseudo-registers are used like real
17985 registers, so there is a tradeoff between GCC's ability to fit the
17986 code into available registers, and the performance penalty of using
17987 memory instead of registers.  Note that all modules in a program must
17988 be compiled with the same value for this option.  Because of that, you
17989 must not use this option with GCC's default runtime libraries.
17991 @end table
17993 @node M32R/D Options
17994 @subsection M32R/D Options
17995 @cindex M32R/D options
17997 These @option{-m} options are defined for Renesas M32R/D architectures:
17999 @table @gcctabopt
18000 @item -m32r2
18001 @opindex m32r2
18002 Generate code for the M32R/2@.
18004 @item -m32rx
18005 @opindex m32rx
18006 Generate code for the M32R/X@.
18008 @item -m32r
18009 @opindex m32r
18010 Generate code for the M32R@.  This is the default.
18012 @item -mmodel=small
18013 @opindex mmodel=small
18014 Assume all objects live in the lower 16MB of memory (so that their addresses
18015 can be loaded with the @code{ld24} instruction), and assume all subroutines
18016 are reachable with the @code{bl} instruction.
18017 This is the default.
18019 The addressability of a particular object can be set with the
18020 @code{model} attribute.
18022 @item -mmodel=medium
18023 @opindex mmodel=medium
18024 Assume objects may be anywhere in the 32-bit address space (the compiler
18025 generates @code{seth/add3} instructions to load their addresses), and
18026 assume all subroutines are reachable with the @code{bl} instruction.
18028 @item -mmodel=large
18029 @opindex mmodel=large
18030 Assume objects may be anywhere in the 32-bit address space (the compiler
18031 generates @code{seth/add3} instructions to load their addresses), and
18032 assume subroutines may not be reachable with the @code{bl} instruction
18033 (the compiler generates the much slower @code{seth/add3/jl}
18034 instruction sequence).
18036 @item -msdata=none
18037 @opindex msdata=none
18038 Disable use of the small data area.  Variables are put into
18039 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18040 @code{section} attribute has been specified).
18041 This is the default.
18043 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18044 Objects may be explicitly put in the small data area with the
18045 @code{section} attribute using one of these sections.
18047 @item -msdata=sdata
18048 @opindex msdata=sdata
18049 Put small global and static data in the small data area, but do not
18050 generate special code to reference them.
18052 @item -msdata=use
18053 @opindex msdata=use
18054 Put small global and static data in the small data area, and generate
18055 special instructions to reference them.
18057 @item -G @var{num}
18058 @opindex G
18059 @cindex smaller data references
18060 Put global and static objects less than or equal to @var{num} bytes
18061 into the small data or BSS sections instead of the normal data or BSS
18062 sections.  The default value of @var{num} is 8.
18063 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18064 for this option to have any effect.
18066 All modules should be compiled with the same @option{-G @var{num}} value.
18067 Compiling with different values of @var{num} may or may not work; if it
18068 doesn't the linker gives an error message---incorrect code is not
18069 generated.
18071 @item -mdebug
18072 @opindex mdebug
18073 Makes the M32R-specific code in the compiler display some statistics
18074 that might help in debugging programs.
18076 @item -malign-loops
18077 @opindex malign-loops
18078 Align all loops to a 32-byte boundary.
18080 @item -mno-align-loops
18081 @opindex mno-align-loops
18082 Do not enforce a 32-byte alignment for loops.  This is the default.
18084 @item -missue-rate=@var{number}
18085 @opindex missue-rate=@var{number}
18086 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18087 or 2.
18089 @item -mbranch-cost=@var{number}
18090 @opindex mbranch-cost=@var{number}
18091 @var{number} can only be 1 or 2.  If it is 1 then branches are
18092 preferred over conditional code, if it is 2, then the opposite applies.
18094 @item -mflush-trap=@var{number}
18095 @opindex mflush-trap=@var{number}
18096 Specifies the trap number to use to flush the cache.  The default is
18097 12.  Valid numbers are between 0 and 15 inclusive.
18099 @item -mno-flush-trap
18100 @opindex mno-flush-trap
18101 Specifies that the cache cannot be flushed by using a trap.
18103 @item -mflush-func=@var{name}
18104 @opindex mflush-func=@var{name}
18105 Specifies the name of the operating system function to call to flush
18106 the cache.  The default is @samp{_flush_cache}, but a function call
18107 is only used if a trap is not available.
18109 @item -mno-flush-func
18110 @opindex mno-flush-func
18111 Indicates that there is no OS function for flushing the cache.
18113 @end table
18115 @node M680x0 Options
18116 @subsection M680x0 Options
18117 @cindex M680x0 options
18119 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18120 The default settings depend on which architecture was selected when
18121 the compiler was configured; the defaults for the most common choices
18122 are given below.
18124 @table @gcctabopt
18125 @item -march=@var{arch}
18126 @opindex march
18127 Generate code for a specific M680x0 or ColdFire instruction set
18128 architecture.  Permissible values of @var{arch} for M680x0
18129 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18130 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18131 architectures are selected according to Freescale's ISA classification
18132 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18133 @samp{isab} and @samp{isac}.
18135 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18136 code for a ColdFire target.  The @var{arch} in this macro is one of the
18137 @option{-march} arguments given above.
18139 When used together, @option{-march} and @option{-mtune} select code
18140 that runs on a family of similar processors but that is optimized
18141 for a particular microarchitecture.
18143 @item -mcpu=@var{cpu}
18144 @opindex mcpu
18145 Generate code for a specific M680x0 or ColdFire processor.
18146 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18147 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18148 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18149 below, which also classifies the CPUs into families:
18151 @multitable @columnfractions 0.20 0.80
18152 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18153 @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}
18154 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18155 @item @samp{5206e} @tab @samp{5206e}
18156 @item @samp{5208} @tab @samp{5207} @samp{5208}
18157 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18158 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18159 @item @samp{5216} @tab @samp{5214} @samp{5216}
18160 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18161 @item @samp{5225} @tab @samp{5224} @samp{5225}
18162 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18163 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18164 @item @samp{5249} @tab @samp{5249}
18165 @item @samp{5250} @tab @samp{5250}
18166 @item @samp{5271} @tab @samp{5270} @samp{5271}
18167 @item @samp{5272} @tab @samp{5272}
18168 @item @samp{5275} @tab @samp{5274} @samp{5275}
18169 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18170 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18171 @item @samp{5307} @tab @samp{5307}
18172 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18173 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18174 @item @samp{5407} @tab @samp{5407}
18175 @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}
18176 @end multitable
18178 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18179 @var{arch} is compatible with @var{cpu}.  Other combinations of
18180 @option{-mcpu} and @option{-march} are rejected.
18182 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18183 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18184 where the value of @var{family} is given by the table above.
18186 @item -mtune=@var{tune}
18187 @opindex mtune
18188 Tune the code for a particular microarchitecture within the
18189 constraints set by @option{-march} and @option{-mcpu}.
18190 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18191 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18192 and @samp{cpu32}.  The ColdFire microarchitectures
18193 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18195 You can also use @option{-mtune=68020-40} for code that needs
18196 to run relatively well on 68020, 68030 and 68040 targets.
18197 @option{-mtune=68020-60} is similar but includes 68060 targets
18198 as well.  These two options select the same tuning decisions as
18199 @option{-m68020-40} and @option{-m68020-60} respectively.
18201 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18202 when tuning for 680x0 architecture @var{arch}.  It also defines
18203 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18204 option is used.  If GCC is tuning for a range of architectures,
18205 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18206 it defines the macros for every architecture in the range.
18208 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18209 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18210 of the arguments given above.
18212 @item -m68000
18213 @itemx -mc68000
18214 @opindex m68000
18215 @opindex mc68000
18216 Generate output for a 68000.  This is the default
18217 when the compiler is configured for 68000-based systems.
18218 It is equivalent to @option{-march=68000}.
18220 Use this option for microcontrollers with a 68000 or EC000 core,
18221 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18223 @item -m68010
18224 @opindex m68010
18225 Generate output for a 68010.  This is the default
18226 when the compiler is configured for 68010-based systems.
18227 It is equivalent to @option{-march=68010}.
18229 @item -m68020
18230 @itemx -mc68020
18231 @opindex m68020
18232 @opindex mc68020
18233 Generate output for a 68020.  This is the default
18234 when the compiler is configured for 68020-based systems.
18235 It is equivalent to @option{-march=68020}.
18237 @item -m68030
18238 @opindex m68030
18239 Generate output for a 68030.  This is the default when the compiler is
18240 configured for 68030-based systems.  It is equivalent to
18241 @option{-march=68030}.
18243 @item -m68040
18244 @opindex m68040
18245 Generate output for a 68040.  This is the default when the compiler is
18246 configured for 68040-based systems.  It is equivalent to
18247 @option{-march=68040}.
18249 This option inhibits the use of 68881/68882 instructions that have to be
18250 emulated by software on the 68040.  Use this option if your 68040 does not
18251 have code to emulate those instructions.
18253 @item -m68060
18254 @opindex m68060
18255 Generate output for a 68060.  This is the default when the compiler is
18256 configured for 68060-based systems.  It is equivalent to
18257 @option{-march=68060}.
18259 This option inhibits the use of 68020 and 68881/68882 instructions that
18260 have to be emulated by software on the 68060.  Use this option if your 68060
18261 does not have code to emulate those instructions.
18263 @item -mcpu32
18264 @opindex mcpu32
18265 Generate output for a CPU32.  This is the default
18266 when the compiler is configured for CPU32-based systems.
18267 It is equivalent to @option{-march=cpu32}.
18269 Use this option for microcontrollers with a
18270 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18271 68336, 68340, 68341, 68349 and 68360.
18273 @item -m5200
18274 @opindex m5200
18275 Generate output for a 520X ColdFire CPU@.  This is the default
18276 when the compiler is configured for 520X-based systems.
18277 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18278 in favor of that option.
18280 Use this option for microcontroller with a 5200 core, including
18281 the MCF5202, MCF5203, MCF5204 and MCF5206.
18283 @item -m5206e
18284 @opindex m5206e
18285 Generate output for a 5206e ColdFire CPU@.  The option is now
18286 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18288 @item -m528x
18289 @opindex m528x
18290 Generate output for a member of the ColdFire 528X family.
18291 The option is now deprecated in favor of the equivalent
18292 @option{-mcpu=528x}.
18294 @item -m5307
18295 @opindex m5307
18296 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18297 in favor of the equivalent @option{-mcpu=5307}.
18299 @item -m5407
18300 @opindex m5407
18301 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18302 in favor of the equivalent @option{-mcpu=5407}.
18304 @item -mcfv4e
18305 @opindex mcfv4e
18306 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18307 This includes use of hardware floating-point instructions.
18308 The option is equivalent to @option{-mcpu=547x}, and is now
18309 deprecated in favor of that option.
18311 @item -m68020-40
18312 @opindex m68020-40
18313 Generate output for a 68040, without using any of the new instructions.
18314 This results in code that can run relatively efficiently on either a
18315 68020/68881 or a 68030 or a 68040.  The generated code does use the
18316 68881 instructions that are emulated on the 68040.
18318 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18320 @item -m68020-60
18321 @opindex m68020-60
18322 Generate output for a 68060, without using any of the new instructions.
18323 This results in code that can run relatively efficiently on either a
18324 68020/68881 or a 68030 or a 68040.  The generated code does use the
18325 68881 instructions that are emulated on the 68060.
18327 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18329 @item -mhard-float
18330 @itemx -m68881
18331 @opindex mhard-float
18332 @opindex m68881
18333 Generate floating-point instructions.  This is the default for 68020
18334 and above, and for ColdFire devices that have an FPU@.  It defines the
18335 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18336 on ColdFire targets.
18338 @item -msoft-float
18339 @opindex msoft-float
18340 Do not generate floating-point instructions; use library calls instead.
18341 This is the default for 68000, 68010, and 68832 targets.  It is also
18342 the default for ColdFire devices that have no FPU.
18344 @item -mdiv
18345 @itemx -mno-div
18346 @opindex mdiv
18347 @opindex mno-div
18348 Generate (do not generate) ColdFire hardware divide and remainder
18349 instructions.  If @option{-march} is used without @option{-mcpu},
18350 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18351 architectures.  Otherwise, the default is taken from the target CPU
18352 (either the default CPU, or the one specified by @option{-mcpu}).  For
18353 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18354 @option{-mcpu=5206e}.
18356 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18358 @item -mshort
18359 @opindex mshort
18360 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18361 Additionally, parameters passed on the stack are also aligned to a
18362 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18364 @item -mno-short
18365 @opindex mno-short
18366 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18368 @item -mnobitfield
18369 @itemx -mno-bitfield
18370 @opindex mnobitfield
18371 @opindex mno-bitfield
18372 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18373 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18375 @item -mbitfield
18376 @opindex mbitfield
18377 Do use the bit-field instructions.  The @option{-m68020} option implies
18378 @option{-mbitfield}.  This is the default if you use a configuration
18379 designed for a 68020.
18381 @item -mrtd
18382 @opindex mrtd
18383 Use a different function-calling convention, in which functions
18384 that take a fixed number of arguments return with the @code{rtd}
18385 instruction, which pops their arguments while returning.  This
18386 saves one instruction in the caller since there is no need to pop
18387 the arguments there.
18389 This calling convention is incompatible with the one normally
18390 used on Unix, so you cannot use it if you need to call libraries
18391 compiled with the Unix compiler.
18393 Also, you must provide function prototypes for all functions that
18394 take variable numbers of arguments (including @code{printf});
18395 otherwise incorrect code is generated for calls to those
18396 functions.
18398 In addition, seriously incorrect code results if you call a
18399 function with too many arguments.  (Normally, extra arguments are
18400 harmlessly ignored.)
18402 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18403 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18405 @item -mno-rtd
18406 @opindex mno-rtd
18407 Do not use the calling conventions selected by @option{-mrtd}.
18408 This is the default.
18410 @item -malign-int
18411 @itemx -mno-align-int
18412 @opindex malign-int
18413 @opindex mno-align-int
18414 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18415 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18416 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18417 Aligning variables on 32-bit boundaries produces code that runs somewhat
18418 faster on processors with 32-bit busses at the expense of more memory.
18420 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18421 aligns structures containing the above types differently than
18422 most published application binary interface specifications for the m68k.
18424 @item -mpcrel
18425 @opindex mpcrel
18426 Use the pc-relative addressing mode of the 68000 directly, instead of
18427 using a global offset table.  At present, this option implies @option{-fpic},
18428 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18429 not presently supported with @option{-mpcrel}, though this could be supported for
18430 68020 and higher processors.
18432 @item -mno-strict-align
18433 @itemx -mstrict-align
18434 @opindex mno-strict-align
18435 @opindex mstrict-align
18436 Do not (do) assume that unaligned memory references are handled by
18437 the system.
18439 @item -msep-data
18440 Generate code that allows the data segment to be located in a different
18441 area of memory from the text segment.  This allows for execute-in-place in
18442 an environment without virtual memory management.  This option implies
18443 @option{-fPIC}.
18445 @item -mno-sep-data
18446 Generate code that assumes that the data segment follows the text segment.
18447 This is the default.
18449 @item -mid-shared-library
18450 Generate code that supports shared libraries via the library ID method.
18451 This allows for execute-in-place and shared libraries in an environment
18452 without virtual memory management.  This option implies @option{-fPIC}.
18454 @item -mno-id-shared-library
18455 Generate code that doesn't assume ID-based shared libraries are being used.
18456 This is the default.
18458 @item -mshared-library-id=n
18459 Specifies the identification number of the ID-based shared library being
18460 compiled.  Specifying a value of 0 generates more compact code; specifying
18461 other values forces the allocation of that number to the current
18462 library, but is no more space- or time-efficient than omitting this option.
18464 @item -mxgot
18465 @itemx -mno-xgot
18466 @opindex mxgot
18467 @opindex mno-xgot
18468 When generating position-independent code for ColdFire, generate code
18469 that works if the GOT has more than 8192 entries.  This code is
18470 larger and slower than code generated without this option.  On M680x0
18471 processors, this option is not needed; @option{-fPIC} suffices.
18473 GCC normally uses a single instruction to load values from the GOT@.
18474 While this is relatively efficient, it only works if the GOT
18475 is smaller than about 64k.  Anything larger causes the linker
18476 to report an error such as:
18478 @cindex relocation truncated to fit (ColdFire)
18479 @smallexample
18480 relocation truncated to fit: R_68K_GOT16O foobar
18481 @end smallexample
18483 If this happens, you should recompile your code with @option{-mxgot}.
18484 It should then work with very large GOTs.  However, code generated with
18485 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18486 the value of a global symbol.
18488 Note that some linkers, including newer versions of the GNU linker,
18489 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18490 you should only need to use @option{-mxgot} when compiling a single
18491 object file that accesses more than 8192 GOT entries.  Very few do.
18493 These options have no effect unless GCC is generating
18494 position-independent code.
18496 @item -mlong-jump-table-offsets
18497 @opindex mlong-jump-table-offsets
18498 Use 32-bit offsets in @code{switch} tables.  The default is to use
18499 16-bit offsets.
18501 @end table
18503 @node MCore Options
18504 @subsection MCore Options
18505 @cindex MCore options
18507 These are the @samp{-m} options defined for the Motorola M*Core
18508 processors.
18510 @table @gcctabopt
18512 @item -mhardlit
18513 @itemx -mno-hardlit
18514 @opindex mhardlit
18515 @opindex mno-hardlit
18516 Inline constants into the code stream if it can be done in two
18517 instructions or less.
18519 @item -mdiv
18520 @itemx -mno-div
18521 @opindex mdiv
18522 @opindex mno-div
18523 Use the divide instruction.  (Enabled by default).
18525 @item -mrelax-immediate
18526 @itemx -mno-relax-immediate
18527 @opindex mrelax-immediate
18528 @opindex mno-relax-immediate
18529 Allow arbitrary-sized immediates in bit operations.
18531 @item -mwide-bitfields
18532 @itemx -mno-wide-bitfields
18533 @opindex mwide-bitfields
18534 @opindex mno-wide-bitfields
18535 Always treat bit-fields as @code{int}-sized.
18537 @item -m4byte-functions
18538 @itemx -mno-4byte-functions
18539 @opindex m4byte-functions
18540 @opindex mno-4byte-functions
18541 Force all functions to be aligned to a 4-byte boundary.
18543 @item -mcallgraph-data
18544 @itemx -mno-callgraph-data
18545 @opindex mcallgraph-data
18546 @opindex mno-callgraph-data
18547 Emit callgraph information.
18549 @item -mslow-bytes
18550 @itemx -mno-slow-bytes
18551 @opindex mslow-bytes
18552 @opindex mno-slow-bytes
18553 Prefer word access when reading byte quantities.
18555 @item -mlittle-endian
18556 @itemx -mbig-endian
18557 @opindex mlittle-endian
18558 @opindex mbig-endian
18559 Generate code for a little-endian target.
18561 @item -m210
18562 @itemx -m340
18563 @opindex m210
18564 @opindex m340
18565 Generate code for the 210 processor.
18567 @item -mno-lsim
18568 @opindex mno-lsim
18569 Assume that runtime support has been provided and so omit the
18570 simulator library (@file{libsim.a)} from the linker command line.
18572 @item -mstack-increment=@var{size}
18573 @opindex mstack-increment
18574 Set the maximum amount for a single stack increment operation.  Large
18575 values can increase the speed of programs that contain functions
18576 that need a large amount of stack space, but they can also trigger a
18577 segmentation fault if the stack is extended too much.  The default
18578 value is 0x1000.
18580 @end table
18582 @node MeP Options
18583 @subsection MeP Options
18584 @cindex MeP options
18586 @table @gcctabopt
18588 @item -mabsdiff
18589 @opindex mabsdiff
18590 Enables the @code{abs} instruction, which is the absolute difference
18591 between two registers.
18593 @item -mall-opts
18594 @opindex mall-opts
18595 Enables all the optional instructions---average, multiply, divide, bit
18596 operations, leading zero, absolute difference, min/max, clip, and
18597 saturation.
18600 @item -maverage
18601 @opindex maverage
18602 Enables the @code{ave} instruction, which computes the average of two
18603 registers.
18605 @item -mbased=@var{n}
18606 @opindex mbased=
18607 Variables of size @var{n} bytes or smaller are placed in the
18608 @code{.based} section by default.  Based variables use the @code{$tp}
18609 register as a base register, and there is a 128-byte limit to the
18610 @code{.based} section.
18612 @item -mbitops
18613 @opindex mbitops
18614 Enables the bit operation instructions---bit test (@code{btstm}), set
18615 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
18616 test-and-set (@code{tas}).
18618 @item -mc=@var{name}
18619 @opindex mc=
18620 Selects which section constant data is placed in.  @var{name} may
18621 be @samp{tiny}, @samp{near}, or @samp{far}.
18623 @item -mclip
18624 @opindex mclip
18625 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
18626 useful unless you also provide @option{-mminmax}.
18628 @item -mconfig=@var{name}
18629 @opindex mconfig=
18630 Selects one of the built-in core configurations.  Each MeP chip has
18631 one or more modules in it; each module has a core CPU and a variety of
18632 coprocessors, optional instructions, and peripherals.  The
18633 @code{MeP-Integrator} tool, not part of GCC, provides these
18634 configurations through this option; using this option is the same as
18635 using all the corresponding command-line options.  The default
18636 configuration is @samp{default}.
18638 @item -mcop
18639 @opindex mcop
18640 Enables the coprocessor instructions.  By default, this is a 32-bit
18641 coprocessor.  Note that the coprocessor is normally enabled via the
18642 @option{-mconfig=} option.
18644 @item -mcop32
18645 @opindex mcop32
18646 Enables the 32-bit coprocessor's instructions.
18648 @item -mcop64
18649 @opindex mcop64
18650 Enables the 64-bit coprocessor's instructions.
18652 @item -mivc2
18653 @opindex mivc2
18654 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
18656 @item -mdc
18657 @opindex mdc
18658 Causes constant variables to be placed in the @code{.near} section.
18660 @item -mdiv
18661 @opindex mdiv
18662 Enables the @code{div} and @code{divu} instructions.
18664 @item -meb
18665 @opindex meb
18666 Generate big-endian code.
18668 @item -mel
18669 @opindex mel
18670 Generate little-endian code.
18672 @item -mio-volatile
18673 @opindex mio-volatile
18674 Tells the compiler that any variable marked with the @code{io}
18675 attribute is to be considered volatile.
18677 @item -ml
18678 @opindex ml
18679 Causes variables to be assigned to the @code{.far} section by default.
18681 @item -mleadz
18682 @opindex mleadz
18683 Enables the @code{leadz} (leading zero) instruction.
18685 @item -mm
18686 @opindex mm
18687 Causes variables to be assigned to the @code{.near} section by default.
18689 @item -mminmax
18690 @opindex mminmax
18691 Enables the @code{min} and @code{max} instructions.
18693 @item -mmult
18694 @opindex mmult
18695 Enables the multiplication and multiply-accumulate instructions.
18697 @item -mno-opts
18698 @opindex mno-opts
18699 Disables all the optional instructions enabled by @option{-mall-opts}.
18701 @item -mrepeat
18702 @opindex mrepeat
18703 Enables the @code{repeat} and @code{erepeat} instructions, used for
18704 low-overhead looping.
18706 @item -ms
18707 @opindex ms
18708 Causes all variables to default to the @code{.tiny} section.  Note
18709 that there is a 65536-byte limit to this section.  Accesses to these
18710 variables use the @code{%gp} base register.
18712 @item -msatur
18713 @opindex msatur
18714 Enables the saturation instructions.  Note that the compiler does not
18715 currently generate these itself, but this option is included for
18716 compatibility with other tools, like @code{as}.
18718 @item -msdram
18719 @opindex msdram
18720 Link the SDRAM-based runtime instead of the default ROM-based runtime.
18722 @item -msim
18723 @opindex msim
18724 Link the simulator run-time libraries.
18726 @item -msimnovec
18727 @opindex msimnovec
18728 Link the simulator runtime libraries, excluding built-in support
18729 for reset and exception vectors and tables.
18731 @item -mtf
18732 @opindex mtf
18733 Causes all functions to default to the @code{.far} section.  Without
18734 this option, functions default to the @code{.near} section.
18736 @item -mtiny=@var{n}
18737 @opindex mtiny=
18738 Variables that are @var{n} bytes or smaller are allocated to the
18739 @code{.tiny} section.  These variables use the @code{$gp} base
18740 register.  The default for this option is 4, but note that there's a
18741 65536-byte limit to the @code{.tiny} section.
18743 @end table
18745 @node MicroBlaze Options
18746 @subsection MicroBlaze Options
18747 @cindex MicroBlaze Options
18749 @table @gcctabopt
18751 @item -msoft-float
18752 @opindex msoft-float
18753 Use software emulation for floating point (default).
18755 @item -mhard-float
18756 @opindex mhard-float
18757 Use hardware floating-point instructions.
18759 @item -mmemcpy
18760 @opindex mmemcpy
18761 Do not optimize block moves, use @code{memcpy}.
18763 @item -mno-clearbss
18764 @opindex mno-clearbss
18765 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
18767 @item -mcpu=@var{cpu-type}
18768 @opindex mcpu=
18769 Use features of, and schedule code for, the given CPU.
18770 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
18771 where @var{X} is a major version, @var{YY} is the minor version, and
18772 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
18773 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
18775 @item -mxl-soft-mul
18776 @opindex mxl-soft-mul
18777 Use software multiply emulation (default).
18779 @item -mxl-soft-div
18780 @opindex mxl-soft-div
18781 Use software emulation for divides (default).
18783 @item -mxl-barrel-shift
18784 @opindex mxl-barrel-shift
18785 Use the hardware barrel shifter.
18787 @item -mxl-pattern-compare
18788 @opindex mxl-pattern-compare
18789 Use pattern compare instructions.
18791 @item -msmall-divides
18792 @opindex msmall-divides
18793 Use table lookup optimization for small signed integer divisions.
18795 @item -mxl-stack-check
18796 @opindex mxl-stack-check
18797 This option is deprecated.  Use @option{-fstack-check} instead.
18799 @item -mxl-gp-opt
18800 @opindex mxl-gp-opt
18801 Use GP-relative @code{.sdata}/@code{.sbss} sections.
18803 @item -mxl-multiply-high
18804 @opindex mxl-multiply-high
18805 Use multiply high instructions for high part of 32x32 multiply.
18807 @item -mxl-float-convert
18808 @opindex mxl-float-convert
18809 Use hardware floating-point conversion instructions.
18811 @item -mxl-float-sqrt
18812 @opindex mxl-float-sqrt
18813 Use hardware floating-point square root instruction.
18815 @item -mbig-endian
18816 @opindex mbig-endian
18817 Generate code for a big-endian target.
18819 @item -mlittle-endian
18820 @opindex mlittle-endian
18821 Generate code for a little-endian target.
18823 @item -mxl-reorder
18824 @opindex mxl-reorder
18825 Use reorder instructions (swap and byte reversed load/store).
18827 @item -mxl-mode-@var{app-model}
18828 Select application model @var{app-model}.  Valid models are
18829 @table @samp
18830 @item executable
18831 normal executable (default), uses startup code @file{crt0.o}.
18833 @item xmdstub
18834 for use with Xilinx Microprocessor Debugger (XMD) based
18835 software intrusive debug agent called xmdstub. This uses startup file
18836 @file{crt1.o} and sets the start address of the program to 0x800.
18838 @item bootstrap
18839 for applications that are loaded using a bootloader.
18840 This model uses startup file @file{crt2.o} which does not contain a processor
18841 reset vector handler. This is suitable for transferring control on a
18842 processor reset to the bootloader rather than the application.
18844 @item novectors
18845 for applications that do not require any of the
18846 MicroBlaze vectors. This option may be useful for applications running
18847 within a monitoring application. This model uses @file{crt3.o} as a startup file.
18848 @end table
18850 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
18851 @option{-mxl-mode-@var{app-model}}.
18853 @end table
18855 @node MIPS Options
18856 @subsection MIPS Options
18857 @cindex MIPS options
18859 @table @gcctabopt
18861 @item -EB
18862 @opindex EB
18863 Generate big-endian code.
18865 @item -EL
18866 @opindex EL
18867 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
18868 configurations.
18870 @item -march=@var{arch}
18871 @opindex march
18872 Generate code that runs on @var{arch}, which can be the name of a
18873 generic MIPS ISA, or the name of a particular processor.
18874 The ISA names are:
18875 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
18876 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
18877 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
18878 @samp{mips64r5} and @samp{mips64r6}.
18879 The processor names are:
18880 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
18881 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
18882 @samp{5kc}, @samp{5kf},
18883 @samp{20kc},
18884 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
18885 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
18886 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
18887 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
18888 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
18889 @samp{i6400},
18890 @samp{interaptiv},
18891 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
18892 @samp{m4k},
18893 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
18894 @samp{m5100}, @samp{m5101},
18895 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
18896 @samp{orion},
18897 @samp{p5600},
18898 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
18899 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
18900 @samp{rm7000}, @samp{rm9000},
18901 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
18902 @samp{sb1},
18903 @samp{sr71000},
18904 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
18905 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
18906 @samp{xlr} and @samp{xlp}.
18907 The special value @samp{from-abi} selects the
18908 most compatible architecture for the selected ABI (that is,
18909 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
18911 The native Linux/GNU toolchain also supports the value @samp{native},
18912 which selects the best architecture option for the host processor.
18913 @option{-march=native} has no effect if GCC does not recognize
18914 the processor.
18916 In processor names, a final @samp{000} can be abbreviated as @samp{k}
18917 (for example, @option{-march=r2k}).  Prefixes are optional, and
18918 @samp{vr} may be written @samp{r}.
18920 Names of the form @samp{@var{n}f2_1} refer to processors with
18921 FPUs clocked at half the rate of the core, names of the form
18922 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
18923 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
18924 processors with FPUs clocked a ratio of 3:2 with respect to the core.
18925 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
18926 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
18927 accepted as synonyms for @samp{@var{n}f1_1}.
18929 GCC defines two macros based on the value of this option.  The first
18930 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
18931 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
18932 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
18933 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
18934 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
18936 Note that the @code{_MIPS_ARCH} macro uses the processor names given
18937 above.  In other words, it has the full prefix and does not
18938 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
18939 the macro names the resolved architecture (either @code{"mips1"} or
18940 @code{"mips3"}).  It names the default architecture when no
18941 @option{-march} option is given.
18943 @item -mtune=@var{arch}
18944 @opindex mtune
18945 Optimize for @var{arch}.  Among other things, this option controls
18946 the way instructions are scheduled, and the perceived cost of arithmetic
18947 operations.  The list of @var{arch} values is the same as for
18948 @option{-march}.
18950 When this option is not used, GCC optimizes for the processor
18951 specified by @option{-march}.  By using @option{-march} and
18952 @option{-mtune} together, it is possible to generate code that
18953 runs on a family of processors, but optimize the code for one
18954 particular member of that family.
18956 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
18957 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
18958 @option{-march} ones described above.
18960 @item -mips1
18961 @opindex mips1
18962 Equivalent to @option{-march=mips1}.
18964 @item -mips2
18965 @opindex mips2
18966 Equivalent to @option{-march=mips2}.
18968 @item -mips3
18969 @opindex mips3
18970 Equivalent to @option{-march=mips3}.
18972 @item -mips4
18973 @opindex mips4
18974 Equivalent to @option{-march=mips4}.
18976 @item -mips32
18977 @opindex mips32
18978 Equivalent to @option{-march=mips32}.
18980 @item -mips32r3
18981 @opindex mips32r3
18982 Equivalent to @option{-march=mips32r3}.
18984 @item -mips32r5
18985 @opindex mips32r5
18986 Equivalent to @option{-march=mips32r5}.
18988 @item -mips32r6
18989 @opindex mips32r6
18990 Equivalent to @option{-march=mips32r6}.
18992 @item -mips64
18993 @opindex mips64
18994 Equivalent to @option{-march=mips64}.
18996 @item -mips64r2
18997 @opindex mips64r2
18998 Equivalent to @option{-march=mips64r2}.
19000 @item -mips64r3
19001 @opindex mips64r3
19002 Equivalent to @option{-march=mips64r3}.
19004 @item -mips64r5
19005 @opindex mips64r5
19006 Equivalent to @option{-march=mips64r5}.
19008 @item -mips64r6
19009 @opindex mips64r6
19010 Equivalent to @option{-march=mips64r6}.
19012 @item -mips16
19013 @itemx -mno-mips16
19014 @opindex mips16
19015 @opindex mno-mips16
19016 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19017 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19019 MIPS16 code generation can also be controlled on a per-function basis
19020 by means of @code{mips16} and @code{nomips16} attributes.
19021 @xref{Function Attributes}, for more information.
19023 @item -mflip-mips16
19024 @opindex mflip-mips16
19025 Generate MIPS16 code on alternating functions.  This option is provided
19026 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19027 not intended for ordinary use in compiling user code.
19029 @item -minterlink-compressed
19030 @item -mno-interlink-compressed
19031 @opindex minterlink-compressed
19032 @opindex mno-interlink-compressed
19033 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19034 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19036 For example, code using the standard ISA encoding cannot jump directly
19037 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19038 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19039 knows that the target of the jump is not compressed.
19041 @item -minterlink-mips16
19042 @itemx -mno-interlink-mips16
19043 @opindex minterlink-mips16
19044 @opindex mno-interlink-mips16
19045 Aliases of @option{-minterlink-compressed} and
19046 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19047 and are retained for backwards compatibility.
19049 @item -mabi=32
19050 @itemx -mabi=o64
19051 @itemx -mabi=n32
19052 @itemx -mabi=64
19053 @itemx -mabi=eabi
19054 @opindex mabi=32
19055 @opindex mabi=o64
19056 @opindex mabi=n32
19057 @opindex mabi=64
19058 @opindex mabi=eabi
19059 Generate code for the given ABI@.
19061 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19062 generates 64-bit code when you select a 64-bit architecture, but you
19063 can use @option{-mgp32} to get 32-bit code instead.
19065 For information about the O64 ABI, see
19066 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19068 GCC supports a variant of the o32 ABI in which floating-point registers
19069 are 64 rather than 32 bits wide.  You can select this combination with
19070 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19071 and @code{mfhc1} instructions and is therefore only supported for
19072 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19074 The register assignments for arguments and return values remain the
19075 same, but each scalar value is passed in a single 64-bit register
19076 rather than a pair of 32-bit registers.  For example, scalar
19077 floating-point values are returned in @samp{$f0} only, not a
19078 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19079 remains the same in that the even-numbered double-precision registers
19080 are saved.
19082 Two additional variants of the o32 ABI are supported to enable
19083 a transition from 32-bit to 64-bit registers.  These are FPXX
19084 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19085 The FPXX extension mandates that all code must execute correctly
19086 when run using 32-bit or 64-bit registers.  The code can be interlinked
19087 with either FP32 or FP64, but not both.
19088 The FP64A extension is similar to the FP64 extension but forbids the
19089 use of odd-numbered single-precision registers.  This can be used
19090 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19091 processors and allows both FP32 and FP64A code to interlink and
19092 run in the same process without changing FPU modes.
19094 @item -mabicalls
19095 @itemx -mno-abicalls
19096 @opindex mabicalls
19097 @opindex mno-abicalls
19098 Generate (do not generate) code that is suitable for SVR4-style
19099 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19100 systems.
19102 @item -mshared
19103 @itemx -mno-shared
19104 Generate (do not generate) code that is fully position-independent,
19105 and that can therefore be linked into shared libraries.  This option
19106 only affects @option{-mabicalls}.
19108 All @option{-mabicalls} code has traditionally been position-independent,
19109 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19110 as an extension, the GNU toolchain allows executables to use absolute
19111 accesses for locally-binding symbols.  It can also use shorter GP
19112 initialization sequences and generate direct calls to locally-defined
19113 functions.  This mode is selected by @option{-mno-shared}.
19115 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19116 objects that can only be linked by the GNU linker.  However, the option
19117 does not affect the ABI of the final executable; it only affects the ABI
19118 of relocatable objects.  Using @option{-mno-shared} generally makes
19119 executables both smaller and quicker.
19121 @option{-mshared} is the default.
19123 @item -mplt
19124 @itemx -mno-plt
19125 @opindex mplt
19126 @opindex mno-plt
19127 Assume (do not assume) that the static and dynamic linkers
19128 support PLTs and copy relocations.  This option only affects
19129 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19130 has no effect without @option{-msym32}.
19132 You can make @option{-mplt} the default by configuring
19133 GCC with @option{--with-mips-plt}.  The default is
19134 @option{-mno-plt} otherwise.
19136 @item -mxgot
19137 @itemx -mno-xgot
19138 @opindex mxgot
19139 @opindex mno-xgot
19140 Lift (do not lift) the usual restrictions on the size of the global
19141 offset table.
19143 GCC normally uses a single instruction to load values from the GOT@.
19144 While this is relatively efficient, it only works if the GOT
19145 is smaller than about 64k.  Anything larger causes the linker
19146 to report an error such as:
19148 @cindex relocation truncated to fit (MIPS)
19149 @smallexample
19150 relocation truncated to fit: R_MIPS_GOT16 foobar
19151 @end smallexample
19153 If this happens, you should recompile your code with @option{-mxgot}.
19154 This works with very large GOTs, although the code is also
19155 less efficient, since it takes three instructions to fetch the
19156 value of a global symbol.
19158 Note that some linkers can create multiple GOTs.  If you have such a
19159 linker, you should only need to use @option{-mxgot} when a single object
19160 file accesses more than 64k's worth of GOT entries.  Very few do.
19162 These options have no effect unless GCC is generating position
19163 independent code.
19165 @item -mgp32
19166 @opindex mgp32
19167 Assume that general-purpose registers are 32 bits wide.
19169 @item -mgp64
19170 @opindex mgp64
19171 Assume that general-purpose registers are 64 bits wide.
19173 @item -mfp32
19174 @opindex mfp32
19175 Assume that floating-point registers are 32 bits wide.
19177 @item -mfp64
19178 @opindex mfp64
19179 Assume that floating-point registers are 64 bits wide.
19181 @item -mfpxx
19182 @opindex mfpxx
19183 Do not assume the width of floating-point registers.
19185 @item -mhard-float
19186 @opindex mhard-float
19187 Use floating-point coprocessor instructions.
19189 @item -msoft-float
19190 @opindex msoft-float
19191 Do not use floating-point coprocessor instructions.  Implement
19192 floating-point calculations using library calls instead.
19194 @item -mno-float
19195 @opindex mno-float
19196 Equivalent to @option{-msoft-float}, but additionally asserts that the
19197 program being compiled does not perform any floating-point operations.
19198 This option is presently supported only by some bare-metal MIPS
19199 configurations, where it may select a special set of libraries
19200 that lack all floating-point support (including, for example, the
19201 floating-point @code{printf} formats).  
19202 If code compiled with @option{-mno-float} accidentally contains
19203 floating-point operations, it is likely to suffer a link-time
19204 or run-time failure.
19206 @item -msingle-float
19207 @opindex msingle-float
19208 Assume that the floating-point coprocessor only supports single-precision
19209 operations.
19211 @item -mdouble-float
19212 @opindex mdouble-float
19213 Assume that the floating-point coprocessor supports double-precision
19214 operations.  This is the default.
19216 @item -modd-spreg
19217 @itemx -mno-odd-spreg
19218 @opindex modd-spreg
19219 @opindex mno-odd-spreg
19220 Enable the use of odd-numbered single-precision floating-point registers
19221 for the o32 ABI.  This is the default for processors that are known to
19222 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19223 is set by default.
19225 @item -mabs=2008
19226 @itemx -mabs=legacy
19227 @opindex mabs=2008
19228 @opindex mabs=legacy
19229 These options control the treatment of the special not-a-number (NaN)
19230 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19231 @code{neg.@i{fmt}} machine instructions.
19233 By default or when @option{-mabs=legacy} is used the legacy
19234 treatment is selected.  In this case these instructions are considered
19235 arithmetic and avoided where correct operation is required and the
19236 input operand might be a NaN.  A longer sequence of instructions that
19237 manipulate the sign bit of floating-point datum manually is used
19238 instead unless the @option{-ffinite-math-only} option has also been
19239 specified.
19241 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19242 this case these instructions are considered non-arithmetic and therefore
19243 operating correctly in all cases, including in particular where the
19244 input operand is a NaN.  These instructions are therefore always used
19245 for the respective operations.
19247 @item -mnan=2008
19248 @itemx -mnan=legacy
19249 @opindex mnan=2008
19250 @opindex mnan=legacy
19251 These options control the encoding of the special not-a-number (NaN)
19252 IEEE 754 floating-point data.
19254 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19255 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19256 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19257 by the first bit of their trailing significand field being 1.
19259 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19260 this case qNaNs are denoted by the first bit of their trailing
19261 significand field being 1, whereas sNaNs are denoted by the first bit of
19262 their trailing significand field being 0.
19264 The default is @option{-mnan=legacy} unless GCC has been configured with
19265 @option{--with-nan=2008}.
19267 @item -mllsc
19268 @itemx -mno-llsc
19269 @opindex mllsc
19270 @opindex mno-llsc
19271 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19272 implement atomic memory built-in functions.  When neither option is
19273 specified, GCC uses the instructions if the target architecture
19274 supports them.
19276 @option{-mllsc} is useful if the runtime environment can emulate the
19277 instructions and @option{-mno-llsc} can be useful when compiling for
19278 nonstandard ISAs.  You can make either option the default by
19279 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19280 respectively.  @option{--with-llsc} is the default for some
19281 configurations; see the installation documentation for details.
19283 @item -mdsp
19284 @itemx -mno-dsp
19285 @opindex mdsp
19286 @opindex mno-dsp
19287 Use (do not use) revision 1 of the MIPS DSP ASE@.
19288 @xref{MIPS DSP Built-in Functions}.  This option defines the
19289 preprocessor macro @code{__mips_dsp}.  It also defines
19290 @code{__mips_dsp_rev} to 1.
19292 @item -mdspr2
19293 @itemx -mno-dspr2
19294 @opindex mdspr2
19295 @opindex mno-dspr2
19296 Use (do not use) revision 2 of the MIPS DSP ASE@.
19297 @xref{MIPS DSP Built-in Functions}.  This option defines the
19298 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19299 It also defines @code{__mips_dsp_rev} to 2.
19301 @item -msmartmips
19302 @itemx -mno-smartmips
19303 @opindex msmartmips
19304 @opindex mno-smartmips
19305 Use (do not use) the MIPS SmartMIPS ASE.
19307 @item -mpaired-single
19308 @itemx -mno-paired-single
19309 @opindex mpaired-single
19310 @opindex mno-paired-single
19311 Use (do not use) paired-single floating-point instructions.
19312 @xref{MIPS Paired-Single Support}.  This option requires
19313 hardware floating-point support to be enabled.
19315 @item -mdmx
19316 @itemx -mno-mdmx
19317 @opindex mdmx
19318 @opindex mno-mdmx
19319 Use (do not use) MIPS Digital Media Extension instructions.
19320 This option can only be used when generating 64-bit code and requires
19321 hardware floating-point support to be enabled.
19323 @item -mips3d
19324 @itemx -mno-mips3d
19325 @opindex mips3d
19326 @opindex mno-mips3d
19327 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19328 The option @option{-mips3d} implies @option{-mpaired-single}.
19330 @item -mmicromips
19331 @itemx -mno-micromips
19332 @opindex mmicromips
19333 @opindex mno-mmicromips
19334 Generate (do not generate) microMIPS code.
19336 MicroMIPS code generation can also be controlled on a per-function basis
19337 by means of @code{micromips} and @code{nomicromips} attributes.
19338 @xref{Function Attributes}, for more information.
19340 @item -mmt
19341 @itemx -mno-mt
19342 @opindex mmt
19343 @opindex mno-mt
19344 Use (do not use) MT Multithreading instructions.
19346 @item -mmcu
19347 @itemx -mno-mcu
19348 @opindex mmcu
19349 @opindex mno-mcu
19350 Use (do not use) the MIPS MCU ASE instructions.
19352 @item -meva
19353 @itemx -mno-eva
19354 @opindex meva
19355 @opindex mno-eva
19356 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19358 @item -mvirt
19359 @itemx -mno-virt
19360 @opindex mvirt
19361 @opindex mno-virt
19362 Use (do not use) the MIPS Virtualization (VZ) instructions.
19364 @item -mxpa
19365 @itemx -mno-xpa
19366 @opindex mxpa
19367 @opindex mno-xpa
19368 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19370 @item -mlong64
19371 @opindex mlong64
19372 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19373 an explanation of the default and the way that the pointer size is
19374 determined.
19376 @item -mlong32
19377 @opindex mlong32
19378 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19380 The default size of @code{int}s, @code{long}s and pointers depends on
19381 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19382 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19383 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19384 or the same size as integer registers, whichever is smaller.
19386 @item -msym32
19387 @itemx -mno-sym32
19388 @opindex msym32
19389 @opindex mno-sym32
19390 Assume (do not assume) that all symbols have 32-bit values, regardless
19391 of the selected ABI@.  This option is useful in combination with
19392 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19393 to generate shorter and faster references to symbolic addresses.
19395 @item -G @var{num}
19396 @opindex G
19397 Put definitions of externally-visible data in a small data section
19398 if that data is no bigger than @var{num} bytes.  GCC can then generate
19399 more efficient accesses to the data; see @option{-mgpopt} for details.
19401 The default @option{-G} option depends on the configuration.
19403 @item -mlocal-sdata
19404 @itemx -mno-local-sdata
19405 @opindex mlocal-sdata
19406 @opindex mno-local-sdata
19407 Extend (do not extend) the @option{-G} behavior to local data too,
19408 such as to static variables in C@.  @option{-mlocal-sdata} is the
19409 default for all configurations.
19411 If the linker complains that an application is using too much small data,
19412 you might want to try rebuilding the less performance-critical parts with
19413 @option{-mno-local-sdata}.  You might also want to build large
19414 libraries with @option{-mno-local-sdata}, so that the libraries leave
19415 more room for the main program.
19417 @item -mextern-sdata
19418 @itemx -mno-extern-sdata
19419 @opindex mextern-sdata
19420 @opindex mno-extern-sdata
19421 Assume (do not assume) that externally-defined data is in
19422 a small data section if the size of that data is within the @option{-G} limit.
19423 @option{-mextern-sdata} is the default for all configurations.
19425 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19426 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19427 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19428 is placed in a small data section.  If @var{Var} is defined by another
19429 module, you must either compile that module with a high-enough
19430 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19431 definition.  If @var{Var} is common, you must link the application
19432 with a high-enough @option{-G} setting.
19434 The easiest way of satisfying these restrictions is to compile
19435 and link every module with the same @option{-G} option.  However,
19436 you may wish to build a library that supports several different
19437 small data limits.  You can do this by compiling the library with
19438 the highest supported @option{-G} setting and additionally using
19439 @option{-mno-extern-sdata} to stop the library from making assumptions
19440 about externally-defined data.
19442 @item -mgpopt
19443 @itemx -mno-gpopt
19444 @opindex mgpopt
19445 @opindex mno-gpopt
19446 Use (do not use) GP-relative accesses for symbols that are known to be
19447 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19448 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19449 configurations.
19451 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19452 might not hold the value of @code{_gp}.  For example, if the code is
19453 part of a library that might be used in a boot monitor, programs that
19454 call boot monitor routines pass an unknown value in @code{$gp}.
19455 (In such situations, the boot monitor itself is usually compiled
19456 with @option{-G0}.)
19458 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19459 @option{-mno-extern-sdata}.
19461 @item -membedded-data
19462 @itemx -mno-embedded-data
19463 @opindex membedded-data
19464 @opindex mno-embedded-data
19465 Allocate variables to the read-only data section first if possible, then
19466 next in the small data section if possible, otherwise in data.  This gives
19467 slightly slower code than the default, but reduces the amount of RAM required
19468 when executing, and thus may be preferred for some embedded systems.
19470 @item -muninit-const-in-rodata
19471 @itemx -mno-uninit-const-in-rodata
19472 @opindex muninit-const-in-rodata
19473 @opindex mno-uninit-const-in-rodata
19474 Put uninitialized @code{const} variables in the read-only data section.
19475 This option is only meaningful in conjunction with @option{-membedded-data}.
19477 @item -mcode-readable=@var{setting}
19478 @opindex mcode-readable
19479 Specify whether GCC may generate code that reads from executable sections.
19480 There are three possible settings:
19482 @table @gcctabopt
19483 @item -mcode-readable=yes
19484 Instructions may freely access executable sections.  This is the
19485 default setting.
19487 @item -mcode-readable=pcrel
19488 MIPS16 PC-relative load instructions can access executable sections,
19489 but other instructions must not do so.  This option is useful on 4KSc
19490 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19491 It is also useful on processors that can be configured to have a dual
19492 instruction/data SRAM interface and that, like the M4K, automatically
19493 redirect PC-relative loads to the instruction RAM.
19495 @item -mcode-readable=no
19496 Instructions must not access executable sections.  This option can be
19497 useful on targets that are configured to have a dual instruction/data
19498 SRAM interface but that (unlike the M4K) do not automatically redirect
19499 PC-relative loads to the instruction RAM.
19500 @end table
19502 @item -msplit-addresses
19503 @itemx -mno-split-addresses
19504 @opindex msplit-addresses
19505 @opindex mno-split-addresses
19506 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19507 relocation operators.  This option has been superseded by
19508 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19510 @item -mexplicit-relocs
19511 @itemx -mno-explicit-relocs
19512 @opindex mexplicit-relocs
19513 @opindex mno-explicit-relocs
19514 Use (do not use) assembler relocation operators when dealing with symbolic
19515 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19516 is to use assembler macros instead.
19518 @option{-mexplicit-relocs} is the default if GCC was configured
19519 to use an assembler that supports relocation operators.
19521 @item -mcheck-zero-division
19522 @itemx -mno-check-zero-division
19523 @opindex mcheck-zero-division
19524 @opindex mno-check-zero-division
19525 Trap (do not trap) on integer division by zero.
19527 The default is @option{-mcheck-zero-division}.
19529 @item -mdivide-traps
19530 @itemx -mdivide-breaks
19531 @opindex mdivide-traps
19532 @opindex mdivide-breaks
19533 MIPS systems check for division by zero by generating either a
19534 conditional trap or a break instruction.  Using traps results in
19535 smaller code, but is only supported on MIPS II and later.  Also, some
19536 versions of the Linux kernel have a bug that prevents trap from
19537 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19538 allow conditional traps on architectures that support them and
19539 @option{-mdivide-breaks} to force the use of breaks.
19541 The default is usually @option{-mdivide-traps}, but this can be
19542 overridden at configure time using @option{--with-divide=breaks}.
19543 Divide-by-zero checks can be completely disabled using
19544 @option{-mno-check-zero-division}.
19546 @item -mload-store-pairs
19547 @itemx -mno-load-store-pairs
19548 @opindex mload-store-pairs
19549 @opindex mno-load-store-pairs
19550 Enable (disable) an optimization that pairs consecutive load or store
19551 instructions to enable load/store bonding.  This option is enabled by
19552 default but only takes effect when the selected architecture is known
19553 to support bonding.
19555 @item -mmemcpy
19556 @itemx -mno-memcpy
19557 @opindex mmemcpy
19558 @opindex mno-memcpy
19559 Force (do not force) the use of @code{memcpy} for non-trivial block
19560 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19561 most constant-sized copies.
19563 @item -mlong-calls
19564 @itemx -mno-long-calls
19565 @opindex mlong-calls
19566 @opindex mno-long-calls
19567 Disable (do not disable) use of the @code{jal} instruction.  Calling
19568 functions using @code{jal} is more efficient but requires the caller
19569 and callee to be in the same 256 megabyte segment.
19571 This option has no effect on abicalls code.  The default is
19572 @option{-mno-long-calls}.
19574 @item -mmad
19575 @itemx -mno-mad
19576 @opindex mmad
19577 @opindex mno-mad
19578 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
19579 instructions, as provided by the R4650 ISA@.
19581 @item -mimadd
19582 @itemx -mno-imadd
19583 @opindex mimadd
19584 @opindex mno-imadd
19585 Enable (disable) use of the @code{madd} and @code{msub} integer
19586 instructions.  The default is @option{-mimadd} on architectures
19587 that support @code{madd} and @code{msub} except for the 74k 
19588 architecture where it was found to generate slower code.
19590 @item -mfused-madd
19591 @itemx -mno-fused-madd
19592 @opindex mfused-madd
19593 @opindex mno-fused-madd
19594 Enable (disable) use of the floating-point multiply-accumulate
19595 instructions, when they are available.  The default is
19596 @option{-mfused-madd}.
19598 On the R8000 CPU when multiply-accumulate instructions are used,
19599 the intermediate product is calculated to infinite precision
19600 and is not subject to the FCSR Flush to Zero bit.  This may be
19601 undesirable in some circumstances.  On other processors the result
19602 is numerically identical to the equivalent computation using
19603 separate multiply, add, subtract and negate instructions.
19605 @item -nocpp
19606 @opindex nocpp
19607 Tell the MIPS assembler to not run its preprocessor over user
19608 assembler files (with a @samp{.s} suffix) when assembling them.
19610 @item -mfix-24k
19611 @item -mno-fix-24k
19612 @opindex mfix-24k
19613 @opindex mno-fix-24k
19614 Work around the 24K E48 (lost data on stores during refill) errata.
19615 The workarounds are implemented by the assembler rather than by GCC@.
19617 @item -mfix-r4000
19618 @itemx -mno-fix-r4000
19619 @opindex mfix-r4000
19620 @opindex mno-fix-r4000
19621 Work around certain R4000 CPU errata:
19622 @itemize @minus
19623 @item
19624 A double-word or a variable shift may give an incorrect result if executed
19625 immediately after starting an integer division.
19626 @item
19627 A double-word or a variable shift may give an incorrect result if executed
19628 while an integer multiplication is in progress.
19629 @item
19630 An integer division may give an incorrect result if started in a delay slot
19631 of a taken branch or a jump.
19632 @end itemize
19634 @item -mfix-r4400
19635 @itemx -mno-fix-r4400
19636 @opindex mfix-r4400
19637 @opindex mno-fix-r4400
19638 Work around certain R4400 CPU errata:
19639 @itemize @minus
19640 @item
19641 A double-word or a variable shift may give an incorrect result if executed
19642 immediately after starting an integer division.
19643 @end itemize
19645 @item -mfix-r10000
19646 @itemx -mno-fix-r10000
19647 @opindex mfix-r10000
19648 @opindex mno-fix-r10000
19649 Work around certain R10000 errata:
19650 @itemize @minus
19651 @item
19652 @code{ll}/@code{sc} sequences may not behave atomically on revisions
19653 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
19654 @end itemize
19656 This option can only be used if the target architecture supports
19657 branch-likely instructions.  @option{-mfix-r10000} is the default when
19658 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
19659 otherwise.
19661 @item -mfix-rm7000
19662 @itemx -mno-fix-rm7000
19663 @opindex mfix-rm7000
19664 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
19665 workarounds are implemented by the assembler rather than by GCC@.
19667 @item -mfix-vr4120
19668 @itemx -mno-fix-vr4120
19669 @opindex mfix-vr4120
19670 Work around certain VR4120 errata:
19671 @itemize @minus
19672 @item
19673 @code{dmultu} does not always produce the correct result.
19674 @item
19675 @code{div} and @code{ddiv} do not always produce the correct result if one
19676 of the operands is negative.
19677 @end itemize
19678 The workarounds for the division errata rely on special functions in
19679 @file{libgcc.a}.  At present, these functions are only provided by
19680 the @code{mips64vr*-elf} configurations.
19682 Other VR4120 errata require a NOP to be inserted between certain pairs of
19683 instructions.  These errata are handled by the assembler, not by GCC itself.
19685 @item -mfix-vr4130
19686 @opindex mfix-vr4130
19687 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
19688 workarounds are implemented by the assembler rather than by GCC,
19689 although GCC avoids using @code{mflo} and @code{mfhi} if the
19690 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
19691 instructions are available instead.
19693 @item -mfix-sb1
19694 @itemx -mno-fix-sb1
19695 @opindex mfix-sb1
19696 Work around certain SB-1 CPU core errata.
19697 (This flag currently works around the SB-1 revision 2
19698 ``F1'' and ``F2'' floating-point errata.)
19700 @item -mr10k-cache-barrier=@var{setting}
19701 @opindex mr10k-cache-barrier
19702 Specify whether GCC should insert cache barriers to avoid the
19703 side-effects of speculation on R10K processors.
19705 In common with many processors, the R10K tries to predict the outcome
19706 of a conditional branch and speculatively executes instructions from
19707 the ``taken'' branch.  It later aborts these instructions if the
19708 predicted outcome is wrong.  However, on the R10K, even aborted
19709 instructions can have side effects.
19711 This problem only affects kernel stores and, depending on the system,
19712 kernel loads.  As an example, a speculatively-executed store may load
19713 the target memory into cache and mark the cache line as dirty, even if
19714 the store itself is later aborted.  If a DMA operation writes to the
19715 same area of memory before the ``dirty'' line is flushed, the cached
19716 data overwrites the DMA-ed data.  See the R10K processor manual
19717 for a full description, including other potential problems.
19719 One workaround is to insert cache barrier instructions before every memory
19720 access that might be speculatively executed and that might have side
19721 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
19722 controls GCC's implementation of this workaround.  It assumes that
19723 aborted accesses to any byte in the following regions does not have
19724 side effects:
19726 @enumerate
19727 @item
19728 the memory occupied by the current function's stack frame;
19730 @item
19731 the memory occupied by an incoming stack argument;
19733 @item
19734 the memory occupied by an object with a link-time-constant address.
19735 @end enumerate
19737 It is the kernel's responsibility to ensure that speculative
19738 accesses to these regions are indeed safe.
19740 If the input program contains a function declaration such as:
19742 @smallexample
19743 void foo (void);
19744 @end smallexample
19746 then the implementation of @code{foo} must allow @code{j foo} and
19747 @code{jal foo} to be executed speculatively.  GCC honors this
19748 restriction for functions it compiles itself.  It expects non-GCC
19749 functions (such as hand-written assembly code) to do the same.
19751 The option has three forms:
19753 @table @gcctabopt
19754 @item -mr10k-cache-barrier=load-store
19755 Insert a cache barrier before a load or store that might be
19756 speculatively executed and that might have side effects even
19757 if aborted.
19759 @item -mr10k-cache-barrier=store
19760 Insert a cache barrier before a store that might be speculatively
19761 executed and that might have side effects even if aborted.
19763 @item -mr10k-cache-barrier=none
19764 Disable the insertion of cache barriers.  This is the default setting.
19765 @end table
19767 @item -mflush-func=@var{func}
19768 @itemx -mno-flush-func
19769 @opindex mflush-func
19770 Specifies the function to call to flush the I and D caches, or to not
19771 call any such function.  If called, the function must take the same
19772 arguments as the common @code{_flush_func}, that is, the address of the
19773 memory range for which the cache is being flushed, the size of the
19774 memory range, and the number 3 (to flush both caches).  The default
19775 depends on the target GCC was configured for, but commonly is either
19776 @code{_flush_func} or @code{__cpu_flush}.
19778 @item mbranch-cost=@var{num}
19779 @opindex mbranch-cost
19780 Set the cost of branches to roughly @var{num} ``simple'' instructions.
19781 This cost is only a heuristic and is not guaranteed to produce
19782 consistent results across releases.  A zero cost redundantly selects
19783 the default, which is based on the @option{-mtune} setting.
19785 @item -mbranch-likely
19786 @itemx -mno-branch-likely
19787 @opindex mbranch-likely
19788 @opindex mno-branch-likely
19789 Enable or disable use of Branch Likely instructions, regardless of the
19790 default for the selected architecture.  By default, Branch Likely
19791 instructions may be generated if they are supported by the selected
19792 architecture.  An exception is for the MIPS32 and MIPS64 architectures
19793 and processors that implement those architectures; for those, Branch
19794 Likely instructions are not be generated by default because the MIPS32
19795 and MIPS64 architectures specifically deprecate their use.
19797 @item -mcompact-branches=never
19798 @itemx -mcompact-branches=optimal
19799 @itemx -mcompact-branches=always
19800 @opindex mcompact-branches=never
19801 @opindex mcompact-branches=optimal
19802 @opindex mcompact-branches=always
19803 These options control which form of branches will be generated.  The
19804 default is @option{-mcompact-branches=optimal}.
19806 The @option{-mcompact-branches=never} option ensures that compact branch
19807 instructions will never be generated.
19809 The @option{-mcompact-branches=always} option ensures that a compact
19810 branch instruction will be generated if available.  If a compact branch
19811 instruction is not available, a delay slot form of the branch will be
19812 used instead.
19814 This option is supported from MIPS Release 6 onwards.
19816 The @option{-mcompact-branches=optimal} option will cause a delay slot
19817 branch to be used if one is available in the current ISA and the delay
19818 slot is successfully filled.  If the delay slot is not filled, a compact
19819 branch will be chosen if one is available.
19821 @item -mfp-exceptions
19822 @itemx -mno-fp-exceptions
19823 @opindex mfp-exceptions
19824 Specifies whether FP exceptions are enabled.  This affects how
19825 FP instructions are scheduled for some processors.
19826 The default is that FP exceptions are
19827 enabled.
19829 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
19830 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
19831 FP pipe.
19833 @item -mvr4130-align
19834 @itemx -mno-vr4130-align
19835 @opindex mvr4130-align
19836 The VR4130 pipeline is two-way superscalar, but can only issue two
19837 instructions together if the first one is 8-byte aligned.  When this
19838 option is enabled, GCC aligns pairs of instructions that it
19839 thinks should execute in parallel.
19841 This option only has an effect when optimizing for the VR4130.
19842 It normally makes code faster, but at the expense of making it bigger.
19843 It is enabled by default at optimization level @option{-O3}.
19845 @item -msynci
19846 @itemx -mno-synci
19847 @opindex msynci
19848 Enable (disable) generation of @code{synci} instructions on
19849 architectures that support it.  The @code{synci} instructions (if
19850 enabled) are generated when @code{__builtin___clear_cache} is
19851 compiled.
19853 This option defaults to @option{-mno-synci}, but the default can be
19854 overridden by configuring GCC with @option{--with-synci}.
19856 When compiling code for single processor systems, it is generally safe
19857 to use @code{synci}.  However, on many multi-core (SMP) systems, it
19858 does not invalidate the instruction caches on all cores and may lead
19859 to undefined behavior.
19861 @item -mrelax-pic-calls
19862 @itemx -mno-relax-pic-calls
19863 @opindex mrelax-pic-calls
19864 Try to turn PIC calls that are normally dispatched via register
19865 @code{$25} into direct calls.  This is only possible if the linker can
19866 resolve the destination at link time and if the destination is within
19867 range for a direct call.
19869 @option{-mrelax-pic-calls} is the default if GCC was configured to use
19870 an assembler and a linker that support the @code{.reloc} assembly
19871 directive and @option{-mexplicit-relocs} is in effect.  With
19872 @option{-mno-explicit-relocs}, this optimization can be performed by the
19873 assembler and the linker alone without help from the compiler.
19875 @item -mmcount-ra-address
19876 @itemx -mno-mcount-ra-address
19877 @opindex mmcount-ra-address
19878 @opindex mno-mcount-ra-address
19879 Emit (do not emit) code that allows @code{_mcount} to modify the
19880 calling function's return address.  When enabled, this option extends
19881 the usual @code{_mcount} interface with a new @var{ra-address}
19882 parameter, which has type @code{intptr_t *} and is passed in register
19883 @code{$12}.  @code{_mcount} can then modify the return address by
19884 doing both of the following:
19885 @itemize
19886 @item
19887 Returning the new address in register @code{$31}.
19888 @item
19889 Storing the new address in @code{*@var{ra-address}},
19890 if @var{ra-address} is nonnull.
19891 @end itemize
19893 The default is @option{-mno-mcount-ra-address}.
19895 @item -mframe-header-opt
19896 @itemx -mno-frame-header-opt
19897 @opindex mframe-header-opt
19898 Enable (disable) frame header optimization in the o32 ABI.  When using the
19899 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
19900 function to write out register arguments.  When enabled, this optimization
19901 will suppress the allocation of the frame header if it can be determined that
19902 it is unused.
19904 This optimization is off by default at all optimization levels.
19906 @item -mlxc1-sxc1
19907 @itemx -mno-lxc1-sxc1
19908 @opindex mlxc1-sxc1
19909 When applicable, enable (disable) the generation of @code{lwxc1},
19910 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
19912 @item -mmadd4
19913 @itemx -mno-madd4
19914 @opindex mmadd4
19915 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
19916 @code{madd.d} and related instructions.  Enabled by default.
19918 @end table
19920 @node MMIX Options
19921 @subsection MMIX Options
19922 @cindex MMIX Options
19924 These options are defined for the MMIX:
19926 @table @gcctabopt
19927 @item -mlibfuncs
19928 @itemx -mno-libfuncs
19929 @opindex mlibfuncs
19930 @opindex mno-libfuncs
19931 Specify that intrinsic library functions are being compiled, passing all
19932 values in registers, no matter the size.
19934 @item -mepsilon
19935 @itemx -mno-epsilon
19936 @opindex mepsilon
19937 @opindex mno-epsilon
19938 Generate floating-point comparison instructions that compare with respect
19939 to the @code{rE} epsilon register.
19941 @item -mabi=mmixware
19942 @itemx -mabi=gnu
19943 @opindex mabi=mmixware
19944 @opindex mabi=gnu
19945 Generate code that passes function parameters and return values that (in
19946 the called function) are seen as registers @code{$0} and up, as opposed to
19947 the GNU ABI which uses global registers @code{$231} and up.
19949 @item -mzero-extend
19950 @itemx -mno-zero-extend
19951 @opindex mzero-extend
19952 @opindex mno-zero-extend
19953 When reading data from memory in sizes shorter than 64 bits, use (do not
19954 use) zero-extending load instructions by default, rather than
19955 sign-extending ones.
19957 @item -mknuthdiv
19958 @itemx -mno-knuthdiv
19959 @opindex mknuthdiv
19960 @opindex mno-knuthdiv
19961 Make the result of a division yielding a remainder have the same sign as
19962 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
19963 remainder follows the sign of the dividend.  Both methods are
19964 arithmetically valid, the latter being almost exclusively used.
19966 @item -mtoplevel-symbols
19967 @itemx -mno-toplevel-symbols
19968 @opindex mtoplevel-symbols
19969 @opindex mno-toplevel-symbols
19970 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
19971 code can be used with the @code{PREFIX} assembly directive.
19973 @item -melf
19974 @opindex melf
19975 Generate an executable in the ELF format, rather than the default
19976 @samp{mmo} format used by the @command{mmix} simulator.
19978 @item -mbranch-predict
19979 @itemx -mno-branch-predict
19980 @opindex mbranch-predict
19981 @opindex mno-branch-predict
19982 Use (do not use) the probable-branch instructions, when static branch
19983 prediction indicates a probable branch.
19985 @item -mbase-addresses
19986 @itemx -mno-base-addresses
19987 @opindex mbase-addresses
19988 @opindex mno-base-addresses
19989 Generate (do not generate) code that uses @emph{base addresses}.  Using a
19990 base address automatically generates a request (handled by the assembler
19991 and the linker) for a constant to be set up in a global register.  The
19992 register is used for one or more base address requests within the range 0
19993 to 255 from the value held in the register.  The generally leads to short
19994 and fast code, but the number of different data items that can be
19995 addressed is limited.  This means that a program that uses lots of static
19996 data may require @option{-mno-base-addresses}.
19998 @item -msingle-exit
19999 @itemx -mno-single-exit
20000 @opindex msingle-exit
20001 @opindex mno-single-exit
20002 Force (do not force) generated code to have a single exit point in each
20003 function.
20004 @end table
20006 @node MN10300 Options
20007 @subsection MN10300 Options
20008 @cindex MN10300 options
20010 These @option{-m} options are defined for Matsushita MN10300 architectures:
20012 @table @gcctabopt
20013 @item -mmult-bug
20014 @opindex mmult-bug
20015 Generate code to avoid bugs in the multiply instructions for the MN10300
20016 processors.  This is the default.
20018 @item -mno-mult-bug
20019 @opindex mno-mult-bug
20020 Do not generate code to avoid bugs in the multiply instructions for the
20021 MN10300 processors.
20023 @item -mam33
20024 @opindex mam33
20025 Generate code using features specific to the AM33 processor.
20027 @item -mno-am33
20028 @opindex mno-am33
20029 Do not generate code using features specific to the AM33 processor.  This
20030 is the default.
20032 @item -mam33-2
20033 @opindex mam33-2
20034 Generate code using features specific to the AM33/2.0 processor.
20036 @item -mam34
20037 @opindex mam34
20038 Generate code using features specific to the AM34 processor.
20040 @item -mtune=@var{cpu-type}
20041 @opindex mtune
20042 Use the timing characteristics of the indicated CPU type when
20043 scheduling instructions.  This does not change the targeted processor
20044 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20045 @samp{am33-2} or @samp{am34}.
20047 @item -mreturn-pointer-on-d0
20048 @opindex mreturn-pointer-on-d0
20049 When generating a function that returns a pointer, return the pointer
20050 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20051 only in @code{a0}, and attempts to call such functions without a prototype
20052 result in errors.  Note that this option is on by default; use
20053 @option{-mno-return-pointer-on-d0} to disable it.
20055 @item -mno-crt0
20056 @opindex mno-crt0
20057 Do not link in the C run-time initialization object file.
20059 @item -mrelax
20060 @opindex mrelax
20061 Indicate to the linker that it should perform a relaxation optimization pass
20062 to shorten branches, calls and absolute memory addresses.  This option only
20063 has an effect when used on the command line for the final link step.
20065 This option makes symbolic debugging impossible.
20067 @item -mliw
20068 @opindex mliw
20069 Allow the compiler to generate @emph{Long Instruction Word}
20070 instructions if the target is the @samp{AM33} or later.  This is the
20071 default.  This option defines the preprocessor macro @code{__LIW__}.
20073 @item -mnoliw
20074 @opindex mnoliw
20075 Do not allow the compiler to generate @emph{Long Instruction Word}
20076 instructions.  This option defines the preprocessor macro
20077 @code{__NO_LIW__}.
20079 @item -msetlb
20080 @opindex msetlb
20081 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20082 instructions if the target is the @samp{AM33} or later.  This is the
20083 default.  This option defines the preprocessor macro @code{__SETLB__}.
20085 @item -mnosetlb
20086 @opindex mnosetlb
20087 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20088 instructions.  This option defines the preprocessor macro
20089 @code{__NO_SETLB__}.
20091 @end table
20093 @node Moxie Options
20094 @subsection Moxie Options
20095 @cindex Moxie Options
20097 @table @gcctabopt
20099 @item -meb
20100 @opindex meb
20101 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20102 configurations.
20104 @item -mel
20105 @opindex mel
20106 Generate little-endian code.
20108 @item -mmul.x
20109 @opindex mmul.x
20110 Generate mul.x and umul.x instructions.  This is the default for
20111 @samp{moxiebox-*-*} configurations.
20113 @item -mno-crt0
20114 @opindex mno-crt0
20115 Do not link in the C run-time initialization object file.
20117 @end table
20119 @node MSP430 Options
20120 @subsection MSP430 Options
20121 @cindex MSP430 Options
20123 These options are defined for the MSP430:
20125 @table @gcctabopt
20127 @item -masm-hex
20128 @opindex masm-hex
20129 Force assembly output to always use hex constants.  Normally such
20130 constants are signed decimals, but this option is available for
20131 testsuite and/or aesthetic purposes.
20133 @item -mmcu=
20134 @opindex mmcu=
20135 Select the MCU to target.  This is used to create a C preprocessor
20136 symbol based upon the MCU name, converted to upper case and pre- and
20137 post-fixed with @samp{__}.  This in turn is used by the
20138 @file{msp430.h} header file to select an MCU-specific supplementary
20139 header file.
20141 The option also sets the ISA to use.  If the MCU name is one that is
20142 known to only support the 430 ISA then that is selected, otherwise the
20143 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20144 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20145 name selects the 430X ISA.
20147 In addition an MCU-specific linker script is added to the linker
20148 command line.  The script's name is the name of the MCU with
20149 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20150 command line defines the C preprocessor symbol @code{__XXX__} and
20151 cause the linker to search for a script called @file{xxx.ld}.
20153 This option is also passed on to the assembler.
20155 @item -mwarn-mcu
20156 @itemx -mno-warn-mcu
20157 @opindex mwarn-mcu
20158 @opindex mno-warn-mcu
20159 This option enables or disables warnings about conflicts between the
20160 MCU name specified by the @option{-mmcu} option and the ISA set by the
20161 @option{-mcpu} option and/or the hardware multiply support set by the
20162 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20163 MCU names.  This option is on by default.
20165 @item -mcpu=
20166 @opindex mcpu=
20167 Specifies the ISA to use.  Accepted values are @samp{msp430},
20168 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20169 @option{-mmcu=} option should be used to select the ISA.
20171 @item -msim
20172 @opindex msim
20173 Link to the simulator runtime libraries and linker script.  Overrides
20174 any scripts that would be selected by the @option{-mmcu=} option.
20176 @item -mlarge
20177 @opindex mlarge
20178 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20180 @item -msmall
20181 @opindex msmall
20182 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20184 @item -mrelax
20185 @opindex mrelax
20186 This option is passed to the assembler and linker, and allows the
20187 linker to perform certain optimizations that cannot be done until
20188 the final link.
20190 @item mhwmult=
20191 @opindex mhwmult=
20192 Describes the type of hardware multiply supported by the target.
20193 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20194 for the original 16-bit-only multiply supported by early MCUs.
20195 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20196 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20197 A value of @samp{auto} can also be given.  This tells GCC to deduce
20198 the hardware multiply support based upon the MCU name provided by the
20199 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20200 the MCU name is not recognized then no hardware multiply support is
20201 assumed.  @code{auto} is the default setting.
20203 Hardware multiplies are normally performed by calling a library
20204 routine.  This saves space in the generated code.  When compiling at
20205 @option{-O3} or higher however the hardware multiplier is invoked
20206 inline.  This makes for bigger, but faster code.
20208 The hardware multiply routines disable interrupts whilst running and
20209 restore the previous interrupt state when they finish.  This makes
20210 them safe to use inside interrupt handlers as well as in normal code.
20212 @item -minrt
20213 @opindex minrt
20214 Enable the use of a minimum runtime environment - no static
20215 initializers or constructors.  This is intended for memory-constrained
20216 devices.  The compiler includes special symbols in some objects
20217 that tell the linker and runtime which code fragments are required.
20219 @item -mcode-region=
20220 @itemx -mdata-region=
20221 @opindex mcode-region
20222 @opindex mdata-region
20223 These options tell the compiler where to place functions and data that
20224 do not have one of the @code{lower}, @code{upper}, @code{either} or
20225 @code{section} attributes.  Possible values are @code{lower},
20226 @code{upper}, @code{either} or @code{any}.  The first three behave
20227 like the corresponding attribute.  The fourth possible value -
20228 @code{any} - is the default.  It leaves placement entirely up to the
20229 linker script and how it assigns the standard sections
20230 (@code{.text}, @code{.data}, etc) to the memory regions.
20232 @item -msilicon-errata=
20233 @opindex msilicon-errata
20234 This option passes on a request to assembler to enable the fixes for
20235 the named silicon errata.
20237 @item -msilicon-errata-warn=
20238 @opindex msilicon-errata-warn
20239 This option passes on a request to the assembler to enable warning
20240 messages when a silicon errata might need to be applied.
20242 @end table
20244 @node NDS32 Options
20245 @subsection NDS32 Options
20246 @cindex NDS32 Options
20248 These options are defined for NDS32 implementations:
20250 @table @gcctabopt
20252 @item -mbig-endian
20253 @opindex mbig-endian
20254 Generate code in big-endian mode.
20256 @item -mlittle-endian
20257 @opindex mlittle-endian
20258 Generate code in little-endian mode.
20260 @item -mreduced-regs
20261 @opindex mreduced-regs
20262 Use reduced-set registers for register allocation.
20264 @item -mfull-regs
20265 @opindex mfull-regs
20266 Use full-set registers for register allocation.
20268 @item -mcmov
20269 @opindex mcmov
20270 Generate conditional move instructions.
20272 @item -mno-cmov
20273 @opindex mno-cmov
20274 Do not generate conditional move instructions.
20276 @item -mperf-ext
20277 @opindex mperf-ext
20278 Generate performance extension instructions.
20280 @item -mno-perf-ext
20281 @opindex mno-perf-ext
20282 Do not generate performance extension instructions.
20284 @item -mv3push
20285 @opindex mv3push
20286 Generate v3 push25/pop25 instructions.
20288 @item -mno-v3push
20289 @opindex mno-v3push
20290 Do not generate v3 push25/pop25 instructions.
20292 @item -m16-bit
20293 @opindex m16-bit
20294 Generate 16-bit instructions.
20296 @item -mno-16-bit
20297 @opindex mno-16-bit
20298 Do not generate 16-bit instructions.
20300 @item -misr-vector-size=@var{num}
20301 @opindex misr-vector-size
20302 Specify the size of each interrupt vector, which must be 4 or 16.
20304 @item -mcache-block-size=@var{num}
20305 @opindex mcache-block-size
20306 Specify the size of each cache block,
20307 which must be a power of 2 between 4 and 512.
20309 @item -march=@var{arch}
20310 @opindex march
20311 Specify the name of the target architecture.
20313 @item -mcmodel=@var{code-model}
20314 @opindex mcmodel
20315 Set the code model to one of
20316 @table @asis
20317 @item @samp{small}
20318 All the data and read-only data segments must be within 512KB addressing space.
20319 The text segment must be within 16MB addressing space.
20320 @item @samp{medium}
20321 The data segment must be within 512KB while the read-only data segment can be
20322 within 4GB addressing space.  The text segment should be still within 16MB
20323 addressing space.
20324 @item @samp{large}
20325 All the text and data segments can be within 4GB addressing space.
20326 @end table
20328 @item -mctor-dtor
20329 @opindex mctor-dtor
20330 Enable constructor/destructor feature.
20332 @item -mrelax
20333 @opindex mrelax
20334 Guide linker to relax instructions.
20336 @end table
20338 @node Nios II Options
20339 @subsection Nios II Options
20340 @cindex Nios II options
20341 @cindex Altera Nios II options
20343 These are the options defined for the Altera Nios II processor.
20345 @table @gcctabopt
20347 @item -G @var{num}
20348 @opindex G
20349 @cindex smaller data references
20350 Put global and static objects less than or equal to @var{num} bytes
20351 into the small data or BSS sections instead of the normal data or BSS
20352 sections.  The default value of @var{num} is 8.
20354 @item -mgpopt=@var{option}
20355 @item -mgpopt
20356 @itemx -mno-gpopt
20357 @opindex mgpopt
20358 @opindex mno-gpopt
20359 Generate (do not generate) GP-relative accesses.  The following 
20360 @var{option} names are recognized:
20362 @table @samp
20364 @item none
20365 Do not generate GP-relative accesses.
20367 @item local
20368 Generate GP-relative accesses for small data objects that are not 
20369 external, weak, or uninitialized common symbols.  
20370 Also use GP-relative addressing for objects that
20371 have been explicitly placed in a small data section via a @code{section}
20372 attribute.
20374 @item global
20375 As for @samp{local}, but also generate GP-relative accesses for
20376 small data objects that are external, weak, or common.  If you use this option,
20377 you must ensure that all parts of your program (including libraries) are
20378 compiled with the same @option{-G} setting.
20380 @item data
20381 Generate GP-relative accesses for all data objects in the program.  If you
20382 use this option, the entire data and BSS segments
20383 of your program must fit in 64K of memory and you must use an appropriate
20384 linker script to allocate them within the addressable range of the
20385 global pointer.
20387 @item all
20388 Generate GP-relative addresses for function pointers as well as data
20389 pointers.  If you use this option, the entire text, data, and BSS segments
20390 of your program must fit in 64K of memory and you must use an appropriate
20391 linker script to allocate them within the addressable range of the
20392 global pointer.
20394 @end table
20396 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20397 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20399 The default is @option{-mgpopt} except when @option{-fpic} or
20400 @option{-fPIC} is specified to generate position-independent code.
20401 Note that the Nios II ABI does not permit GP-relative accesses from
20402 shared libraries.
20404 You may need to specify @option{-mno-gpopt} explicitly when building
20405 programs that include large amounts of small data, including large
20406 GOT data sections.  In this case, the 16-bit offset for GP-relative
20407 addressing may not be large enough to allow access to the entire 
20408 small data section.
20410 @item -mel
20411 @itemx -meb
20412 @opindex mel
20413 @opindex meb
20414 Generate little-endian (default) or big-endian (experimental) code,
20415 respectively.
20417 @item -march=@var{arch}
20418 @opindex march
20419 This specifies the name of the target Nios II architecture.  GCC uses this
20420 name to determine what kind of instructions it can emit when generating
20421 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20423 The preprocessor macro @code{__nios2_arch__} is available to programs,
20424 with value 1 or 2, indicating the targeted ISA level.
20426 @item -mbypass-cache
20427 @itemx -mno-bypass-cache
20428 @opindex mno-bypass-cache
20429 @opindex mbypass-cache
20430 Force all load and store instructions to always bypass cache by 
20431 using I/O variants of the instructions. The default is not to
20432 bypass the cache.
20434 @item -mno-cache-volatile 
20435 @itemx -mcache-volatile       
20436 @opindex mcache-volatile 
20437 @opindex mno-cache-volatile
20438 Volatile memory access bypass the cache using the I/O variants of 
20439 the load and store instructions. The default is not to bypass the cache.
20441 @item -mno-fast-sw-div
20442 @itemx -mfast-sw-div
20443 @opindex mno-fast-sw-div
20444 @opindex mfast-sw-div
20445 Do not use table-based fast divide for small numbers. The default 
20446 is to use the fast divide at @option{-O3} and above.
20448 @item -mno-hw-mul
20449 @itemx -mhw-mul
20450 @itemx -mno-hw-mulx
20451 @itemx -mhw-mulx
20452 @itemx -mno-hw-div
20453 @itemx -mhw-div
20454 @opindex mno-hw-mul
20455 @opindex mhw-mul
20456 @opindex mno-hw-mulx
20457 @opindex mhw-mulx
20458 @opindex mno-hw-div
20459 @opindex mhw-div
20460 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20461 instructions by the compiler. The default is to emit @code{mul}
20462 and not emit @code{div} and @code{mulx}.
20464 @item -mbmx
20465 @itemx -mno-bmx
20466 @itemx -mcdx
20467 @itemx -mno-cdx
20468 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20469 CDX (code density) instructions.  Enabling these instructions also
20470 requires @option{-march=r2}.  Since these instructions are optional
20471 extensions to the R2 architecture, the default is not to emit them.
20473 @item -mcustom-@var{insn}=@var{N}
20474 @itemx -mno-custom-@var{insn}
20475 @opindex mcustom-@var{insn}
20476 @opindex mno-custom-@var{insn}
20477 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20478 custom instruction with encoding @var{N} when generating code that uses 
20479 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20480 instruction 253 for single-precision floating-point add operations instead
20481 of the default behavior of using a library call.
20483 The following values of @var{insn} are supported.  Except as otherwise
20484 noted, floating-point operations are expected to be implemented with
20485 normal IEEE 754 semantics and correspond directly to the C operators or the
20486 equivalent GCC built-in functions (@pxref{Other Builtins}).
20488 Single-precision floating point:
20489 @table @asis
20491 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20492 Binary arithmetic operations.
20494 @item @samp{fnegs}
20495 Unary negation.
20497 @item @samp{fabss}
20498 Unary absolute value.
20500 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20501 Comparison operations.
20503 @item @samp{fmins}, @samp{fmaxs}
20504 Floating-point minimum and maximum.  These instructions are only
20505 generated if @option{-ffinite-math-only} is specified.
20507 @item @samp{fsqrts}
20508 Unary square root operation.
20510 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20511 Floating-point trigonometric and exponential functions.  These instructions
20512 are only generated if @option{-funsafe-math-optimizations} is also specified.
20514 @end table
20516 Double-precision floating point:
20517 @table @asis
20519 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20520 Binary arithmetic operations.
20522 @item @samp{fnegd}
20523 Unary negation.
20525 @item @samp{fabsd}
20526 Unary absolute value.
20528 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20529 Comparison operations.
20531 @item @samp{fmind}, @samp{fmaxd}
20532 Double-precision minimum and maximum.  These instructions are only
20533 generated if @option{-ffinite-math-only} is specified.
20535 @item @samp{fsqrtd}
20536 Unary square root operation.
20538 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20539 Double-precision trigonometric and exponential functions.  These instructions
20540 are only generated if @option{-funsafe-math-optimizations} is also specified.
20542 @end table
20544 Conversions:
20545 @table @asis
20546 @item @samp{fextsd}
20547 Conversion from single precision to double precision.
20549 @item @samp{ftruncds}
20550 Conversion from double precision to single precision.
20552 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20553 Conversion from floating point to signed or unsigned integer types, with
20554 truncation towards zero.
20556 @item @samp{round}
20557 Conversion from single-precision floating point to signed integer,
20558 rounding to the nearest integer and ties away from zero.
20559 This corresponds to the @code{__builtin_lroundf} function when
20560 @option{-fno-math-errno} is used.
20562 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20563 Conversion from signed or unsigned integer types to floating-point types.
20565 @end table
20567 In addition, all of the following transfer instructions for internal
20568 registers X and Y must be provided to use any of the double-precision
20569 floating-point instructions.  Custom instructions taking two
20570 double-precision source operands expect the first operand in the
20571 64-bit register X.  The other operand (or only operand of a unary
20572 operation) is given to the custom arithmetic instruction with the
20573 least significant half in source register @var{src1} and the most
20574 significant half in @var{src2}.  A custom instruction that returns a
20575 double-precision result returns the most significant 32 bits in the
20576 destination register and the other half in 32-bit register Y.  
20577 GCC automatically generates the necessary code sequences to write
20578 register X and/or read register Y when double-precision floating-point
20579 instructions are used.
20581 @table @asis
20583 @item @samp{fwrx}
20584 Write @var{src1} into the least significant half of X and @var{src2} into
20585 the most significant half of X.
20587 @item @samp{fwry}
20588 Write @var{src1} into Y.
20590 @item @samp{frdxhi}, @samp{frdxlo}
20591 Read the most or least (respectively) significant half of X and store it in
20592 @var{dest}.
20594 @item @samp{frdy}
20595 Read the value of Y and store it into @var{dest}.
20596 @end table
20598 Note that you can gain more local control over generation of Nios II custom
20599 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
20600 and @code{target("no-custom-@var{insn}")} function attributes
20601 (@pxref{Function Attributes})
20602 or pragmas (@pxref{Function Specific Option Pragmas}).
20604 @item -mcustom-fpu-cfg=@var{name}
20605 @opindex mcustom-fpu-cfg
20607 This option enables a predefined, named set of custom instruction encodings
20608 (see @option{-mcustom-@var{insn}} above).  
20609 Currently, the following sets are defined:
20611 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
20612 @gccoptlist{-mcustom-fmuls=252 @gol
20613 -mcustom-fadds=253 @gol
20614 -mcustom-fsubs=254 @gol
20615 -fsingle-precision-constant}
20617 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
20618 @gccoptlist{-mcustom-fmuls=252 @gol
20619 -mcustom-fadds=253 @gol
20620 -mcustom-fsubs=254 @gol
20621 -mcustom-fdivs=255 @gol
20622 -fsingle-precision-constant}
20624 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
20625 @gccoptlist{-mcustom-floatus=243 @gol
20626 -mcustom-fixsi=244 @gol
20627 -mcustom-floatis=245 @gol
20628 -mcustom-fcmpgts=246 @gol
20629 -mcustom-fcmples=249 @gol
20630 -mcustom-fcmpeqs=250 @gol
20631 -mcustom-fcmpnes=251 @gol
20632 -mcustom-fmuls=252 @gol
20633 -mcustom-fadds=253 @gol
20634 -mcustom-fsubs=254 @gol
20635 -mcustom-fdivs=255 @gol
20636 -fsingle-precision-constant}
20638 Custom instruction assignments given by individual
20639 @option{-mcustom-@var{insn}=} options override those given by
20640 @option{-mcustom-fpu-cfg=}, regardless of the
20641 order of the options on the command line.
20643 Note that you can gain more local control over selection of a FPU
20644 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
20645 function attribute (@pxref{Function Attributes})
20646 or pragma (@pxref{Function Specific Option Pragmas}).
20648 @end table
20650 These additional @samp{-m} options are available for the Altera Nios II
20651 ELF (bare-metal) target:
20653 @table @gcctabopt
20655 @item -mhal
20656 @opindex mhal
20657 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
20658 startup and termination code, and is typically used in conjunction with
20659 @option{-msys-crt0=} to specify the location of the alternate startup code
20660 provided by the HAL BSP.
20662 @item -msmallc
20663 @opindex msmallc
20664 Link with a limited version of the C library, @option{-lsmallc}, rather than
20665 Newlib.
20667 @item -msys-crt0=@var{startfile}
20668 @opindex msys-crt0
20669 @var{startfile} is the file name of the startfile (crt0) to use 
20670 when linking.  This option is only useful in conjunction with @option{-mhal}.
20672 @item -msys-lib=@var{systemlib}
20673 @opindex msys-lib
20674 @var{systemlib} is the library name of the library that provides
20675 low-level system calls required by the C library,
20676 e.g. @code{read} and @code{write}.
20677 This option is typically used to link with a library provided by a HAL BSP.
20679 @end table
20681 @node Nvidia PTX Options
20682 @subsection Nvidia PTX Options
20683 @cindex Nvidia PTX options
20684 @cindex nvptx options
20686 These options are defined for Nvidia PTX:
20688 @table @gcctabopt
20690 @item -m32
20691 @itemx -m64
20692 @opindex m32
20693 @opindex m64
20694 Generate code for 32-bit or 64-bit ABI.
20696 @item -mmainkernel
20697 @opindex mmainkernel
20698 Link in code for a __main kernel.  This is for stand-alone instead of
20699 offloading execution.
20701 @item -moptimize
20702 @opindex moptimize
20703 Apply partitioned execution optimizations.  This is the default when any
20704 level of optimization is selected.
20706 @item -msoft-stack
20707 @opindex msoft-stack
20708 Generate code that does not use @code{.local} memory
20709 directly for stack storage. Instead, a per-warp stack pointer is
20710 maintained explicitly. This enables variable-length stack allocation (with
20711 variable-length arrays or @code{alloca}), and when global memory is used for
20712 underlying storage, makes it possible to access automatic variables from other
20713 threads, or with atomic instructions. This code generation variant is used
20714 for OpenMP offloading, but the option is exposed on its own for the purpose
20715 of testing the compiler; to generate code suitable for linking into programs
20716 using OpenMP offloading, use option @option{-mgomp}.
20718 @item -muniform-simt
20719 @opindex muniform-simt
20720 Switch to code generation variant that allows to execute all threads in each
20721 warp, while maintaining memory state and side effects as if only one thread
20722 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
20723 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
20724 current lane index equals the master lane index), and the register being
20725 assigned is copied via a shuffle instruction from the master lane.  Outside of
20726 SIMD regions lane 0 is the master; inside, each thread sees itself as the
20727 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
20728 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
20729 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
20730 with current lane index to compute the master lane index.
20732 @item -mgomp
20733 @opindex mgomp
20734 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
20735 @option{-muniform-simt} options, and selects corresponding multilib variant.
20737 @end table
20739 @node PDP-11 Options
20740 @subsection PDP-11 Options
20741 @cindex PDP-11 Options
20743 These options are defined for the PDP-11:
20745 @table @gcctabopt
20746 @item -mfpu
20747 @opindex mfpu
20748 Use hardware FPP floating point.  This is the default.  (FIS floating
20749 point on the PDP-11/40 is not supported.)
20751 @item -msoft-float
20752 @opindex msoft-float
20753 Do not use hardware floating point.
20755 @item -mac0
20756 @opindex mac0
20757 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
20759 @item -mno-ac0
20760 @opindex mno-ac0
20761 Return floating-point results in memory.  This is the default.
20763 @item -m40
20764 @opindex m40
20765 Generate code for a PDP-11/40.
20767 @item -m45
20768 @opindex m45
20769 Generate code for a PDP-11/45.  This is the default.
20771 @item -m10
20772 @opindex m10
20773 Generate code for a PDP-11/10.
20775 @item -mbcopy-builtin
20776 @opindex mbcopy-builtin
20777 Use inline @code{movmemhi} patterns for copying memory.  This is the
20778 default.
20780 @item -mbcopy
20781 @opindex mbcopy
20782 Do not use inline @code{movmemhi} patterns for copying memory.
20784 @item -mint16
20785 @itemx -mno-int32
20786 @opindex mint16
20787 @opindex mno-int32
20788 Use 16-bit @code{int}.  This is the default.
20790 @item -mint32
20791 @itemx -mno-int16
20792 @opindex mint32
20793 @opindex mno-int16
20794 Use 32-bit @code{int}.
20796 @item -mfloat64
20797 @itemx -mno-float32
20798 @opindex mfloat64
20799 @opindex mno-float32
20800 Use 64-bit @code{float}.  This is the default.
20802 @item -mfloat32
20803 @itemx -mno-float64
20804 @opindex mfloat32
20805 @opindex mno-float64
20806 Use 32-bit @code{float}.
20808 @item -mabshi
20809 @opindex mabshi
20810 Use @code{abshi2} pattern.  This is the default.
20812 @item -mno-abshi
20813 @opindex mno-abshi
20814 Do not use @code{abshi2} pattern.
20816 @item -mbranch-expensive
20817 @opindex mbranch-expensive
20818 Pretend that branches are expensive.  This is for experimenting with
20819 code generation only.
20821 @item -mbranch-cheap
20822 @opindex mbranch-cheap
20823 Do not pretend that branches are expensive.  This is the default.
20825 @item -munix-asm
20826 @opindex munix-asm
20827 Use Unix assembler syntax.  This is the default when configured for
20828 @samp{pdp11-*-bsd}.
20830 @item -mdec-asm
20831 @opindex mdec-asm
20832 Use DEC assembler syntax.  This is the default when configured for any
20833 PDP-11 target other than @samp{pdp11-*-bsd}.
20834 @end table
20836 @node picoChip Options
20837 @subsection picoChip Options
20838 @cindex picoChip options
20840 These @samp{-m} options are defined for picoChip implementations:
20842 @table @gcctabopt
20844 @item -mae=@var{ae_type}
20845 @opindex mcpu
20846 Set the instruction set, register set, and instruction scheduling
20847 parameters for array element type @var{ae_type}.  Supported values
20848 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
20850 @option{-mae=ANY} selects a completely generic AE type.  Code
20851 generated with this option runs on any of the other AE types.  The
20852 code is not as efficient as it would be if compiled for a specific
20853 AE type, and some types of operation (e.g., multiplication) do not
20854 work properly on all types of AE.
20856 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
20857 for compiled code, and is the default.
20859 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
20860 option may suffer from poor performance of byte (char) manipulation,
20861 since the DSP AE does not provide hardware support for byte load/stores.
20863 @item -msymbol-as-address
20864 Enable the compiler to directly use a symbol name as an address in a
20865 load/store instruction, without first loading it into a
20866 register.  Typically, the use of this option generates larger
20867 programs, which run faster than when the option isn't used.  However, the
20868 results vary from program to program, so it is left as a user option,
20869 rather than being permanently enabled.
20871 @item -mno-inefficient-warnings
20872 Disables warnings about the generation of inefficient code.  These
20873 warnings can be generated, for example, when compiling code that
20874 performs byte-level memory operations on the MAC AE type.  The MAC AE has
20875 no hardware support for byte-level memory operations, so all byte
20876 load/stores must be synthesized from word load/store operations.  This is
20877 inefficient and a warning is generated to indicate
20878 that you should rewrite the code to avoid byte operations, or to target
20879 an AE type that has the necessary hardware support.  This option disables
20880 these warnings.
20882 @end table
20884 @node PowerPC Options
20885 @subsection PowerPC Options
20886 @cindex PowerPC options
20888 These are listed under @xref{RS/6000 and PowerPC Options}.
20890 @node RISC-V Options
20891 @subsection RISC-V Options
20892 @cindex RISC-V Options
20894 These command-line options are defined for RISC-V targets:
20896 @table @gcctabopt
20897 @item -mbranch-cost=@var{n}
20898 @opindex mbranch-cost
20899 Set the cost of branches to roughly @var{n} instructions.
20901 @item -mmemcpy
20902 @itemx -mno-memcpy
20903 @opindex mmemcpy
20904 Don't optimize block moves.
20906 @item -mplt
20907 @itemx -mno-plt
20908 @opindex plt
20909 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
20911 @item -mabi=@var{ABI-string}
20912 @opindex mabi
20913 Specify integer and floating-point calling convention.  This defaults to the
20914 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
20915 RV64G.
20917 @item -mfdiv
20918 @itemx -mno-fdiv
20919 @opindex mfdiv
20920 Use hardware floating-point divide and square root instructions.  This requires
20921 the F or D extensions for floating-point registers.
20923 @item -mdiv
20924 @itemx -mno-div
20925 @opindex mdiv
20926 Use hardware instructions for integer division.  This requires the M extension.
20928 @item -march=@var{ISA-string}
20929 @opindex march
20930 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
20931 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
20933 @item -mtune=@var{processor-string}
20934 @opindex mtune
20935 Optimize the output for the given processor, specified by microarchitecture
20936 name.
20938 @item -msmall-data-limit=@var{n}
20939 @opindex msmall-data-limit
20940 Put global and static data smaller than @var{n} bytes into a special section
20941 (on some targets).
20943 @item -msave-restore
20944 @itemx -mno-save-restore
20945 @opindex msave-restore
20946 Use smaller but slower prologue and epilogue code.
20948 @item -mcmodel=@var{code-model}
20949 @opindex mcmodel
20950 Specify the code model.
20952 @end table
20954 @node RL78 Options
20955 @subsection RL78 Options
20956 @cindex RL78 Options
20958 @table @gcctabopt
20960 @item -msim
20961 @opindex msim
20962 Links in additional target libraries to support operation within a
20963 simulator.
20965 @item -mmul=none
20966 @itemx -mmul=g10
20967 @itemx -mmul=g13
20968 @itemx -mmul=g14
20969 @itemx -mmul=rl78
20970 @opindex mmul
20971 Specifies the type of hardware multiplication and division support to
20972 be used.  The simplest is @code{none}, which uses software for both
20973 multiplication and division.  This is the default.  The @code{g13}
20974 value is for the hardware multiply/divide peripheral found on the
20975 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
20976 the multiplication and division instructions supported by the RL78/G14
20977 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
20978 the value @code{mg10} is an alias for @code{none}.
20980 In addition a C preprocessor macro is defined, based upon the setting
20981 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
20982 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
20984 @item -mcpu=g10
20985 @itemx -mcpu=g13
20986 @itemx -mcpu=g14
20987 @itemx -mcpu=rl78
20988 @opindex mcpu
20989 Specifies the RL78 core to target.  The default is the G14 core, also
20990 known as an S3 core or just RL78.  The G13 or S2 core does not have
20991 multiply or divide instructions, instead it uses a hardware peripheral
20992 for these operations.  The G10 or S1 core does not have register
20993 banks, so it uses a different calling convention.
20995 If this option is set it also selects the type of hardware multiply
20996 support to use, unless this is overridden by an explicit
20997 @option{-mmul=none} option on the command line.  Thus specifying
20998 @option{-mcpu=g13} enables the use of the G13 hardware multiply
20999 peripheral and specifying @option{-mcpu=g10} disables the use of
21000 hardware multiplications altogether.
21002 Note, although the RL78/G14 core is the default target, specifying
21003 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21004 change the behavior of the toolchain since it also enables G14
21005 hardware multiply support.  If these options are not specified on the
21006 command line then software multiplication routines will be used even
21007 though the code targets the RL78 core.  This is for backwards
21008 compatibility with older toolchains which did not have hardware
21009 multiply and divide support.
21011 In addition a C preprocessor macro is defined, based upon the setting
21012 of this option.  Possible values are: @code{__RL78_G10__},
21013 @code{__RL78_G13__} or @code{__RL78_G14__}.
21015 @item -mg10
21016 @itemx -mg13
21017 @itemx -mg14
21018 @itemx -mrl78
21019 @opindex mg10
21020 @opindex mg13
21021 @opindex mg14
21022 @opindex mrl78
21023 These are aliases for the corresponding @option{-mcpu=} option.  They
21024 are provided for backwards compatibility.
21026 @item -mallregs
21027 @opindex mallregs
21028 Allow the compiler to use all of the available registers.  By default
21029 registers @code{r24..r31} are reserved for use in interrupt handlers.
21030 With this option enabled these registers can be used in ordinary
21031 functions as well.
21033 @item -m64bit-doubles
21034 @itemx -m32bit-doubles
21035 @opindex m64bit-doubles
21036 @opindex m32bit-doubles
21037 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21038 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21039 @option{-m32bit-doubles}.
21041 @item -msave-mduc-in-interrupts
21042 @item -mno-save-mduc-in-interrupts
21043 @opindex msave-mduc-in-interrupts
21044 @opindex mno-save-mduc-in-interrupts
21045 Specifies that interrupt handler functions should preserve the
21046 MDUC registers.  This is only necessary if normal code might use
21047 the MDUC registers, for example because it performs multiplication
21048 and division operations.  The default is to ignore the MDUC registers
21049 as this makes the interrupt handlers faster.  The target option -mg13
21050 needs to be passed for this to work as this feature is only available
21051 on the G13 target (S2 core).  The MDUC registers will only be saved
21052 if the interrupt handler performs a multiplication or division
21053 operation or it calls another function.
21055 @end table
21057 @node RS/6000 and PowerPC Options
21058 @subsection IBM RS/6000 and PowerPC Options
21059 @cindex RS/6000 and PowerPC Options
21060 @cindex IBM RS/6000 and PowerPC Options
21062 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21063 @table @gcctabopt
21064 @item -mpowerpc-gpopt
21065 @itemx -mno-powerpc-gpopt
21066 @itemx -mpowerpc-gfxopt
21067 @itemx -mno-powerpc-gfxopt
21068 @need 800
21069 @itemx -mpowerpc64
21070 @itemx -mno-powerpc64
21071 @itemx -mmfcrf
21072 @itemx -mno-mfcrf
21073 @itemx -mpopcntb
21074 @itemx -mno-popcntb
21075 @itemx -mpopcntd
21076 @itemx -mno-popcntd
21077 @itemx -mfprnd
21078 @itemx -mno-fprnd
21079 @need 800
21080 @itemx -mcmpb
21081 @itemx -mno-cmpb
21082 @itemx -mmfpgpr
21083 @itemx -mno-mfpgpr
21084 @itemx -mhard-dfp
21085 @itemx -mno-hard-dfp
21086 @opindex mpowerpc-gpopt
21087 @opindex mno-powerpc-gpopt
21088 @opindex mpowerpc-gfxopt
21089 @opindex mno-powerpc-gfxopt
21090 @opindex mpowerpc64
21091 @opindex mno-powerpc64
21092 @opindex mmfcrf
21093 @opindex mno-mfcrf
21094 @opindex mpopcntb
21095 @opindex mno-popcntb
21096 @opindex mpopcntd
21097 @opindex mno-popcntd
21098 @opindex mfprnd
21099 @opindex mno-fprnd
21100 @opindex mcmpb
21101 @opindex mno-cmpb
21102 @opindex mmfpgpr
21103 @opindex mno-mfpgpr
21104 @opindex mhard-dfp
21105 @opindex mno-hard-dfp
21106 You use these options to specify which instructions are available on the
21107 processor you are using.  The default value of these options is
21108 determined when configuring GCC@.  Specifying the
21109 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21110 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21111 rather than the options listed above.
21113 Specifying @option{-mpowerpc-gpopt} allows
21114 GCC to use the optional PowerPC architecture instructions in the
21115 General Purpose group, including floating-point square root.  Specifying
21116 @option{-mpowerpc-gfxopt} allows GCC to
21117 use the optional PowerPC architecture instructions in the Graphics
21118 group, including floating-point select.
21120 The @option{-mmfcrf} option allows GCC to generate the move from
21121 condition register field instruction implemented on the POWER4
21122 processor and other processors that support the PowerPC V2.01
21123 architecture.
21124 The @option{-mpopcntb} option allows GCC to generate the popcount and
21125 double-precision FP reciprocal estimate instruction implemented on the
21126 POWER5 processor and other processors that support the PowerPC V2.02
21127 architecture.
21128 The @option{-mpopcntd} option allows GCC to generate the popcount
21129 instruction implemented on the POWER7 processor and other processors
21130 that support the PowerPC V2.06 architecture.
21131 The @option{-mfprnd} option allows GCC to generate the FP round to
21132 integer instructions implemented on the POWER5+ processor and other
21133 processors that support the PowerPC V2.03 architecture.
21134 The @option{-mcmpb} option allows GCC to generate the compare bytes
21135 instruction implemented on the POWER6 processor and other processors
21136 that support the PowerPC V2.05 architecture.
21137 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21138 general-purpose register instructions implemented on the POWER6X
21139 processor and other processors that support the extended PowerPC V2.05
21140 architecture.
21141 The @option{-mhard-dfp} option allows GCC to generate the decimal
21142 floating-point instructions implemented on some POWER processors.
21144 The @option{-mpowerpc64} option allows GCC to generate the additional
21145 64-bit instructions that are found in the full PowerPC64 architecture
21146 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21147 @option{-mno-powerpc64}.
21149 @item -mcpu=@var{cpu_type}
21150 @opindex mcpu
21151 Set architecture type, register usage, and
21152 instruction scheduling parameters for machine type @var{cpu_type}.
21153 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21154 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21155 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21156 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21157 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21158 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21159 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21160 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21161 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21162 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21163 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21164 and @samp{rs64}.
21166 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21167 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21168 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21169 architecture machine types, with an appropriate, generic processor
21170 model assumed for scheduling purposes.
21172 The other options specify a specific processor.  Code generated under
21173 those options runs best on that processor, and may not run at all on
21174 others.
21176 The @option{-mcpu} options automatically enable or disable the
21177 following options:
21179 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21180 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21181 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21182 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21183 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21184 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21186 The particular options set for any particular CPU varies between
21187 compiler versions, depending on what setting seems to produce optimal
21188 code for that CPU; it doesn't necessarily reflect the actual hardware's
21189 capabilities.  If you wish to set an individual option to a particular
21190 value, you may specify it after the @option{-mcpu} option, like
21191 @option{-mcpu=970 -mno-altivec}.
21193 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21194 not enabled or disabled by the @option{-mcpu} option at present because
21195 AIX does not have full support for these options.  You may still
21196 enable or disable them individually if you're sure it'll work in your
21197 environment.
21199 @item -mtune=@var{cpu_type}
21200 @opindex mtune
21201 Set the instruction scheduling parameters for machine type
21202 @var{cpu_type}, but do not set the architecture type or register usage,
21203 as @option{-mcpu=@var{cpu_type}} does.  The same
21204 values for @var{cpu_type} are used for @option{-mtune} as for
21205 @option{-mcpu}.  If both are specified, the code generated uses the
21206 architecture and registers set by @option{-mcpu}, but the
21207 scheduling parameters set by @option{-mtune}.
21209 @item -mcmodel=small
21210 @opindex mcmodel=small
21211 Generate PowerPC64 code for the small model: The TOC is limited to
21212 64k.
21214 @item -mcmodel=medium
21215 @opindex mcmodel=medium
21216 Generate PowerPC64 code for the medium model: The TOC and other static
21217 data may be up to a total of 4G in size.  This is the default for 64-bit
21218 Linux.
21220 @item -mcmodel=large
21221 @opindex mcmodel=large
21222 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21223 in size.  Other data and code is only limited by the 64-bit address
21224 space.
21226 @item -maltivec
21227 @itemx -mno-altivec
21228 @opindex maltivec
21229 @opindex mno-altivec
21230 Generate code that uses (does not use) AltiVec instructions, and also
21231 enable the use of built-in functions that allow more direct access to
21232 the AltiVec instruction set.  You may also need to set
21233 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21234 enhancements.
21236 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21237 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21238 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21239 match array element order corresponding to the endianness of the
21240 target.  That is, element zero identifies the leftmost element in a
21241 vector register when targeting a big-endian platform, and identifies
21242 the rightmost element in a vector register when targeting a
21243 little-endian platform.
21245 @item -maltivec=be
21246 @opindex maltivec=be
21247 Generate AltiVec instructions using big-endian element order,
21248 regardless of whether the target is big- or little-endian.  This is
21249 the default when targeting a big-endian platform.
21251 The element order is used to interpret element numbers in AltiVec
21252 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21253 @code{vec_insert}.  By default, these match array element order
21254 corresponding to the endianness for the target.
21256 @item -maltivec=le
21257 @opindex maltivec=le
21258 Generate AltiVec instructions using little-endian element order,
21259 regardless of whether the target is big- or little-endian.  This is
21260 the default when targeting a little-endian platform.  This option is
21261 currently ignored when targeting a big-endian platform.
21263 The element order is used to interpret element numbers in AltiVec
21264 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21265 @code{vec_insert}.  By default, these match array element order
21266 corresponding to the endianness for the target.
21268 @item -mvrsave
21269 @itemx -mno-vrsave
21270 @opindex mvrsave
21271 @opindex mno-vrsave
21272 Generate VRSAVE instructions when generating AltiVec code.
21274 @item -mgen-cell-microcode
21275 @opindex mgen-cell-microcode
21276 Generate Cell microcode instructions.
21278 @item -mwarn-cell-microcode
21279 @opindex mwarn-cell-microcode
21280 Warn when a Cell microcode instruction is emitted.  An example
21281 of a Cell microcode instruction is a variable shift.
21283 @item -msecure-plt
21284 @opindex msecure-plt
21285 Generate code that allows @command{ld} and @command{ld.so}
21286 to build executables and shared
21287 libraries with non-executable @code{.plt} and @code{.got} sections.
21288 This is a PowerPC
21289 32-bit SYSV ABI option.
21291 @item -mbss-plt
21292 @opindex mbss-plt
21293 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21294 fills in, and
21295 requires @code{.plt} and @code{.got}
21296 sections that are both writable and executable.
21297 This is a PowerPC 32-bit SYSV ABI option.
21299 @item -misel
21300 @itemx -mno-isel
21301 @opindex misel
21302 @opindex mno-isel
21303 This switch enables or disables the generation of ISEL instructions.
21305 @item -misel=@var{yes/no}
21306 This switch has been deprecated.  Use @option{-misel} and
21307 @option{-mno-isel} instead.
21309 @item -mlra
21310 @opindex mlra
21311 Enable Local Register Allocation. By default the port uses LRA.
21312 (i.e. @option{-mno-lra}).
21314 @item -mspe
21315 @itemx -mno-spe
21316 @opindex mspe
21317 @opindex mno-spe
21318 This switch enables or disables the generation of SPE simd
21319 instructions.
21321 @item -mpaired
21322 @itemx -mno-paired
21323 @opindex mpaired
21324 @opindex mno-paired
21325 This switch enables or disables the generation of PAIRED simd
21326 instructions.
21328 @item -mspe=@var{yes/no}
21329 This option has been deprecated.  Use @option{-mspe} and
21330 @option{-mno-spe} instead.
21332 @item -mvsx
21333 @itemx -mno-vsx
21334 @opindex mvsx
21335 @opindex mno-vsx
21336 Generate code that uses (does not use) vector/scalar (VSX)
21337 instructions, and also enable the use of built-in functions that allow
21338 more direct access to the VSX instruction set.
21340 @item -mcrypto
21341 @itemx -mno-crypto
21342 @opindex mcrypto
21343 @opindex mno-crypto
21344 Enable the use (disable) of the built-in functions that allow direct
21345 access to the cryptographic instructions that were added in version
21346 2.07 of the PowerPC ISA.
21348 @item -mdirect-move
21349 @itemx -mno-direct-move
21350 @opindex mdirect-move
21351 @opindex mno-direct-move
21352 Generate code that uses (does not use) the instructions to move data
21353 between the general purpose registers and the vector/scalar (VSX)
21354 registers that were added in version 2.07 of the PowerPC ISA.
21356 @item -mhtm
21357 @itemx -mno-htm
21358 @opindex mhtm
21359 @opindex mno-htm
21360 Enable (disable) the use of the built-in functions that allow direct
21361 access to the Hardware Transactional Memory (HTM) instructions that
21362 were added in version 2.07 of the PowerPC ISA.
21364 @item -mpower8-fusion
21365 @itemx -mno-power8-fusion
21366 @opindex mpower8-fusion
21367 @opindex mno-power8-fusion
21368 Generate code that keeps (does not keeps) some integer operations
21369 adjacent so that the instructions can be fused together on power8 and
21370 later processors.
21372 @item -mpower8-vector
21373 @itemx -mno-power8-vector
21374 @opindex mpower8-vector
21375 @opindex mno-power8-vector
21376 Generate code that uses (does not use) the vector and scalar
21377 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21378 enable the use of built-in functions that allow more direct access to
21379 the vector instructions.
21381 @item -mquad-memory
21382 @itemx -mno-quad-memory
21383 @opindex mquad-memory
21384 @opindex mno-quad-memory
21385 Generate code that uses (does not use) the non-atomic quad word memory
21386 instructions.  The @option{-mquad-memory} option requires use of
21387 64-bit mode.
21389 @item -mquad-memory-atomic
21390 @itemx -mno-quad-memory-atomic
21391 @opindex mquad-memory-atomic
21392 @opindex mno-quad-memory-atomic
21393 Generate code that uses (does not use) the atomic quad word memory
21394 instructions.  The @option{-mquad-memory-atomic} option requires use of
21395 64-bit mode.
21397 @item -mupper-regs-di
21398 @itemx -mno-upper-regs-di
21399 @opindex mupper-regs-di
21400 @opindex mno-upper-regs-di
21401 Generate code that uses (does not use) the scalar instructions that
21402 target all 64 registers in the vector/scalar floating point register
21403 set that were added in version 2.06 of the PowerPC ISA when processing
21404 integers.  @option{-mupper-regs-di} is turned on by default if you use
21405 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21406 @option{-mcpu=power9}, or @option{-mvsx} options.
21408 @item -mupper-regs-df
21409 @itemx -mno-upper-regs-df
21410 @opindex mupper-regs-df
21411 @opindex mno-upper-regs-df
21412 Generate code that uses (does not use) the scalar double precision
21413 instructions that target all 64 registers in the vector/scalar
21414 floating point register set that were added in version 2.06 of the
21415 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21416 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21417 @option{-mcpu=power9}, or @option{-mvsx} options.
21419 @item -mupper-regs-sf
21420 @itemx -mno-upper-regs-sf
21421 @opindex mupper-regs-sf
21422 @opindex mno-upper-regs-sf
21423 Generate code that uses (does not use) the scalar single precision
21424 instructions that target all 64 registers in the vector/scalar
21425 floating point register set that were added in version 2.07 of the
21426 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21427 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21428 @option{-mcpu=power9} options.
21430 @item -mupper-regs
21431 @itemx -mno-upper-regs
21432 @opindex mupper-regs
21433 @opindex mno-upper-regs
21434 Generate code that uses (does not use) the scalar
21435 instructions that target all 64 registers in the vector/scalar
21436 floating point register set, depending on the model of the machine.
21438 If the @option{-mno-upper-regs} option is used, it turns off both
21439 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21441 @item -mfloat128
21442 @itemx -mno-float128
21443 @opindex mfloat128
21444 @opindex mno-float128
21445 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21446 and use either software emulation for IEEE 128-bit floating point or
21447 hardware instructions.
21449 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21450 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21451 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21452 Linux systems.
21454 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21455 @option{-mfloat128} option will also enable the generation of ISA 3.0
21456 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21457 floating point will be done with software emulation.
21459 @item -mfloat128-hardware
21460 @itemx -mno-float128-hardware
21461 @opindex mfloat128-hardware
21462 @opindex mno-float128-hardware
21463 Enable/disable using ISA 3.0 hardware instructions to support the
21464 @var{__float128} data type.
21466 If you use @option{-mfloat128-hardware}, it will enable the option
21467 @option{-mfloat128} as well.
21469 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21470 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21471 the IEEE 128-bit floating point support will not be enabled.
21473 @item -mfloat-gprs=@var{yes/single/double/no}
21474 @itemx -mfloat-gprs
21475 @opindex mfloat-gprs
21476 This switch enables or disables the generation of floating-point
21477 operations on the general-purpose registers for architectures that
21478 support it.
21480 The argument @samp{yes} or @samp{single} enables the use of
21481 single-precision floating-point operations.
21483 The argument @samp{double} enables the use of single and
21484 double-precision floating-point operations.
21486 The argument @samp{no} disables floating-point operations on the
21487 general-purpose registers.
21489 This option is currently only available on the MPC854x.
21491 @item -m32
21492 @itemx -m64
21493 @opindex m32
21494 @opindex m64
21495 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21496 targets (including GNU/Linux).  The 32-bit environment sets int, long
21497 and pointer to 32 bits and generates code that runs on any PowerPC
21498 variant.  The 64-bit environment sets int to 32 bits and long and
21499 pointer to 64 bits, and generates code for PowerPC64, as for
21500 @option{-mpowerpc64}.
21502 @item -mfull-toc
21503 @itemx -mno-fp-in-toc
21504 @itemx -mno-sum-in-toc
21505 @itemx -mminimal-toc
21506 @opindex mfull-toc
21507 @opindex mno-fp-in-toc
21508 @opindex mno-sum-in-toc
21509 @opindex mminimal-toc
21510 Modify generation of the TOC (Table Of Contents), which is created for
21511 every executable file.  The @option{-mfull-toc} option is selected by
21512 default.  In that case, GCC allocates at least one TOC entry for
21513 each unique non-automatic variable reference in your program.  GCC
21514 also places floating-point constants in the TOC@.  However, only
21515 16,384 entries are available in the TOC@.
21517 If you receive a linker error message that saying you have overflowed
21518 the available TOC space, you can reduce the amount of TOC space used
21519 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21520 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21521 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21522 generate code to calculate the sum of an address and a constant at
21523 run time instead of putting that sum into the TOC@.  You may specify one
21524 or both of these options.  Each causes GCC to produce very slightly
21525 slower and larger code at the expense of conserving TOC space.
21527 If you still run out of space in the TOC even when you specify both of
21528 these options, specify @option{-mminimal-toc} instead.  This option causes
21529 GCC to make only one TOC entry for every file.  When you specify this
21530 option, GCC produces code that is slower and larger but which
21531 uses extremely little TOC space.  You may wish to use this option
21532 only on files that contain less frequently-executed code.
21534 @item -maix64
21535 @itemx -maix32
21536 @opindex maix64
21537 @opindex maix32
21538 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21539 @code{long} type, and the infrastructure needed to support them.
21540 Specifying @option{-maix64} implies @option{-mpowerpc64},
21541 while @option{-maix32} disables the 64-bit ABI and
21542 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21544 @item -mxl-compat
21545 @itemx -mno-xl-compat
21546 @opindex mxl-compat
21547 @opindex mno-xl-compat
21548 Produce code that conforms more closely to IBM XL compiler semantics
21549 when using AIX-compatible ABI@.  Pass floating-point arguments to
21550 prototyped functions beyond the register save area (RSA) on the stack
21551 in addition to argument FPRs.  Do not assume that most significant
21552 double in 128-bit long double value is properly rounded when comparing
21553 values and converting to double.  Use XL symbol names for long double
21554 support routines.
21556 The AIX calling convention was extended but not initially documented to
21557 handle an obscure K&R C case of calling a function that takes the
21558 address of its arguments with fewer arguments than declared.  IBM XL
21559 compilers access floating-point arguments that do not fit in the
21560 RSA from the stack when a subroutine is compiled without
21561 optimization.  Because always storing floating-point arguments on the
21562 stack is inefficient and rarely needed, this option is not enabled by
21563 default and only is necessary when calling subroutines compiled by IBM
21564 XL compilers without optimization.
21566 @item -mpe
21567 @opindex mpe
21568 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21569 application written to use message passing with special startup code to
21570 enable the application to run.  The system must have PE installed in the
21571 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21572 must be overridden with the @option{-specs=} option to specify the
21573 appropriate directory location.  The Parallel Environment does not
21574 support threads, so the @option{-mpe} option and the @option{-pthread}
21575 option are incompatible.
21577 @item -malign-natural
21578 @itemx -malign-power
21579 @opindex malign-natural
21580 @opindex malign-power
21581 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
21582 @option{-malign-natural} overrides the ABI-defined alignment of larger
21583 types, such as floating-point doubles, on their natural size-based boundary.
21584 The option @option{-malign-power} instructs GCC to follow the ABI-specified
21585 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
21587 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
21588 is not supported.
21590 @item -msoft-float
21591 @itemx -mhard-float
21592 @opindex msoft-float
21593 @opindex mhard-float
21594 Generate code that does not use (uses) the floating-point register set.
21595 Software floating-point emulation is provided if you use the
21596 @option{-msoft-float} option, and pass the option to GCC when linking.
21598 @item -msingle-float
21599 @itemx -mdouble-float
21600 @opindex msingle-float
21601 @opindex mdouble-float
21602 Generate code for single- or double-precision floating-point operations.
21603 @option{-mdouble-float} implies @option{-msingle-float}.
21605 @item -msimple-fpu
21606 @opindex msimple-fpu
21607 Do not generate @code{sqrt} and @code{div} instructions for hardware
21608 floating-point unit.
21610 @item -mfpu=@var{name}
21611 @opindex mfpu
21612 Specify type of floating-point unit.  Valid values for @var{name} are
21613 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
21614 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
21615 @samp{sp_full} (equivalent to @option{-msingle-float}),
21616 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
21618 @item -mxilinx-fpu
21619 @opindex mxilinx-fpu
21620 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
21622 @item -mmultiple
21623 @itemx -mno-multiple
21624 @opindex mmultiple
21625 @opindex mno-multiple
21626 Generate code that uses (does not use) the load multiple word
21627 instructions and the store multiple word instructions.  These
21628 instructions are generated by default on POWER systems, and not
21629 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
21630 PowerPC systems, since those instructions do not work when the
21631 processor is in little-endian mode.  The exceptions are PPC740 and
21632 PPC750 which permit these instructions in little-endian mode.
21634 @item -mstring
21635 @itemx -mno-string
21636 @opindex mstring
21637 @opindex mno-string
21638 Generate code that uses (does not use) the load string instructions
21639 and the store string word instructions to save multiple registers and
21640 do small block moves.  These instructions are generated by default on
21641 POWER systems, and not generated on PowerPC systems.  Do not use
21642 @option{-mstring} on little-endian PowerPC systems, since those
21643 instructions do not work when the processor is in little-endian mode.
21644 The exceptions are PPC740 and PPC750 which permit these instructions
21645 in little-endian mode.
21647 @item -mupdate
21648 @itemx -mno-update
21649 @opindex mupdate
21650 @opindex mno-update
21651 Generate code that uses (does not use) the load or store instructions
21652 that update the base register to the address of the calculated memory
21653 location.  These instructions are generated by default.  If you use
21654 @option{-mno-update}, there is a small window between the time that the
21655 stack pointer is updated and the address of the previous frame is
21656 stored, which means code that walks the stack frame across interrupts or
21657 signals may get corrupted data.
21659 @item -mavoid-indexed-addresses
21660 @itemx -mno-avoid-indexed-addresses
21661 @opindex mavoid-indexed-addresses
21662 @opindex mno-avoid-indexed-addresses
21663 Generate code that tries to avoid (not avoid) the use of indexed load
21664 or store instructions. These instructions can incur a performance
21665 penalty on Power6 processors in certain situations, such as when
21666 stepping through large arrays that cross a 16M boundary.  This option
21667 is enabled by default when targeting Power6 and disabled otherwise.
21669 @item -mfused-madd
21670 @itemx -mno-fused-madd
21671 @opindex mfused-madd
21672 @opindex mno-fused-madd
21673 Generate code that uses (does not use) the floating-point multiply and
21674 accumulate instructions.  These instructions are generated by default
21675 if hardware floating point is used.  The machine-dependent
21676 @option{-mfused-madd} option is now mapped to the machine-independent
21677 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21678 mapped to @option{-ffp-contract=off}.
21680 @item -mmulhw
21681 @itemx -mno-mulhw
21682 @opindex mmulhw
21683 @opindex mno-mulhw
21684 Generate code that uses (does not use) the half-word multiply and
21685 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
21686 These instructions are generated by default when targeting those
21687 processors.
21689 @item -mdlmzb
21690 @itemx -mno-dlmzb
21691 @opindex mdlmzb
21692 @opindex mno-dlmzb
21693 Generate code that uses (does not use) the string-search @samp{dlmzb}
21694 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
21695 generated by default when targeting those processors.
21697 @item -mno-bit-align
21698 @itemx -mbit-align
21699 @opindex mno-bit-align
21700 @opindex mbit-align
21701 On System V.4 and embedded PowerPC systems do not (do) force structures
21702 and unions that contain bit-fields to be aligned to the base type of the
21703 bit-field.
21705 For example, by default a structure containing nothing but 8
21706 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
21707 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
21708 the structure is aligned to a 1-byte boundary and is 1 byte in
21709 size.
21711 @item -mno-strict-align
21712 @itemx -mstrict-align
21713 @opindex mno-strict-align
21714 @opindex mstrict-align
21715 On System V.4 and embedded PowerPC systems do not (do) assume that
21716 unaligned memory references are handled by the system.
21718 @item -mrelocatable
21719 @itemx -mno-relocatable
21720 @opindex mrelocatable
21721 @opindex mno-relocatable
21722 Generate code that allows (does not allow) a static executable to be
21723 relocated to a different address at run time.  A simple embedded
21724 PowerPC system loader should relocate the entire contents of
21725 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
21726 a table of 32-bit addresses generated by this option.  For this to
21727 work, all objects linked together must be compiled with
21728 @option{-mrelocatable} or @option{-mrelocatable-lib}.
21729 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
21731 @item -mrelocatable-lib
21732 @itemx -mno-relocatable-lib
21733 @opindex mrelocatable-lib
21734 @opindex mno-relocatable-lib
21735 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
21736 @code{.fixup} section to allow static executables to be relocated at
21737 run time, but @option{-mrelocatable-lib} does not use the smaller stack
21738 alignment of @option{-mrelocatable}.  Objects compiled with
21739 @option{-mrelocatable-lib} may be linked with objects compiled with
21740 any combination of the @option{-mrelocatable} options.
21742 @item -mno-toc
21743 @itemx -mtoc
21744 @opindex mno-toc
21745 @opindex mtoc
21746 On System V.4 and embedded PowerPC systems do not (do) assume that
21747 register 2 contains a pointer to a global area pointing to the addresses
21748 used in the program.
21750 @item -mlittle
21751 @itemx -mlittle-endian
21752 @opindex mlittle
21753 @opindex mlittle-endian
21754 On System V.4 and embedded PowerPC systems compile code for the
21755 processor in little-endian mode.  The @option{-mlittle-endian} option is
21756 the same as @option{-mlittle}.
21758 @item -mbig
21759 @itemx -mbig-endian
21760 @opindex mbig
21761 @opindex mbig-endian
21762 On System V.4 and embedded PowerPC systems compile code for the
21763 processor in big-endian mode.  The @option{-mbig-endian} option is
21764 the same as @option{-mbig}.
21766 @item -mdynamic-no-pic
21767 @opindex mdynamic-no-pic
21768 On Darwin and Mac OS X systems, compile code so that it is not
21769 relocatable, but that its external references are relocatable.  The
21770 resulting code is suitable for applications, but not shared
21771 libraries.
21773 @item -msingle-pic-base
21774 @opindex msingle-pic-base
21775 Treat the register used for PIC addressing as read-only, rather than
21776 loading it in the prologue for each function.  The runtime system is
21777 responsible for initializing this register with an appropriate value
21778 before execution begins.
21780 @item -mprioritize-restricted-insns=@var{priority}
21781 @opindex mprioritize-restricted-insns
21782 This option controls the priority that is assigned to
21783 dispatch-slot restricted instructions during the second scheduling
21784 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
21785 or @samp{2} to assign no, highest, or second-highest (respectively) 
21786 priority to dispatch-slot restricted
21787 instructions.
21789 @item -msched-costly-dep=@var{dependence_type}
21790 @opindex msched-costly-dep
21791 This option controls which dependences are considered costly
21792 by the target during instruction scheduling.  The argument
21793 @var{dependence_type} takes one of the following values:
21795 @table @asis
21796 @item @samp{no}
21797 No dependence is costly.
21799 @item @samp{all}
21800 All dependences are costly.
21802 @item @samp{true_store_to_load}
21803 A true dependence from store to load is costly.
21805 @item @samp{store_to_load}
21806 Any dependence from store to load is costly.
21808 @item @var{number}
21809 Any dependence for which the latency is greater than or equal to 
21810 @var{number} is costly.
21811 @end table
21813 @item -minsert-sched-nops=@var{scheme}
21814 @opindex minsert-sched-nops
21815 This option controls which NOP insertion scheme is used during
21816 the second scheduling pass.  The argument @var{scheme} takes one of the
21817 following values:
21819 @table @asis
21820 @item @samp{no}
21821 Don't insert NOPs.
21823 @item @samp{pad}
21824 Pad with NOPs any dispatch group that has vacant issue slots,
21825 according to the scheduler's grouping.
21827 @item @samp{regroup_exact}
21828 Insert NOPs to force costly dependent insns into
21829 separate groups.  Insert exactly as many NOPs as needed to force an insn
21830 to a new group, according to the estimated processor grouping.
21832 @item @var{number}
21833 Insert NOPs to force costly dependent insns into
21834 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
21835 @end table
21837 @item -mcall-sysv
21838 @opindex mcall-sysv
21839 On System V.4 and embedded PowerPC systems compile code using calling
21840 conventions that adhere to the March 1995 draft of the System V
21841 Application Binary Interface, PowerPC processor supplement.  This is the
21842 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
21844 @item -mcall-sysv-eabi
21845 @itemx -mcall-eabi
21846 @opindex mcall-sysv-eabi
21847 @opindex mcall-eabi
21848 Specify both @option{-mcall-sysv} and @option{-meabi} options.
21850 @item -mcall-sysv-noeabi
21851 @opindex mcall-sysv-noeabi
21852 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
21854 @item -mcall-aixdesc
21855 @opindex m
21856 On System V.4 and embedded PowerPC systems compile code for the AIX
21857 operating system.
21859 @item -mcall-linux
21860 @opindex mcall-linux
21861 On System V.4 and embedded PowerPC systems compile code for the
21862 Linux-based GNU system.
21864 @item -mcall-freebsd
21865 @opindex mcall-freebsd
21866 On System V.4 and embedded PowerPC systems compile code for the
21867 FreeBSD operating system.
21869 @item -mcall-netbsd
21870 @opindex mcall-netbsd
21871 On System V.4 and embedded PowerPC systems compile code for the
21872 NetBSD operating system.
21874 @item -mcall-openbsd
21875 @opindex mcall-netbsd
21876 On System V.4 and embedded PowerPC systems compile code for the
21877 OpenBSD operating system.
21879 @item -maix-struct-return
21880 @opindex maix-struct-return
21881 Return all structures in memory (as specified by the AIX ABI)@.
21883 @item -msvr4-struct-return
21884 @opindex msvr4-struct-return
21885 Return structures smaller than 8 bytes in registers (as specified by the
21886 SVR4 ABI)@.
21888 @item -mabi=@var{abi-type}
21889 @opindex mabi
21890 Extend the current ABI with a particular extension, or remove such extension.
21891 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
21892 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
21893 @samp{elfv1}, @samp{elfv2}@.
21895 @item -mabi=spe
21896 @opindex mabi=spe
21897 Extend the current ABI with SPE ABI extensions.  This does not change
21898 the default ABI, instead it adds the SPE ABI extensions to the current
21899 ABI@.
21901 @item -mabi=no-spe
21902 @opindex mabi=no-spe
21903 Disable Book-E SPE ABI extensions for the current ABI@.
21905 @item -mabi=ibmlongdouble
21906 @opindex mabi=ibmlongdouble
21907 Change the current ABI to use IBM extended-precision long double.
21908 This is a PowerPC 32-bit SYSV ABI option.
21910 @item -mabi=ieeelongdouble
21911 @opindex mabi=ieeelongdouble
21912 Change the current ABI to use IEEE extended-precision long double.
21913 This is a PowerPC 32-bit Linux ABI option.
21915 @item -mabi=elfv1
21916 @opindex mabi=elfv1
21917 Change the current ABI to use the ELFv1 ABI.
21918 This is the default ABI for big-endian PowerPC 64-bit Linux.
21919 Overriding the default ABI requires special system support and is
21920 likely to fail in spectacular ways.
21922 @item -mabi=elfv2
21923 @opindex mabi=elfv2
21924 Change the current ABI to use the ELFv2 ABI.
21925 This is the default ABI for little-endian PowerPC 64-bit Linux.
21926 Overriding the default ABI requires special system support and is
21927 likely to fail in spectacular ways.
21929 @item -mgnu-attribute
21930 @itemx -mno-gnu-attribute
21931 @opindex mgnu-attribute
21932 @opindex mno-gnu-attribute
21933 Emit .gnu_attribute assembly directives to set tag/value pairs in a
21934 .gnu.attributes section that specify ABI variations in function
21935 parameters or return values.
21937 @item -mprototype
21938 @itemx -mno-prototype
21939 @opindex mprototype
21940 @opindex mno-prototype
21941 On System V.4 and embedded PowerPC systems assume that all calls to
21942 variable argument functions are properly prototyped.  Otherwise, the
21943 compiler must insert an instruction before every non-prototyped call to
21944 set or clear bit 6 of the condition code register (@code{CR}) to
21945 indicate whether floating-point values are passed in the floating-point
21946 registers in case the function takes variable arguments.  With
21947 @option{-mprototype}, only calls to prototyped variable argument functions
21948 set or clear the bit.
21950 @item -msim
21951 @opindex msim
21952 On embedded PowerPC systems, assume that the startup module is called
21953 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
21954 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
21955 configurations.
21957 @item -mmvme
21958 @opindex mmvme
21959 On embedded PowerPC systems, assume that the startup module is called
21960 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
21961 @file{libc.a}.
21963 @item -mads
21964 @opindex mads
21965 On embedded PowerPC systems, assume that the startup module is called
21966 @file{crt0.o} and the standard C libraries are @file{libads.a} and
21967 @file{libc.a}.
21969 @item -myellowknife
21970 @opindex myellowknife
21971 On embedded PowerPC systems, assume that the startup module is called
21972 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
21973 @file{libc.a}.
21975 @item -mvxworks
21976 @opindex mvxworks
21977 On System V.4 and embedded PowerPC systems, specify that you are
21978 compiling for a VxWorks system.
21980 @item -memb
21981 @opindex memb
21982 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
21983 header to indicate that @samp{eabi} extended relocations are used.
21985 @item -meabi
21986 @itemx -mno-eabi
21987 @opindex meabi
21988 @opindex mno-eabi
21989 On System V.4 and embedded PowerPC systems do (do not) adhere to the
21990 Embedded Applications Binary Interface (EABI), which is a set of
21991 modifications to the System V.4 specifications.  Selecting @option{-meabi}
21992 means that the stack is aligned to an 8-byte boundary, a function
21993 @code{__eabi} is called from @code{main} to set up the EABI
21994 environment, and the @option{-msdata} option can use both @code{r2} and
21995 @code{r13} to point to two separate small data areas.  Selecting
21996 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
21997 no EABI initialization function is called from @code{main}, and the
21998 @option{-msdata} option only uses @code{r13} to point to a single
21999 small data area.  The @option{-meabi} option is on by default if you
22000 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22002 @item -msdata=eabi
22003 @opindex msdata=eabi
22004 On System V.4 and embedded PowerPC systems, put small initialized
22005 @code{const} global and static data in the @code{.sdata2} section, which
22006 is pointed to by register @code{r2}.  Put small initialized
22007 non-@code{const} global and static data in the @code{.sdata} section,
22008 which is pointed to by register @code{r13}.  Put small uninitialized
22009 global and static data in the @code{.sbss} section, which is adjacent to
22010 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22011 incompatible with the @option{-mrelocatable} option.  The
22012 @option{-msdata=eabi} option also sets the @option{-memb} option.
22014 @item -msdata=sysv
22015 @opindex msdata=sysv
22016 On System V.4 and embedded PowerPC systems, put small global and static
22017 data in the @code{.sdata} section, which is pointed to by register
22018 @code{r13}.  Put small uninitialized global and static data in the
22019 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22020 The @option{-msdata=sysv} option is incompatible with the
22021 @option{-mrelocatable} option.
22023 @item -msdata=default
22024 @itemx -msdata
22025 @opindex msdata=default
22026 @opindex msdata
22027 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22028 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22029 same as @option{-msdata=sysv}.
22031 @item -msdata=data
22032 @opindex msdata=data
22033 On System V.4 and embedded PowerPC systems, put small global
22034 data in the @code{.sdata} section.  Put small uninitialized global
22035 data in the @code{.sbss} section.  Do not use register @code{r13}
22036 to address small data however.  This is the default behavior unless
22037 other @option{-msdata} options are used.
22039 @item -msdata=none
22040 @itemx -mno-sdata
22041 @opindex msdata=none
22042 @opindex mno-sdata
22043 On embedded PowerPC systems, put all initialized global and static data
22044 in the @code{.data} section, and all uninitialized data in the
22045 @code{.bss} section.
22047 @item -mblock-move-inline-limit=@var{num}
22048 @opindex mblock-move-inline-limit
22049 Inline all block moves (such as calls to @code{memcpy} or structure
22050 copies) less than or equal to @var{num} bytes.  The minimum value for
22051 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22052 targets.  The default value is target-specific.
22054 @item -G @var{num}
22055 @opindex G
22056 @cindex smaller data references (PowerPC)
22057 @cindex .sdata/.sdata2 references (PowerPC)
22058 On embedded PowerPC systems, put global and static items less than or
22059 equal to @var{num} bytes into the small data or BSS sections instead of
22060 the normal data or BSS section.  By default, @var{num} is 8.  The
22061 @option{-G @var{num}} switch is also passed to the linker.
22062 All modules should be compiled with the same @option{-G @var{num}} value.
22064 @item -mregnames
22065 @itemx -mno-regnames
22066 @opindex mregnames
22067 @opindex mno-regnames
22068 On System V.4 and embedded PowerPC systems do (do not) emit register
22069 names in the assembly language output using symbolic forms.
22071 @item -mlongcall
22072 @itemx -mno-longcall
22073 @opindex mlongcall
22074 @opindex mno-longcall
22075 By default assume that all calls are far away so that a longer and more
22076 expensive calling sequence is required.  This is required for calls
22077 farther than 32 megabytes (33,554,432 bytes) from the current location.
22078 A short call is generated if the compiler knows
22079 the call cannot be that far away.  This setting can be overridden by
22080 the @code{shortcall} function attribute, or by @code{#pragma
22081 longcall(0)}.
22083 Some linkers are capable of detecting out-of-range calls and generating
22084 glue code on the fly.  On these systems, long calls are unnecessary and
22085 generate slower code.  As of this writing, the AIX linker can do this,
22086 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22087 to the GNU linker for 32-bit PowerPC systems as well.
22089 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22090 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22091 addresses represent the callee and the branch island.  The
22092 Darwin/PPC linker prefers the first address and generates a @code{bl
22093 callee} if the PPC @code{bl} instruction reaches the callee directly;
22094 otherwise, the linker generates @code{bl L42} to call the branch
22095 island.  The branch island is appended to the body of the
22096 calling function; it computes the full 32-bit address of the callee
22097 and jumps to it.
22099 On Mach-O (Darwin) systems, this option directs the compiler emit to
22100 the glue for every direct call, and the Darwin linker decides whether
22101 to use or discard it.
22103 In the future, GCC may ignore all longcall specifications
22104 when the linker is known to generate glue.
22106 @item -mtls-markers
22107 @itemx -mno-tls-markers
22108 @opindex mtls-markers
22109 @opindex mno-tls-markers
22110 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22111 specifying the function argument.  The relocation allows the linker to
22112 reliably associate function call with argument setup instructions for
22113 TLS optimization, which in turn allows GCC to better schedule the
22114 sequence.
22116 @item -mrecip
22117 @itemx -mno-recip
22118 @opindex mrecip
22119 This option enables use of the reciprocal estimate and
22120 reciprocal square root estimate instructions with additional
22121 Newton-Raphson steps to increase precision instead of doing a divide or
22122 square root and divide for floating-point arguments.  You should use
22123 the @option{-ffast-math} option when using @option{-mrecip} (or at
22124 least @option{-funsafe-math-optimizations},
22125 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22126 @option{-fno-trapping-math}).  Note that while the throughput of the
22127 sequence is generally higher than the throughput of the non-reciprocal
22128 instruction, the precision of the sequence can be decreased by up to 2
22129 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22130 roots.
22132 @item -mrecip=@var{opt}
22133 @opindex mrecip=opt
22134 This option controls which reciprocal estimate instructions
22135 may be used.  @var{opt} is a comma-separated list of options, which may
22136 be preceded by a @code{!} to invert the option:
22138 @table @samp
22140 @item all
22141 Enable all estimate instructions.
22143 @item default 
22144 Enable the default instructions, equivalent to @option{-mrecip}.
22146 @item none 
22147 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22149 @item div 
22150 Enable the reciprocal approximation instructions for both 
22151 single and double precision.
22153 @item divf 
22154 Enable the single-precision reciprocal approximation instructions.
22156 @item divd 
22157 Enable the double-precision reciprocal approximation instructions.
22159 @item rsqrt 
22160 Enable the reciprocal square root approximation instructions for both
22161 single and double precision.
22163 @item rsqrtf 
22164 Enable the single-precision reciprocal square root approximation instructions.
22166 @item rsqrtd 
22167 Enable the double-precision reciprocal square root approximation instructions.
22169 @end table
22171 So, for example, @option{-mrecip=all,!rsqrtd} enables
22172 all of the reciprocal estimate instructions, except for the
22173 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22174 which handle the double-precision reciprocal square root calculations.
22176 @item -mrecip-precision
22177 @itemx -mno-recip-precision
22178 @opindex mrecip-precision
22179 Assume (do not assume) that the reciprocal estimate instructions
22180 provide higher-precision estimates than is mandated by the PowerPC
22181 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22182 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22183 The double-precision square root estimate instructions are not generated by
22184 default on low-precision machines, since they do not provide an
22185 estimate that converges after three steps.
22187 @item -mveclibabi=@var{type}
22188 @opindex mveclibabi
22189 Specifies the ABI type to use for vectorizing intrinsics using an
22190 external library.  The only type supported at present is @samp{mass},
22191 which specifies to use IBM's Mathematical Acceleration Subsystem
22192 (MASS) libraries for vectorizing intrinsics using external libraries.
22193 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22194 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22195 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22196 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22197 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22198 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22199 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22200 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22201 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22202 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22203 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22204 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22205 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22206 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22207 for power7.  Both @option{-ftree-vectorize} and
22208 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22209 libraries must be specified at link time.
22211 @item -mfriz
22212 @itemx -mno-friz
22213 @opindex mfriz
22214 Generate (do not generate) the @code{friz} instruction when the
22215 @option{-funsafe-math-optimizations} option is used to optimize
22216 rounding of floating-point values to 64-bit integer and back to floating
22217 point.  The @code{friz} instruction does not return the same value if
22218 the floating-point number is too large to fit in an integer.
22220 @item -mpointers-to-nested-functions
22221 @itemx -mno-pointers-to-nested-functions
22222 @opindex mpointers-to-nested-functions
22223 Generate (do not generate) code to load up the static chain register
22224 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22225 systems where a function pointer points to a 3-word descriptor giving
22226 the function address, TOC value to be loaded in register @code{r2}, and
22227 static chain value to be loaded in register @code{r11}.  The
22228 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22229 call through pointers to nested functions or pointers
22230 to functions compiled in other languages that use the static chain if
22231 you use @option{-mno-pointers-to-nested-functions}.
22233 @item -msave-toc-indirect
22234 @itemx -mno-save-toc-indirect
22235 @opindex msave-toc-indirect
22236 Generate (do not generate) code to save the TOC value in the reserved
22237 stack location in the function prologue if the function calls through
22238 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22239 saved in the prologue, it is saved just before the call through the
22240 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22242 @item -mcompat-align-parm
22243 @itemx -mno-compat-align-parm
22244 @opindex mcompat-align-parm
22245 Generate (do not generate) code to pass structure parameters with a
22246 maximum alignment of 64 bits, for compatibility with older versions
22247 of GCC.
22249 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22250 structure parameter on a 128-bit boundary when that structure contained
22251 a member requiring 128-bit alignment.  This is corrected in more
22252 recent versions of GCC.  This option may be used to generate code
22253 that is compatible with functions compiled with older versions of
22254 GCC.
22256 The @option{-mno-compat-align-parm} option is the default.
22258 @item -mstack-protector-guard=@var{guard}
22259 @itemx -mstack-protector-guard-reg=@var{reg}
22260 @itemx -mstack-protector-guard-offset=@var{offset}
22261 @opindex mstack-protector-guard
22262 @opindex mstack-protector-guard-reg
22263 @opindex mstack-protector-guard-offset
22264 Generate stack protection code using canary at @var{guard}.  Supported
22265 locations are @samp{global} for global canary or @samp{tls} for per-thread
22266 canary in the TLS block (the default with GNU libc version 2.4 or later).
22268 With the latter choice the options
22269 @option{-mstack-protector-guard-reg=@var{reg}} and
22270 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22271 which register to use as base register for reading the canary, and from what
22272 offset from that base register. The default for those is as specified in the
22273 relevant ABI.
22274 @end table
22276 @node RX Options
22277 @subsection RX Options
22278 @cindex RX Options
22280 These command-line options are defined for RX targets:
22282 @table @gcctabopt
22283 @item -m64bit-doubles
22284 @itemx -m32bit-doubles
22285 @opindex m64bit-doubles
22286 @opindex m32bit-doubles
22287 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22288 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22289 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22290 works on 32-bit values, which is why the default is
22291 @option{-m32bit-doubles}.
22293 @item -fpu
22294 @itemx -nofpu
22295 @opindex fpu
22296 @opindex nofpu
22297 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22298 floating-point hardware.  The default is enabled for the RX600
22299 series and disabled for the RX200 series.
22301 Floating-point instructions are only generated for 32-bit floating-point 
22302 values, however, so the FPU hardware is not used for doubles if the
22303 @option{-m64bit-doubles} option is used.
22305 @emph{Note} If the @option{-fpu} option is enabled then
22306 @option{-funsafe-math-optimizations} is also enabled automatically.
22307 This is because the RX FPU instructions are themselves unsafe.
22309 @item -mcpu=@var{name}
22310 @opindex mcpu
22311 Selects the type of RX CPU to be targeted.  Currently three types are
22312 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22313 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22315 The only difference between @samp{RX600} and @samp{RX610} is that the
22316 @samp{RX610} does not support the @code{MVTIPL} instruction.
22318 The @samp{RX200} series does not have a hardware floating-point unit
22319 and so @option{-nofpu} is enabled by default when this type is
22320 selected.
22322 @item -mbig-endian-data
22323 @itemx -mlittle-endian-data
22324 @opindex mbig-endian-data
22325 @opindex mlittle-endian-data
22326 Store data (but not code) in the big-endian format.  The default is
22327 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22328 format.
22330 @item -msmall-data-limit=@var{N}
22331 @opindex msmall-data-limit
22332 Specifies the maximum size in bytes of global and static variables
22333 which can be placed into the small data area.  Using the small data
22334 area can lead to smaller and faster code, but the size of area is
22335 limited and it is up to the programmer to ensure that the area does
22336 not overflow.  Also when the small data area is used one of the RX's
22337 registers (usually @code{r13}) is reserved for use pointing to this
22338 area, so it is no longer available for use by the compiler.  This
22339 could result in slower and/or larger code if variables are pushed onto
22340 the stack instead of being held in this register.
22342 Note, common variables (variables that have not been initialized) and
22343 constants are not placed into the small data area as they are assigned
22344 to other sections in the output executable.
22346 The default value is zero, which disables this feature.  Note, this
22347 feature is not enabled by default with higher optimization levels
22348 (@option{-O2} etc) because of the potentially detrimental effects of
22349 reserving a register.  It is up to the programmer to experiment and
22350 discover whether this feature is of benefit to their program.  See the
22351 description of the @option{-mpid} option for a description of how the
22352 actual register to hold the small data area pointer is chosen.
22354 @item -msim
22355 @itemx -mno-sim
22356 @opindex msim
22357 @opindex mno-sim
22358 Use the simulator runtime.  The default is to use the libgloss
22359 board-specific runtime.
22361 @item -mas100-syntax
22362 @itemx -mno-as100-syntax
22363 @opindex mas100-syntax
22364 @opindex mno-as100-syntax
22365 When generating assembler output use a syntax that is compatible with
22366 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22367 assembler, but it has some restrictions so it is not generated by default.
22369 @item -mmax-constant-size=@var{N}
22370 @opindex mmax-constant-size
22371 Specifies the maximum size, in bytes, of a constant that can be used as
22372 an operand in a RX instruction.  Although the RX instruction set does
22373 allow constants of up to 4 bytes in length to be used in instructions,
22374 a longer value equates to a longer instruction.  Thus in some
22375 circumstances it can be beneficial to restrict the size of constants
22376 that are used in instructions.  Constants that are too big are instead
22377 placed into a constant pool and referenced via register indirection.
22379 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22380 or 4 means that constants of any size are allowed.
22382 @item -mrelax
22383 @opindex mrelax
22384 Enable linker relaxation.  Linker relaxation is a process whereby the
22385 linker attempts to reduce the size of a program by finding shorter
22386 versions of various instructions.  Disabled by default.
22388 @item -mint-register=@var{N}
22389 @opindex mint-register
22390 Specify the number of registers to reserve for fast interrupt handler
22391 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22392 means that register @code{r13} is reserved for the exclusive use
22393 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22394 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22395 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22396 A value of 0, the default, does not reserve any registers.
22398 @item -msave-acc-in-interrupts
22399 @opindex msave-acc-in-interrupts
22400 Specifies that interrupt handler functions should preserve the
22401 accumulator register.  This is only necessary if normal code might use
22402 the accumulator register, for example because it performs 64-bit
22403 multiplications.  The default is to ignore the accumulator as this
22404 makes the interrupt handlers faster.
22406 @item -mpid
22407 @itemx -mno-pid
22408 @opindex mpid
22409 @opindex mno-pid
22410 Enables the generation of position independent data.  When enabled any
22411 access to constant data is done via an offset from a base address
22412 held in a register.  This allows the location of constant data to be
22413 determined at run time without requiring the executable to be
22414 relocated, which is a benefit to embedded applications with tight
22415 memory constraints.  Data that can be modified is not affected by this
22416 option.
22418 Note, using this feature reserves a register, usually @code{r13}, for
22419 the constant data base address.  This can result in slower and/or
22420 larger code, especially in complicated functions.
22422 The actual register chosen to hold the constant data base address
22423 depends upon whether the @option{-msmall-data-limit} and/or the
22424 @option{-mint-register} command-line options are enabled.  Starting
22425 with register @code{r13} and proceeding downwards, registers are
22426 allocated first to satisfy the requirements of @option{-mint-register},
22427 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22428 is possible for the small data area register to be @code{r8} if both
22429 @option{-mint-register=4} and @option{-mpid} are specified on the
22430 command line.
22432 By default this feature is not enabled.  The default can be restored
22433 via the @option{-mno-pid} command-line option.
22435 @item -mno-warn-multiple-fast-interrupts
22436 @itemx -mwarn-multiple-fast-interrupts
22437 @opindex mno-warn-multiple-fast-interrupts
22438 @opindex mwarn-multiple-fast-interrupts
22439 Prevents GCC from issuing a warning message if it finds more than one
22440 fast interrupt handler when it is compiling a file.  The default is to
22441 issue a warning for each extra fast interrupt handler found, as the RX
22442 only supports one such interrupt.
22444 @item -mallow-string-insns
22445 @itemx -mno-allow-string-insns
22446 @opindex mallow-string-insns
22447 @opindex mno-allow-string-insns
22448 Enables or disables the use of the string manipulation instructions
22449 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22450 @code{SWHILE} and also the @code{RMPA} instruction.  These
22451 instructions may prefetch data, which is not safe to do if accessing
22452 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22453 for more information).
22455 The default is to allow these instructions, but it is not possible for
22456 GCC to reliably detect all circumstances where a string instruction
22457 might be used to access an I/O register, so their use cannot be
22458 disabled automatically.  Instead it is reliant upon the programmer to
22459 use the @option{-mno-allow-string-insns} option if their program
22460 accesses I/O space.
22462 When the instructions are enabled GCC defines the C preprocessor
22463 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22464 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22466 @item -mjsr
22467 @itemx -mno-jsr
22468 @opindex mjsr
22469 @opindex mno-jsr
22470 Use only (or not only) @code{JSR} instructions to access functions.
22471 This option can be used when code size exceeds the range of @code{BSR}
22472 instructions.  Note that @option{-mno-jsr} does not mean to not use
22473 @code{JSR} but instead means that any type of branch may be used.
22474 @end table
22476 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22477 has special significance to the RX port when used with the
22478 @code{interrupt} function attribute.  This attribute indicates a
22479 function intended to process fast interrupts.  GCC ensures
22480 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22481 and/or @code{r13} and only provided that the normal use of the
22482 corresponding registers have been restricted via the
22483 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22484 options.
22486 @node S/390 and zSeries Options
22487 @subsection S/390 and zSeries Options
22488 @cindex S/390 and zSeries Options
22490 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22492 @table @gcctabopt
22493 @item -mhard-float
22494 @itemx -msoft-float
22495 @opindex mhard-float
22496 @opindex msoft-float
22497 Use (do not use) the hardware floating-point instructions and registers
22498 for floating-point operations.  When @option{-msoft-float} is specified,
22499 functions in @file{libgcc.a} are used to perform floating-point
22500 operations.  When @option{-mhard-float} is specified, the compiler
22501 generates IEEE floating-point instructions.  This is the default.
22503 @item -mhard-dfp
22504 @itemx -mno-hard-dfp
22505 @opindex mhard-dfp
22506 @opindex mno-hard-dfp
22507 Use (do not use) the hardware decimal-floating-point instructions for
22508 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22509 specified, functions in @file{libgcc.a} are used to perform
22510 decimal-floating-point operations.  When @option{-mhard-dfp} is
22511 specified, the compiler generates decimal-floating-point hardware
22512 instructions.  This is the default for @option{-march=z9-ec} or higher.
22514 @item -mlong-double-64
22515 @itemx -mlong-double-128
22516 @opindex mlong-double-64
22517 @opindex mlong-double-128
22518 These switches control the size of @code{long double} type. A size
22519 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22520 type. This is the default.
22522 @item -mbackchain
22523 @itemx -mno-backchain
22524 @opindex mbackchain
22525 @opindex mno-backchain
22526 Store (do not store) the address of the caller's frame as backchain pointer
22527 into the callee's stack frame.
22528 A backchain may be needed to allow debugging using tools that do not understand
22529 DWARF call frame information.
22530 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22531 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22532 the backchain is placed into the topmost word of the 96/160 byte register
22533 save area.
22535 In general, code compiled with @option{-mbackchain} is call-compatible with
22536 code compiled with @option{-mmo-backchain}; however, use of the backchain
22537 for debugging purposes usually requires that the whole binary is built with
22538 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22539 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22540 to build a linux kernel use @option{-msoft-float}.
22542 The default is to not maintain the backchain.
22544 @item -mpacked-stack
22545 @itemx -mno-packed-stack
22546 @opindex mpacked-stack
22547 @opindex mno-packed-stack
22548 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22549 specified, the compiler uses the all fields of the 96/160 byte register save
22550 area only for their default purpose; unused fields still take up stack space.
22551 When @option{-mpacked-stack} is specified, register save slots are densely
22552 packed at the top of the register save area; unused space is reused for other
22553 purposes, allowing for more efficient use of the available stack space.
22554 However, when @option{-mbackchain} is also in effect, the topmost word of
22555 the save area is always used to store the backchain, and the return address
22556 register is always saved two words below the backchain.
22558 As long as the stack frame backchain is not used, code generated with
22559 @option{-mpacked-stack} is call-compatible with code generated with
22560 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22561 S/390 or zSeries generated code that uses the stack frame backchain at run
22562 time, not just for debugging purposes.  Such code is not call-compatible
22563 with code compiled with @option{-mpacked-stack}.  Also, note that the
22564 combination of @option{-mbackchain},
22565 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22566 to build a linux kernel use @option{-msoft-float}.
22568 The default is to not use the packed stack layout.
22570 @item -msmall-exec
22571 @itemx -mno-small-exec
22572 @opindex msmall-exec
22573 @opindex mno-small-exec
22574 Generate (or do not generate) code using the @code{bras} instruction
22575 to do subroutine calls.
22576 This only works reliably if the total executable size does not
22577 exceed 64k.  The default is to use the @code{basr} instruction instead,
22578 which does not have this limitation.
22580 @item -m64
22581 @itemx -m31
22582 @opindex m64
22583 @opindex m31
22584 When @option{-m31} is specified, generate code compliant to the
22585 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
22586 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
22587 particular to generate 64-bit instructions.  For the @samp{s390}
22588 targets, the default is @option{-m31}, while the @samp{s390x}
22589 targets default to @option{-m64}.
22591 @item -mzarch
22592 @itemx -mesa
22593 @opindex mzarch
22594 @opindex mesa
22595 When @option{-mzarch} is specified, generate code using the
22596 instructions available on z/Architecture.
22597 When @option{-mesa} is specified, generate code using the
22598 instructions available on ESA/390.  Note that @option{-mesa} is
22599 not possible with @option{-m64}.
22600 When generating code compliant to the GNU/Linux for S/390 ABI,
22601 the default is @option{-mesa}.  When generating code compliant
22602 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
22604 @item -mhtm
22605 @itemx -mno-htm
22606 @opindex mhtm
22607 @opindex mno-htm
22608 The @option{-mhtm} option enables a set of builtins making use of
22609 instructions available with the transactional execution facility
22610 introduced with the IBM zEnterprise EC12 machine generation
22611 @ref{S/390 System z Built-in Functions}.
22612 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
22614 @item -mvx
22615 @itemx -mno-vx
22616 @opindex mvx
22617 @opindex mno-vx
22618 When @option{-mvx} is specified, generate code using the instructions
22619 available with the vector extension facility introduced with the IBM
22620 z13 machine generation.
22621 This option changes the ABI for some vector type values with regard to
22622 alignment and calling conventions.  In case vector type values are
22623 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
22624 command will be added to mark the resulting binary with the ABI used.
22625 @option{-mvx} is enabled by default when using @option{-march=z13}.
22627 @item -mzvector
22628 @itemx -mno-zvector
22629 @opindex mzvector
22630 @opindex mno-zvector
22631 The @option{-mzvector} option enables vector language extensions and
22632 builtins using instructions available with the vector extension
22633 facility introduced with the IBM z13 machine generation.
22634 This option adds support for @samp{vector} to be used as a keyword to
22635 define vector type variables and arguments.  @samp{vector} is only
22636 available when GNU extensions are enabled.  It will not be expanded
22637 when requesting strict standard compliance e.g. with @option{-std=c99}.
22638 In addition to the GCC low-level builtins @option{-mzvector} enables
22639 a set of builtins added for compatibility with AltiVec-style
22640 implementations like Power and Cell.  In order to make use of these
22641 builtins the header file @file{vecintrin.h} needs to be included.
22642 @option{-mzvector} is disabled by default.
22644 @item -mmvcle
22645 @itemx -mno-mvcle
22646 @opindex mmvcle
22647 @opindex mno-mvcle
22648 Generate (or do not generate) code using the @code{mvcle} instruction
22649 to perform block moves.  When @option{-mno-mvcle} is specified,
22650 use a @code{mvc} loop instead.  This is the default unless optimizing for
22651 size.
22653 @item -mdebug
22654 @itemx -mno-debug
22655 @opindex mdebug
22656 @opindex mno-debug
22657 Print (or do not print) additional debug information when compiling.
22658 The default is to not print debug information.
22660 @item -march=@var{cpu-type}
22661 @opindex march
22662 Generate code that runs on @var{cpu-type}, which is the name of a
22663 system representing a certain processor type.  Possible values for
22664 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
22665 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
22666 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
22667 @samp{native}.
22669 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
22670 @samp{g6} are deprecated and will be removed with future releases.
22672 Specifying @samp{native} as cpu type can be used to select the best
22673 architecture option for the host processor.
22674 @option{-march=native} has no effect if GCC does not recognize the
22675 processor.
22677 @item -mtune=@var{cpu-type}
22678 @opindex mtune
22679 Tune to @var{cpu-type} everything applicable about the generated code,
22680 except for the ABI and the set of available instructions.
22681 The list of @var{cpu-type} values is the same as for @option{-march}.
22682 The default is the value used for @option{-march}.
22684 @item -mtpf-trace
22685 @itemx -mno-tpf-trace
22686 @opindex mtpf-trace
22687 @opindex mno-tpf-trace
22688 Generate code that adds (does not add) in TPF OS specific branches to trace
22689 routines in the operating system.  This option is off by default, even
22690 when compiling for the TPF OS@.
22692 @item -mfused-madd
22693 @itemx -mno-fused-madd
22694 @opindex mfused-madd
22695 @opindex mno-fused-madd
22696 Generate code that uses (does not use) the floating-point multiply and
22697 accumulate instructions.  These instructions are generated by default if
22698 hardware floating point is used.
22700 @item -mwarn-framesize=@var{framesize}
22701 @opindex mwarn-framesize
22702 Emit a warning if the current function exceeds the given frame size.  Because
22703 this is a compile-time check it doesn't need to be a real problem when the program
22704 runs.  It is intended to identify functions that most probably cause
22705 a stack overflow.  It is useful to be used in an environment with limited stack
22706 size e.g.@: the linux kernel.
22708 @item -mwarn-dynamicstack
22709 @opindex mwarn-dynamicstack
22710 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
22711 arrays.  This is generally a bad idea with a limited stack size.
22713 @item -mstack-guard=@var{stack-guard}
22714 @itemx -mstack-size=@var{stack-size}
22715 @opindex mstack-guard
22716 @opindex mstack-size
22717 If these options are provided the S/390 back end emits additional instructions in
22718 the function prologue that trigger a trap if the stack size is @var{stack-guard}
22719 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
22720 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
22721 the frame size of the compiled function is chosen.
22722 These options are intended to be used to help debugging stack overflow problems.
22723 The additionally emitted code causes only little overhead and hence can also be
22724 used in production-like systems without greater performance degradation.  The given
22725 values have to be exact powers of 2 and @var{stack-size} has to be greater than
22726 @var{stack-guard} without exceeding 64k.
22727 In order to be efficient the extra code makes the assumption that the stack starts
22728 at an address aligned to the value given by @var{stack-size}.
22729 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
22731 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
22732 @opindex mhotpatch
22733 If the hotpatch option is enabled, a ``hot-patching'' function
22734 prologue is generated for all functions in the compilation unit.
22735 The funtion label is prepended with the given number of two-byte
22736 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
22737 the label, 2 * @var{post-halfwords} bytes are appended, using the
22738 largest NOP like instructions the architecture allows (maximum
22739 1000000).
22741 If both arguments are zero, hotpatching is disabled.
22743 This option can be overridden for individual functions with the
22744 @code{hotpatch} attribute.
22745 @end table
22747 @node Score Options
22748 @subsection Score Options
22749 @cindex Score Options
22751 These options are defined for Score implementations:
22753 @table @gcctabopt
22754 @item -meb
22755 @opindex meb
22756 Compile code for big-endian mode.  This is the default.
22758 @item -mel
22759 @opindex mel
22760 Compile code for little-endian mode.
22762 @item -mnhwloop
22763 @opindex mnhwloop
22764 Disable generation of @code{bcnz} instructions.
22766 @item -muls
22767 @opindex muls
22768 Enable generation of unaligned load and store instructions.
22770 @item -mmac
22771 @opindex mmac
22772 Enable the use of multiply-accumulate instructions. Disabled by default.
22774 @item -mscore5
22775 @opindex mscore5
22776 Specify the SCORE5 as the target architecture.
22778 @item -mscore5u
22779 @opindex mscore5u
22780 Specify the SCORE5U of the target architecture.
22782 @item -mscore7
22783 @opindex mscore7
22784 Specify the SCORE7 as the target architecture. This is the default.
22786 @item -mscore7d
22787 @opindex mscore7d
22788 Specify the SCORE7D as the target architecture.
22789 @end table
22791 @node SH Options
22792 @subsection SH Options
22794 These @samp{-m} options are defined for the SH implementations:
22796 @table @gcctabopt
22797 @item -m1
22798 @opindex m1
22799 Generate code for the SH1.
22801 @item -m2
22802 @opindex m2
22803 Generate code for the SH2.
22805 @item -m2e
22806 Generate code for the SH2e.
22808 @item -m2a-nofpu
22809 @opindex m2a-nofpu
22810 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
22811 that the floating-point unit is not used.
22813 @item -m2a-single-only
22814 @opindex m2a-single-only
22815 Generate code for the SH2a-FPU, in such a way that no double-precision
22816 floating-point operations are used.
22818 @item -m2a-single
22819 @opindex m2a-single
22820 Generate code for the SH2a-FPU assuming the floating-point unit is in
22821 single-precision mode by default.
22823 @item -m2a
22824 @opindex m2a
22825 Generate code for the SH2a-FPU assuming the floating-point unit is in
22826 double-precision mode by default.
22828 @item -m3
22829 @opindex m3
22830 Generate code for the SH3.
22832 @item -m3e
22833 @opindex m3e
22834 Generate code for the SH3e.
22836 @item -m4-nofpu
22837 @opindex m4-nofpu
22838 Generate code for the SH4 without a floating-point unit.
22840 @item -m4-single-only
22841 @opindex m4-single-only
22842 Generate code for the SH4 with a floating-point unit that only
22843 supports single-precision arithmetic.
22845 @item -m4-single
22846 @opindex m4-single
22847 Generate code for the SH4 assuming the floating-point unit is in
22848 single-precision mode by default.
22850 @item -m4
22851 @opindex m4
22852 Generate code for the SH4.
22854 @item -m4-100
22855 @opindex m4-100
22856 Generate code for SH4-100.
22858 @item -m4-100-nofpu
22859 @opindex m4-100-nofpu
22860 Generate code for SH4-100 in such a way that the
22861 floating-point unit is not used.
22863 @item -m4-100-single
22864 @opindex m4-100-single
22865 Generate code for SH4-100 assuming the floating-point unit is in
22866 single-precision mode by default.
22868 @item -m4-100-single-only
22869 @opindex m4-100-single-only
22870 Generate code for SH4-100 in such a way that no double-precision
22871 floating-point operations are used.
22873 @item -m4-200
22874 @opindex m4-200
22875 Generate code for SH4-200.
22877 @item -m4-200-nofpu
22878 @opindex m4-200-nofpu
22879 Generate code for SH4-200 without in such a way that the
22880 floating-point unit is not used.
22882 @item -m4-200-single
22883 @opindex m4-200-single
22884 Generate code for SH4-200 assuming the floating-point unit is in
22885 single-precision mode by default.
22887 @item -m4-200-single-only
22888 @opindex m4-200-single-only
22889 Generate code for SH4-200 in such a way that no double-precision
22890 floating-point operations are used.
22892 @item -m4-300
22893 @opindex m4-300
22894 Generate code for SH4-300.
22896 @item -m4-300-nofpu
22897 @opindex m4-300-nofpu
22898 Generate code for SH4-300 without in such a way that the
22899 floating-point unit is not used.
22901 @item -m4-300-single
22902 @opindex m4-300-single
22903 Generate code for SH4-300 in such a way that no double-precision
22904 floating-point operations are used.
22906 @item -m4-300-single-only
22907 @opindex m4-300-single-only
22908 Generate code for SH4-300 in such a way that no double-precision
22909 floating-point operations are used.
22911 @item -m4-340
22912 @opindex m4-340
22913 Generate code for SH4-340 (no MMU, no FPU).
22915 @item -m4-500
22916 @opindex m4-500
22917 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
22918 assembler.
22920 @item -m4a-nofpu
22921 @opindex m4a-nofpu
22922 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
22923 floating-point unit is not used.
22925 @item -m4a-single-only
22926 @opindex m4a-single-only
22927 Generate code for the SH4a, in such a way that no double-precision
22928 floating-point operations are used.
22930 @item -m4a-single
22931 @opindex m4a-single
22932 Generate code for the SH4a assuming the floating-point unit is in
22933 single-precision mode by default.
22935 @item -m4a
22936 @opindex m4a
22937 Generate code for the SH4a.
22939 @item -m4al
22940 @opindex m4al
22941 Same as @option{-m4a-nofpu}, except that it implicitly passes
22942 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
22943 instructions at the moment.
22945 @item -mb
22946 @opindex mb
22947 Compile code for the processor in big-endian mode.
22949 @item -ml
22950 @opindex ml
22951 Compile code for the processor in little-endian mode.
22953 @item -mdalign
22954 @opindex mdalign
22955 Align doubles at 64-bit boundaries.  Note that this changes the calling
22956 conventions, and thus some functions from the standard C library do
22957 not work unless you recompile it first with @option{-mdalign}.
22959 @item -mrelax
22960 @opindex mrelax
22961 Shorten some address references at link time, when possible; uses the
22962 linker option @option{-relax}.
22964 @item -mbigtable
22965 @opindex mbigtable
22966 Use 32-bit offsets in @code{switch} tables.  The default is to use
22967 16-bit offsets.
22969 @item -mbitops
22970 @opindex mbitops
22971 Enable the use of bit manipulation instructions on SH2A.
22973 @item -mfmovd
22974 @opindex mfmovd
22975 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
22976 alignment constraints.
22978 @item -mrenesas
22979 @opindex mrenesas
22980 Comply with the calling conventions defined by Renesas.
22982 @item -mno-renesas
22983 @opindex mno-renesas
22984 Comply with the calling conventions defined for GCC before the Renesas
22985 conventions were available.  This option is the default for all
22986 targets of the SH toolchain.
22988 @item -mnomacsave
22989 @opindex mnomacsave
22990 Mark the @code{MAC} register as call-clobbered, even if
22991 @option{-mrenesas} is given.
22993 @item -mieee
22994 @itemx -mno-ieee
22995 @opindex mieee
22996 @opindex mno-ieee
22997 Control the IEEE compliance of floating-point comparisons, which affects the
22998 handling of cases where the result of a comparison is unordered.  By default
22999 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23000 enabled @option{-mno-ieee} is implicitly set, which results in faster
23001 floating-point greater-equal and less-equal comparisons.  The implicit settings
23002 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23004 @item -minline-ic_invalidate
23005 @opindex minline-ic_invalidate
23006 Inline code to invalidate instruction cache entries after setting up
23007 nested function trampolines.
23008 This option has no effect if @option{-musermode} is in effect and the selected
23009 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23010 instruction.
23011 If the selected code generation option does not allow the use of the @code{icbi}
23012 instruction, and @option{-musermode} is not in effect, the inlined code
23013 manipulates the instruction cache address array directly with an associative
23014 write.  This not only requires privileged mode at run time, but it also
23015 fails if the cache line had been mapped via the TLB and has become unmapped.
23017 @item -misize
23018 @opindex misize
23019 Dump instruction size and location in the assembly code.
23021 @item -mpadstruct
23022 @opindex mpadstruct
23023 This option is deprecated.  It pads structures to multiple of 4 bytes,
23024 which is incompatible with the SH ABI@.
23026 @item -matomic-model=@var{model}
23027 @opindex matomic-model=@var{model}
23028 Sets the model of atomic operations and additional parameters as a comma
23029 separated list.  For details on the atomic built-in functions see
23030 @ref{__atomic Builtins}.  The following models and parameters are supported:
23032 @table @samp
23034 @item none
23035 Disable compiler generated atomic sequences and emit library calls for atomic
23036 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23038 @item soft-gusa
23039 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23040 built-in functions.  The generated atomic sequences require additional support
23041 from the interrupt/exception handling code of the system and are only suitable
23042 for SH3* and SH4* single-core systems.  This option is enabled by default when
23043 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23044 this option also partially utilizes the hardware atomic instructions
23045 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23046 @samp{strict} is specified.  
23048 @item soft-tcb
23049 Generate software atomic sequences that use a variable in the thread control
23050 block.  This is a variation of the gUSA sequences which can also be used on
23051 SH1* and SH2* targets.  The generated atomic sequences require additional
23052 support from the interrupt/exception handling code of the system and are only
23053 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23054 parameter has to be specified as well.
23056 @item soft-imask
23057 Generate software atomic sequences that temporarily disable interrupts by
23058 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23059 in privileged mode and is only suitable for single-core systems.  Additional
23060 support from the interrupt/exception handling code of the system is not
23061 required.  This model is enabled by default when the target is
23062 @code{sh*-*-linux*} and SH1* or SH2*.
23064 @item hard-llcs
23065 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23066 instructions only.  This is only available on SH4A and is suitable for
23067 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23068 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23069 Code compiled with this option is also compatible with other software
23070 atomic model interrupt/exception handling systems if executed on an SH4A
23071 system.  Additional support from the interrupt/exception handling code of the
23072 system is not required for this model.
23074 @item gbr-offset=
23075 This parameter specifies the offset in bytes of the variable in the thread
23076 control block structure that should be used by the generated atomic sequences
23077 when the @samp{soft-tcb} model has been selected.  For other models this
23078 parameter is ignored.  The specified value must be an integer multiple of four
23079 and in the range 0-1020.
23081 @item strict
23082 This parameter prevents mixed usage of multiple atomic models, even if they
23083 are compatible, and makes the compiler generate atomic sequences of the
23084 specified model only.
23086 @end table
23088 @item -mtas
23089 @opindex mtas
23090 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23091 Notice that depending on the particular hardware and software configuration
23092 this can degrade overall performance due to the operand cache line flushes
23093 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23094 processors the @code{tas.b} instruction must be used with caution since it
23095 can result in data corruption for certain cache configurations.
23097 @item -mprefergot
23098 @opindex mprefergot
23099 When generating position-independent code, emit function calls using
23100 the Global Offset Table instead of the Procedure Linkage Table.
23102 @item -musermode
23103 @itemx -mno-usermode
23104 @opindex musermode
23105 @opindex mno-usermode
23106 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23107 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23108 inlined code would not work in user mode.  @option{-musermode} is the default
23109 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23110 @option{-musermode} has no effect, since there is no user mode.
23112 @item -multcost=@var{number}
23113 @opindex multcost=@var{number}
23114 Set the cost to assume for a multiply insn.
23116 @item -mdiv=@var{strategy}
23117 @opindex mdiv=@var{strategy}
23118 Set the division strategy to be used for integer division operations.
23119 @var{strategy} can be one of: 
23121 @table @samp
23123 @item call-div1
23124 Calls a library function that uses the single-step division instruction
23125 @code{div1} to perform the operation.  Division by zero calculates an
23126 unspecified result and does not trap.  This is the default except for SH4,
23127 SH2A and SHcompact.
23129 @item call-fp
23130 Calls a library function that performs the operation in double precision
23131 floating point.  Division by zero causes a floating-point exception.  This is
23132 the default for SHcompact with FPU.  Specifying this for targets that do not
23133 have a double precision FPU defaults to @code{call-div1}.
23135 @item call-table
23136 Calls a library function that uses a lookup table for small divisors and
23137 the @code{div1} instruction with case distinction for larger divisors.  Division
23138 by zero calculates an unspecified result and does not trap.  This is the default
23139 for SH4.  Specifying this for targets that do not have dynamic shift
23140 instructions defaults to @code{call-div1}.
23142 @end table
23144 When a division strategy has not been specified the default strategy is
23145 selected based on the current target.  For SH2A the default strategy is to
23146 use the @code{divs} and @code{divu} instructions instead of library function
23147 calls.
23149 @item -maccumulate-outgoing-args
23150 @opindex maccumulate-outgoing-args
23151 Reserve space once for outgoing arguments in the function prologue rather
23152 than around each call.  Generally beneficial for performance and size.  Also
23153 needed for unwinding to avoid changing the stack frame around conditional code.
23155 @item -mdivsi3_libfunc=@var{name}
23156 @opindex mdivsi3_libfunc=@var{name}
23157 Set the name of the library function used for 32-bit signed division to
23158 @var{name}.
23159 This only affects the name used in the @samp{call} division strategies, and
23160 the compiler still expects the same sets of input/output/clobbered registers as
23161 if this option were not present.
23163 @item -mfixed-range=@var{register-range}
23164 @opindex mfixed-range
23165 Generate code treating the given register range as fixed registers.
23166 A fixed register is one that the register allocator can not use.  This is
23167 useful when compiling kernel code.  A register range is specified as
23168 two registers separated by a dash.  Multiple register ranges can be
23169 specified separated by a comma.
23171 @item -mbranch-cost=@var{num}
23172 @opindex mbranch-cost=@var{num}
23173 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23174 make the compiler try to generate more branch-free code if possible.  
23175 If not specified the value is selected depending on the processor type that
23176 is being compiled for.
23178 @item -mzdcbranch
23179 @itemx -mno-zdcbranch
23180 @opindex mzdcbranch
23181 @opindex mno-zdcbranch
23182 Assume (do not assume) that zero displacement conditional branch instructions
23183 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23184 compiler prefers zero displacement branch code sequences.  This is
23185 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23186 disabled by specifying @option{-mno-zdcbranch}.
23188 @item -mcbranch-force-delay-slot
23189 @opindex mcbranch-force-delay-slot
23190 Force the usage of delay slots for conditional branches, which stuffs the delay
23191 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23192 this option is disabled.  It can be enabled to work around hardware bugs as
23193 found in the original SH7055.
23195 @item -mfused-madd
23196 @itemx -mno-fused-madd
23197 @opindex mfused-madd
23198 @opindex mno-fused-madd
23199 Generate code that uses (does not use) the floating-point multiply and
23200 accumulate instructions.  These instructions are generated by default
23201 if hardware floating point is used.  The machine-dependent
23202 @option{-mfused-madd} option is now mapped to the machine-independent
23203 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23204 mapped to @option{-ffp-contract=off}.
23206 @item -mfsca
23207 @itemx -mno-fsca
23208 @opindex mfsca
23209 @opindex mno-fsca
23210 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23211 and cosine approximations.  The option @option{-mfsca} must be used in
23212 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23213 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23214 approximations even if @option{-funsafe-math-optimizations} is in effect.
23216 @item -mfsrra
23217 @itemx -mno-fsrra
23218 @opindex mfsrra
23219 @opindex mno-fsrra
23220 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23221 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23222 in combination with @option{-funsafe-math-optimizations} and
23223 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23224 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23225 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23226 in effect.
23228 @item -mpretend-cmove
23229 @opindex mpretend-cmove
23230 Prefer zero-displacement conditional branches for conditional move instruction
23231 patterns.  This can result in faster code on the SH4 processor.
23233 @item -mfdpic
23234 @opindex fdpic
23235 Generate code using the FDPIC ABI.
23237 @end table
23239 @node Solaris 2 Options
23240 @subsection Solaris 2 Options
23241 @cindex Solaris 2 options
23243 These @samp{-m} options are supported on Solaris 2:
23245 @table @gcctabopt
23246 @item -mclear-hwcap
23247 @opindex mclear-hwcap
23248 @option{-mclear-hwcap} tells the compiler to remove the hardware
23249 capabilities generated by the Solaris assembler.  This is only necessary
23250 when object files use ISA extensions not supported by the current
23251 machine, but check at runtime whether or not to use them.
23253 @item -mimpure-text
23254 @opindex mimpure-text
23255 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23256 the compiler to not pass @option{-z text} to the linker when linking a
23257 shared object.  Using this option, you can link position-dependent
23258 code into a shared object.
23260 @option{-mimpure-text} suppresses the ``relocations remain against
23261 allocatable but non-writable sections'' linker error message.
23262 However, the necessary relocations trigger copy-on-write, and the
23263 shared object is not actually shared across processes.  Instead of
23264 using @option{-mimpure-text}, you should compile all source code with
23265 @option{-fpic} or @option{-fPIC}.
23267 @end table
23269 These switches are supported in addition to the above on Solaris 2:
23271 @table @gcctabopt
23272 @item -pthreads
23273 @opindex pthreads
23274 This is a synonym for @option{-pthread}.
23275 @end table
23277 @node SPARC Options
23278 @subsection SPARC Options
23279 @cindex SPARC options
23281 These @samp{-m} options are supported on the SPARC:
23283 @table @gcctabopt
23284 @item -mno-app-regs
23285 @itemx -mapp-regs
23286 @opindex mno-app-regs
23287 @opindex mapp-regs
23288 Specify @option{-mapp-regs} to generate output using the global registers
23289 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23290 global register 1, each global register 2 through 4 is then treated as an
23291 allocable register that is clobbered by function calls.  This is the default.
23293 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23294 specify @option{-mno-app-regs}.  You should compile libraries and system
23295 software with this option.
23297 @item -mflat
23298 @itemx -mno-flat
23299 @opindex mflat
23300 @opindex mno-flat
23301 With @option{-mflat}, the compiler does not generate save/restore instructions
23302 and uses a ``flat'' or single register window model.  This model is compatible
23303 with the regular register window model.  The local registers and the input
23304 registers (0--5) are still treated as ``call-saved'' registers and are
23305 saved on the stack as needed.
23307 With @option{-mno-flat} (the default), the compiler generates save/restore
23308 instructions (except for leaf functions).  This is the normal operating mode.
23310 @item -mfpu
23311 @itemx -mhard-float
23312 @opindex mfpu
23313 @opindex mhard-float
23314 Generate output containing floating-point instructions.  This is the
23315 default.
23317 @item -mno-fpu
23318 @itemx -msoft-float
23319 @opindex mno-fpu
23320 @opindex msoft-float
23321 Generate output containing library calls for floating point.
23322 @strong{Warning:} the requisite libraries are not available for all SPARC
23323 targets.  Normally the facilities of the machine's usual C compiler are
23324 used, but this cannot be done directly in cross-compilation.  You must make
23325 your own arrangements to provide suitable library functions for
23326 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23327 @samp{sparclite-*-*} do provide software floating-point support.
23329 @option{-msoft-float} changes the calling convention in the output file;
23330 therefore, it is only useful if you compile @emph{all} of a program with
23331 this option.  In particular, you need to compile @file{libgcc.a}, the
23332 library that comes with GCC, with @option{-msoft-float} in order for
23333 this to work.
23335 @item -mhard-quad-float
23336 @opindex mhard-quad-float
23337 Generate output containing quad-word (long double) floating-point
23338 instructions.
23340 @item -msoft-quad-float
23341 @opindex msoft-quad-float
23342 Generate output containing library calls for quad-word (long double)
23343 floating-point instructions.  The functions called are those specified
23344 in the SPARC ABI@.  This is the default.
23346 As of this writing, there are no SPARC implementations that have hardware
23347 support for the quad-word floating-point instructions.  They all invoke
23348 a trap handler for one of these instructions, and then the trap handler
23349 emulates the effect of the instruction.  Because of the trap handler overhead,
23350 this is much slower than calling the ABI library routines.  Thus the
23351 @option{-msoft-quad-float} option is the default.
23353 @item -mno-unaligned-doubles
23354 @itemx -munaligned-doubles
23355 @opindex mno-unaligned-doubles
23356 @opindex munaligned-doubles
23357 Assume that doubles have 8-byte alignment.  This is the default.
23359 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23360 alignment only if they are contained in another type, or if they have an
23361 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23362 Specifying this option avoids some rare compatibility problems with code
23363 generated by other compilers.  It is not the default because it results
23364 in a performance loss, especially for floating-point code.
23366 @item -muser-mode
23367 @itemx -mno-user-mode
23368 @opindex muser-mode
23369 @opindex mno-user-mode
23370 Do not generate code that can only run in supervisor mode.  This is relevant
23371 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23372 is the default.
23374 @item -mfaster-structs
23375 @itemx -mno-faster-structs
23376 @opindex mfaster-structs
23377 @opindex mno-faster-structs
23378 With @option{-mfaster-structs}, the compiler assumes that structures
23379 should have 8-byte alignment.  This enables the use of pairs of
23380 @code{ldd} and @code{std} instructions for copies in structure
23381 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23382 However, the use of this changed alignment directly violates the SPARC
23383 ABI@.  Thus, it's intended only for use on targets where the developer
23384 acknowledges that their resulting code is not directly in line with
23385 the rules of the ABI@.
23387 @item -mstd-struct-return
23388 @itemx -mno-std-struct-return
23389 @opindex mstd-struct-return
23390 @opindex mno-std-struct-return
23391 With @option{-mstd-struct-return}, the compiler generates checking code
23392 in functions returning structures or unions to detect size mismatches
23393 between the two sides of function calls, as per the 32-bit ABI@.
23395 The default is @option{-mno-std-struct-return}.  This option has no effect
23396 in 64-bit mode.
23398 @item -mlra
23399 @itemx -mno-lra
23400 @opindex mlra
23401 @opindex mno-lra
23402 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23403 so @option{-mno-lra} needs to be passed to get old Reload.
23405 @item -mcpu=@var{cpu_type}
23406 @opindex mcpu
23407 Set the instruction set, register set, and instruction scheduling parameters
23408 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23409 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23410 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23411 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23412 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23413 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23415 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23416 which selects the best architecture option for the host processor.
23417 @option{-mcpu=native} has no effect if GCC does not recognize
23418 the processor.
23420 Default instruction scheduling parameters are used for values that select
23421 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23422 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23424 Here is a list of each supported architecture and their supported
23425 implementations.
23427 @table @asis
23428 @item v7
23429 cypress, leon3v7
23431 @item v8
23432 supersparc, hypersparc, leon, leon3
23434 @item sparclite
23435 f930, f934, sparclite86x
23437 @item sparclet
23438 tsc701
23440 @item v9
23441 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23442 @end table
23444 By default (unless configured otherwise), GCC generates code for the V7
23445 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23446 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23447 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23448 SPARCStation 1, 2, IPX etc.
23450 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23451 architecture.  The only difference from V7 code is that the compiler emits
23452 the integer multiply and integer divide instructions which exist in SPARC-V8
23453 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23454 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23455 2000 series.
23457 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23458 the SPARC architecture.  This adds the integer multiply, integer divide step
23459 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23460 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23461 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23462 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23463 MB86934 chip, which is the more recent SPARClite with FPU@.
23465 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23466 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23467 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23468 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23469 optimizes it for the TEMIC SPARClet chip.
23471 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23472 architecture.  This adds 64-bit integer and floating-point move instructions,
23473 3 additional floating-point condition code registers and conditional move
23474 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23475 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23476 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23477 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23478 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23479 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23480 additionally optimizes it for Sun UltraSPARC T2 chips. With
23481 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23482 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23483 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23484 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23485 Oracle SPARC M7 chips.
23487 @item -mtune=@var{cpu_type}
23488 @opindex mtune
23489 Set the instruction scheduling parameters for machine type
23490 @var{cpu_type}, but do not set the instruction set or register set that the
23491 option @option{-mcpu=@var{cpu_type}} does.
23493 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23494 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23495 that select a particular CPU implementation.  Those are
23496 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23497 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23498 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23499 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23500 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23501 GNU/Linux toolchains, @samp{native} can also be used.
23503 @item -mv8plus
23504 @itemx -mno-v8plus
23505 @opindex mv8plus
23506 @opindex mno-v8plus
23507 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23508 difference from the V8 ABI is that the global and out registers are
23509 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23510 mode for all SPARC-V9 processors.
23512 @item -mvis
23513 @itemx -mno-vis
23514 @opindex mvis
23515 @opindex mno-vis
23516 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23517 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23519 @item -mvis2
23520 @itemx -mno-vis2
23521 @opindex mvis2
23522 @opindex mno-vis2
23523 With @option{-mvis2}, GCC generates code that takes advantage of
23524 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23525 default is @option{-mvis2} when targeting a cpu that supports such
23526 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23527 also sets @option{-mvis}.
23529 @item -mvis3
23530 @itemx -mno-vis3
23531 @opindex mvis3
23532 @opindex mno-vis3
23533 With @option{-mvis3}, GCC generates code that takes advantage of
23534 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23535 default is @option{-mvis3} when targeting a cpu that supports such
23536 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23537 also sets @option{-mvis2} and @option{-mvis}.
23539 @item -mvis4
23540 @itemx -mno-vis4
23541 @opindex mvis4
23542 @opindex mno-vis4
23543 With @option{-mvis4}, GCC generates code that takes advantage of
23544 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23545 default is @option{-mvis4} when targeting a cpu that supports such
23546 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23547 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23549 @item -mcbcond
23550 @itemx -mno-cbcond
23551 @opindex mcbcond
23552 @opindex mno-cbcond
23553 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23554 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23555 when targeting a CPU that supports such instructions, such as Niagara-4 and
23556 later.
23558 @item -mfmaf
23559 @itemx -mno-fmaf
23560 @opindex mfmaf
23561 @opindex mno-fmaf
23562 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23563 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23564 when targeting a CPU that supports such instructions, such as Niagara-3 and
23565 later.
23567 @item -mpopc
23568 @itemx -mno-popc
23569 @opindex mpopc
23570 @opindex mno-popc
23571 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23572 Population Count instruction.  The default is @option{-mpopc}
23573 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23574 later.
23576 @item -msubxc
23577 @itemx -mno-subxc
23578 @opindex msubxc
23579 @opindex mno-subxc
23580 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
23581 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
23582 when targeting a CPU that supports such an instruction, such as Niagara-7 and
23583 later.
23585 @item -mfix-at697f
23586 @opindex mfix-at697f
23587 Enable the documented workaround for the single erratum of the Atmel AT697F
23588 processor (which corresponds to erratum #13 of the AT697E processor).
23590 @item -mfix-ut699
23591 @opindex mfix-ut699
23592 Enable the documented workarounds for the floating-point errata and the data
23593 cache nullify errata of the UT699 processor.
23594 @end table
23596 These @samp{-m} options are supported in addition to the above
23597 on SPARC-V9 processors in 64-bit environments:
23599 @table @gcctabopt
23600 @item -m32
23601 @itemx -m64
23602 @opindex m32
23603 @opindex m64
23604 Generate code for a 32-bit or 64-bit environment.
23605 The 32-bit environment sets int, long and pointer to 32 bits.
23606 The 64-bit environment sets int to 32 bits and long and pointer
23607 to 64 bits.
23609 @item -mcmodel=@var{which}
23610 @opindex mcmodel
23611 Set the code model to one of
23613 @table @samp
23614 @item medlow
23615 The Medium/Low code model: 64-bit addresses, programs
23616 must be linked in the low 32 bits of memory.  Programs can be statically
23617 or dynamically linked.
23619 @item medmid
23620 The Medium/Middle code model: 64-bit addresses, programs
23621 must be linked in the low 44 bits of memory, the text and data segments must
23622 be less than 2GB in size and the data segment must be located within 2GB of
23623 the text segment.
23625 @item medany
23626 The Medium/Anywhere code model: 64-bit addresses, programs
23627 may be linked anywhere in memory, the text and data segments must be less
23628 than 2GB in size and the data segment must be located within 2GB of the
23629 text segment.
23631 @item embmedany
23632 The Medium/Anywhere code model for embedded systems:
23633 64-bit addresses, the text and data segments must be less than 2GB in
23634 size, both starting anywhere in memory (determined at link time).  The
23635 global register %g4 points to the base of the data segment.  Programs
23636 are statically linked and PIC is not supported.
23637 @end table
23639 @item -mmemory-model=@var{mem-model}
23640 @opindex mmemory-model
23641 Set the memory model in force on the processor to one of
23643 @table @samp
23644 @item default
23645 The default memory model for the processor and operating system.
23647 @item rmo
23648 Relaxed Memory Order
23650 @item pso
23651 Partial Store Order
23653 @item tso
23654 Total Store Order
23656 @item sc
23657 Sequential Consistency
23658 @end table
23660 These memory models are formally defined in Appendix D of the SPARC-V9
23661 architecture manual, as set in the processor's @code{PSTATE.MM} field.
23663 @item -mstack-bias
23664 @itemx -mno-stack-bias
23665 @opindex mstack-bias
23666 @opindex mno-stack-bias
23667 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
23668 frame pointer if present, are offset by @minus{}2047 which must be added back
23669 when making stack frame references.  This is the default in 64-bit mode.
23670 Otherwise, assume no such offset is present.
23671 @end table
23673 @node SPU Options
23674 @subsection SPU Options
23675 @cindex SPU options
23677 These @samp{-m} options are supported on the SPU:
23679 @table @gcctabopt
23680 @item -mwarn-reloc
23681 @itemx -merror-reloc
23682 @opindex mwarn-reloc
23683 @opindex merror-reloc
23685 The loader for SPU does not handle dynamic relocations.  By default, GCC
23686 gives an error when it generates code that requires a dynamic
23687 relocation.  @option{-mno-error-reloc} disables the error,
23688 @option{-mwarn-reloc} generates a warning instead.
23690 @item -msafe-dma
23691 @itemx -munsafe-dma
23692 @opindex msafe-dma
23693 @opindex munsafe-dma
23695 Instructions that initiate or test completion of DMA must not be
23696 reordered with respect to loads and stores of the memory that is being
23697 accessed.
23698 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
23699 memory accesses, but that can lead to inefficient code in places where the
23700 memory is known to not change.  Rather than mark the memory as volatile,
23701 you can use @option{-msafe-dma} to tell the compiler to treat
23702 the DMA instructions as potentially affecting all memory.  
23704 @item -mbranch-hints
23705 @opindex mbranch-hints
23707 By default, GCC generates a branch hint instruction to avoid
23708 pipeline stalls for always-taken or probably-taken branches.  A hint
23709 is not generated closer than 8 instructions away from its branch.
23710 There is little reason to disable them, except for debugging purposes,
23711 or to make an object a little bit smaller.
23713 @item -msmall-mem
23714 @itemx -mlarge-mem
23715 @opindex msmall-mem
23716 @opindex mlarge-mem
23718 By default, GCC generates code assuming that addresses are never larger
23719 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
23720 a full 32-bit address.
23722 @item -mstdmain
23723 @opindex mstdmain
23725 By default, GCC links against startup code that assumes the SPU-style
23726 main function interface (which has an unconventional parameter list).
23727 With @option{-mstdmain}, GCC links your program against startup
23728 code that assumes a C99-style interface to @code{main}, including a
23729 local copy of @code{argv} strings.
23731 @item -mfixed-range=@var{register-range}
23732 @opindex mfixed-range
23733 Generate code treating the given register range as fixed registers.
23734 A fixed register is one that the register allocator cannot use.  This is
23735 useful when compiling kernel code.  A register range is specified as
23736 two registers separated by a dash.  Multiple register ranges can be
23737 specified separated by a comma.
23739 @item -mea32
23740 @itemx -mea64
23741 @opindex mea32
23742 @opindex mea64
23743 Compile code assuming that pointers to the PPU address space accessed
23744 via the @code{__ea} named address space qualifier are either 32 or 64
23745 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
23746 all object code in an executable must be compiled with the same setting.
23748 @item -maddress-space-conversion
23749 @itemx -mno-address-space-conversion
23750 @opindex maddress-space-conversion
23751 @opindex mno-address-space-conversion
23752 Allow/disallow treating the @code{__ea} address space as superset
23753 of the generic address space.  This enables explicit type casts
23754 between @code{__ea} and generic pointer as well as implicit
23755 conversions of generic pointers to @code{__ea} pointers.  The
23756 default is to allow address space pointer conversions.
23758 @item -mcache-size=@var{cache-size}
23759 @opindex mcache-size
23760 This option controls the version of libgcc that the compiler links to an
23761 executable and selects a software-managed cache for accessing variables
23762 in the @code{__ea} address space with a particular cache size.  Possible
23763 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
23764 and @samp{128}.  The default cache size is 64KB.
23766 @item -matomic-updates
23767 @itemx -mno-atomic-updates
23768 @opindex matomic-updates
23769 @opindex mno-atomic-updates
23770 This option controls the version of libgcc that the compiler links to an
23771 executable and selects whether atomic updates to the software-managed
23772 cache of PPU-side variables are used.  If you use atomic updates, changes
23773 to a PPU variable from SPU code using the @code{__ea} named address space
23774 qualifier do not interfere with changes to other PPU variables residing
23775 in the same cache line from PPU code.  If you do not use atomic updates,
23776 such interference may occur; however, writing back cache lines is
23777 more efficient.  The default behavior is to use atomic updates.
23779 @item -mdual-nops
23780 @itemx -mdual-nops=@var{n}
23781 @opindex mdual-nops
23782 By default, GCC inserts NOPs to increase dual issue when it expects
23783 it to increase performance.  @var{n} can be a value from 0 to 10.  A
23784 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
23785 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
23787 @item -mhint-max-nops=@var{n}
23788 @opindex mhint-max-nops
23789 Maximum number of NOPs to insert for a branch hint.  A branch hint must
23790 be at least 8 instructions away from the branch it is affecting.  GCC
23791 inserts up to @var{n} NOPs to enforce this, otherwise it does not
23792 generate the branch hint.
23794 @item -mhint-max-distance=@var{n}
23795 @opindex mhint-max-distance
23796 The encoding of the branch hint instruction limits the hint to be within
23797 256 instructions of the branch it is affecting.  By default, GCC makes
23798 sure it is within 125.
23800 @item -msafe-hints
23801 @opindex msafe-hints
23802 Work around a hardware bug that causes the SPU to stall indefinitely.
23803 By default, GCC inserts the @code{hbrp} instruction to make sure
23804 this stall won't happen.
23806 @end table
23808 @node System V Options
23809 @subsection Options for System V
23811 These additional options are available on System V Release 4 for
23812 compatibility with other compilers on those systems:
23814 @table @gcctabopt
23815 @item -G
23816 @opindex G
23817 Create a shared object.
23818 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
23820 @item -Qy
23821 @opindex Qy
23822 Identify the versions of each tool used by the compiler, in a
23823 @code{.ident} assembler directive in the output.
23825 @item -Qn
23826 @opindex Qn
23827 Refrain from adding @code{.ident} directives to the output file (this is
23828 the default).
23830 @item -YP,@var{dirs}
23831 @opindex YP
23832 Search the directories @var{dirs}, and no others, for libraries
23833 specified with @option{-l}.
23835 @item -Ym,@var{dir}
23836 @opindex Ym
23837 Look in the directory @var{dir} to find the M4 preprocessor.
23838 The assembler uses this option.
23839 @c This is supposed to go with a -Yd for predefined M4 macro files, but
23840 @c the generic assembler that comes with Solaris takes just -Ym.
23841 @end table
23843 @node TILE-Gx Options
23844 @subsection TILE-Gx Options
23845 @cindex TILE-Gx options
23847 These @samp{-m} options are supported on the TILE-Gx:
23849 @table @gcctabopt
23850 @item -mcmodel=small
23851 @opindex mcmodel=small
23852 Generate code for the small model.  The distance for direct calls is
23853 limited to 500M in either direction.  PC-relative addresses are 32
23854 bits.  Absolute addresses support the full address range.
23856 @item -mcmodel=large
23857 @opindex mcmodel=large
23858 Generate code for the large model.  There is no limitation on call
23859 distance, pc-relative addresses, or absolute addresses.
23861 @item -mcpu=@var{name}
23862 @opindex mcpu
23863 Selects the type of CPU to be targeted.  Currently the only supported
23864 type is @samp{tilegx}.
23866 @item -m32
23867 @itemx -m64
23868 @opindex m32
23869 @opindex m64
23870 Generate code for a 32-bit or 64-bit environment.  The 32-bit
23871 environment sets int, long, and pointer to 32 bits.  The 64-bit
23872 environment sets int to 32 bits and long and pointer to 64 bits.
23874 @item -mbig-endian
23875 @itemx -mlittle-endian
23876 @opindex mbig-endian
23877 @opindex mlittle-endian
23878 Generate code in big/little endian mode, respectively.
23879 @end table
23881 @node TILEPro Options
23882 @subsection TILEPro Options
23883 @cindex TILEPro options
23885 These @samp{-m} options are supported on the TILEPro:
23887 @table @gcctabopt
23888 @item -mcpu=@var{name}
23889 @opindex mcpu
23890 Selects the type of CPU to be targeted.  Currently the only supported
23891 type is @samp{tilepro}.
23893 @item -m32
23894 @opindex m32
23895 Generate code for a 32-bit environment, which sets int, long, and
23896 pointer to 32 bits.  This is the only supported behavior so the flag
23897 is essentially ignored.
23898 @end table
23900 @node V850 Options
23901 @subsection V850 Options
23902 @cindex V850 Options
23904 These @samp{-m} options are defined for V850 implementations:
23906 @table @gcctabopt
23907 @item -mlong-calls
23908 @itemx -mno-long-calls
23909 @opindex mlong-calls
23910 @opindex mno-long-calls
23911 Treat all calls as being far away (near).  If calls are assumed to be
23912 far away, the compiler always loads the function's address into a
23913 register, and calls indirect through the pointer.
23915 @item -mno-ep
23916 @itemx -mep
23917 @opindex mno-ep
23918 @opindex mep
23919 Do not optimize (do optimize) basic blocks that use the same index
23920 pointer 4 or more times to copy pointer into the @code{ep} register, and
23921 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
23922 option is on by default if you optimize.
23924 @item -mno-prolog-function
23925 @itemx -mprolog-function
23926 @opindex mno-prolog-function
23927 @opindex mprolog-function
23928 Do not use (do use) external functions to save and restore registers
23929 at the prologue and epilogue of a function.  The external functions
23930 are slower, but use less code space if more than one function saves
23931 the same number of registers.  The @option{-mprolog-function} option
23932 is on by default if you optimize.
23934 @item -mspace
23935 @opindex mspace
23936 Try to make the code as small as possible.  At present, this just turns
23937 on the @option{-mep} and @option{-mprolog-function} options.
23939 @item -mtda=@var{n}
23940 @opindex mtda
23941 Put static or global variables whose size is @var{n} bytes or less into
23942 the tiny data area that register @code{ep} points to.  The tiny data
23943 area can hold up to 256 bytes in total (128 bytes for byte references).
23945 @item -msda=@var{n}
23946 @opindex msda
23947 Put static or global variables whose size is @var{n} bytes or less into
23948 the small data area that register @code{gp} points to.  The small data
23949 area can hold up to 64 kilobytes.
23951 @item -mzda=@var{n}
23952 @opindex mzda
23953 Put static or global variables whose size is @var{n} bytes or less into
23954 the first 32 kilobytes of memory.
23956 @item -mv850
23957 @opindex mv850
23958 Specify that the target processor is the V850.
23960 @item -mv850e3v5
23961 @opindex mv850e3v5
23962 Specify that the target processor is the V850E3V5.  The preprocessor
23963 constant @code{__v850e3v5__} is defined if this option is used.
23965 @item -mv850e2v4
23966 @opindex mv850e2v4
23967 Specify that the target processor is the V850E3V5.  This is an alias for
23968 the @option{-mv850e3v5} option.
23970 @item -mv850e2v3
23971 @opindex mv850e2v3
23972 Specify that the target processor is the V850E2V3.  The preprocessor
23973 constant @code{__v850e2v3__} is defined if this option is used.
23975 @item -mv850e2
23976 @opindex mv850e2
23977 Specify that the target processor is the V850E2.  The preprocessor
23978 constant @code{__v850e2__} is defined if this option is used.
23980 @item -mv850e1
23981 @opindex mv850e1
23982 Specify that the target processor is the V850E1.  The preprocessor
23983 constants @code{__v850e1__} and @code{__v850e__} are defined if
23984 this option is used.
23986 @item -mv850es
23987 @opindex mv850es
23988 Specify that the target processor is the V850ES.  This is an alias for
23989 the @option{-mv850e1} option.
23991 @item -mv850e
23992 @opindex mv850e
23993 Specify that the target processor is the V850E@.  The preprocessor
23994 constant @code{__v850e__} is defined if this option is used.
23996 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
23997 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
23998 are defined then a default target processor is chosen and the
23999 relevant @samp{__v850*__} preprocessor constant is defined.
24001 The preprocessor constants @code{__v850} and @code{__v851__} are always
24002 defined, regardless of which processor variant is the target.
24004 @item -mdisable-callt
24005 @itemx -mno-disable-callt
24006 @opindex mdisable-callt
24007 @opindex mno-disable-callt
24008 This option suppresses generation of the @code{CALLT} instruction for the
24009 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24010 architecture.
24012 This option is enabled by default when the RH850 ABI is
24013 in use (see @option{-mrh850-abi}), and disabled by default when the
24014 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24015 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24017 @item -mrelax
24018 @itemx -mno-relax
24019 @opindex mrelax
24020 @opindex mno-relax
24021 Pass on (or do not pass on) the @option{-mrelax} command-line option
24022 to the assembler.
24024 @item -mlong-jumps
24025 @itemx -mno-long-jumps
24026 @opindex mlong-jumps
24027 @opindex mno-long-jumps
24028 Disable (or re-enable) the generation of PC-relative jump instructions.
24030 @item -msoft-float
24031 @itemx -mhard-float
24032 @opindex msoft-float
24033 @opindex mhard-float
24034 Disable (or re-enable) the generation of hardware floating point
24035 instructions.  This option is only significant when the target
24036 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24037 instructions are being generated then the C preprocessor symbol
24038 @code{__FPU_OK__} is defined, otherwise the symbol
24039 @code{__NO_FPU__} is defined.
24041 @item -mloop
24042 @opindex mloop
24043 Enables the use of the e3v5 LOOP instruction.  The use of this
24044 instruction is not enabled by default when the e3v5 architecture is
24045 selected because its use is still experimental.
24047 @item -mrh850-abi
24048 @itemx -mghs
24049 @opindex mrh850-abi
24050 @opindex mghs
24051 Enables support for the RH850 version of the V850 ABI.  This is the
24052 default.  With this version of the ABI the following rules apply:
24054 @itemize
24055 @item
24056 Integer sized structures and unions are returned via a memory pointer
24057 rather than a register.
24059 @item
24060 Large structures and unions (more than 8 bytes in size) are passed by
24061 value.
24063 @item
24064 Functions are aligned to 16-bit boundaries.
24066 @item
24067 The @option{-m8byte-align} command-line option is supported.
24069 @item
24070 The @option{-mdisable-callt} command-line option is enabled by
24071 default.  The @option{-mno-disable-callt} command-line option is not
24072 supported.
24073 @end itemize
24075 When this version of the ABI is enabled the C preprocessor symbol
24076 @code{__V850_RH850_ABI__} is defined.
24078 @item -mgcc-abi
24079 @opindex mgcc-abi
24080 Enables support for the old GCC version of the V850 ABI.  With this
24081 version of the ABI the following rules apply:
24083 @itemize
24084 @item
24085 Integer sized structures and unions are returned in register @code{r10}.
24087 @item
24088 Large structures and unions (more than 8 bytes in size) are passed by
24089 reference.
24091 @item
24092 Functions are aligned to 32-bit boundaries, unless optimizing for
24093 size.
24095 @item
24096 The @option{-m8byte-align} command-line option is not supported.
24098 @item
24099 The @option{-mdisable-callt} command-line option is supported but not
24100 enabled by default.
24101 @end itemize
24103 When this version of the ABI is enabled the C preprocessor symbol
24104 @code{__V850_GCC_ABI__} is defined.
24106 @item -m8byte-align
24107 @itemx -mno-8byte-align
24108 @opindex m8byte-align
24109 @opindex mno-8byte-align
24110 Enables support for @code{double} and @code{long long} types to be
24111 aligned on 8-byte boundaries.  The default is to restrict the
24112 alignment of all objects to at most 4-bytes.  When
24113 @option{-m8byte-align} is in effect the C preprocessor symbol
24114 @code{__V850_8BYTE_ALIGN__} is defined.
24116 @item -mbig-switch
24117 @opindex mbig-switch
24118 Generate code suitable for big switch tables.  Use this option only if
24119 the assembler/linker complain about out of range branches within a switch
24120 table.
24122 @item -mapp-regs
24123 @opindex mapp-regs
24124 This option causes r2 and r5 to be used in the code generated by
24125 the compiler.  This setting is the default.
24127 @item -mno-app-regs
24128 @opindex mno-app-regs
24129 This option causes r2 and r5 to be treated as fixed registers.
24131 @end table
24133 @node VAX Options
24134 @subsection VAX Options
24135 @cindex VAX options
24137 These @samp{-m} options are defined for the VAX:
24139 @table @gcctabopt
24140 @item -munix
24141 @opindex munix
24142 Do not output certain jump instructions (@code{aobleq} and so on)
24143 that the Unix assembler for the VAX cannot handle across long
24144 ranges.
24146 @item -mgnu
24147 @opindex mgnu
24148 Do output those jump instructions, on the assumption that the
24149 GNU assembler is being used.
24151 @item -mg
24152 @opindex mg
24153 Output code for G-format floating-point numbers instead of D-format.
24154 @end table
24156 @node Visium Options
24157 @subsection Visium Options
24158 @cindex Visium options
24160 @table @gcctabopt
24162 @item -mdebug
24163 @opindex mdebug
24164 A program which performs file I/O and is destined to run on an MCM target
24165 should be linked with this option.  It causes the libraries libc.a and
24166 libdebug.a to be linked.  The program should be run on the target under
24167 the control of the GDB remote debugging stub.
24169 @item -msim
24170 @opindex msim
24171 A program which performs file I/O and is destined to run on the simulator
24172 should be linked with option.  This causes libraries libc.a and libsim.a to
24173 be linked.
24175 @item -mfpu
24176 @itemx -mhard-float
24177 @opindex mfpu
24178 @opindex mhard-float
24179 Generate code containing floating-point instructions.  This is the
24180 default.
24182 @item -mno-fpu
24183 @itemx -msoft-float
24184 @opindex mno-fpu
24185 @opindex msoft-float
24186 Generate code containing library calls for floating-point.
24188 @option{-msoft-float} changes the calling convention in the output file;
24189 therefore, it is only useful if you compile @emph{all} of a program with
24190 this option.  In particular, you need to compile @file{libgcc.a}, the
24191 library that comes with GCC, with @option{-msoft-float} in order for
24192 this to work.
24194 @item -mcpu=@var{cpu_type}
24195 @opindex mcpu
24196 Set the instruction set, register set, and instruction scheduling parameters
24197 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24198 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24200 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24202 By default (unless configured otherwise), GCC generates code for the GR5
24203 variant of the Visium architecture.  
24205 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24206 architecture.  The only difference from GR5 code is that the compiler will
24207 generate block move instructions.
24209 @item -mtune=@var{cpu_type}
24210 @opindex mtune
24211 Set the instruction scheduling parameters for machine type @var{cpu_type},
24212 but do not set the instruction set or register set that the option
24213 @option{-mcpu=@var{cpu_type}} would.
24215 @item -msv-mode
24216 @opindex msv-mode
24217 Generate code for the supervisor mode, where there are no restrictions on
24218 the access to general registers.  This is the default.
24220 @item -muser-mode
24221 @opindex muser-mode
24222 Generate code for the user mode, where the access to some general registers
24223 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24224 mode; on the GR6, only registers r29 to r31 are affected.
24225 @end table
24227 @node VMS Options
24228 @subsection VMS Options
24230 These @samp{-m} options are defined for the VMS implementations:
24232 @table @gcctabopt
24233 @item -mvms-return-codes
24234 @opindex mvms-return-codes
24235 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24236 condition (e.g.@ error) codes.
24238 @item -mdebug-main=@var{prefix}
24239 @opindex mdebug-main=@var{prefix}
24240 Flag the first routine whose name starts with @var{prefix} as the main
24241 routine for the debugger.
24243 @item -mmalloc64
24244 @opindex mmalloc64
24245 Default to 64-bit memory allocation routines.
24247 @item -mpointer-size=@var{size}
24248 @opindex mpointer-size=@var{size}
24249 Set the default size of pointers. Possible options for @var{size} are
24250 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24251 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24252 The later option disables @code{pragma pointer_size}.
24253 @end table
24255 @node VxWorks Options
24256 @subsection VxWorks Options
24257 @cindex VxWorks Options
24259 The options in this section are defined for all VxWorks targets.
24260 Options specific to the target hardware are listed with the other
24261 options for that target.
24263 @table @gcctabopt
24264 @item -mrtp
24265 @opindex mrtp
24266 GCC can generate code for both VxWorks kernels and real time processes
24267 (RTPs).  This option switches from the former to the latter.  It also
24268 defines the preprocessor macro @code{__RTP__}.
24270 @item -non-static
24271 @opindex non-static
24272 Link an RTP executable against shared libraries rather than static
24273 libraries.  The options @option{-static} and @option{-shared} can
24274 also be used for RTPs (@pxref{Link Options}); @option{-static}
24275 is the default.
24277 @item -Bstatic
24278 @itemx -Bdynamic
24279 @opindex Bstatic
24280 @opindex Bdynamic
24281 These options are passed down to the linker.  They are defined for
24282 compatibility with Diab.
24284 @item -Xbind-lazy
24285 @opindex Xbind-lazy
24286 Enable lazy binding of function calls.  This option is equivalent to
24287 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24289 @item -Xbind-now
24290 @opindex Xbind-now
24291 Disable lazy binding of function calls.  This option is the default and
24292 is defined for compatibility with Diab.
24293 @end table
24295 @node x86 Options
24296 @subsection x86 Options
24297 @cindex x86 Options
24299 These @samp{-m} options are defined for the x86 family of computers.
24301 @table @gcctabopt
24303 @item -march=@var{cpu-type}
24304 @opindex march
24305 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24306 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24307 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24308 to generate code that may not run at all on processors other than the one
24309 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24310 @option{-mtune=@var{cpu-type}}.
24312 The choices for @var{cpu-type} are:
24314 @table @samp
24315 @item native
24316 This selects the CPU to generate code for at compilation time by determining
24317 the processor type of the compiling machine.  Using @option{-march=native}
24318 enables all instruction subsets supported by the local machine (hence
24319 the result might not run on different machines).  Using @option{-mtune=native}
24320 produces code optimized for the local machine under the constraints
24321 of the selected instruction set.  
24323 @item i386
24324 Original Intel i386 CPU@.
24326 @item i486
24327 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24329 @item i586
24330 @itemx pentium
24331 Intel Pentium CPU with no MMX support.
24333 @item lakemont
24334 Intel Lakemont MCU, based on Intel Pentium CPU.
24336 @item pentium-mmx
24337 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24339 @item pentiumpro
24340 Intel Pentium Pro CPU@.
24342 @item i686
24343 When used with @option{-march}, the Pentium Pro
24344 instruction set is used, so the code runs on all i686 family chips.
24345 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24347 @item pentium2
24348 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24349 support.
24351 @item pentium3
24352 @itemx pentium3m
24353 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24354 set support.
24356 @item pentium-m
24357 Intel Pentium M; low-power version of Intel Pentium III CPU
24358 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24360 @item pentium4
24361 @itemx pentium4m
24362 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24364 @item prescott
24365 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24366 set support.
24368 @item nocona
24369 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24370 SSE2 and SSE3 instruction set support.
24372 @item core2
24373 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24374 instruction set support.
24376 @item nehalem
24377 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24378 SSE4.1, SSE4.2 and POPCNT instruction set support.
24380 @item westmere
24381 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24382 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24384 @item sandybridge
24385 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24386 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24388 @item ivybridge
24389 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24390 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24391 instruction set support.
24393 @item haswell
24394 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24395 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24396 BMI, BMI2 and F16C instruction set support.
24398 @item broadwell
24399 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24400 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24401 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24403 @item skylake
24404 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24405 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24406 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24407 XSAVES instruction set support.
24409 @item bonnell
24410 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24411 instruction set support.
24413 @item silvermont
24414 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24415 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24417 @item knl
24418 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24419 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24420 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24421 AVX512CD instruction set support.
24423 @item skylake-avx512
24424 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24425 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24426 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24427 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24429 @item k6
24430 AMD K6 CPU with MMX instruction set support.
24432 @item k6-2
24433 @itemx k6-3
24434 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24436 @item athlon
24437 @itemx athlon-tbird
24438 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24439 support.
24441 @item athlon-4
24442 @itemx athlon-xp
24443 @itemx athlon-mp
24444 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24445 instruction set support.
24447 @item k8
24448 @itemx opteron
24449 @itemx athlon64
24450 @itemx athlon-fx
24451 Processors based on the AMD K8 core with x86-64 instruction set support,
24452 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24453 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24454 instruction set extensions.)
24456 @item k8-sse3
24457 @itemx opteron-sse3
24458 @itemx athlon64-sse3
24459 Improved versions of AMD K8 cores with SSE3 instruction set support.
24461 @item amdfam10
24462 @itemx barcelona
24463 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24464 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24465 instruction set extensions.)
24467 @item bdver1
24468 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24469 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24470 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24471 @item bdver2
24472 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24473 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24474 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24475 extensions.)
24476 @item bdver3
24477 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24478 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24479 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24480 64-bit instruction set extensions.
24481 @item bdver4
24482 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24483 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24484 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24485 SSE4.2, ABM and 64-bit instruction set extensions.
24487 @item znver1
24488 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24489 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24490 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24491 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24492 instruction set extensions.
24494 @item btver1
24495 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24496 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24497 instruction set extensions.)
24499 @item btver2
24500 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24501 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24502 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24504 @item winchip-c6
24505 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24506 set support.
24508 @item winchip2
24509 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24510 instruction set support.
24512 @item c3
24513 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24514 (No scheduling is implemented for this chip.)
24516 @item c3-2
24517 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24518 (No scheduling is implemented for this chip.)
24520 @item c7
24521 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24522 (No scheduling is implemented for this chip.)
24524 @item samuel-2
24525 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24526 (No scheduling is implemented for this chip.)
24528 @item nehemiah
24529 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24530 (No scheduling is implemented for this chip.)
24532 @item esther
24533 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24534 (No scheduling is implemented for this chip.)
24536 @item eden-x2
24537 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24538 (No scheduling is implemented for this chip.)
24540 @item eden-x4
24541 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24542 AVX and AVX2 instruction set support.
24543 (No scheduling is implemented for this chip.)
24545 @item nano
24546 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24547 instruction set support.
24548 (No scheduling is implemented for this chip.)
24550 @item nano-1000
24551 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24552 instruction set support.
24553 (No scheduling is implemented for this chip.)
24555 @item nano-2000
24556 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24557 instruction set support.
24558 (No scheduling is implemented for this chip.)
24560 @item nano-3000
24561 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24562 instruction set support.
24563 (No scheduling is implemented for this chip.)
24565 @item nano-x2
24566 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24567 instruction set support.
24568 (No scheduling is implemented for this chip.)
24570 @item nano-x4
24571 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24572 instruction set support.
24573 (No scheduling is implemented for this chip.)
24575 @item geode
24576 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
24577 @end table
24579 @item -mtune=@var{cpu-type}
24580 @opindex mtune
24581 Tune to @var{cpu-type} everything applicable about the generated code, except
24582 for the ABI and the set of available instructions.  
24583 While picking a specific @var{cpu-type} schedules things appropriately
24584 for that particular chip, the compiler does not generate any code that
24585 cannot run on the default machine type unless you use a
24586 @option{-march=@var{cpu-type}} option.
24587 For example, if GCC is configured for i686-pc-linux-gnu
24588 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
24589 but still runs on i686 machines.
24591 The choices for @var{cpu-type} are the same as for @option{-march}.
24592 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
24594 @table @samp
24595 @item generic
24596 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
24597 If you know the CPU on which your code will run, then you should use
24598 the corresponding @option{-mtune} or @option{-march} option instead of
24599 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
24600 of your application will have, then you should use this option.
24602 As new processors are deployed in the marketplace, the behavior of this
24603 option will change.  Therefore, if you upgrade to a newer version of
24604 GCC, code generation controlled by this option will change to reflect
24605 the processors
24606 that are most common at the time that version of GCC is released.
24608 There is no @option{-march=generic} option because @option{-march}
24609 indicates the instruction set the compiler can use, and there is no
24610 generic instruction set applicable to all processors.  In contrast,
24611 @option{-mtune} indicates the processor (or, in this case, collection of
24612 processors) for which the code is optimized.
24614 @item intel
24615 Produce code optimized for the most current Intel processors, which are
24616 Haswell and Silvermont for this version of GCC.  If you know the CPU
24617 on which your code will run, then you should use the corresponding
24618 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
24619 But, if you want your application performs better on both Haswell and
24620 Silvermont, then you should use this option.
24622 As new Intel processors are deployed in the marketplace, the behavior of
24623 this option will change.  Therefore, if you upgrade to a newer version of
24624 GCC, code generation controlled by this option will change to reflect
24625 the most current Intel processors at the time that version of GCC is
24626 released.
24628 There is no @option{-march=intel} option because @option{-march} indicates
24629 the instruction set the compiler can use, and there is no common
24630 instruction set applicable to all processors.  In contrast,
24631 @option{-mtune} indicates the processor (or, in this case, collection of
24632 processors) for which the code is optimized.
24633 @end table
24635 @item -mcpu=@var{cpu-type}
24636 @opindex mcpu
24637 A deprecated synonym for @option{-mtune}.
24639 @item -mfpmath=@var{unit}
24640 @opindex mfpmath
24641 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
24642 for @var{unit} are:
24644 @table @samp
24645 @item 387
24646 Use the standard 387 floating-point coprocessor present on the majority of chips and
24647 emulated otherwise.  Code compiled with this option runs almost everywhere.
24648 The temporary results are computed in 80-bit precision instead of the precision
24649 specified by the type, resulting in slightly different results compared to most
24650 of other chips.  See @option{-ffloat-store} for more detailed description.
24652 This is the default choice for non-Darwin x86-32 targets.
24654 @item sse
24655 Use scalar floating-point instructions present in the SSE instruction set.
24656 This instruction set is supported by Pentium III and newer chips,
24657 and in the AMD line
24658 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
24659 instruction set supports only single-precision arithmetic, thus the double and
24660 extended-precision arithmetic are still done using 387.  A later version, present
24661 only in Pentium 4 and AMD x86-64 chips, supports double-precision
24662 arithmetic too.
24664 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
24665 or @option{-msse2} switches to enable SSE extensions and make this option
24666 effective.  For the x86-64 compiler, these extensions are enabled by default.
24668 The resulting code should be considerably faster in the majority of cases and avoid
24669 the numerical instability problems of 387 code, but may break some existing
24670 code that expects temporaries to be 80 bits.
24672 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
24673 and the default choice for x86-32 targets with the SSE2 instruction set
24674 when @option{-ffast-math} is enabled.
24676 @item sse,387
24677 @itemx sse+387
24678 @itemx both
24679 Attempt to utilize both instruction sets at once.  This effectively doubles the
24680 amount of available registers, and on chips with separate execution units for
24681 387 and SSE the execution resources too.  Use this option with care, as it is
24682 still experimental, because the GCC register allocator does not model separate
24683 functional units well, resulting in unstable performance.
24684 @end table
24686 @item -masm=@var{dialect}
24687 @opindex masm=@var{dialect}
24688 Output assembly instructions using selected @var{dialect}.  Also affects
24689 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
24690 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
24691 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
24692 not support @samp{intel}.
24694 @item -mieee-fp
24695 @itemx -mno-ieee-fp
24696 @opindex mieee-fp
24697 @opindex mno-ieee-fp
24698 Control whether or not the compiler uses IEEE floating-point
24699 comparisons.  These correctly handle the case where the result of a
24700 comparison is unordered.
24702 @item -m80387
24703 @item -mhard-float
24704 @opindex 80387
24705 @opindex mhard-float
24706 Generate output containing 80387 instructions for floating point.
24708 @item -mno-80387
24709 @item -msoft-float
24710 @opindex no-80387
24711 @opindex msoft-float
24712 Generate output containing library calls for floating point.
24714 @strong{Warning:} the requisite libraries are not part of GCC@.
24715 Normally the facilities of the machine's usual C compiler are used, but
24716 this cannot be done directly in cross-compilation.  You must make your
24717 own arrangements to provide suitable library functions for
24718 cross-compilation.
24720 On machines where a function returns floating-point results in the 80387
24721 register stack, some floating-point opcodes may be emitted even if
24722 @option{-msoft-float} is used.
24724 @item -mno-fp-ret-in-387
24725 @opindex mno-fp-ret-in-387
24726 Do not use the FPU registers for return values of functions.
24728 The usual calling convention has functions return values of types
24729 @code{float} and @code{double} in an FPU register, even if there
24730 is no FPU@.  The idea is that the operating system should emulate
24731 an FPU@.
24733 The option @option{-mno-fp-ret-in-387} causes such values to be returned
24734 in ordinary CPU registers instead.
24736 @item -mno-fancy-math-387
24737 @opindex mno-fancy-math-387
24738 Some 387 emulators do not support the @code{sin}, @code{cos} and
24739 @code{sqrt} instructions for the 387.  Specify this option to avoid
24740 generating those instructions.  This option is the default on
24741 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
24742 indicates that the target CPU always has an FPU and so the
24743 instruction does not need emulation.  These
24744 instructions are not generated unless you also use the
24745 @option{-funsafe-math-optimizations} switch.
24747 @item -malign-double
24748 @itemx -mno-align-double
24749 @opindex malign-double
24750 @opindex mno-align-double
24751 Control whether GCC aligns @code{double}, @code{long double}, and
24752 @code{long long} variables on a two-word boundary or a one-word
24753 boundary.  Aligning @code{double} variables on a two-word boundary
24754 produces code that runs somewhat faster on a Pentium at the
24755 expense of more memory.
24757 On x86-64, @option{-malign-double} is enabled by default.
24759 @strong{Warning:} if you use the @option{-malign-double} switch,
24760 structures containing the above types are aligned differently than
24761 the published application binary interface specifications for the x86-32
24762 and are not binary compatible with structures in code compiled
24763 without that switch.
24765 @item -m96bit-long-double
24766 @itemx -m128bit-long-double
24767 @opindex m96bit-long-double
24768 @opindex m128bit-long-double
24769 These switches control the size of @code{long double} type.  The x86-32
24770 application binary interface specifies the size to be 96 bits,
24771 so @option{-m96bit-long-double} is the default in 32-bit mode.
24773 Modern architectures (Pentium and newer) prefer @code{long double}
24774 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
24775 conforming to the ABI, this is not possible.  So specifying
24776 @option{-m128bit-long-double} aligns @code{long double}
24777 to a 16-byte boundary by padding the @code{long double} with an additional
24778 32-bit zero.
24780 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
24781 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
24783 Notice that neither of these options enable any extra precision over the x87
24784 standard of 80 bits for a @code{long double}.
24786 @strong{Warning:} if you override the default value for your target ABI, this
24787 changes the size of 
24788 structures and arrays containing @code{long double} variables,
24789 as well as modifying the function calling convention for functions taking
24790 @code{long double}.  Hence they are not binary-compatible
24791 with code compiled without that switch.
24793 @item -mlong-double-64
24794 @itemx -mlong-double-80
24795 @itemx -mlong-double-128
24796 @opindex mlong-double-64
24797 @opindex mlong-double-80
24798 @opindex mlong-double-128
24799 These switches control the size of @code{long double} type. A size
24800 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24801 type. This is the default for 32-bit Bionic C library.  A size
24802 of 128 bits makes the @code{long double} type equivalent to the
24803 @code{__float128} type. This is the default for 64-bit Bionic C library.
24805 @strong{Warning:} if you override the default value for your target ABI, this
24806 changes the size of
24807 structures and arrays containing @code{long double} variables,
24808 as well as modifying the function calling convention for functions taking
24809 @code{long double}.  Hence they are not binary-compatible
24810 with code compiled without that switch.
24812 @item -malign-data=@var{type}
24813 @opindex malign-data
24814 Control how GCC aligns variables.  Supported values for @var{type} are
24815 @samp{compat} uses increased alignment value compatible uses GCC 4.8
24816 and earlier, @samp{abi} uses alignment value as specified by the
24817 psABI, and @samp{cacheline} uses increased alignment value to match
24818 the cache line size.  @samp{compat} is the default.
24820 @item -mlarge-data-threshold=@var{threshold}
24821 @opindex mlarge-data-threshold
24822 When @option{-mcmodel=medium} is specified, data objects larger than
24823 @var{threshold} are placed in the large data section.  This value must be the
24824 same across all objects linked into the binary, and defaults to 65535.
24826 @item -mrtd
24827 @opindex mrtd
24828 Use a different function-calling convention, in which functions that
24829 take a fixed number of arguments return with the @code{ret @var{num}}
24830 instruction, which pops their arguments while returning.  This saves one
24831 instruction in the caller since there is no need to pop the arguments
24832 there.
24834 You can specify that an individual function is called with this calling
24835 sequence with the function attribute @code{stdcall}.  You can also
24836 override the @option{-mrtd} option by using the function attribute
24837 @code{cdecl}.  @xref{Function Attributes}.
24839 @strong{Warning:} this calling convention is incompatible with the one
24840 normally used on Unix, so you cannot use it if you need to call
24841 libraries compiled with the Unix compiler.
24843 Also, you must provide function prototypes for all functions that
24844 take variable numbers of arguments (including @code{printf});
24845 otherwise incorrect code is generated for calls to those
24846 functions.
24848 In addition, seriously incorrect code results if you call a
24849 function with too many arguments.  (Normally, extra arguments are
24850 harmlessly ignored.)
24852 @item -mregparm=@var{num}
24853 @opindex mregparm
24854 Control how many registers are used to pass integer arguments.  By
24855 default, no registers are used to pass arguments, and at most 3
24856 registers can be used.  You can control this behavior for a specific
24857 function by using the function attribute @code{regparm}.
24858 @xref{Function Attributes}.
24860 @strong{Warning:} if you use this switch, and
24861 @var{num} is nonzero, then you must build all modules with the same
24862 value, including any libraries.  This includes the system libraries and
24863 startup modules.
24865 @item -msseregparm
24866 @opindex msseregparm
24867 Use SSE register passing conventions for float and double arguments
24868 and return values.  You can control this behavior for a specific
24869 function by using the function attribute @code{sseregparm}.
24870 @xref{Function Attributes}.
24872 @strong{Warning:} if you use this switch then you must build all
24873 modules with the same value, including any libraries.  This includes
24874 the system libraries and startup modules.
24876 @item -mvect8-ret-in-mem
24877 @opindex mvect8-ret-in-mem
24878 Return 8-byte vectors in memory instead of MMX registers.  This is the
24879 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
24880 Studio compilers until version 12.  Later compiler versions (starting
24881 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
24882 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
24883 you need to remain compatible with existing code produced by those
24884 previous compiler versions or older versions of GCC@.
24886 @item -mpc32
24887 @itemx -mpc64
24888 @itemx -mpc80
24889 @opindex mpc32
24890 @opindex mpc64
24891 @opindex mpc80
24893 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
24894 is specified, the significands of results of floating-point operations are
24895 rounded to 24 bits (single precision); @option{-mpc64} rounds the
24896 significands of results of floating-point operations to 53 bits (double
24897 precision) and @option{-mpc80} rounds the significands of results of
24898 floating-point operations to 64 bits (extended double precision), which is
24899 the default.  When this option is used, floating-point operations in higher
24900 precisions are not available to the programmer without setting the FPU
24901 control word explicitly.
24903 Setting the rounding of floating-point operations to less than the default
24904 80 bits can speed some programs by 2% or more.  Note that some mathematical
24905 libraries assume that extended-precision (80-bit) floating-point operations
24906 are enabled by default; routines in such libraries could suffer significant
24907 loss of accuracy, typically through so-called ``catastrophic cancellation'',
24908 when this option is used to set the precision to less than extended precision.
24910 @item -mstackrealign
24911 @opindex mstackrealign
24912 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
24913 option generates an alternate prologue and epilogue that realigns the
24914 run-time stack if necessary.  This supports mixing legacy codes that keep
24915 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
24916 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
24917 applicable to individual functions.
24919 @item -mpreferred-stack-boundary=@var{num}
24920 @opindex mpreferred-stack-boundary
24921 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
24922 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
24923 the default is 4 (16 bytes or 128 bits).
24925 @strong{Warning:} When generating code for the x86-64 architecture with
24926 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
24927 used to keep the stack boundary aligned to 8 byte boundary.  Since
24928 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
24929 intended to be used in controlled environment where stack space is
24930 important limitation.  This option leads to wrong code when functions
24931 compiled with 16 byte stack alignment (such as functions from a standard
24932 library) are called with misaligned stack.  In this case, SSE
24933 instructions may lead to misaligned memory access traps.  In addition,
24934 variable arguments are handled incorrectly for 16 byte aligned
24935 objects (including x87 long double and __int128), leading to wrong
24936 results.  You must build all modules with
24937 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
24938 includes the system libraries and startup modules.
24940 @item -mincoming-stack-boundary=@var{num}
24941 @opindex mincoming-stack-boundary
24942 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
24943 boundary.  If @option{-mincoming-stack-boundary} is not specified,
24944 the one specified by @option{-mpreferred-stack-boundary} is used.
24946 On Pentium and Pentium Pro, @code{double} and @code{long double} values
24947 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
24948 suffer significant run time performance penalties.  On Pentium III, the
24949 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
24950 properly if it is not 16-byte aligned.
24952 To ensure proper alignment of this values on the stack, the stack boundary
24953 must be as aligned as that required by any value stored on the stack.
24954 Further, every function must be generated such that it keeps the stack
24955 aligned.  Thus calling a function compiled with a higher preferred
24956 stack boundary from a function compiled with a lower preferred stack
24957 boundary most likely misaligns the stack.  It is recommended that
24958 libraries that use callbacks always use the default setting.
24960 This extra alignment does consume extra stack space, and generally
24961 increases code size.  Code that is sensitive to stack space usage, such
24962 as embedded systems and operating system kernels, may want to reduce the
24963 preferred alignment to @option{-mpreferred-stack-boundary=2}.
24965 @need 200
24966 @item -mmmx
24967 @opindex mmmx
24968 @need 200
24969 @itemx -msse
24970 @opindex msse
24971 @need 200
24972 @itemx -msse2
24973 @opindex msse2
24974 @need 200
24975 @itemx -msse3
24976 @opindex msse3
24977 @need 200
24978 @itemx -mssse3
24979 @opindex mssse3
24980 @need 200
24981 @itemx -msse4
24982 @opindex msse4
24983 @need 200
24984 @itemx -msse4a
24985 @opindex msse4a
24986 @need 200
24987 @itemx -msse4.1
24988 @opindex msse4.1
24989 @need 200
24990 @itemx -msse4.2
24991 @opindex msse4.2
24992 @need 200
24993 @itemx -mavx
24994 @opindex mavx
24995 @need 200
24996 @itemx -mavx2
24997 @opindex mavx2
24998 @need 200
24999 @itemx -mavx512f
25000 @opindex mavx512f
25001 @need 200
25002 @itemx -mavx512pf
25003 @opindex mavx512pf
25004 @need 200
25005 @itemx -mavx512er
25006 @opindex mavx512er
25007 @need 200
25008 @itemx -mavx512cd
25009 @opindex mavx512cd
25010 @need 200
25011 @itemx -mavx512vl
25012 @opindex mavx512vl
25013 @need 200
25014 @itemx -mavx512bw
25015 @opindex mavx512bw
25016 @need 200
25017 @itemx -mavx512dq
25018 @opindex mavx512dq
25019 @need 200
25020 @itemx -mavx512ifma
25021 @opindex mavx512ifma
25022 @need 200
25023 @itemx -mavx512vbmi
25024 @opindex mavx512vbmi
25025 @need 200
25026 @itemx -msha
25027 @opindex msha
25028 @need 200
25029 @itemx -maes
25030 @opindex maes
25031 @need 200
25032 @itemx -mpclmul
25033 @opindex mpclmul
25034 @need 200
25035 @itemx -mclfushopt
25036 @opindex mclfushopt
25037 @need 200
25038 @itemx -mfsgsbase
25039 @opindex mfsgsbase
25040 @need 200
25041 @itemx -mrdrnd
25042 @opindex mrdrnd
25043 @need 200
25044 @itemx -mf16c
25045 @opindex mf16c
25046 @need 200
25047 @itemx -mfma
25048 @opindex mfma
25049 @need 200
25050 @itemx -mfma4
25051 @opindex mfma4
25052 @need 200
25053 @itemx -mprefetchwt1
25054 @opindex mprefetchwt1
25055 @need 200
25056 @itemx -mxop
25057 @opindex mxop
25058 @need 200
25059 @itemx -mlwp
25060 @opindex mlwp
25061 @need 200
25062 @itemx -m3dnow
25063 @opindex m3dnow
25064 @need 200
25065 @itemx -m3dnowa
25066 @opindex m3dnowa
25067 @need 200
25068 @itemx -mpopcnt
25069 @opindex mpopcnt
25070 @need 200
25071 @itemx -mabm
25072 @opindex mabm
25073 @need 200
25074 @itemx -mbmi
25075 @opindex mbmi
25076 @need 200
25077 @itemx -mbmi2
25078 @need 200
25079 @itemx -mlzcnt
25080 @opindex mlzcnt
25081 @need 200
25082 @itemx -mfxsr
25083 @opindex mfxsr
25084 @need 200
25085 @itemx -mxsave
25086 @opindex mxsave
25087 @need 200
25088 @itemx -mxsaveopt
25089 @opindex mxsaveopt
25090 @need 200
25091 @itemx -mxsavec
25092 @opindex mxsavec
25093 @need 200
25094 @itemx -mxsaves
25095 @opindex mxsaves
25096 @need 200
25097 @itemx -mrtm
25098 @opindex mrtm
25099 @need 200
25100 @itemx -mtbm
25101 @opindex mtbm
25102 @need 200
25103 @itemx -mmpx
25104 @opindex mmpx
25105 @need 200
25106 @itemx -mmwaitx
25107 @opindex mmwaitx
25108 @need 200
25109 @itemx -mclzero
25110 @opindex mclzero
25111 @itemx -mpku
25112 @opindex mpku
25113 These switches enable the use of instructions in the MMX, SSE,
25114 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25115 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25116 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25117 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25118 extended instruction sets.  Each has a corresponding @option{-mno-} option
25119 to disable use of these instructions.
25121 These extensions are also available as built-in functions: see
25122 @ref{x86 Built-in Functions}, for details of the functions enabled and
25123 disabled by these switches.
25125 To generate SSE/SSE2 instructions automatically from floating-point
25126 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25128 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25129 generates new AVX instructions or AVX equivalence for all SSEx instructions
25130 when needed.
25132 These options enable GCC to use these extended instructions in
25133 generated code, even without @option{-mfpmath=sse}.  Applications that
25134 perform run-time CPU detection must compile separate files for each
25135 supported architecture, using the appropriate flags.  In particular,
25136 the file containing the CPU detection code should be compiled without
25137 these options.
25139 @item -mdump-tune-features
25140 @opindex mdump-tune-features
25141 This option instructs GCC to dump the names of the x86 performance 
25142 tuning features and default settings. The names can be used in 
25143 @option{-mtune-ctrl=@var{feature-list}}.
25145 @item -mtune-ctrl=@var{feature-list}
25146 @opindex mtune-ctrl=@var{feature-list}
25147 This option is used to do fine grain control of x86 code generation features.
25148 @var{feature-list} is a comma separated list of @var{feature} names. See also
25149 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25150 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25151 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25152 developers. Using it may lead to code paths not covered by testing and can
25153 potentially result in compiler ICEs or runtime errors.
25155 @item -mno-default
25156 @opindex mno-default
25157 This option instructs GCC to turn off all tunable features. See also 
25158 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25160 @item -mcld
25161 @opindex mcld
25162 This option instructs GCC to emit a @code{cld} instruction in the prologue
25163 of functions that use string instructions.  String instructions depend on
25164 the DF flag to select between autoincrement or autodecrement mode.  While the
25165 ABI specifies the DF flag to be cleared on function entry, some operating
25166 systems violate this specification by not clearing the DF flag in their
25167 exception dispatchers.  The exception handler can be invoked with the DF flag
25168 set, which leads to wrong direction mode when string instructions are used.
25169 This option can be enabled by default on 32-bit x86 targets by configuring
25170 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25171 instructions can be suppressed with the @option{-mno-cld} compiler option
25172 in this case.
25174 @item -mvzeroupper
25175 @opindex mvzeroupper
25176 This option instructs GCC to emit a @code{vzeroupper} instruction
25177 before a transfer of control flow out of the function to minimize
25178 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25179 intrinsics.
25181 @item -mprefer-avx128
25182 @opindex mprefer-avx128
25183 This option instructs GCC to use 128-bit AVX instructions instead of
25184 256-bit AVX instructions in the auto-vectorizer.
25186 @item -mcx16
25187 @opindex mcx16
25188 This option enables GCC to generate @code{CMPXCHG16B} instructions.
25189 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
25190 (or oword) data types.  
25191 This is useful for high-resolution counters that can be updated
25192 by multiple processors (or cores).  This instruction is generated as part of
25193 atomic built-in functions: see @ref{__sync Builtins} or
25194 @ref{__atomic Builtins} for details.
25196 @item -msahf
25197 @opindex msahf
25198 This option enables generation of @code{SAHF} instructions in 64-bit code.
25199 Early Intel Pentium 4 CPUs with Intel 64 support,
25200 prior to the introduction of Pentium 4 G1 step in December 2005,
25201 lacked the @code{LAHF} and @code{SAHF} instructions
25202 which are supported by AMD64.
25203 These are load and store instructions, respectively, for certain status flags.
25204 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25205 @code{drem}, and @code{remainder} built-in functions;
25206 see @ref{Other Builtins} for details.
25208 @item -mmovbe
25209 @opindex mmovbe
25210 This option enables use of the @code{movbe} instruction to implement
25211 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25213 @item -mcrc32
25214 @opindex mcrc32
25215 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25216 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25217 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25219 @item -mrecip
25220 @opindex mrecip
25221 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25222 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25223 with an additional Newton-Raphson step
25224 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25225 (and their vectorized
25226 variants) for single-precision floating-point arguments.  These instructions
25227 are generated only when @option{-funsafe-math-optimizations} is enabled
25228 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25229 Note that while the throughput of the sequence is higher than the throughput
25230 of the non-reciprocal instruction, the precision of the sequence can be
25231 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25233 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25234 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25235 combination), and doesn't need @option{-mrecip}.
25237 Also note that GCC emits the above sequence with additional Newton-Raphson step
25238 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25239 already with @option{-ffast-math} (or the above option combination), and
25240 doesn't need @option{-mrecip}.
25242 @item -mrecip=@var{opt}
25243 @opindex mrecip=opt
25244 This option controls which reciprocal estimate instructions
25245 may be used.  @var{opt} is a comma-separated list of options, which may
25246 be preceded by a @samp{!} to invert the option:
25248 @table @samp
25249 @item all
25250 Enable all estimate instructions.
25252 @item default
25253 Enable the default instructions, equivalent to @option{-mrecip}.
25255 @item none
25256 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25258 @item div
25259 Enable the approximation for scalar division.
25261 @item vec-div
25262 Enable the approximation for vectorized division.
25264 @item sqrt
25265 Enable the approximation for scalar square root.
25267 @item vec-sqrt
25268 Enable the approximation for vectorized square root.
25269 @end table
25271 So, for example, @option{-mrecip=all,!sqrt} enables
25272 all of the reciprocal approximations, except for square root.
25274 @item -mveclibabi=@var{type}
25275 @opindex mveclibabi
25276 Specifies the ABI type to use for vectorizing intrinsics using an
25277 external library.  Supported values for @var{type} are @samp{svml} 
25278 for the Intel short
25279 vector math library and @samp{acml} for the AMD math core library.
25280 To use this option, both @option{-ftree-vectorize} and
25281 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25282 ABI-compatible library must be specified at link time.
25284 GCC currently emits calls to @code{vmldExp2},
25285 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25286 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25287 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25288 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25289 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25290 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25291 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25292 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25293 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25294 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25295 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25296 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25297 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25298 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25299 when @option{-mveclibabi=acml} is used.  
25301 @item -mabi=@var{name}
25302 @opindex mabi
25303 Generate code for the specified calling convention.  Permissible values
25304 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25305 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25306 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25307 You can control this behavior for specific functions by
25308 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25309 @xref{Function Attributes}.
25311 @item -mtls-dialect=@var{type}
25312 @opindex mtls-dialect
25313 Generate code to access thread-local storage using the @samp{gnu} or
25314 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25315 @samp{gnu2} is more efficient, but it may add compile- and run-time
25316 requirements that cannot be satisfied on all systems.
25318 @item -mpush-args
25319 @itemx -mno-push-args
25320 @opindex mpush-args
25321 @opindex mno-push-args
25322 Use PUSH operations to store outgoing parameters.  This method is shorter
25323 and usually equally fast as method using SUB/MOV operations and is enabled
25324 by default.  In some cases disabling it may improve performance because of
25325 improved scheduling and reduced dependencies.
25327 @item -maccumulate-outgoing-args
25328 @opindex maccumulate-outgoing-args
25329 If enabled, the maximum amount of space required for outgoing arguments is
25330 computed in the function prologue.  This is faster on most modern CPUs
25331 because of reduced dependencies, improved scheduling and reduced stack usage
25332 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25333 increase in code size.  This switch implies @option{-mno-push-args}.
25335 @item -mthreads
25336 @opindex mthreads
25337 Support thread-safe exception handling on MinGW.  Programs that rely
25338 on thread-safe exception handling must compile and link all code with the
25339 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25340 @option{-D_MT}; when linking, it links in a special thread helper library
25341 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25343 @item -mms-bitfields
25344 @itemx -mno-ms-bitfields
25345 @opindex mms-bitfields
25346 @opindex mno-ms-bitfields
25348 Enable/disable bit-field layout compatible with the native Microsoft
25349 Windows compiler.  
25351 If @code{packed} is used on a structure, or if bit-fields are used,
25352 it may be that the Microsoft ABI lays out the structure differently
25353 than the way GCC normally does.  Particularly when moving packed
25354 data between functions compiled with GCC and the native Microsoft compiler
25355 (either via function call or as data in a file), it may be necessary to access
25356 either format.
25358 This option is enabled by default for Microsoft Windows
25359 targets.  This behavior can also be controlled locally by use of variable
25360 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25361 and @ref{x86 Type Attributes}.
25363 The Microsoft structure layout algorithm is fairly simple with the exception
25364 of the bit-field packing.  
25365 The padding and alignment of members of structures and whether a bit-field 
25366 can straddle a storage-unit boundary are determine by these rules:
25368 @enumerate
25369 @item Structure members are stored sequentially in the order in which they are
25370 declared: the first member has the lowest memory address and the last member
25371 the highest.
25373 @item Every data object has an alignment requirement.  The alignment requirement
25374 for all data except structures, unions, and arrays is either the size of the
25375 object or the current packing size (specified with either the
25376 @code{aligned} attribute or the @code{pack} pragma),
25377 whichever is less.  For structures, unions, and arrays,
25378 the alignment requirement is the largest alignment requirement of its members.
25379 Every object is allocated an offset so that:
25381 @smallexample
25382 offset % alignment_requirement == 0
25383 @end smallexample
25385 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25386 unit if the integral types are the same size and if the next bit-field fits
25387 into the current allocation unit without crossing the boundary imposed by the
25388 common alignment requirements of the bit-fields.
25389 @end enumerate
25391 MSVC interprets zero-length bit-fields in the following ways:
25393 @enumerate
25394 @item If a zero-length bit-field is inserted between two bit-fields that
25395 are normally coalesced, the bit-fields are not coalesced.
25397 For example:
25399 @smallexample
25400 struct
25401  @{
25402    unsigned long bf_1 : 12;
25403    unsigned long : 0;
25404    unsigned long bf_2 : 12;
25405  @} t1;
25406 @end smallexample
25408 @noindent
25409 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25410 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25412 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25413 alignment of the zero-length bit-field is greater than the member that follows it,
25414 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25416 For example:
25418 @smallexample
25419 struct
25420  @{
25421    char foo : 4;
25422    short : 0;
25423    char bar;
25424  @} t2;
25426 struct
25427  @{
25428    char foo : 4;
25429    short : 0;
25430    double bar;
25431  @} t3;
25432 @end smallexample
25434 @noindent
25435 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25436 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25437 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25438 of the structure.
25440 Taking this into account, it is important to note the following:
25442 @enumerate
25443 @item If a zero-length bit-field follows a normal bit-field, the type of the
25444 zero-length bit-field may affect the alignment of the structure as whole. For
25445 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25446 normal bit-field, and is of type short.
25448 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25449 still affect the alignment of the structure:
25451 @smallexample
25452 struct
25453  @{
25454    char foo : 6;
25455    long : 0;
25456  @} t4;
25457 @end smallexample
25459 @noindent
25460 Here, @code{t4} takes up 4 bytes.
25461 @end enumerate
25463 @item Zero-length bit-fields following non-bit-field members are ignored:
25465 @smallexample
25466 struct
25467  @{
25468    char foo;
25469    long : 0;
25470    char bar;
25471  @} t5;
25472 @end smallexample
25474 @noindent
25475 Here, @code{t5} takes up 2 bytes.
25476 @end enumerate
25479 @item -mno-align-stringops
25480 @opindex mno-align-stringops
25481 Do not align the destination of inlined string operations.  This switch reduces
25482 code size and improves performance in case the destination is already aligned,
25483 but GCC doesn't know about it.
25485 @item -minline-all-stringops
25486 @opindex minline-all-stringops
25487 By default GCC inlines string operations only when the destination is 
25488 known to be aligned to least a 4-byte boundary.  
25489 This enables more inlining and increases code
25490 size, but may improve performance of code that depends on fast
25491 @code{memcpy}, @code{strlen},
25492 and @code{memset} for short lengths.
25494 @item -minline-stringops-dynamically
25495 @opindex minline-stringops-dynamically
25496 For string operations of unknown size, use run-time checks with
25497 inline code for small blocks and a library call for large blocks.
25499 @item -mstringop-strategy=@var{alg}
25500 @opindex mstringop-strategy=@var{alg}
25501 Override the internal decision heuristic for the particular algorithm to use
25502 for inlining string operations.  The allowed values for @var{alg} are:
25504 @table @samp
25505 @item rep_byte
25506 @itemx rep_4byte
25507 @itemx rep_8byte
25508 Expand using i386 @code{rep} prefix of the specified size.
25510 @item byte_loop
25511 @itemx loop
25512 @itemx unrolled_loop
25513 Expand into an inline loop.
25515 @item libcall
25516 Always use a library call.
25517 @end table
25519 @item -mmemcpy-strategy=@var{strategy}
25520 @opindex mmemcpy-strategy=@var{strategy}
25521 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25522 should be inlined and what inline algorithm to use when the expected size
25523 of the copy operation is known. @var{strategy} 
25524 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25525 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25526 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25527 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25528 in the list must be specified in increasing order.  The minimal byte size for 
25529 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25530 preceding range.
25532 @item -mmemset-strategy=@var{strategy}
25533 @opindex mmemset-strategy=@var{strategy}
25534 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25535 @code{__builtin_memset} expansion.
25537 @item -momit-leaf-frame-pointer
25538 @opindex momit-leaf-frame-pointer
25539 Don't keep the frame pointer in a register for leaf functions.  This
25540 avoids the instructions to save, set up, and restore frame pointers and
25541 makes an extra register available in leaf functions.  The option
25542 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25543 which might make debugging harder.
25545 @item -mtls-direct-seg-refs
25546 @itemx -mno-tls-direct-seg-refs
25547 @opindex mtls-direct-seg-refs
25548 Controls whether TLS variables may be accessed with offsets from the
25549 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25550 or whether the thread base pointer must be added.  Whether or not this
25551 is valid depends on the operating system, and whether it maps the
25552 segment to cover the entire TLS area.
25554 For systems that use the GNU C Library, the default is on.
25556 @item -msse2avx
25557 @itemx -mno-sse2avx
25558 @opindex msse2avx
25559 Specify that the assembler should encode SSE instructions with VEX
25560 prefix.  The option @option{-mavx} turns this on by default.
25562 @item -mfentry
25563 @itemx -mno-fentry
25564 @opindex mfentry
25565 If profiling is active (@option{-pg}), put the profiling
25566 counter call before the prologue.
25567 Note: On x86 architectures the attribute @code{ms_hook_prologue}
25568 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
25570 @item -mrecord-mcount
25571 @itemx -mno-record-mcount
25572 @opindex mrecord-mcount
25573 If profiling is active (@option{-pg}), generate a __mcount_loc section
25574 that contains pointers to each profiling call. This is useful for
25575 automatically patching and out calls.
25577 @item -mnop-mcount
25578 @itemx -mno-nop-mcount
25579 @opindex mnop-mcount
25580 If profiling is active (@option{-pg}), generate the calls to
25581 the profiling functions as NOPs. This is useful when they
25582 should be patched in later dynamically. This is likely only
25583 useful together with @option{-mrecord-mcount}.
25585 @item -mskip-rax-setup
25586 @itemx -mno-skip-rax-setup
25587 @opindex mskip-rax-setup
25588 When generating code for the x86-64 architecture with SSE extensions
25589 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
25590 register when there are no variable arguments passed in vector registers.
25592 @strong{Warning:} Since RAX register is used to avoid unnecessarily
25593 saving vector registers on stack when passing variable arguments, the
25594 impacts of this option are callees may waste some stack space,
25595 misbehave or jump to a random location.  GCC 4.4 or newer don't have
25596 those issues, regardless the RAX register value.
25598 @item -m8bit-idiv
25599 @itemx -mno-8bit-idiv
25600 @opindex m8bit-idiv
25601 On some processors, like Intel Atom, 8-bit unsigned integer divide is
25602 much faster than 32-bit/64-bit integer divide.  This option generates a
25603 run-time check.  If both dividend and divisor are within range of 0
25604 to 255, 8-bit unsigned integer divide is used instead of
25605 32-bit/64-bit integer divide.
25607 @item -mavx256-split-unaligned-load
25608 @itemx -mavx256-split-unaligned-store
25609 @opindex mavx256-split-unaligned-load
25610 @opindex mavx256-split-unaligned-store
25611 Split 32-byte AVX unaligned load and store.
25613 @item -mstack-protector-guard=@var{guard}
25614 @opindex mstack-protector-guard=@var{guard}
25615 Generate stack protection code using canary at @var{guard}.  Supported
25616 locations are @samp{global} for global canary or @samp{tls} for per-thread
25617 canary in the TLS block (the default).  This option has effect only when
25618 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
25620 @item -mmitigate-rop
25621 @opindex mmitigate-rop
25622 Try to avoid generating code sequences that contain unintended return
25623 opcodes, to mitigate against certain forms of attack. At the moment,
25624 this option is limited in what it can do and should not be relied
25625 on to provide serious protection.
25627 @item -mgeneral-regs-only
25628 @opindex mgeneral-regs-only
25629 Generate code that uses only the general-purpose registers.  This
25630 prevents the compiler from using floating-point, vector, mask and bound
25631 registers.
25633 @end table
25635 These @samp{-m} switches are supported in addition to the above
25636 on x86-64 processors in 64-bit environments.
25638 @table @gcctabopt
25639 @item -m32
25640 @itemx -m64
25641 @itemx -mx32
25642 @itemx -m16
25643 @itemx -miamcu
25644 @opindex m32
25645 @opindex m64
25646 @opindex mx32
25647 @opindex m16
25648 @opindex miamcu
25649 Generate code for a 16-bit, 32-bit or 64-bit environment.
25650 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
25651 to 32 bits, and
25652 generates code that runs on any i386 system.
25654 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
25655 types to 64 bits, and generates code for the x86-64 architecture.
25656 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
25657 and @option{-mdynamic-no-pic} options.
25659 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
25660 to 32 bits, and
25661 generates code for the x86-64 architecture.
25663 The @option{-m16} option is the same as @option{-m32}, except for that
25664 it outputs the @code{.code16gcc} assembly directive at the beginning of
25665 the assembly output so that the binary can run in 16-bit mode.
25667 The @option{-miamcu} option generates code which conforms to Intel MCU
25668 psABI.  It requires the @option{-m32} option to be turned on.
25670 @item -mno-red-zone
25671 @opindex mno-red-zone
25672 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
25673 by the x86-64 ABI; it is a 128-byte area beyond the location of the
25674 stack pointer that is not modified by signal or interrupt handlers
25675 and therefore can be used for temporary data without adjusting the stack
25676 pointer.  The flag @option{-mno-red-zone} disables this red zone.
25678 @item -mcmodel=small
25679 @opindex mcmodel=small
25680 Generate code for the small code model: the program and its symbols must
25681 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
25682 Programs can be statically or dynamically linked.  This is the default
25683 code model.
25685 @item -mcmodel=kernel
25686 @opindex mcmodel=kernel
25687 Generate code for the kernel code model.  The kernel runs in the
25688 negative 2 GB of the address space.
25689 This model has to be used for Linux kernel code.
25691 @item -mcmodel=medium
25692 @opindex mcmodel=medium
25693 Generate code for the medium model: the program is linked in the lower 2
25694 GB of the address space.  Small symbols are also placed there.  Symbols
25695 with sizes larger than @option{-mlarge-data-threshold} are put into
25696 large data or BSS sections and can be located above 2GB.  Programs can
25697 be statically or dynamically linked.
25699 @item -mcmodel=large
25700 @opindex mcmodel=large
25701 Generate code for the large model.  This model makes no assumptions
25702 about addresses and sizes of sections.
25704 @item -maddress-mode=long
25705 @opindex maddress-mode=long
25706 Generate code for long address mode.  This is only supported for 64-bit
25707 and x32 environments.  It is the default address mode for 64-bit
25708 environments.
25710 @item -maddress-mode=short
25711 @opindex maddress-mode=short
25712 Generate code for short address mode.  This is only supported for 32-bit
25713 and x32 environments.  It is the default address mode for 32-bit and
25714 x32 environments.
25715 @end table
25717 @node x86 Windows Options
25718 @subsection x86 Windows Options
25719 @cindex x86 Windows Options
25720 @cindex Windows Options for x86
25722 These additional options are available for Microsoft Windows targets:
25724 @table @gcctabopt
25725 @item -mconsole
25726 @opindex mconsole
25727 This option
25728 specifies that a console application is to be generated, by
25729 instructing the linker to set the PE header subsystem type
25730 required for console applications.
25731 This option is available for Cygwin and MinGW targets and is
25732 enabled by default on those targets.
25734 @item -mdll
25735 @opindex mdll
25736 This option is available for Cygwin and MinGW targets.  It
25737 specifies that a DLL---a dynamic link library---is to be
25738 generated, enabling the selection of the required runtime
25739 startup object and entry point.
25741 @item -mnop-fun-dllimport
25742 @opindex mnop-fun-dllimport
25743 This option is available for Cygwin and MinGW targets.  It
25744 specifies that the @code{dllimport} attribute should be ignored.
25746 @item -mthread
25747 @opindex mthread
25748 This option is available for MinGW targets. It specifies
25749 that MinGW-specific thread support is to be used.
25751 @item -municode
25752 @opindex municode
25753 This option is available for MinGW-w64 targets.  It causes
25754 the @code{UNICODE} preprocessor macro to be predefined, and
25755 chooses Unicode-capable runtime startup code.
25757 @item -mwin32
25758 @opindex mwin32
25759 This option is available for Cygwin and MinGW targets.  It
25760 specifies that the typical Microsoft Windows predefined macros are to
25761 be set in the pre-processor, but does not influence the choice
25762 of runtime library/startup code.
25764 @item -mwindows
25765 @opindex mwindows
25766 This option is available for Cygwin and MinGW targets.  It
25767 specifies that a GUI application is to be generated by
25768 instructing the linker to set the PE header subsystem type
25769 appropriately.
25771 @item -fno-set-stack-executable
25772 @opindex fno-set-stack-executable
25773 This option is available for MinGW targets. It specifies that
25774 the executable flag for the stack used by nested functions isn't
25775 set. This is necessary for binaries running in kernel mode of
25776 Microsoft Windows, as there the User32 API, which is used to set executable
25777 privileges, isn't available.
25779 @item -fwritable-relocated-rdata
25780 @opindex fno-writable-relocated-rdata
25781 This option is available for MinGW and Cygwin targets.  It specifies
25782 that relocated-data in read-only section is put into the @code{.data}
25783 section.  This is a necessary for older runtimes not supporting
25784 modification of @code{.rdata} sections for pseudo-relocation.
25786 @item -mpe-aligned-commons
25787 @opindex mpe-aligned-commons
25788 This option is available for Cygwin and MinGW targets.  It
25789 specifies that the GNU extension to the PE file format that
25790 permits the correct alignment of COMMON variables should be
25791 used when generating code.  It is enabled by default if
25792 GCC detects that the target assembler found during configuration
25793 supports the feature.
25794 @end table
25796 See also under @ref{x86 Options} for standard options.
25798 @node Xstormy16 Options
25799 @subsection Xstormy16 Options
25800 @cindex Xstormy16 Options
25802 These options are defined for Xstormy16:
25804 @table @gcctabopt
25805 @item -msim
25806 @opindex msim
25807 Choose startup files and linker script suitable for the simulator.
25808 @end table
25810 @node Xtensa Options
25811 @subsection Xtensa Options
25812 @cindex Xtensa Options
25814 These options are supported for Xtensa targets:
25816 @table @gcctabopt
25817 @item -mconst16
25818 @itemx -mno-const16
25819 @opindex mconst16
25820 @opindex mno-const16
25821 Enable or disable use of @code{CONST16} instructions for loading
25822 constant values.  The @code{CONST16} instruction is currently not a
25823 standard option from Tensilica.  When enabled, @code{CONST16}
25824 instructions are always used in place of the standard @code{L32R}
25825 instructions.  The use of @code{CONST16} is enabled by default only if
25826 the @code{L32R} instruction is not available.
25828 @item -mfused-madd
25829 @itemx -mno-fused-madd
25830 @opindex mfused-madd
25831 @opindex mno-fused-madd
25832 Enable or disable use of fused multiply/add and multiply/subtract
25833 instructions in the floating-point option.  This has no effect if the
25834 floating-point option is not also enabled.  Disabling fused multiply/add
25835 and multiply/subtract instructions forces the compiler to use separate
25836 instructions for the multiply and add/subtract operations.  This may be
25837 desirable in some cases where strict IEEE 754-compliant results are
25838 required: the fused multiply add/subtract instructions do not round the
25839 intermediate result, thereby producing results with @emph{more} bits of
25840 precision than specified by the IEEE standard.  Disabling fused multiply
25841 add/subtract instructions also ensures that the program output is not
25842 sensitive to the compiler's ability to combine multiply and add/subtract
25843 operations.
25845 @item -mserialize-volatile
25846 @itemx -mno-serialize-volatile
25847 @opindex mserialize-volatile
25848 @opindex mno-serialize-volatile
25849 When this option is enabled, GCC inserts @code{MEMW} instructions before
25850 @code{volatile} memory references to guarantee sequential consistency.
25851 The default is @option{-mserialize-volatile}.  Use
25852 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
25854 @item -mforce-no-pic
25855 @opindex mforce-no-pic
25856 For targets, like GNU/Linux, where all user-mode Xtensa code must be
25857 position-independent code (PIC), this option disables PIC for compiling
25858 kernel code.
25860 @item -mtext-section-literals
25861 @itemx -mno-text-section-literals
25862 @opindex mtext-section-literals
25863 @opindex mno-text-section-literals
25864 These options control the treatment of literal pools.  The default is
25865 @option{-mno-text-section-literals}, which places literals in a separate
25866 section in the output file.  This allows the literal pool to be placed
25867 in a data RAM/ROM, and it also allows the linker to combine literal
25868 pools from separate object files to remove redundant literals and
25869 improve code size.  With @option{-mtext-section-literals}, the literals
25870 are interspersed in the text section in order to keep them as close as
25871 possible to their references.  This may be necessary for large assembly
25872 files.  Literals for each function are placed right before that function.
25874 @item -mauto-litpools
25875 @itemx -mno-auto-litpools
25876 @opindex mauto-litpools
25877 @opindex mno-auto-litpools
25878 These options control the treatment of literal pools.  The default is
25879 @option{-mno-auto-litpools}, which places literals in a separate
25880 section in the output file unless @option{-mtext-section-literals} is
25881 used.  With @option{-mauto-litpools} the literals are interspersed in
25882 the text section by the assembler.  Compiler does not produce explicit
25883 @code{.literal} directives and loads literals into registers with
25884 @code{MOVI} instructions instead of @code{L32R} to let the assembler
25885 do relaxation and place literals as necessary.  This option allows
25886 assembler to create several literal pools per function and assemble
25887 very big functions, which may not be possible with
25888 @option{-mtext-section-literals}.
25890 @item -mtarget-align
25891 @itemx -mno-target-align
25892 @opindex mtarget-align
25893 @opindex mno-target-align
25894 When this option is enabled, GCC instructs the assembler to
25895 automatically align instructions to reduce branch penalties at the
25896 expense of some code density.  The assembler attempts to widen density
25897 instructions to align branch targets and the instructions following call
25898 instructions.  If there are not enough preceding safe density
25899 instructions to align a target, no widening is performed.  The
25900 default is @option{-mtarget-align}.  These options do not affect the
25901 treatment of auto-aligned instructions like @code{LOOP}, which the
25902 assembler always aligns, either by widening density instructions or
25903 by inserting NOP instructions.
25905 @item -mlongcalls
25906 @itemx -mno-longcalls
25907 @opindex mlongcalls
25908 @opindex mno-longcalls
25909 When this option is enabled, GCC instructs the assembler to translate
25910 direct calls to indirect calls unless it can determine that the target
25911 of a direct call is in the range allowed by the call instruction.  This
25912 translation typically occurs for calls to functions in other source
25913 files.  Specifically, the assembler translates a direct @code{CALL}
25914 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
25915 The default is @option{-mno-longcalls}.  This option should be used in
25916 programs where the call target can potentially be out of range.  This
25917 option is implemented in the assembler, not the compiler, so the
25918 assembly code generated by GCC still shows direct call
25919 instructions---look at the disassembled object code to see the actual
25920 instructions.  Note that the assembler uses an indirect call for
25921 every cross-file call, not just those that really are out of range.
25922 @end table
25924 @node zSeries Options
25925 @subsection zSeries Options
25926 @cindex zSeries options
25928 These are listed under @xref{S/390 and zSeries Options}.
25931 @c man end
25933 @node Spec Files
25934 @section Specifying Subprocesses and the Switches to Pass to Them
25935 @cindex Spec Files
25937 @command{gcc} is a driver program.  It performs its job by invoking a
25938 sequence of other programs to do the work of compiling, assembling and
25939 linking.  GCC interprets its command-line parameters and uses these to
25940 deduce which programs it should invoke, and which command-line options
25941 it ought to place on their command lines.  This behavior is controlled
25942 by @dfn{spec strings}.  In most cases there is one spec string for each
25943 program that GCC can invoke, but a few programs have multiple spec
25944 strings to control their behavior.  The spec strings built into GCC can
25945 be overridden by using the @option{-specs=} command-line switch to specify
25946 a spec file.
25948 @dfn{Spec files} are plain-text files that are used to construct spec
25949 strings.  They consist of a sequence of directives separated by blank
25950 lines.  The type of directive is determined by the first non-whitespace
25951 character on the line, which can be one of the following:
25953 @table @code
25954 @item %@var{command}
25955 Issues a @var{command} to the spec file processor.  The commands that can
25956 appear here are:
25958 @table @code
25959 @item %include <@var{file}>
25960 @cindex @code{%include}
25961 Search for @var{file} and insert its text at the current point in the
25962 specs file.
25964 @item %include_noerr <@var{file}>
25965 @cindex @code{%include_noerr}
25966 Just like @samp{%include}, but do not generate an error message if the include
25967 file cannot be found.
25969 @item %rename @var{old_name} @var{new_name}
25970 @cindex @code{%rename}
25971 Rename the spec string @var{old_name} to @var{new_name}.
25973 @end table
25975 @item *[@var{spec_name}]:
25976 This tells the compiler to create, override or delete the named spec
25977 string.  All lines after this directive up to the next directive or
25978 blank line are considered to be the text for the spec string.  If this
25979 results in an empty string then the spec is deleted.  (Or, if the
25980 spec did not exist, then nothing happens.)  Otherwise, if the spec
25981 does not currently exist a new spec is created.  If the spec does
25982 exist then its contents are overridden by the text of this
25983 directive, unless the first character of that text is the @samp{+}
25984 character, in which case the text is appended to the spec.
25986 @item [@var{suffix}]:
25987 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
25988 and up to the next directive or blank line are considered to make up the
25989 spec string for the indicated suffix.  When the compiler encounters an
25990 input file with the named suffix, it processes the spec string in
25991 order to work out how to compile that file.  For example:
25993 @smallexample
25994 .ZZ:
25995 z-compile -input %i
25996 @end smallexample
25998 This says that any input file whose name ends in @samp{.ZZ} should be
25999 passed to the program @samp{z-compile}, which should be invoked with the
26000 command-line switch @option{-input} and with the result of performing the
26001 @samp{%i} substitution.  (See below.)
26003 As an alternative to providing a spec string, the text following a
26004 suffix directive can be one of the following:
26006 @table @code
26007 @item @@@var{language}
26008 This says that the suffix is an alias for a known @var{language}.  This is
26009 similar to using the @option{-x} command-line switch to GCC to specify a
26010 language explicitly.  For example:
26012 @smallexample
26013 .ZZ:
26014 @@c++
26015 @end smallexample
26017 Says that .ZZ files are, in fact, C++ source files.
26019 @item #@var{name}
26020 This causes an error messages saying:
26022 @smallexample
26023 @var{name} compiler not installed on this system.
26024 @end smallexample
26025 @end table
26027 GCC already has an extensive list of suffixes built into it.
26028 This directive adds an entry to the end of the list of suffixes, but
26029 since the list is searched from the end backwards, it is effectively
26030 possible to override earlier entries using this technique.
26032 @end table
26034 GCC has the following spec strings built into it.  Spec files can
26035 override these strings or create their own.  Note that individual
26036 targets can also add their own spec strings to this list.
26038 @smallexample
26039 asm          Options to pass to the assembler
26040 asm_final    Options to pass to the assembler post-processor
26041 cpp          Options to pass to the C preprocessor
26042 cc1          Options to pass to the C compiler
26043 cc1plus      Options to pass to the C++ compiler
26044 endfile      Object files to include at the end of the link
26045 link         Options to pass to the linker
26046 lib          Libraries to include on the command line to the linker
26047 libgcc       Decides which GCC support library to pass to the linker
26048 linker       Sets the name of the linker
26049 predefines   Defines to be passed to the C preprocessor
26050 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26051              by default
26052 startfile    Object files to include at the start of the link
26053 @end smallexample
26055 Here is a small example of a spec file:
26057 @smallexample
26058 %rename lib                 old_lib
26060 *lib:
26061 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26062 @end smallexample
26064 This example renames the spec called @samp{lib} to @samp{old_lib} and
26065 then overrides the previous definition of @samp{lib} with a new one.
26066 The new definition adds in some extra command-line options before
26067 including the text of the old definition.
26069 @dfn{Spec strings} are a list of command-line options to be passed to their
26070 corresponding program.  In addition, the spec strings can contain
26071 @samp{%}-prefixed sequences to substitute variable text or to
26072 conditionally insert text into the command line.  Using these constructs
26073 it is possible to generate quite complex command lines.
26075 Here is a table of all defined @samp{%}-sequences for spec
26076 strings.  Note that spaces are not generated automatically around the
26077 results of expanding these sequences.  Therefore you can concatenate them
26078 together or combine them with constant text in a single argument.
26080 @table @code
26081 @item %%
26082 Substitute one @samp{%} into the program name or argument.
26084 @item %i
26085 Substitute the name of the input file being processed.
26087 @item %b
26088 Substitute the basename of the input file being processed.
26089 This is the substring up to (and not including) the last period
26090 and not including the directory.
26092 @item %B
26093 This is the same as @samp{%b}, but include the file suffix (text after
26094 the last period).
26096 @item %d
26097 Marks the argument containing or following the @samp{%d} as a
26098 temporary file name, so that that file is deleted if GCC exits
26099 successfully.  Unlike @samp{%g}, this contributes no text to the
26100 argument.
26102 @item %g@var{suffix}
26103 Substitute a file name that has suffix @var{suffix} and is chosen
26104 once per compilation, and mark the argument in the same way as
26105 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26106 name is now chosen in a way that is hard to predict even when previously
26107 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26108 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26109 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26110 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26111 was simply substituted with a file name chosen once per compilation,
26112 without regard to any appended suffix (which was therefore treated
26113 just like ordinary text), making such attacks more likely to succeed.
26115 @item %u@var{suffix}
26116 Like @samp{%g}, but generates a new temporary file name
26117 each time it appears instead of once per compilation.
26119 @item %U@var{suffix}
26120 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26121 new one if there is no such last file name.  In the absence of any
26122 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26123 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26124 involves the generation of two distinct file names, one
26125 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26126 simply substituted with a file name chosen for the previous @samp{%u},
26127 without regard to any appended suffix.
26129 @item %j@var{suffix}
26130 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26131 writable, and if @option{-save-temps} is not used; 
26132 otherwise, substitute the name
26133 of a temporary file, just like @samp{%u}.  This temporary file is not
26134 meant for communication between processes, but rather as a junk
26135 disposal mechanism.
26137 @item %|@var{suffix}
26138 @itemx %m@var{suffix}
26139 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26140 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26141 all.  These are the two most common ways to instruct a program that it
26142 should read from standard input or write to standard output.  If you
26143 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26144 construct: see for example @file{f/lang-specs.h}.
26146 @item %.@var{SUFFIX}
26147 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26148 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26149 terminated by the next space or %.
26151 @item %w
26152 Marks the argument containing or following the @samp{%w} as the
26153 designated output file of this compilation.  This puts the argument
26154 into the sequence of arguments that @samp{%o} substitutes.
26156 @item %o
26157 Substitutes the names of all the output files, with spaces
26158 automatically placed around them.  You should write spaces
26159 around the @samp{%o} as well or the results are undefined.
26160 @samp{%o} is for use in the specs for running the linker.
26161 Input files whose names have no recognized suffix are not compiled
26162 at all, but they are included among the output files, so they are
26163 linked.
26165 @item %O
26166 Substitutes the suffix for object files.  Note that this is
26167 handled specially when it immediately follows @samp{%g, %u, or %U},
26168 because of the need for those to form complete file names.  The
26169 handling is such that @samp{%O} is treated exactly as if it had already
26170 been substituted, except that @samp{%g, %u, and %U} do not currently
26171 support additional @var{suffix} characters following @samp{%O} as they do
26172 following, for example, @samp{.o}.
26174 @item %p
26175 Substitutes the standard macro predefinitions for the
26176 current target machine.  Use this when running @command{cpp}.
26178 @item %P
26179 Like @samp{%p}, but puts @samp{__} before and after the name of each
26180 predefined macro, except for macros that start with @samp{__} or with
26181 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26184 @item %I
26185 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26186 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26187 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26188 and @option{-imultilib} as necessary.
26190 @item %s
26191 Current argument is the name of a library or startup file of some sort.
26192 Search for that file in a standard list of directories and substitute
26193 the full name found.  The current working directory is included in the
26194 list of directories scanned.
26196 @item %T
26197 Current argument is the name of a linker script.  Search for that file
26198 in the current list of directories to scan for libraries. If the file
26199 is located insert a @option{--script} option into the command line
26200 followed by the full path name found.  If the file is not found then
26201 generate an error message.  Note: the current working directory is not
26202 searched.
26204 @item %e@var{str}
26205 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26206 Use this when inconsistent options are detected.
26208 @item %(@var{name})
26209 Substitute the contents of spec string @var{name} at this point.
26211 @item %x@{@var{option}@}
26212 Accumulate an option for @samp{%X}.
26214 @item %X
26215 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26216 spec string.
26218 @item %Y
26219 Output the accumulated assembler options specified by @option{-Wa}.
26221 @item %Z
26222 Output the accumulated preprocessor options specified by @option{-Wp}.
26224 @item %a
26225 Process the @code{asm} spec.  This is used to compute the
26226 switches to be passed to the assembler.
26228 @item %A
26229 Process the @code{asm_final} spec.  This is a spec string for
26230 passing switches to an assembler post-processor, if such a program is
26231 needed.
26233 @item %l
26234 Process the @code{link} spec.  This is the spec for computing the
26235 command line passed to the linker.  Typically it makes use of the
26236 @samp{%L %G %S %D and %E} sequences.
26238 @item %D
26239 Dump out a @option{-L} option for each directory that GCC believes might
26240 contain startup files.  If the target supports multilibs then the
26241 current multilib directory is prepended to each of these paths.
26243 @item %L
26244 Process the @code{lib} spec.  This is a spec string for deciding which
26245 libraries are included on the command line to the linker.
26247 @item %G
26248 Process the @code{libgcc} spec.  This is a spec string for deciding
26249 which GCC support library is included on the command line to the linker.
26251 @item %S
26252 Process the @code{startfile} spec.  This is a spec for deciding which
26253 object files are the first ones passed to the linker.  Typically
26254 this might be a file named @file{crt0.o}.
26256 @item %E
26257 Process the @code{endfile} spec.  This is a spec string that specifies
26258 the last object files that are passed to the linker.
26260 @item %C
26261 Process the @code{cpp} spec.  This is used to construct the arguments
26262 to be passed to the C preprocessor.
26264 @item %1
26265 Process the @code{cc1} spec.  This is used to construct the options to be
26266 passed to the actual C compiler (@command{cc1}).
26268 @item %2
26269 Process the @code{cc1plus} spec.  This is used to construct the options to be
26270 passed to the actual C++ compiler (@command{cc1plus}).
26272 @item %*
26273 Substitute the variable part of a matched option.  See below.
26274 Note that each comma in the substituted string is replaced by
26275 a single space.
26277 @item %<@code{S}
26278 Remove all occurrences of @code{-S} from the command line.  Note---this
26279 command is position dependent.  @samp{%} commands in the spec string
26280 before this one see @code{-S}, @samp{%} commands in the spec string
26281 after this one do not.
26283 @item %:@var{function}(@var{args})
26284 Call the named function @var{function}, passing it @var{args}.
26285 @var{args} is first processed as a nested spec string, then split
26286 into an argument vector in the usual fashion.  The function returns
26287 a string which is processed as if it had appeared literally as part
26288 of the current spec.
26290 The following built-in spec functions are provided:
26292 @table @code
26293 @item @code{getenv}
26294 The @code{getenv} spec function takes two arguments: an environment
26295 variable name and a string.  If the environment variable is not
26296 defined, a fatal error is issued.  Otherwise, the return value is the
26297 value of the environment variable concatenated with the string.  For
26298 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26300 @smallexample
26301 %:getenv(TOPDIR /include)
26302 @end smallexample
26304 expands to @file{/path/to/top/include}.
26306 @item @code{if-exists}
26307 The @code{if-exists} spec function takes one argument, an absolute
26308 pathname to a file.  If the file exists, @code{if-exists} returns the
26309 pathname.  Here is a small example of its usage:
26311 @smallexample
26312 *startfile:
26313 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26314 @end smallexample
26316 @item @code{if-exists-else}
26317 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26318 spec function, except that it takes two arguments.  The first argument is
26319 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26320 returns the pathname.  If it does not exist, it returns the second argument.
26321 This way, @code{if-exists-else} can be used to select one file or another,
26322 based on the existence of the first.  Here is a small example of its usage:
26324 @smallexample
26325 *startfile:
26326 crt0%O%s %:if-exists(crti%O%s) \
26327 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26328 @end smallexample
26330 @item @code{replace-outfile}
26331 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26332 first argument in the outfiles array and replaces it with the second argument.  Here
26333 is a small example of its usage:
26335 @smallexample
26336 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26337 @end smallexample
26339 @item @code{remove-outfile}
26340 The @code{remove-outfile} spec function takes one argument.  It looks for the
26341 first argument in the outfiles array and removes it.  Here is a small example
26342 its usage:
26344 @smallexample
26345 %:remove-outfile(-lm)
26346 @end smallexample
26348 @item @code{pass-through-libs}
26349 The @code{pass-through-libs} spec function takes any number of arguments.  It
26350 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26351 assumes are the names of linker input library archive files) and returns a
26352 result containing all the found arguments each prepended by
26353 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26354 intended to be passed to the LTO linker plugin.
26356 @smallexample
26357 %:pass-through-libs(%G %L %G)
26358 @end smallexample
26360 @item @code{print-asm-header}
26361 The @code{print-asm-header} function takes no arguments and simply
26362 prints a banner like:
26364 @smallexample
26365 Assembler options
26366 =================
26368 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26369 @end smallexample
26371 It is used to separate compiler options from assembler options
26372 in the @option{--target-help} output.
26373 @end table
26375 @item %@{@code{S}@}
26376 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26377 If that switch is not specified, this substitutes nothing.  Note that
26378 the leading dash is omitted when specifying this option, and it is
26379 automatically inserted if the substitution is performed.  Thus the spec
26380 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26381 and outputs the command-line option @option{-foo}.
26383 @item %W@{@code{S}@}
26384 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26385 deleted on failure.
26387 @item %@{@code{S}*@}
26388 Substitutes all the switches specified to GCC whose names start
26389 with @code{-S}, but which also take an argument.  This is used for
26390 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26391 GCC considers @option{-o foo} as being
26392 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26393 text, including the space.  Thus two arguments are generated.
26395 @item %@{@code{S}*&@code{T}*@}
26396 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26397 (the order of @code{S} and @code{T} in the spec is not significant).
26398 There can be any number of ampersand-separated variables; for each the
26399 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26401 @item %@{@code{S}:@code{X}@}
26402 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26404 @item %@{!@code{S}:@code{X}@}
26405 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26407 @item %@{@code{S}*:@code{X}@}
26408 Substitutes @code{X} if one or more switches whose names start with
26409 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26410 once, no matter how many such switches appeared.  However, if @code{%*}
26411 appears somewhere in @code{X}, then @code{X} is substituted once
26412 for each matching switch, with the @code{%*} replaced by the part of
26413 that switch matching the @code{*}.
26415 If @code{%*} appears as the last part of a spec sequence then a space
26416 is added after the end of the last substitution.  If there is more
26417 text in the sequence, however, then a space is not generated.  This
26418 allows the @code{%*} substitution to be used as part of a larger
26419 string.  For example, a spec string like this:
26421 @smallexample
26422 %@{mcu=*:--script=%*/memory.ld@}
26423 @end smallexample
26425 @noindent
26426 when matching an option like @option{-mcu=newchip} produces:
26428 @smallexample
26429 --script=newchip/memory.ld
26430 @end smallexample
26432 @item %@{.@code{S}:@code{X}@}
26433 Substitutes @code{X}, if processing a file with suffix @code{S}.
26435 @item %@{!.@code{S}:@code{X}@}
26436 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26438 @item %@{,@code{S}:@code{X}@}
26439 Substitutes @code{X}, if processing a file for language @code{S}.
26441 @item %@{!,@code{S}:@code{X}@}
26442 Substitutes @code{X}, if not processing a file for language @code{S}.
26444 @item %@{@code{S}|@code{P}:@code{X}@}
26445 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26446 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26447 @code{*} sequences as well, although they have a stronger binding than
26448 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26449 alternatives must be starred, and only the first matching alternative
26450 is substituted.
26452 For example, a spec string like this:
26454 @smallexample
26455 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26456 @end smallexample
26458 @noindent
26459 outputs the following command-line options from the following input
26460 command-line options:
26462 @smallexample
26463 fred.c        -foo -baz
26464 jim.d         -bar -boggle
26465 -d fred.c     -foo -baz -boggle
26466 -d jim.d      -bar -baz -boggle
26467 @end smallexample
26469 @item %@{S:X; T:Y; :D@}
26471 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26472 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26473 be as many clauses as you need.  This may be combined with @code{.},
26474 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26477 @end table
26479 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
26480 construct may contain other nested @samp{%} constructs or spaces, or
26481 even newlines.  They are processed as usual, as described above.
26482 Trailing white space in @code{X} is ignored.  White space may also
26483 appear anywhere on the left side of the colon in these constructs,
26484 except between @code{.} or @code{*} and the corresponding word.
26486 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26487 handled specifically in these constructs.  If another value of
26488 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26489 @option{-W} switch is found later in the command line, the earlier
26490 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26491 just one letter, which passes all matching options.
26493 The character @samp{|} at the beginning of the predicate text is used to
26494 indicate that a command should be piped to the following command, but
26495 only if @option{-pipe} is specified.
26497 It is built into GCC which switches take arguments and which do not.
26498 (You might think it would be useful to generalize this to allow each
26499 compiler's spec to say which switches take arguments.  But this cannot
26500 be done in a consistent fashion.  GCC cannot even decide which input
26501 files have been specified without knowing which switches take arguments,
26502 and it must know which input files to compile in order to tell which
26503 compilers to run).
26505 GCC also knows implicitly that arguments starting in @option{-l} are to be
26506 treated as compiler output files, and passed to the linker in their
26507 proper position among the other output files.
26509 @node Environment Variables
26510 @section Environment Variables Affecting GCC
26511 @cindex environment variables
26513 @c man begin ENVIRONMENT
26514 This section describes several environment variables that affect how GCC
26515 operates.  Some of them work by specifying directories or prefixes to use
26516 when searching for various kinds of files.  Some are used to specify other
26517 aspects of the compilation environment.
26519 Note that you can also specify places to search using options such as
26520 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26521 take precedence over places specified using environment variables, which
26522 in turn take precedence over those specified by the configuration of GCC@.
26523 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26524 GNU Compiler Collection (GCC) Internals}.
26526 @table @env
26527 @item LANG
26528 @itemx LC_CTYPE
26529 @c @itemx LC_COLLATE
26530 @itemx LC_MESSAGES
26531 @c @itemx LC_MONETARY
26532 @c @itemx LC_NUMERIC
26533 @c @itemx LC_TIME
26534 @itemx LC_ALL
26535 @findex LANG
26536 @findex LC_CTYPE
26537 @c @findex LC_COLLATE
26538 @findex LC_MESSAGES
26539 @c @findex LC_MONETARY
26540 @c @findex LC_NUMERIC
26541 @c @findex LC_TIME
26542 @findex LC_ALL
26543 @cindex locale
26544 These environment variables control the way that GCC uses
26545 localization information which allows GCC to work with different
26546 national conventions.  GCC inspects the locale categories
26547 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26548 so.  These locale categories can be set to any value supported by your
26549 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26550 Kingdom encoded in UTF-8.
26552 The @env{LC_CTYPE} environment variable specifies character
26553 classification.  GCC uses it to determine the character boundaries in
26554 a string; this is needed for some multibyte encodings that contain quote
26555 and escape characters that are otherwise interpreted as a string
26556 end or escape.
26558 The @env{LC_MESSAGES} environment variable specifies the language to
26559 use in diagnostic messages.
26561 If the @env{LC_ALL} environment variable is set, it overrides the value
26562 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
26563 and @env{LC_MESSAGES} default to the value of the @env{LANG}
26564 environment variable.  If none of these variables are set, GCC
26565 defaults to traditional C English behavior.
26567 @item TMPDIR
26568 @findex TMPDIR
26569 If @env{TMPDIR} is set, it specifies the directory to use for temporary
26570 files.  GCC uses temporary files to hold the output of one stage of
26571 compilation which is to be used as input to the next stage: for example,
26572 the output of the preprocessor, which is the input to the compiler
26573 proper.
26575 @item GCC_COMPARE_DEBUG
26576 @findex GCC_COMPARE_DEBUG
26577 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
26578 @option{-fcompare-debug} to the compiler driver.  See the documentation
26579 of this option for more details.
26581 @item GCC_EXEC_PREFIX
26582 @findex GCC_EXEC_PREFIX
26583 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
26584 names of the subprograms executed by the compiler.  No slash is added
26585 when this prefix is combined with the name of a subprogram, but you can
26586 specify a prefix that ends with a slash if you wish.
26588 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
26589 an appropriate prefix to use based on the pathname it is invoked with.
26591 If GCC cannot find the subprogram using the specified prefix, it
26592 tries looking in the usual places for the subprogram.
26594 The default value of @env{GCC_EXEC_PREFIX} is
26595 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
26596 the installed compiler. In many cases @var{prefix} is the value
26597 of @code{prefix} when you ran the @file{configure} script.
26599 Other prefixes specified with @option{-B} take precedence over this prefix.
26601 This prefix is also used for finding files such as @file{crt0.o} that are
26602 used for linking.
26604 In addition, the prefix is used in an unusual way in finding the
26605 directories to search for header files.  For each of the standard
26606 directories whose name normally begins with @samp{/usr/local/lib/gcc}
26607 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
26608 replacing that beginning with the specified prefix to produce an
26609 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
26610 @file{foo/bar} just before it searches the standard directory 
26611 @file{/usr/local/lib/bar}.
26612 If a standard directory begins with the configured
26613 @var{prefix} then the value of @var{prefix} is replaced by
26614 @env{GCC_EXEC_PREFIX} when looking for header files.
26616 @item COMPILER_PATH
26617 @findex COMPILER_PATH
26618 The value of @env{COMPILER_PATH} is a colon-separated list of
26619 directories, much like @env{PATH}.  GCC tries the directories thus
26620 specified when searching for subprograms, if it cannot find the
26621 subprograms using @env{GCC_EXEC_PREFIX}.
26623 @item LIBRARY_PATH
26624 @findex LIBRARY_PATH
26625 The value of @env{LIBRARY_PATH} is a colon-separated list of
26626 directories, much like @env{PATH}.  When configured as a native compiler,
26627 GCC tries the directories thus specified when searching for special
26628 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
26629 using GCC also uses these directories when searching for ordinary
26630 libraries for the @option{-l} option (but directories specified with
26631 @option{-L} come first).
26633 @item LANG
26634 @findex LANG
26635 @cindex locale definition
26636 This variable is used to pass locale information to the compiler.  One way in
26637 which this information is used is to determine the character set to be used
26638 when character literals, string literals and comments are parsed in C and C++.
26639 When the compiler is configured to allow multibyte characters,
26640 the following values for @env{LANG} are recognized:
26642 @table @samp
26643 @item C-JIS
26644 Recognize JIS characters.
26645 @item C-SJIS
26646 Recognize SJIS characters.
26647 @item C-EUCJP
26648 Recognize EUCJP characters.
26649 @end table
26651 If @env{LANG} is not defined, or if it has some other value, then the
26652 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
26653 recognize and translate multibyte characters.
26654 @end table
26656 @noindent
26657 Some additional environment variables affect the behavior of the
26658 preprocessor.
26660 @include cppenv.texi
26662 @c man end
26664 @node Precompiled Headers
26665 @section Using Precompiled Headers
26666 @cindex precompiled headers
26667 @cindex speed of compilation
26669 Often large projects have many header files that are included in every
26670 source file.  The time the compiler takes to process these header files
26671 over and over again can account for nearly all of the time required to
26672 build the project.  To make builds faster, GCC allows you to
26673 @dfn{precompile} a header file.
26675 To create a precompiled header file, simply compile it as you would any
26676 other file, if necessary using the @option{-x} option to make the driver
26677 treat it as a C or C++ header file.  You may want to use a
26678 tool like @command{make} to keep the precompiled header up-to-date when
26679 the headers it contains change.
26681 A precompiled header file is searched for when @code{#include} is
26682 seen in the compilation.  As it searches for the included file
26683 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
26684 compiler looks for a precompiled header in each directory just before it
26685 looks for the include file in that directory.  The name searched for is
26686 the name specified in the @code{#include} with @samp{.gch} appended.  If
26687 the precompiled header file cannot be used, it is ignored.
26689 For instance, if you have @code{#include "all.h"}, and you have
26690 @file{all.h.gch} in the same directory as @file{all.h}, then the
26691 precompiled header file is used if possible, and the original
26692 header is used otherwise.
26694 Alternatively, you might decide to put the precompiled header file in a
26695 directory and use @option{-I} to ensure that directory is searched
26696 before (or instead of) the directory containing the original header.
26697 Then, if you want to check that the precompiled header file is always
26698 used, you can put a file of the same name as the original header in this
26699 directory containing an @code{#error} command.
26701 This also works with @option{-include}.  So yet another way to use
26702 precompiled headers, good for projects not designed with precompiled
26703 header files in mind, is to simply take most of the header files used by
26704 a project, include them from another header file, precompile that header
26705 file, and @option{-include} the precompiled header.  If the header files
26706 have guards against multiple inclusion, they are skipped because
26707 they've already been included (in the precompiled header).
26709 If you need to precompile the same header file for different
26710 languages, targets, or compiler options, you can instead make a
26711 @emph{directory} named like @file{all.h.gch}, and put each precompiled
26712 header in the directory, perhaps using @option{-o}.  It doesn't matter
26713 what you call the files in the directory; every precompiled header in
26714 the directory is considered.  The first precompiled header
26715 encountered in the directory that is valid for this compilation is
26716 used; they're searched in no particular order.
26718 There are many other possibilities, limited only by your imagination,
26719 good sense, and the constraints of your build system.
26721 A precompiled header file can be used only when these conditions apply:
26723 @itemize
26724 @item
26725 Only one precompiled header can be used in a particular compilation.
26727 @item
26728 A precompiled header cannot be used once the first C token is seen.  You
26729 can have preprocessor directives before a precompiled header; you cannot
26730 include a precompiled header from inside another header.
26732 @item
26733 The precompiled header file must be produced for the same language as
26734 the current compilation.  You cannot use a C precompiled header for a C++
26735 compilation.
26737 @item
26738 The precompiled header file must have been produced by the same compiler
26739 binary as the current compilation is using.
26741 @item
26742 Any macros defined before the precompiled header is included must
26743 either be defined in the same way as when the precompiled header was
26744 generated, or must not affect the precompiled header, which usually
26745 means that they don't appear in the precompiled header at all.
26747 The @option{-D} option is one way to define a macro before a
26748 precompiled header is included; using a @code{#define} can also do it.
26749 There are also some options that define macros implicitly, like
26750 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
26751 defined this way.
26753 @item If debugging information is output when using the precompiled
26754 header, using @option{-g} or similar, the same kind of debugging information
26755 must have been output when building the precompiled header.  However,
26756 a precompiled header built using @option{-g} can be used in a compilation
26757 when no debugging information is being output.
26759 @item The same @option{-m} options must generally be used when building
26760 and using the precompiled header.  @xref{Submodel Options},
26761 for any cases where this rule is relaxed.
26763 @item Each of the following options must be the same when building and using
26764 the precompiled header:
26766 @gccoptlist{-fexceptions}
26768 @item
26769 Some other command-line options starting with @option{-f},
26770 @option{-p}, or @option{-O} must be defined in the same way as when
26771 the precompiled header was generated.  At present, it's not clear
26772 which options are safe to change and which are not; the safest choice
26773 is to use exactly the same options when generating and using the
26774 precompiled header.  The following are known to be safe:
26776 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
26777 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
26778 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
26779 -pedantic-errors}
26781 @end itemize
26783 For all of these except the last, the compiler automatically
26784 ignores the precompiled header if the conditions aren't met.  If you
26785 find an option combination that doesn't work and doesn't cause the
26786 precompiled header to be ignored, please consider filing a bug report,
26787 see @ref{Bugs}.
26789 If you do use differing options when generating and using the
26790 precompiled header, the actual behavior is a mixture of the
26791 behavior for the options.  For instance, if you use @option{-g} to
26792 generate the precompiled header but not when using it, you may or may
26793 not get debugging information for routines in the precompiled header.