Fix missing Aarch64 falkor/qdf24xx options.
[official-gcc.git] / gcc / doc / invoke.texi
blobe4ca1b4b4fcd30e39f2c906a9a90736c4660489c
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wcast-align  -Wcast-qual  @gol
270 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
271 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
272 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
273 -Wdelete-incomplete @gol
274 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
275 -Wdisabled-optimization @gol
276 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
277 -Wno-div-by-zero  -Wdouble-promotion @gol
278 -Wduplicated-branches  -Wduplicated-cond @gol
279 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
280 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
281 -Wfloat-equal  -Wformat  -Wformat=2 @gol
282 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
283 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
284 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
285 -Wformat-y2k  -Wframe-address @gol
286 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
287 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
288 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
289 -Wimplicit-function-declaration  -Wimplicit-int @gol
290 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
291 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
292 -Winvalid-pch  -Wlarger-than=@var{len} @gol
293 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
294 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
295 -Wmisleading-indentation  -Wmissing-braces @gol
296 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
297 -Wno-multichar  -Wnonnull  -Wnonnull-compare @gol
298 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
299 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
300 -Woverride-init-side-effects  -Woverlength-strings @gol
301 -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
302 -Wparentheses  -Wno-pedantic-ms-format @gol
303 -Wplacement-new  -Wplacement-new=@var{n} @gol
304 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
305 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
306 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
307 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
308 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
309 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
310 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
311 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
312 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
313 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
314 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
315 -Wstringop-overflow=@var{n} @gol
316 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
317 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
318 -Wmissing-format-attribute  -Wsubobject-linkage @gol
319 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
320 -Wswitch-unreachable  -Wsync-nand @gol
321 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
322 -Wtype-limits  -Wundef @gol
323 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
324 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
325 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
326 -Wunused-parameter  -Wno-unused-result @gol
327 -Wunused-value  -Wunused-variable @gol
328 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
329 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
330 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
331 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
332 -Wzero-as-null-pointer-constant  -Whsa}
334 @item C and Objective-C-only Warning Options
335 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
336 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
337 -Wold-style-declaration  -Wold-style-definition @gol
338 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
339 -Wdeclaration-after-statement  -Wpointer-sign}
341 @item Debugging Options
342 @xref{Debugging Options,,Options for Debugging Your Program}.
343 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
344 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
345 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
346 -gcolumn-info  -gno-column-info @gol
347 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
348 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
349 -feliminate-dwarf2-dups  -fno-eliminate-unused-debug-types @gol
350 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
351 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
352 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
353 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
354 -fvar-tracking  -fvar-tracking-assignments}
356 @item Optimization Options
357 @xref{Optimize Options,,Options that Control Optimization}.
358 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
359 -falign-jumps[=@var{n}] @gol
360 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
361 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
362 -fauto-inc-dec  -fbranch-probabilities @gol
363 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
364 -fbtr-bb-exclusive  -fcaller-saves @gol
365 -fcombine-stack-adjustments  -fconserve-stack @gol
366 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
367 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
368 -fcx-limited-range @gol
369 -fdata-sections  -fdce  -fdelayed-branch @gol
370 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
371 -fdevirtualize-at-ltrans  -fdse @gol
372 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
373 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
374 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
375 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
376 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
377 -fif-conversion2  -findirect-inlining @gol
378 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
379 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
380 -fipa-bit-cp -fipa-vrp @gol
381 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
382 -fira-algorithm=@var{algorithm} @gol
383 -fira-region=@var{region}  -fira-hoist-pressure @gol
384 -fira-loop-pressure  -fno-ira-share-save-slots @gol
385 -fno-ira-share-spill-slots @gol
386 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
387 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
388 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
389 -floop-block  -floop-interchange  -floop-strip-mine @gol
390 -floop-unroll-and-jam  -floop-nest-optimize @gol
391 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
392 -flto-partition=@var{alg}  -fmerge-all-constants @gol
393 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
394 -fmove-loop-invariants  -fno-branch-count-reg @gol
395 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
396 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
397 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
398 -fno-sched-spec  -fno-signed-zeros @gol
399 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
400 -fomit-frame-pointer  -foptimize-sibling-calls @gol
401 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
402 -fprefetch-loop-arrays @gol
403 -fprofile-correction @gol
404 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
405 -fprofile-reorder-functions @gol
406 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
407 -freorder-blocks-algorithm=@var{algorithm} @gol
408 -freorder-blocks-and-partition  -freorder-functions @gol
409 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
410 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
411 -fsched-spec-load  -fsched-spec-load-dangerous @gol
412 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
413 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
414 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
415 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
416 -fschedule-fusion @gol
417 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
418 -fselective-scheduling  -fselective-scheduling2 @gol
419 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
420 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
421 -fsignaling-nans @gol
422 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
423 -fsplit-paths @gol
424 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
425 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
426 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
427 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
428 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
429 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
430 -ftree-loop-if-convert  -ftree-loop-im @gol
431 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
432 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
433 -ftree-loop-vectorize @gol
434 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
435 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
436 -ftree-switch-conversion  -ftree-tail-merge @gol
437 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
438 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
439 -funsafe-math-optimizations  -funswitch-loops @gol
440 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
441 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
442 --param @var{name}=@var{value}
443 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
445 @item Program Instrumentation Options
446 @xref{Instrumentation Options,,Program Instrumentation Options}.
447 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
448 -fprofile-abs-path @gol
449 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
450 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
451 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
452 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
453 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
454 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
455 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
456 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
457 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
458 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
459 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
460 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
461 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
462 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
463 -fstack-protector-explicit  -fstack-check @gol
464 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
465 -fno-stack-limit  -fsplit-stack @gol
466 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
467 -fvtv-counts  -fvtv-debug @gol
468 -finstrument-functions @gol
469 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
470 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
472 @item Preprocessor Options
473 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
474 @gccoptlist{-A@var{question}=@var{answer} @gol
475 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
476 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
477 -dD  -dI  -dM  -dN  -dU @gol
478 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
479 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
480 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
481 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
482 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
483 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
484 -H  -imacros @var{file}  -include @var{file} @gol
485 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
486 -no-integrated-cpp  -P  -pthread  -remap @gol
487 -traditional  -traditional-cpp  -trigraphs @gol
488 -U@var{macro}  -undef  @gol
489 -Wp,@var{option}  -Xpreprocessor @var{option}}
491 @item Assembler Options
492 @xref{Assembler Options,,Passing Options to the Assembler}.
493 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
495 @item Linker Options
496 @xref{Link Options,,Options for Linking}.
497 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
498 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
499 -s  -static  -static-libgcc  -static-libstdc++ @gol
500 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
501 -static-libmpx  -static-libmpxwrappers @gol
502 -shared  -shared-libgcc  -symbolic @gol
503 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
504 -u @var{symbol}  -z @var{keyword}}
506 @item Directory Options
507 @xref{Directory Options,,Options for Directory Search}.
508 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
509 -idirafter @var{dir} @gol
510 -imacros @var{file}  -imultilib @var{dir} @gol
511 -iplugindir=@var{dir}  -iprefix @var{file} @gol
512 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
513 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
514 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
515 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
517 @item Code Generation Options
518 @xref{Code Gen Options,,Options for Code Generation Conventions}.
519 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
520 -ffixed-@var{reg}  -fexceptions @gol
521 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
522 -fasynchronous-unwind-tables @gol
523 -fno-gnu-unique @gol
524 -finhibit-size-directive  -fno-common  -fno-ident @gol
525 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
526 -fno-jump-tables @gol
527 -frecord-gcc-switches @gol
528 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
529 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
530 -fleading-underscore  -ftls-model=@var{model} @gol
531 -fstack-reuse=@var{reuse_level} @gol
532 -ftrampolines  -ftrapv  -fwrapv @gol
533 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
534 -fstrict-volatile-bitfields  -fsync-libcalls}
536 @item Developer Options
537 @xref{Developer Options,,GCC Developer Options}.
538 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
539 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
540 -fdbg-cnt=@var{counter-value-list} @gol
541 -fdisable-ipa-@var{pass_name} @gol
542 -fdisable-rtl-@var{pass_name} @gol
543 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
544 -fdisable-tree-@var{pass_name} @gol
545 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
546 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
547 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
548 -fdump-final-insns@r{[}=@var{file}@r{]}
549 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
550 -fdump-lang-all @gol
551 -fdump-lang-@var{switch} @gol
552 -fdump-lang-@var{switch}-@var{options} @gol
553 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
554 -fdump-passes @gol
555 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
556 -fdump-statistics @gol
557 -fdump-tree-all @gol
558 -fdump-tree-@var{switch} @gol
559 -fdump-tree-@var{switch}-@var{options} @gol
560 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
561 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
562 -fenable-@var{kind}-@var{pass} @gol
563 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
564 -fira-verbose=@var{n} @gol
565 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
566 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
567 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
568 -fprofile-report @gol
569 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
570 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
571 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
572 -fvar-tracking-assignments-toggle  -gtoggle @gol
573 -print-file-name=@var{library}  -print-libgcc-file-name @gol
574 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
575 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
576 -print-sysroot  -print-sysroot-headers-suffix @gol
577 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
579 @item Machine-Dependent Options
580 @xref{Submodel Options,,Machine-Dependent Options}.
581 @c This list is ordered alphanumerically by subsection name.
582 @c Try and put the significant identifier (CPU or system) first,
583 @c so users have a clue at guessing where the ones they want will be.
585 @emph{AArch64 Options}
586 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
587 -mgeneral-regs-only @gol
588 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
589 -mstrict-align @gol
590 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
591 -mtls-dialect=desc  -mtls-dialect=traditional @gol
592 -mtls-size=@var{size} @gol
593 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
594 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
595 -mlow-precision-recip-sqrt  -mno-low-precision-recip-sqrt@gol
596 -mlow-precision-sqrt  -mno-low-precision-sqrt@gol
597 -mlow-precision-div  -mno-low-precision-div @gol
598 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
600 @emph{Adapteva Epiphany Options}
601 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
602 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
603 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
604 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
605 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
606 -msplit-vecmove-early  -m1reg-@var{reg}}
608 @emph{ARC Options}
609 @gccoptlist{-mbarrel-shifter @gol
610 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
611 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
612 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
613 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
614 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
615 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
616 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
617 -mrgf-banked-regs @gol
618 -mvolatile-cache  -mtp-regno=@var{regno} @gol
619 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
620 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
621 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
622 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
623 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
624 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
625 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
626 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
628 @emph{ARM Options}
629 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
630 -mabi=@var{name} @gol
631 -mapcs-stack-check  -mno-apcs-stack-check @gol
632 -mapcs-reentrant  -mno-apcs-reentrant @gol
633 -msched-prolog  -mno-sched-prolog @gol
634 -mlittle-endian  -mbig-endian @gol
635 -mfloat-abi=@var{name} @gol
636 -mfp16-format=@var{name}
637 -mthumb-interwork  -mno-thumb-interwork @gol
638 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
639 -mtune=@var{name}  -mprint-tune-info @gol
640 -mstructure-size-boundary=@var{n} @gol
641 -mabort-on-noreturn @gol
642 -mlong-calls  -mno-long-calls @gol
643 -msingle-pic-base  -mno-single-pic-base @gol
644 -mpic-register=@var{reg} @gol
645 -mnop-fun-dllimport @gol
646 -mpoke-function-name @gol
647 -mthumb  -marm @gol
648 -mtpcs-frame  -mtpcs-leaf-frame @gol
649 -mcaller-super-interworking  -mcallee-super-interworking @gol
650 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
651 -mword-relocations @gol
652 -mfix-cortex-m3-ldrd @gol
653 -munaligned-access @gol
654 -mneon-for-64bits @gol
655 -mslow-flash-data @gol
656 -masm-syntax-unified @gol
657 -mrestrict-it @gol
658 -mpure-code @gol
659 -mcmse}
661 @emph{AVR Options}
662 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
663 -mbranch-cost=@var{cost} @gol
664 -mcall-prologues  -mint8  -mn_flash=@var{size}  -mno-interrupts @gol
665 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
666 -mshort-calls  -nodevicelib @gol
667 -Waddr-space-convert  -Wmisspelled-isr}
669 @emph{Blackfin Options}
670 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
671 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
672 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
673 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
674 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
675 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
676 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
677 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
678 -micplb}
680 @emph{C6X Options}
681 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
682 -msim  -msdata=@var{sdata-type}}
684 @emph{CRIS Options}
685 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
686 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
687 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
688 -mstack-align  -mdata-align  -mconst-align @gol
689 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
690 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
691 -mmul-bug-workaround  -mno-mul-bug-workaround}
693 @emph{CR16 Options}
694 @gccoptlist{-mmac @gol
695 -mcr16cplus  -mcr16c @gol
696 -msim  -mint32  -mbit-ops
697 -mdata-model=@var{model}}
699 @emph{Darwin Options}
700 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
701 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
702 -client_name  -compatibility_version  -current_version @gol
703 -dead_strip @gol
704 -dependency-file  -dylib_file  -dylinker_install_name @gol
705 -dynamic  -dynamiclib  -exported_symbols_list @gol
706 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
707 -force_flat_namespace  -headerpad_max_install_names @gol
708 -iframework @gol
709 -image_base  -init  -install_name  -keep_private_externs @gol
710 -multi_module  -multiply_defined  -multiply_defined_unused @gol
711 -noall_load   -no_dead_strip_inits_and_terms @gol
712 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
713 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
714 -private_bundle  -read_only_relocs  -sectalign @gol
715 -sectobjectsymbols  -whyload  -seg1addr @gol
716 -sectcreate  -sectobjectsymbols  -sectorder @gol
717 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
718 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
719 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
720 -single_module  -static  -sub_library  -sub_umbrella @gol
721 -twolevel_namespace  -umbrella  -undefined @gol
722 -unexported_symbols_list  -weak_reference_mismatches @gol
723 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
724 -mkernel  -mone-byte-bool}
726 @emph{DEC Alpha Options}
727 @gccoptlist{-mno-fp-regs  -msoft-float @gol
728 -mieee  -mieee-with-inexact  -mieee-conformant @gol
729 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
730 -mtrap-precision=@var{mode}  -mbuild-constants @gol
731 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
732 -mbwx  -mmax  -mfix  -mcix @gol
733 -mfloat-vax  -mfloat-ieee @gol
734 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
735 -msmall-text  -mlarge-text @gol
736 -mmemory-latency=@var{time}}
738 @emph{FR30 Options}
739 @gccoptlist{-msmall-model  -mno-lsim}
741 @emph{FT32 Options}
742 @gccoptlist{-msim  -mlra  -mnodiv}
744 @emph{FRV Options}
745 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
746 -mhard-float  -msoft-float @gol
747 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
748 -mdouble  -mno-double @gol
749 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
750 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
751 -mlinked-fp  -mlong-calls  -malign-labels @gol
752 -mlibrary-pic  -macc-4  -macc-8 @gol
753 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
754 -moptimize-membar  -mno-optimize-membar @gol
755 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
756 -mvliw-branch  -mno-vliw-branch @gol
757 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
758 -mno-nested-cond-exec  -mtomcat-stats @gol
759 -mTLS  -mtls @gol
760 -mcpu=@var{cpu}}
762 @emph{GNU/Linux Options}
763 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
764 -tno-android-cc  -tno-android-ld}
766 @emph{H8/300 Options}
767 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
769 @emph{HPPA Options}
770 @gccoptlist{-march=@var{architecture-type} @gol
771 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
772 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
773 -mfixed-range=@var{register-range} @gol
774 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
775 -mlong-load-store  -mno-disable-fpregs @gol
776 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
777 -mno-jump-in-delay  -mno-long-load-store @gol
778 -mno-portable-runtime  -mno-soft-float @gol
779 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
780 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
781 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
782 -munix=@var{unix-std}  -nolibdld  -static  -threads}
784 @emph{IA-64 Options}
785 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
786 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
787 -mconstant-gp  -mauto-pic  -mfused-madd @gol
788 -minline-float-divide-min-latency @gol
789 -minline-float-divide-max-throughput @gol
790 -mno-inline-float-divide @gol
791 -minline-int-divide-min-latency @gol
792 -minline-int-divide-max-throughput  @gol
793 -mno-inline-int-divide @gol
794 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
795 -mno-inline-sqrt @gol
796 -mdwarf2-asm  -mearly-stop-bits @gol
797 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
798 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
799 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
800 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
801 -msched-spec-ldc  -msched-spec-control-ldc @gol
802 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
803 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
804 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
805 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
807 @emph{LM32 Options}
808 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
809 -msign-extend-enabled  -muser-enabled}
811 @emph{M32R/D Options}
812 @gccoptlist{-m32r2  -m32rx  -m32r @gol
813 -mdebug @gol
814 -malign-loops  -mno-align-loops @gol
815 -missue-rate=@var{number} @gol
816 -mbranch-cost=@var{number} @gol
817 -mmodel=@var{code-size-model-type} @gol
818 -msdata=@var{sdata-type} @gol
819 -mno-flush-func  -mflush-func=@var{name} @gol
820 -mno-flush-trap  -mflush-trap=@var{number} @gol
821 -G @var{num}}
823 @emph{M32C Options}
824 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
826 @emph{M680x0 Options}
827 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
828 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
829 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
830 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
831 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
832 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
833 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
834 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
835 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
837 @emph{MCore Options}
838 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
839 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
840 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
841 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
842 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
844 @emph{MeP Options}
845 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
846 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
847 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
848 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
849 -mtiny=@var{n}}
851 @emph{MicroBlaze Options}
852 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
853 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
854 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
855 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
856 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
858 @emph{MIPS Options}
859 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
860 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
861 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
862 -mips16  -mno-mips16  -mflip-mips16 @gol
863 -minterlink-compressed  -mno-interlink-compressed @gol
864 -minterlink-mips16  -mno-interlink-mips16 @gol
865 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
866 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
867 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
868 -mno-float  -msingle-float  -mdouble-float @gol
869 -modd-spreg  -mno-odd-spreg @gol
870 -mabs=@var{mode}  -mnan=@var{encoding} @gol
871 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
872 -mmcu  -mmno-mcu @gol
873 -meva  -mno-eva @gol
874 -mvirt  -mno-virt @gol
875 -mxpa  -mno-xpa @gol
876 -mmicromips  -mno-micromips @gol
877 -mmsa  -mno-msa @gol
878 -mfpu=@var{fpu-type} @gol
879 -msmartmips  -mno-smartmips @gol
880 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
881 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
882 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
883 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
884 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
885 -membedded-data  -mno-embedded-data @gol
886 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
887 -mcode-readable=@var{setting} @gol
888 -msplit-addresses  -mno-split-addresses @gol
889 -mexplicit-relocs  -mno-explicit-relocs @gol
890 -mcheck-zero-division  -mno-check-zero-division @gol
891 -mdivide-traps  -mdivide-breaks @gol
892 -mload-store-pairs  -mno-load-store-pairs @gol
893 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
894 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
895 -mfix-24k  -mno-fix-24k @gol
896 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
897 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
898 -mfix-vr4120  -mno-fix-vr4120 @gol
899 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
900 -mflush-func=@var{func}  -mno-flush-func @gol
901 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
902 -mcompact-branches=@var{policy} @gol
903 -mfp-exceptions  -mno-fp-exceptions @gol
904 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
905 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
906 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
907 -mframe-header-opt  -mno-frame-header-opt}
909 @emph{MMIX Options}
910 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
911 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
912 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
913 -mno-base-addresses  -msingle-exit  -mno-single-exit}
915 @emph{MN10300 Options}
916 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
917 -mno-am33  -mam33  -mam33-2  -mam34 @gol
918 -mtune=@var{cpu-type} @gol
919 -mreturn-pointer-on-d0 @gol
920 -mno-crt0  -mrelax  -mliw  -msetlb}
922 @emph{Moxie Options}
923 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
925 @emph{MSP430 Options}
926 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
927 -mwarn-mcu @gol
928 -mcode-region=  -mdata-region= @gol
929 -msilicon-errata=  -msilicon-errata-warn= @gol
930 -mhwmult=  -minrt}
932 @emph{NDS32 Options}
933 @gccoptlist{-mbig-endian  -mlittle-endian @gol
934 -mreduced-regs  -mfull-regs @gol
935 -mcmov  -mno-cmov @gol
936 -mperf-ext  -mno-perf-ext @gol
937 -mv3push  -mno-v3push @gol
938 -m16bit  -mno-16bit @gol
939 -misr-vector-size=@var{num} @gol
940 -mcache-block-size=@var{num} @gol
941 -march=@var{arch} @gol
942 -mcmodel=@var{code-model} @gol
943 -mctor-dtor  -mrelax}
945 @emph{Nios II Options}
946 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
947 -mel  -meb @gol
948 -mno-bypass-cache  -mbypass-cache @gol
949 -mno-cache-volatile  -mcache-volatile @gol
950 -mno-fast-sw-div  -mfast-sw-div @gol
951 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
952 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
953 -mcustom-fpu-cfg=@var{name} @gol
954 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
955 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
957 @emph{Nvidia PTX Options}
958 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
960 @emph{PDP-11 Options}
961 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
962 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
963 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
964 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
965 -mbranch-expensive  -mbranch-cheap @gol
966 -munix-asm  -mdec-asm}
968 @emph{picoChip Options}
969 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
970 -msymbol-as-address  -mno-inefficient-warnings}
972 @emph{PowerPC Options}
973 See RS/6000 and PowerPC Options.
975 @emph{RISC-V Options}
976 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
977 -mmemcpy  -mno-memcpy @gol
978 -mplt  -mno-plt @gol
979 -mabi=@var{ABI-string} @gol
980 -mfdiv  -mno-fdiv @gol
981 -mdiv  -mno-div @gol
982 -march=@var{ISA-string} @gol
983 -mtune=@var{processor-string} @gol
984 -msmall-data-limit=@var{N-bytes} @gol
985 -msave-restore  -mno-save-restore @gol
986 -mstrict-align -mno-strict-align @gol
987 -mcmodel=@var{code-model} @gol
988 -mexplicit-relocs  -mno-explicit-relocs @gol}
990 @emph{RL78 Options}
991 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
992 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
993 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
995 @emph{RS/6000 and PowerPC Options}
996 @gccoptlist{-mcpu=@var{cpu-type} @gol
997 -mtune=@var{cpu-type} @gol
998 -mcmodel=@var{code-model} @gol
999 -mpowerpc64 @gol
1000 -maltivec  -mno-altivec @gol
1001 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1002 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1003 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1004 -mfprnd  -mno-fprnd @gol
1005 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1006 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1007 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1008 -malign-power  -malign-natural @gol
1009 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1010 -msingle-float  -mdouble-float  -msimple-fpu @gol
1011 -mstring  -mno-string  -mupdate  -mno-update @gol
1012 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1013 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1014 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1015 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1016 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1017 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1018 -mprioritize-restricted-insns=@var{priority} @gol
1019 -msched-costly-dep=@var{dependence_type} @gol
1020 -minsert-sched-nops=@var{scheme} @gol
1021 -mcall-sysv  -mcall-netbsd @gol
1022 -maix-struct-return  -msvr4-struct-return @gol
1023 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1024 -mblock-move-inline-limit=@var{num} @gol
1025 -misel  -mno-isel @gol
1026 -misel=yes  -misel=no @gol
1027 -mspe  -mno-spe @gol
1028 -mspe=yes  -mspe=no @gol
1029 -mpaired @gol
1030 -mvrsave  -mno-vrsave @gol
1031 -mmulhw  -mno-mulhw @gol
1032 -mdlmzb  -mno-dlmzb @gol
1033 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1034 -mprototype  -mno-prototype @gol
1035 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1036 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1037 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1038 -mno-recip-precision @gol
1039 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1040 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1041 -msave-toc-indirect  -mno-save-toc-indirect @gol
1042 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1043 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1044 -mquad-memory  -mno-quad-memory @gol
1045 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1046 -mcompat-align-parm  -mno-compat-align-parm @gol
1047 -mupper-regs-df  -mno-upper-regs-df  -mupper-regs-sf  -mno-upper-regs-sf @gol
1048 -mupper-regs-di  -mno-upper-regs-di @gol
1049 -mupper-regs  -mno-upper-regs @gol
1050 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1051 -mgnu-attribute  -mno-gnu-attribute @gol
1052 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1053 -mstack-protector-guard-offset=@var{offset} @gol
1054 -mlra  -mno-lra}
1056 @emph{RX Options}
1057 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1058 -mcpu=@gol
1059 -mbig-endian-data  -mlittle-endian-data @gol
1060 -msmall-data @gol
1061 -msim  -mno-sim@gol
1062 -mas100-syntax  -mno-as100-syntax@gol
1063 -mrelax@gol
1064 -mmax-constant-size=@gol
1065 -mint-register=@gol
1066 -mpid@gol
1067 -mallow-string-insns  -mno-allow-string-insns@gol
1068 -mjsr@gol
1069 -mno-warn-multiple-fast-interrupts@gol
1070 -msave-acc-in-interrupts}
1072 @emph{S/390 and zSeries Options}
1073 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1074 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1075 -mlong-double-64  -mlong-double-128 @gol
1076 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1077 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1078 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1079 -mhtm  -mvx  -mzvector @gol
1080 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1081 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1082 -mhotpatch=@var{halfwords},@var{halfwords}}
1084 @emph{Score Options}
1085 @gccoptlist{-meb  -mel @gol
1086 -mnhwloop @gol
1087 -muls @gol
1088 -mmac @gol
1089 -mscore5  -mscore5u  -mscore7  -mscore7d}
1091 @emph{SH Options}
1092 @gccoptlist{-m1  -m2  -m2e @gol
1093 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1094 -m3  -m3e @gol
1095 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1096 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1097 -mb  -ml  -mdalign  -mrelax @gol
1098 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1099 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1100 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1101 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1102 -maccumulate-outgoing-args @gol
1103 -matomic-model=@var{atomic-model} @gol
1104 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1105 -mcbranch-force-delay-slot @gol
1106 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1107 -mpretend-cmove  -mtas}
1109 @emph{Solaris 2 Options}
1110 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1111 -pthreads}
1113 @emph{SPARC Options}
1114 @gccoptlist{-mcpu=@var{cpu-type} @gol
1115 -mtune=@var{cpu-type} @gol
1116 -mcmodel=@var{code-model} @gol
1117 -mmemory-model=@var{mem-model} @gol
1118 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1119 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1120 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1121 -mhard-quad-float  -msoft-quad-float @gol
1122 -mstack-bias  -mno-stack-bias @gol
1123 -mstd-struct-return  -mno-std-struct-return @gol
1124 -munaligned-doubles  -mno-unaligned-doubles @gol
1125 -muser-mode  -mno-user-mode @gol
1126 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1127 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1128 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  @gol
1129 -mpopc  -mno-popc  -msubxc  -mno-subxc@gol
1130 -mfix-at697f  -mfix-ut699 @gol
1131 -mlra  -mno-lra}
1133 @emph{SPU Options}
1134 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1135 -msafe-dma  -munsafe-dma @gol
1136 -mbranch-hints @gol
1137 -msmall-mem  -mlarge-mem  -mstdmain @gol
1138 -mfixed-range=@var{register-range} @gol
1139 -mea32  -mea64 @gol
1140 -maddress-space-conversion  -mno-address-space-conversion @gol
1141 -mcache-size=@var{cache-size} @gol
1142 -matomic-updates  -mno-atomic-updates}
1144 @emph{System V Options}
1145 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1147 @emph{TILE-Gx Options}
1148 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1149 -mcmodel=@var{code-model}}
1151 @emph{TILEPro Options}
1152 @gccoptlist{-mcpu=@var{cpu}  -m32}
1154 @emph{V850 Options}
1155 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1156 -mprolog-function  -mno-prolog-function  -mspace @gol
1157 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1158 -mapp-regs  -mno-app-regs @gol
1159 -mdisable-callt  -mno-disable-callt @gol
1160 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1161 -mv850e  -mv850  -mv850e3v5 @gol
1162 -mloop @gol
1163 -mrelax @gol
1164 -mlong-jumps @gol
1165 -msoft-float @gol
1166 -mhard-float @gol
1167 -mgcc-abi @gol
1168 -mrh850-abi @gol
1169 -mbig-switch}
1171 @emph{VAX Options}
1172 @gccoptlist{-mg  -mgnu  -munix}
1174 @emph{Visium Options}
1175 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1178 @emph{VMS Options}
1179 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1180 -mpointer-size=@var{size}}
1182 @emph{VxWorks Options}
1183 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1184 -Xbind-lazy  -Xbind-now}
1186 @emph{x86 Options}
1187 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1188 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1189 -mfpmath=@var{unit} @gol
1190 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1191 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1192 -mno-wide-multiply  -mrtd  -malign-double @gol
1193 -mpreferred-stack-boundary=@var{num} @gol
1194 -mincoming-stack-boundary=@var{num} @gol
1195 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1196 -mrecip  -mrecip=@var{opt} @gol
1197 -mvzeroupper  -mprefer-avx128 @gol
1198 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1199 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1200 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1201 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1202 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1203 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1204 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1205 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1206 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1207 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1208 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1209 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1210 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1211 -mregparm=@var{num}  -msseregparm @gol
1212 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1213 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1214 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1215 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1216 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1217 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1218 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1219 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1220 -mmitigate-rop  -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1222 @emph{x86 Windows Options}
1223 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1224 -mnop-fun-dllimport  -mthread @gol
1225 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1227 @emph{Xstormy16 Options}
1228 @gccoptlist{-msim}
1230 @emph{Xtensa Options}
1231 @gccoptlist{-mconst16  -mno-const16 @gol
1232 -mfused-madd  -mno-fused-madd @gol
1233 -mforce-no-pic @gol
1234 -mserialize-volatile  -mno-serialize-volatile @gol
1235 -mtext-section-literals  -mno-text-section-literals @gol
1236 -mauto-litpools  -mno-auto-litpools @gol
1237 -mtarget-align  -mno-target-align @gol
1238 -mlongcalls  -mno-longcalls}
1240 @emph{zSeries Options}
1241 See S/390 and zSeries Options.
1242 @end table
1245 @node Overall Options
1246 @section Options Controlling the Kind of Output
1248 Compilation can involve up to four stages: preprocessing, compilation
1249 proper, assembly and linking, always in that order.  GCC is capable of
1250 preprocessing and compiling several files either into several
1251 assembler input files, or into one assembler input file; then each
1252 assembler input file produces an object file, and linking combines all
1253 the object files (those newly compiled, and those specified as input)
1254 into an executable file.
1256 @cindex file name suffix
1257 For any given input file, the file name suffix determines what kind of
1258 compilation is done:
1260 @table @gcctabopt
1261 @item @var{file}.c
1262 C source code that must be preprocessed.
1264 @item @var{file}.i
1265 C source code that should not be preprocessed.
1267 @item @var{file}.ii
1268 C++ source code that should not be preprocessed.
1270 @item @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.
1274 @item @var{file}.mi
1275 Objective-C source code that should not be preprocessed.
1277 @item @var{file}.mm
1278 @itemx @var{file}.M
1279 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1280 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1281 to a literal capital M@.
1283 @item @var{file}.mii
1284 Objective-C++ source code that should not be preprocessed.
1286 @item @var{file}.h
1287 C, C++, Objective-C or Objective-C++ header file to be turned into a
1288 precompiled header (default), or C, C++ header file to be turned into an
1289 Ada spec (via the @option{-fdump-ada-spec} switch).
1291 @item @var{file}.cc
1292 @itemx @var{file}.cp
1293 @itemx @var{file}.cxx
1294 @itemx @var{file}.cpp
1295 @itemx @var{file}.CPP
1296 @itemx @var{file}.c++
1297 @itemx @var{file}.C
1298 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1299 the last two letters must both be literally @samp{x}.  Likewise,
1300 @samp{.C} refers to a literal capital C@.
1302 @item @var{file}.mm
1303 @itemx @var{file}.M
1304 Objective-C++ source code that must be preprocessed.
1306 @item @var{file}.mii
1307 Objective-C++ source code that should not be preprocessed.
1309 @item @var{file}.hh
1310 @itemx @var{file}.H
1311 @itemx @var{file}.hp
1312 @itemx @var{file}.hxx
1313 @itemx @var{file}.hpp
1314 @itemx @var{file}.HPP
1315 @itemx @var{file}.h++
1316 @itemx @var{file}.tcc
1317 C++ header file to be turned into a precompiled header or Ada spec.
1319 @item @var{file}.f
1320 @itemx @var{file}.for
1321 @itemx @var{file}.ftn
1322 Fixed form Fortran source code that should not be preprocessed.
1324 @item @var{file}.F
1325 @itemx @var{file}.FOR
1326 @itemx @var{file}.fpp
1327 @itemx @var{file}.FPP
1328 @itemx @var{file}.FTN
1329 Fixed form Fortran source code that must be preprocessed (with the traditional
1330 preprocessor).
1332 @item @var{file}.f90
1333 @itemx @var{file}.f95
1334 @itemx @var{file}.f03
1335 @itemx @var{file}.f08
1336 Free form Fortran source code that should not be preprocessed.
1338 @item @var{file}.F90
1339 @itemx @var{file}.F95
1340 @itemx @var{file}.F03
1341 @itemx @var{file}.F08
1342 Free form Fortran source code that must be preprocessed (with the
1343 traditional preprocessor).
1345 @item @var{file}.go
1346 Go source code.
1348 @item @var{file}.brig
1349 BRIG files (binary representation of HSAIL).
1351 @item @var{file}.ads
1352 Ada source code file that contains a library unit declaration (a
1353 declaration of a package, subprogram, or generic, or a generic
1354 instantiation), or a library unit renaming declaration (a package,
1355 generic, or subprogram renaming declaration).  Such files are also
1356 called @dfn{specs}.
1358 @item @var{file}.adb
1359 Ada source code file containing a library unit body (a subprogram or
1360 package body).  Such files are also called @dfn{bodies}.
1362 @c GCC also knows about some suffixes for languages not yet included:
1363 @c Pascal:
1364 @c @var{file}.p
1365 @c @var{file}.pas
1366 @c Ratfor:
1367 @c @var{file}.r
1369 @item @var{file}.s
1370 Assembler code.
1372 @item @var{file}.S
1373 @itemx @var{file}.sx
1374 Assembler code that must be preprocessed.
1376 @item @var{other}
1377 An object file to be fed straight into linking.
1378 Any file name with no recognized suffix is treated this way.
1379 @end table
1381 @opindex x
1382 You can specify the input language explicitly with the @option{-x} option:
1384 @table @gcctabopt
1385 @item -x @var{language}
1386 Specify explicitly the @var{language} for the following input files
1387 (rather than letting the compiler choose a default based on the file
1388 name suffix).  This option applies to all following input files until
1389 the next @option{-x} option.  Possible values for @var{language} are:
1390 @smallexample
1391 c  c-header  cpp-output
1392 c++  c++-header  c++-cpp-output
1393 objective-c  objective-c-header  objective-c-cpp-output
1394 objective-c++ objective-c++-header objective-c++-cpp-output
1395 assembler  assembler-with-cpp
1397 f77  f77-cpp-input f95  f95-cpp-input
1399 brig
1400 @end smallexample
1402 @item -x none
1403 Turn off any specification of a language, so that subsequent files are
1404 handled according to their file name suffixes (as they are if @option{-x}
1405 has not been used at all).
1406 @end table
1408 If you only want some of the stages of compilation, you can use
1409 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1410 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1411 @command{gcc} is to stop.  Note that some combinations (for example,
1412 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1414 @table @gcctabopt
1415 @item -c
1416 @opindex c
1417 Compile or assemble the source files, but do not link.  The linking
1418 stage simply is not done.  The ultimate output is in the form of an
1419 object file for each source file.
1421 By default, the object file name for a source file is made by replacing
1422 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1424 Unrecognized input files, not requiring compilation or assembly, are
1425 ignored.
1427 @item -S
1428 @opindex S
1429 Stop after the stage of compilation proper; do not assemble.  The output
1430 is in the form of an assembler code file for each non-assembler input
1431 file specified.
1433 By default, the assembler file name for a source file is made by
1434 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1436 Input files that don't require compilation are ignored.
1438 @item -E
1439 @opindex E
1440 Stop after the preprocessing stage; do not run the compiler proper.  The
1441 output is in the form of preprocessed source code, which is sent to the
1442 standard output.
1444 Input files that don't require preprocessing are ignored.
1446 @cindex output file option
1447 @item -o @var{file}
1448 @opindex o
1449 Place output in file @var{file}.  This applies to whatever
1450 sort of output is being produced, whether it be an executable file,
1451 an object file, an assembler file or preprocessed C code.
1453 If @option{-o} is not specified, the default is to put an executable
1454 file in @file{a.out}, the object file for
1455 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1456 assembler file in @file{@var{source}.s}, a precompiled header file in
1457 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1458 standard output.
1460 @item -v
1461 @opindex v
1462 Print (on standard error output) the commands executed to run the stages
1463 of compilation.  Also print the version number of the compiler driver
1464 program and of the preprocessor and the compiler proper.
1466 @item -###
1467 @opindex ###
1468 Like @option{-v} except the commands are not executed and arguments
1469 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1470 This is useful for shell scripts to capture the driver-generated command lines.
1472 @item --help
1473 @opindex help
1474 Print (on the standard output) a description of the command-line options
1475 understood by @command{gcc}.  If the @option{-v} option is also specified
1476 then @option{--help} is also passed on to the various processes
1477 invoked by @command{gcc}, so that they can display the command-line options
1478 they accept.  If the @option{-Wextra} option has also been specified
1479 (prior to the @option{--help} option), then command-line options that
1480 have no documentation associated with them are also displayed.
1482 @item --target-help
1483 @opindex target-help
1484 Print (on the standard output) a description of target-specific command-line
1485 options for each tool.  For some targets extra target-specific
1486 information may also be printed.
1488 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1489 Print (on the standard output) a description of the command-line
1490 options understood by the compiler that fit into all specified classes
1491 and qualifiers.  These are the supported classes:
1493 @table @asis
1494 @item @samp{optimizers}
1495 Display all of the optimization options supported by the
1496 compiler.
1498 @item @samp{warnings}
1499 Display all of the options controlling warning messages
1500 produced by the compiler.
1502 @item @samp{target}
1503 Display target-specific options.  Unlike the
1504 @option{--target-help} option however, target-specific options of the
1505 linker and assembler are not displayed.  This is because those
1506 tools do not currently support the extended @option{--help=} syntax.
1508 @item @samp{params}
1509 Display the values recognized by the @option{--param}
1510 option.
1512 @item @var{language}
1513 Display the options supported for @var{language}, where
1514 @var{language} is the name of one of the languages supported in this
1515 version of GCC@.
1517 @item @samp{common}
1518 Display the options that are common to all languages.
1519 @end table
1521 These are the supported qualifiers:
1523 @table @asis
1524 @item @samp{undocumented}
1525 Display only those options that are undocumented.
1527 @item @samp{joined}
1528 Display options taking an argument that appears after an equal
1529 sign in the same continuous piece of text, such as:
1530 @samp{--help=target}.
1532 @item @samp{separate}
1533 Display options taking an argument that appears as a separate word
1534 following the original option, such as: @samp{-o output-file}.
1535 @end table
1537 Thus for example to display all the undocumented target-specific
1538 switches supported by the compiler, use:
1540 @smallexample
1541 --help=target,undocumented
1542 @end smallexample
1544 The sense of a qualifier can be inverted by prefixing it with the
1545 @samp{^} character, so for example to display all binary warning
1546 options (i.e., ones that are either on or off and that do not take an
1547 argument) that have a description, use:
1549 @smallexample
1550 --help=warnings,^joined,^undocumented
1551 @end smallexample
1553 The argument to @option{--help=} should not consist solely of inverted
1554 qualifiers.
1556 Combining several classes is possible, although this usually
1557 restricts the output so much that there is nothing to display.  One
1558 case where it does work, however, is when one of the classes is
1559 @var{target}.  For example, to display all the target-specific
1560 optimization options, use:
1562 @smallexample
1563 --help=target,optimizers
1564 @end smallexample
1566 The @option{--help=} option can be repeated on the command line.  Each
1567 successive use displays its requested class of options, skipping
1568 those that have already been displayed.
1570 If the @option{-Q} option appears on the command line before the
1571 @option{--help=} option, then the descriptive text displayed by
1572 @option{--help=} is changed.  Instead of describing the displayed
1573 options, an indication is given as to whether the option is enabled,
1574 disabled or set to a specific value (assuming that the compiler
1575 knows this at the point where the @option{--help=} option is used).
1577 Here is a truncated example from the ARM port of @command{gcc}:
1579 @smallexample
1580   % gcc -Q -mabi=2 --help=target -c
1581   The following options are target specific:
1582   -mabi=                                2
1583   -mabort-on-noreturn                   [disabled]
1584   -mapcs                                [disabled]
1585 @end smallexample
1587 The output is sensitive to the effects of previous command-line
1588 options, so for example it is possible to find out which optimizations
1589 are enabled at @option{-O2} by using:
1591 @smallexample
1592 -Q -O2 --help=optimizers
1593 @end smallexample
1595 Alternatively you can discover which binary optimizations are enabled
1596 by @option{-O3} by using:
1598 @smallexample
1599 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1600 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1601 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1602 @end smallexample
1604 @item --version
1605 @opindex version
1606 Display the version number and copyrights of the invoked GCC@.
1608 @item -pass-exit-codes
1609 @opindex pass-exit-codes
1610 Normally the @command{gcc} program exits with the code of 1 if any
1611 phase of the compiler returns a non-success return code.  If you specify
1612 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1613 the numerically highest error produced by any phase returning an error
1614 indication.  The C, C++, and Fortran front ends return 4 if an internal
1615 compiler error is encountered.
1617 @item -pipe
1618 @opindex pipe
1619 Use pipes rather than temporary files for communication between the
1620 various stages of compilation.  This fails to work on some systems where
1621 the assembler is unable to read from a pipe; but the GNU assembler has
1622 no trouble.
1624 @item -specs=@var{file}
1625 @opindex specs
1626 Process @var{file} after the compiler reads in the standard @file{specs}
1627 file, in order to override the defaults which the @command{gcc} driver
1628 program uses when determining what switches to pass to @command{cc1},
1629 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1630 @option{-specs=@var{file}} can be specified on the command line, and they
1631 are processed in order, from left to right.  @xref{Spec Files}, for
1632 information about the format of the @var{file}.
1634 @item -wrapper
1635 @opindex wrapper
1636 Invoke all subcommands under a wrapper program.  The name of the
1637 wrapper program and its parameters are passed as a comma separated
1638 list.
1640 @smallexample
1641 gcc -c t.c -wrapper gdb,--args
1642 @end smallexample
1644 @noindent
1645 This invokes all subprograms of @command{gcc} under
1646 @samp{gdb --args}, thus the invocation of @command{cc1} is
1647 @samp{gdb --args cc1 @dots{}}.
1649 @item -fplugin=@var{name}.so
1650 @opindex fplugin
1651 Load the plugin code in file @var{name}.so, assumed to be a
1652 shared object to be dlopen'd by the compiler.  The base name of
1653 the shared object file is used to identify the plugin for the
1654 purposes of argument parsing (See
1655 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1656 Each plugin should define the callback functions specified in the
1657 Plugins API.
1659 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1660 @opindex fplugin-arg
1661 Define an argument called @var{key} with a value of @var{value}
1662 for the plugin called @var{name}.
1664 @item -fdump-ada-spec@r{[}-slim@r{]}
1665 @opindex fdump-ada-spec
1666 For C and C++ source and include files, generate corresponding Ada specs.
1667 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1668 GNAT User's Guide}, which provides detailed documentation on this feature.
1670 @item -fada-spec-parent=@var{unit}
1671 @opindex fada-spec-parent
1672 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1673 Ada specs as child units of parent @var{unit}.
1675 @item -fdump-go-spec=@var{file}
1676 @opindex fdump-go-spec
1677 For input files in any language, generate corresponding Go
1678 declarations in @var{file}.  This generates Go @code{const},
1679 @code{type}, @code{var}, and @code{func} declarations which may be a
1680 useful way to start writing a Go interface to code written in some
1681 other language.
1683 @include @value{srcdir}/../libiberty/at-file.texi
1684 @end table
1686 @node Invoking G++
1687 @section Compiling C++ Programs
1689 @cindex suffixes for C++ source
1690 @cindex C++ source file suffixes
1691 C++ source files conventionally use one of the suffixes @samp{.C},
1692 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1693 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1694 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1695 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1696 files with these names and compiles them as C++ programs even if you
1697 call the compiler the same way as for compiling C programs (usually
1698 with the name @command{gcc}).
1700 @findex g++
1701 @findex c++
1702 However, the use of @command{gcc} does not add the C++ library.
1703 @command{g++} is a program that calls GCC and automatically specifies linking
1704 against the C++ library.  It treats @samp{.c},
1705 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1706 files unless @option{-x} is used.  This program is also useful when
1707 precompiling a C header file with a @samp{.h} extension for use in C++
1708 compilations.  On many systems, @command{g++} is also installed with
1709 the name @command{c++}.
1711 @cindex invoking @command{g++}
1712 When you compile C++ programs, you may specify many of the same
1713 command-line options that you use for compiling programs in any
1714 language; or command-line options meaningful for C and related
1715 languages; or options that are meaningful only for C++ programs.
1716 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1717 explanations of options for languages related to C@.
1718 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1719 explanations of options that are meaningful only for C++ programs.
1721 @node C Dialect Options
1722 @section Options Controlling C Dialect
1723 @cindex dialect options
1724 @cindex language dialect options
1725 @cindex options, dialect
1727 The following options control the dialect of C (or languages derived
1728 from C, such as C++, Objective-C and Objective-C++) that the compiler
1729 accepts:
1731 @table @gcctabopt
1732 @cindex ANSI support
1733 @cindex ISO support
1734 @item -ansi
1735 @opindex ansi
1736 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1737 equivalent to @option{-std=c++98}.
1739 This turns off certain features of GCC that are incompatible with ISO
1740 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1741 such as the @code{asm} and @code{typeof} keywords, and
1742 predefined macros such as @code{unix} and @code{vax} that identify the
1743 type of system you are using.  It also enables the undesirable and
1744 rarely used ISO trigraph feature.  For the C compiler,
1745 it disables recognition of C++ style @samp{//} comments as well as
1746 the @code{inline} keyword.
1748 The alternate keywords @code{__asm__}, @code{__extension__},
1749 @code{__inline__} and @code{__typeof__} continue to work despite
1750 @option{-ansi}.  You would not want to use them in an ISO C program, of
1751 course, but it is useful to put them in header files that might be included
1752 in compilations done with @option{-ansi}.  Alternate predefined macros
1753 such as @code{__unix__} and @code{__vax__} are also available, with or
1754 without @option{-ansi}.
1756 The @option{-ansi} option does not cause non-ISO programs to be
1757 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1758 addition to @option{-ansi}.  @xref{Warning Options}.
1760 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1761 option is used.  Some header files may notice this macro and refrain
1762 from declaring certain functions or defining certain macros that the
1763 ISO standard doesn't call for; this is to avoid interfering with any
1764 programs that might use these names for other things.
1766 Functions that are normally built in but do not have semantics
1767 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1768 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1769 built-in functions provided by GCC}, for details of the functions
1770 affected.
1772 @item -std=
1773 @opindex std
1774 Determine the language standard. @xref{Standards,,Language Standards
1775 Supported by GCC}, for details of these standard versions.  This option
1776 is currently only supported when compiling C or C++.
1778 The compiler can accept several base standards, such as @samp{c90} or
1779 @samp{c++98}, and GNU dialects of those standards, such as
1780 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1781 compiler accepts all programs following that standard plus those
1782 using GNU extensions that do not contradict it.  For example,
1783 @option{-std=c90} turns off certain features of GCC that are
1784 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1785 keywords, but not other GNU extensions that do not have a meaning in
1786 ISO C90, such as omitting the middle term of a @code{?:}
1787 expression. On the other hand, when a GNU dialect of a standard is
1788 specified, all features supported by the compiler are enabled, even when
1789 those features change the meaning of the base standard.  As a result, some
1790 strict-conforming programs may be rejected.  The particular standard
1791 is used by @option{-Wpedantic} to identify which features are GNU
1792 extensions given that version of the standard. For example
1793 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1794 comments, while @option{-std=gnu99 -Wpedantic} does not.
1796 A value for this option must be provided; possible values are
1798 @table @samp
1799 @item c90
1800 @itemx c89
1801 @itemx iso9899:1990
1802 Support all ISO C90 programs (certain GNU extensions that conflict
1803 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1805 @item iso9899:199409
1806 ISO C90 as modified in amendment 1.
1808 @item c99
1809 @itemx c9x
1810 @itemx iso9899:1999
1811 @itemx iso9899:199x
1812 ISO C99.  This standard is substantially completely supported, modulo
1813 bugs and floating-point issues
1814 (mainly but not entirely relating to optional C99 features from
1815 Annexes F and G).  See
1816 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1817 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1819 @item c11
1820 @itemx c1x
1821 @itemx iso9899:2011
1822 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1823 substantially completely supported, modulo bugs, floating-point issues
1824 (mainly but not entirely relating to optional C11 features from
1825 Annexes F and G) and the optional Annexes K (Bounds-checking
1826 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1828 @item gnu90
1829 @itemx gnu89
1830 GNU dialect of ISO C90 (including some C99 features).
1832 @item gnu99
1833 @itemx gnu9x
1834 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1836 @item gnu11
1837 @itemx gnu1x
1838 GNU dialect of ISO C11.  This is the default for C code.
1839 The name @samp{gnu1x} is deprecated.
1841 @item c++98
1842 @itemx c++03
1843 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1844 additional defect reports. Same as @option{-ansi} for C++ code.
1846 @item gnu++98
1847 @itemx gnu++03
1848 GNU dialect of @option{-std=c++98}.
1850 @item c++11
1851 @itemx c++0x
1852 The 2011 ISO C++ standard plus amendments.
1853 The name @samp{c++0x} is deprecated.
1855 @item gnu++11
1856 @itemx gnu++0x
1857 GNU dialect of @option{-std=c++11}.
1858 The name @samp{gnu++0x} is deprecated.
1860 @item c++14
1861 @itemx c++1y
1862 The 2014 ISO C++ standard plus amendments.
1863 The name @samp{c++1y} is deprecated.
1865 @item gnu++14
1866 @itemx gnu++1y
1867 GNU dialect of @option{-std=c++14}.
1868 This is the default for C++ code.
1869 The name @samp{gnu++1y} is deprecated.
1871 @item c++1z
1872 The next revision of the ISO C++ standard, tentatively planned for
1873 2017.  Support is highly experimental, and will almost certainly
1874 change in incompatible ways in future releases.
1876 @item gnu++1z
1877 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1878 and will almost certainly change in incompatible ways in future
1879 releases.
1880 @end table
1882 @item -fgnu89-inline
1883 @opindex fgnu89-inline
1884 The option @option{-fgnu89-inline} tells GCC to use the traditional
1885 GNU semantics for @code{inline} functions when in C99 mode.
1886 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1887 Using this option is roughly equivalent to adding the
1888 @code{gnu_inline} function attribute to all inline functions
1889 (@pxref{Function Attributes}).
1891 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1892 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1893 specifies the default behavior).
1894 This option is not supported in @option{-std=c90} or
1895 @option{-std=gnu90} mode.
1897 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1898 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1899 in effect for @code{inline} functions.  @xref{Common Predefined
1900 Macros,,,cpp,The C Preprocessor}.
1902 @item -fpermitted-flt-eval-methods=@var{style}
1903 @opindex fpermitted-flt-eval-methods
1904 @opindex fpermitted-flt-eval-methods=c11
1905 @opindex fpermitted-flt-eval-methods=ts-18661-3
1906 ISO/IEC TS 18661-3 defines new permissible values for
1907 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1908 a semantic type that is an interchange or extended format should be
1909 evaluated to the precision and range of that type.  These new values are
1910 a superset of those permitted under C99/C11, which does not specify the
1911 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1912 conforming to C11 may not have been written expecting the possibility of
1913 the new values.
1915 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1916 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1917 or the extended set of values specified in ISO/IEC TS 18661-3.
1919 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1921 The default when in a standards compliant mode (@option{-std=c11} or similar)
1922 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1923 dialect (@option{-std=gnu11} or similar) is
1924 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1926 @item -aux-info @var{filename}
1927 @opindex aux-info
1928 Output to the given filename prototyped declarations for all functions
1929 declared and/or defined in a translation unit, including those in header
1930 files.  This option is silently ignored in any language other than C@.
1932 Besides declarations, the file indicates, in comments, the origin of
1933 each declaration (source file and line), whether the declaration was
1934 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1935 @samp{O} for old, respectively, in the first character after the line
1936 number and the colon), and whether it came from a declaration or a
1937 definition (@samp{C} or @samp{F}, respectively, in the following
1938 character).  In the case of function definitions, a K&R-style list of
1939 arguments followed by their declarations is also provided, inside
1940 comments, after the declaration.
1942 @item -fallow-parameterless-variadic-functions
1943 @opindex fallow-parameterless-variadic-functions
1944 Accept variadic functions without named parameters.
1946 Although it is possible to define such a function, this is not very
1947 useful as it is not possible to read the arguments.  This is only
1948 supported for C as this construct is allowed by C++.
1950 @item -fno-asm
1951 @opindex fno-asm
1952 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1953 keyword, so that code can use these words as identifiers.  You can use
1954 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1955 instead.  @option{-ansi} implies @option{-fno-asm}.
1957 In C++, this switch only affects the @code{typeof} keyword, since
1958 @code{asm} and @code{inline} are standard keywords.  You may want to
1959 use the @option{-fno-gnu-keywords} flag instead, which has the same
1960 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1961 switch only affects the @code{asm} and @code{typeof} keywords, since
1962 @code{inline} is a standard keyword in ISO C99.
1964 @item -fno-builtin
1965 @itemx -fno-builtin-@var{function}
1966 @opindex fno-builtin
1967 @cindex built-in functions
1968 Don't recognize built-in functions that do not begin with
1969 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1970 functions provided by GCC}, for details of the functions affected,
1971 including those which are not built-in functions when @option{-ansi} or
1972 @option{-std} options for strict ISO C conformance are used because they
1973 do not have an ISO standard meaning.
1975 GCC normally generates special code to handle certain built-in functions
1976 more efficiently; for instance, calls to @code{alloca} may become single
1977 instructions which adjust the stack directly, and calls to @code{memcpy}
1978 may become inline copy loops.  The resulting code is often both smaller
1979 and faster, but since the function calls no longer appear as such, you
1980 cannot set a breakpoint on those calls, nor can you change the behavior
1981 of the functions by linking with a different library.  In addition,
1982 when a function is recognized as a built-in function, GCC may use
1983 information about that function to warn about problems with calls to
1984 that function, or to generate more efficient code, even if the
1985 resulting code still contains calls to that function.  For example,
1986 warnings are given with @option{-Wformat} for bad calls to
1987 @code{printf} when @code{printf} is built in and @code{strlen} is
1988 known not to modify global memory.
1990 With the @option{-fno-builtin-@var{function}} option
1991 only the built-in function @var{function} is
1992 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1993 function is named that is not built-in in this version of GCC, this
1994 option is ignored.  There is no corresponding
1995 @option{-fbuiltin-@var{function}} option; if you wish to enable
1996 built-in functions selectively when using @option{-fno-builtin} or
1997 @option{-ffreestanding}, you may define macros such as:
1999 @smallexample
2000 #define abs(n)          __builtin_abs ((n))
2001 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2002 @end smallexample
2004 @item -fgimple
2005 @opindex fgimple
2007 Enable parsing of function definitions marked with @code{__GIMPLE}.
2008 This is an experimental feature that allows unit testing of GIMPLE
2009 passes.
2011 @item -fhosted
2012 @opindex fhosted
2013 @cindex hosted environment
2015 Assert that compilation targets a hosted environment.  This implies
2016 @option{-fbuiltin}.  A hosted environment is one in which the
2017 entire standard library is available, and in which @code{main} has a return
2018 type of @code{int}.  Examples are nearly everything except a kernel.
2019 This is equivalent to @option{-fno-freestanding}.
2021 @item -ffreestanding
2022 @opindex ffreestanding
2023 @cindex hosted environment
2025 Assert that compilation targets a freestanding environment.  This
2026 implies @option{-fno-builtin}.  A freestanding environment
2027 is one in which the standard library may not exist, and program startup may
2028 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2029 This is equivalent to @option{-fno-hosted}.
2031 @xref{Standards,,Language Standards Supported by GCC}, for details of
2032 freestanding and hosted environments.
2034 @item -fopenacc
2035 @opindex fopenacc
2036 @cindex OpenACC accelerator programming
2037 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2038 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2039 compiler generates accelerated code according to the OpenACC Application
2040 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
2041 implies @option{-pthread}, and thus is only supported on targets that
2042 have support for @option{-pthread}.
2044 @item -fopenacc-dim=@var{geom}
2045 @opindex fopenacc-dim
2046 @cindex OpenACC accelerator programming
2047 Specify default compute dimensions for parallel offload regions that do
2048 not explicitly specify.  The @var{geom} value is a triple of
2049 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2050 can be omitted, to use a target-specific default value.
2052 @item -fopenmp
2053 @opindex fopenmp
2054 @cindex OpenMP parallel
2055 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2056 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2057 compiler generates parallel code according to the OpenMP Application
2058 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2059 implies @option{-pthread}, and thus is only supported on targets that
2060 have support for @option{-pthread}. @option{-fopenmp} implies
2061 @option{-fopenmp-simd}.
2063 @item -fopenmp-simd
2064 @opindex fopenmp-simd
2065 @cindex OpenMP SIMD
2066 @cindex SIMD
2067 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2068 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2069 are ignored.
2071 @item -fcilkplus
2072 @opindex fcilkplus
2073 @cindex Enable Cilk Plus
2074 Enable the usage of Cilk Plus language extension features for C/C++.
2075 When the option @option{-fcilkplus} is specified, enable the usage of
2076 the Cilk Plus Language extension features for C/C++.  The present
2077 implementation follows ABI version 1.2.  This is an experimental
2078 feature that is only partially complete, and whose interface may
2079 change in future versions of GCC as the official specification
2080 changes.  Currently, all features but @code{_Cilk_for} have been
2081 implemented.
2083 @item -fgnu-tm
2084 @opindex fgnu-tm
2085 When the option @option{-fgnu-tm} is specified, the compiler
2086 generates code for the Linux variant of Intel's current Transactional
2087 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2088 an experimental feature whose interface may change in future versions
2089 of GCC, as the official specification changes.  Please note that not
2090 all architectures are supported for this feature.
2092 For more information on GCC's support for transactional memory,
2093 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2094 Transactional Memory Library}.
2096 Note that the transactional memory feature is not supported with
2097 non-call exceptions (@option{-fnon-call-exceptions}).
2099 @item -fms-extensions
2100 @opindex fms-extensions
2101 Accept some non-standard constructs used in Microsoft header files.
2103 In C++ code, this allows member names in structures to be similar
2104 to previous types declarations.
2106 @smallexample
2107 typedef int UOW;
2108 struct ABC @{
2109   UOW UOW;
2111 @end smallexample
2113 Some cases of unnamed fields in structures and unions are only
2114 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2115 fields within structs/unions}, for details.
2117 Note that this option is off for all targets but x86 
2118 targets using ms-abi.
2120 @item -fplan9-extensions
2121 @opindex fplan9-extensions
2122 Accept some non-standard constructs used in Plan 9 code.
2124 This enables @option{-fms-extensions}, permits passing pointers to
2125 structures with anonymous fields to functions that expect pointers to
2126 elements of the type of the field, and permits referring to anonymous
2127 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2128 struct/union fields within structs/unions}, for details.  This is only
2129 supported for C, not C++.
2131 @item -fcond-mismatch
2132 @opindex fcond-mismatch
2133 Allow conditional expressions with mismatched types in the second and
2134 third arguments.  The value of such an expression is void.  This option
2135 is not supported for C++.
2137 @item -flax-vector-conversions
2138 @opindex flax-vector-conversions
2139 Allow implicit conversions between vectors with differing numbers of
2140 elements and/or incompatible element types.  This option should not be
2141 used for new code.
2143 @item -funsigned-char
2144 @opindex funsigned-char
2145 Let the type @code{char} be unsigned, like @code{unsigned char}.
2147 Each kind of machine has a default for what @code{char} should
2148 be.  It is either like @code{unsigned char} by default or like
2149 @code{signed char} by default.
2151 Ideally, a portable program should always use @code{signed char} or
2152 @code{unsigned char} when it depends on the signedness of an object.
2153 But many programs have been written to use plain @code{char} and
2154 expect it to be signed, or expect it to be unsigned, depending on the
2155 machines they were written for.  This option, and its inverse, let you
2156 make such a program work with the opposite default.
2158 The type @code{char} is always a distinct type from each of
2159 @code{signed char} or @code{unsigned char}, even though its behavior
2160 is always just like one of those two.
2162 @item -fsigned-char
2163 @opindex fsigned-char
2164 Let the type @code{char} be signed, like @code{signed char}.
2166 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2167 the negative form of @option{-funsigned-char}.  Likewise, the option
2168 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2170 @item -fsigned-bitfields
2171 @itemx -funsigned-bitfields
2172 @itemx -fno-signed-bitfields
2173 @itemx -fno-unsigned-bitfields
2174 @opindex fsigned-bitfields
2175 @opindex funsigned-bitfields
2176 @opindex fno-signed-bitfields
2177 @opindex fno-unsigned-bitfields
2178 These options control whether a bit-field is signed or unsigned, when the
2179 declaration does not use either @code{signed} or @code{unsigned}.  By
2180 default, such a bit-field is signed, because this is consistent: the
2181 basic integer types such as @code{int} are signed types.
2183 @item -fsso-struct=@var{endianness}
2184 @opindex fsso-struct
2185 Set the default scalar storage order of structures and unions to the
2186 specified endianness.  The accepted values are @samp{big-endian},
2187 @samp{little-endian} and @samp{native} for the native endianness of
2188 the target (the default).  This option is not supported for C++.
2190 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2191 code that is not binary compatible with code generated without it if the
2192 specified endianness is not the native endianness of the target.
2193 @end table
2195 @node C++ Dialect Options
2196 @section Options Controlling C++ Dialect
2198 @cindex compiler options, C++
2199 @cindex C++ options, command-line
2200 @cindex options, C++
2201 This section describes the command-line options that are only meaningful
2202 for C++ programs.  You can also use most of the GNU compiler options
2203 regardless of what language your program is in.  For example, you
2204 might compile a file @file{firstClass.C} like this:
2206 @smallexample
2207 g++ -g -fstrict-enums -O -c firstClass.C
2208 @end smallexample
2210 @noindent
2211 In this example, only @option{-fstrict-enums} is an option meant
2212 only for C++ programs; you can use the other options with any
2213 language supported by GCC@.
2215 Some options for compiling C programs, such as @option{-std}, are also
2216 relevant for C++ programs.
2217 @xref{C Dialect Options,,Options Controlling C Dialect}.
2219 Here is a list of options that are @emph{only} for compiling C++ programs:
2221 @table @gcctabopt
2223 @item -fabi-version=@var{n}
2224 @opindex fabi-version
2225 Use version @var{n} of the C++ ABI@.  The default is version 0.
2227 Version 0 refers to the version conforming most closely to
2228 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2229 will change in different versions of G++ as ABI bugs are fixed.
2231 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2233 Version 2 is the version of the C++ ABI that first appeared in G++
2234 3.4, and was the default through G++ 4.9.
2236 Version 3 corrects an error in mangling a constant address as a
2237 template argument.
2239 Version 4, which first appeared in G++ 4.5, implements a standard
2240 mangling for vector types.
2242 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2243 attribute const/volatile on function pointer types, decltype of a
2244 plain decl, and use of a function parameter in the declaration of
2245 another parameter.
2247 Version 6, which first appeared in G++ 4.7, corrects the promotion
2248 behavior of C++11 scoped enums and the mangling of template argument
2249 packs, const/static_cast, prefix ++ and --, and a class scope function
2250 used as a template argument.
2252 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2253 builtin type and corrects the mangling of lambdas in default argument
2254 scope.
2256 Version 8, which first appeared in G++ 4.9, corrects the substitution
2257 behavior of function types with function-cv-qualifiers.
2259 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2260 @code{nullptr_t}.
2262 Version 10, which first appeared in G++ 6.1, adds mangling of
2263 attributes that affect type identity, such as ia32 calling convention
2264 attributes (e.g. @samp{stdcall}).
2266 Version 11, which first appeared in G++ 7, corrects the mangling of
2267 sizeof... expressions and operator names.  For multiple entities with
2268 the same name within a function, that are declared in different scopes,
2269 the mangling now changes starting with the twelfth occurrence.  It also
2270 implies @option{-fnew-inheriting-ctors}.
2272 See also @option{-Wabi}.
2274 @item -fabi-compat-version=@var{n}
2275 @opindex fabi-compat-version
2276 On targets that support strong aliases, G++
2277 works around mangling changes by creating an alias with the correct
2278 mangled name when defining a symbol with an incorrect mangled name.
2279 This switch specifies which ABI version to use for the alias.
2281 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2282 compatibility).  If another ABI version is explicitly selected, this
2283 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2284 use @option{-fabi-compat-version=2}.
2286 If this option is not provided but @option{-Wabi=@var{n}} is, that
2287 version is used for compatibility aliases.  If this option is provided
2288 along with @option{-Wabi} (without the version), the version from this
2289 option is used for the warning.
2291 @item -fno-access-control
2292 @opindex fno-access-control
2293 Turn off all access checking.  This switch is mainly useful for working
2294 around bugs in the access control code.
2296 @item -faligned-new
2297 @opindex faligned-new
2298 Enable support for C++17 @code{new} of types that require more
2299 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2300 numeric argument such as @code{-faligned-new=32} can be used to
2301 specify how much alignment (in bytes) is provided by that function,
2302 but few users will need to override the default of
2303 @code{alignof(std::max_align_t)}.
2305 This flag is enabled by default for @option{-std=c++1z}.
2307 @item -fcheck-new
2308 @opindex fcheck-new
2309 Check that the pointer returned by @code{operator new} is non-null
2310 before attempting to modify the storage allocated.  This check is
2311 normally unnecessary because the C++ standard specifies that
2312 @code{operator new} only returns @code{0} if it is declared
2313 @code{throw()}, in which case the compiler always checks the
2314 return value even without this option.  In all other cases, when
2315 @code{operator new} has a non-empty exception specification, memory
2316 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2317 @samp{new (nothrow)}.
2319 @item -fconcepts
2320 @opindex fconcepts
2321 Enable support for the C++ Extensions for Concepts Technical
2322 Specification, ISO 19217 (2015), which allows code like
2324 @smallexample
2325 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2326 template <Addable T> T add (T a, T b) @{ return a + b; @}
2327 @end smallexample
2329 @item -fconstexpr-depth=@var{n}
2330 @opindex fconstexpr-depth
2331 Set the maximum nested evaluation depth for C++11 constexpr functions
2332 to @var{n}.  A limit is needed to detect endless recursion during
2333 constant expression evaluation.  The minimum specified by the standard
2334 is 512.
2336 @item -fconstexpr-loop-limit=@var{n}
2337 @opindex fconstexpr-loop-limit
2338 Set the maximum number of iterations for a loop in C++14 constexpr functions
2339 to @var{n}.  A limit is needed to detect infinite loops during
2340 constant expression evaluation.  The default is 262144 (1<<18).
2342 @item -fdeduce-init-list
2343 @opindex fdeduce-init-list
2344 Enable deduction of a template type parameter as
2345 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2347 @smallexample
2348 template <class T> auto forward(T t) -> decltype (realfn (t))
2350   return realfn (t);
2353 void f()
2355   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2357 @end smallexample
2359 This deduction was implemented as a possible extension to the
2360 originally proposed semantics for the C++11 standard, but was not part
2361 of the final standard, so it is disabled by default.  This option is
2362 deprecated, and may be removed in a future version of G++.
2364 @item -ffriend-injection
2365 @opindex ffriend-injection
2366 Inject friend functions into the enclosing namespace, so that they are
2367 visible outside the scope of the class in which they are declared.
2368 Friend functions were documented to work this way in the old Annotated
2369 C++ Reference Manual.  
2370 However, in ISO C++ a friend function that is not declared
2371 in an enclosing scope can only be found using argument dependent
2372 lookup.  GCC defaults to the standard behavior.
2374 This option is for compatibility, and may be removed in a future
2375 release of G++.
2377 @item -fno-elide-constructors
2378 @opindex fno-elide-constructors
2379 The C++ standard allows an implementation to omit creating a temporary
2380 that is only used to initialize another object of the same type.
2381 Specifying this option disables that optimization, and forces G++ to
2382 call the copy constructor in all cases.  This option also causes G++
2383 to call trivial member functions which otherwise would be expanded inline.
2385 In C++17, the compiler is required to omit these temporaries, but this
2386 option still affects trivial member functions.
2388 @item -fno-enforce-eh-specs
2389 @opindex fno-enforce-eh-specs
2390 Don't generate code to check for violation of exception specifications
2391 at run time.  This option violates the C++ standard, but may be useful
2392 for reducing code size in production builds, much like defining
2393 @code{NDEBUG}.  This does not give user code permission to throw
2394 exceptions in violation of the exception specifications; the compiler
2395 still optimizes based on the specifications, so throwing an
2396 unexpected exception results in undefined behavior at run time.
2398 @item -fextern-tls-init
2399 @itemx -fno-extern-tls-init
2400 @opindex fextern-tls-init
2401 @opindex fno-extern-tls-init
2402 The C++11 and OpenMP standards allow @code{thread_local} and
2403 @code{threadprivate} variables to have dynamic (runtime)
2404 initialization.  To support this, any use of such a variable goes
2405 through a wrapper function that performs any necessary initialization.
2406 When the use and definition of the variable are in the same
2407 translation unit, this overhead can be optimized away, but when the
2408 use is in a different translation unit there is significant overhead
2409 even if the variable doesn't actually need dynamic initialization.  If
2410 the programmer can be sure that no use of the variable in a
2411 non-defining TU needs to trigger dynamic initialization (either
2412 because the variable is statically initialized, or a use of the
2413 variable in the defining TU will be executed before any uses in
2414 another TU), they can avoid this overhead with the
2415 @option{-fno-extern-tls-init} option.
2417 On targets that support symbol aliases, the default is
2418 @option{-fextern-tls-init}.  On targets that do not support symbol
2419 aliases, the default is @option{-fno-extern-tls-init}.
2421 @item -ffor-scope
2422 @itemx -fno-for-scope
2423 @opindex ffor-scope
2424 @opindex fno-for-scope
2425 If @option{-ffor-scope} is specified, the scope of variables declared in
2426 a @i{for-init-statement} is limited to the @code{for} loop itself,
2427 as specified by the C++ standard.
2428 If @option{-fno-for-scope} is specified, the scope of variables declared in
2429 a @i{for-init-statement} extends to the end of the enclosing scope,
2430 as was the case in old versions of G++, and other (traditional)
2431 implementations of C++.
2433 If neither flag is given, the default is to follow the standard,
2434 but to allow and give a warning for old-style code that would
2435 otherwise be invalid, or have different behavior.
2437 @item -fno-gnu-keywords
2438 @opindex fno-gnu-keywords
2439 Do not recognize @code{typeof} as a keyword, so that code can use this
2440 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2441 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2442 @option{-std=c++98}, @option{-std=c++11}, etc.
2444 @item -fno-implicit-templates
2445 @opindex fno-implicit-templates
2446 Never emit code for non-inline templates that are instantiated
2447 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2448 @xref{Template Instantiation}, for more information.
2450 @item -fno-implicit-inline-templates
2451 @opindex fno-implicit-inline-templates
2452 Don't emit code for implicit instantiations of inline templates, either.
2453 The default is to handle inlines differently so that compiles with and
2454 without optimization need the same set of explicit instantiations.
2456 @item -fno-implement-inlines
2457 @opindex fno-implement-inlines
2458 To save space, do not emit out-of-line copies of inline functions
2459 controlled by @code{#pragma implementation}.  This causes linker
2460 errors if these functions are not inlined everywhere they are called.
2462 @item -fms-extensions
2463 @opindex fms-extensions
2464 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2465 int and getting a pointer to member function via non-standard syntax.
2467 @item -fnew-inheriting-ctors
2468 @opindex fnew-inheriting-ctors
2469 Enable the P0136 adjustment to the semantics of C++11 constructor
2470 inheritance.  This is part of C++17 but also considered to be a Defect
2471 Report against C++11 and C++14.  This flag is enabled by default
2472 unless @option{-fabi-version=10} or lower is specified.
2474 @item -fnew-ttp-matching
2475 @opindex fnew-ttp-matching
2476 Enable the P0522 resolution to Core issue 150, template template
2477 parameters and default arguments: this allows a template with default
2478 template arguments as an argument for a template template parameter
2479 with fewer template parameters.  This flag is enabled by default for
2480 @option{-std=c++1z}.
2482 @item -fno-nonansi-builtins
2483 @opindex fno-nonansi-builtins
2484 Disable built-in declarations of functions that are not mandated by
2485 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2486 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2488 @item -fnothrow-opt
2489 @opindex fnothrow-opt
2490 Treat a @code{throw()} exception specification as if it were a
2491 @code{noexcept} specification to reduce or eliminate the text size
2492 overhead relative to a function with no exception specification.  If
2493 the function has local variables of types with non-trivial
2494 destructors, the exception specification actually makes the
2495 function smaller because the EH cleanups for those variables can be
2496 optimized away.  The semantic effect is that an exception thrown out of
2497 a function with such an exception specification results in a call
2498 to @code{terminate} rather than @code{unexpected}.
2500 @item -fno-operator-names
2501 @opindex fno-operator-names
2502 Do not treat the operator name keywords @code{and}, @code{bitand},
2503 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2504 synonyms as keywords.
2506 @item -fno-optional-diags
2507 @opindex fno-optional-diags
2508 Disable diagnostics that the standard says a compiler does not need to
2509 issue.  Currently, the only such diagnostic issued by G++ is the one for
2510 a name having multiple meanings within a class.
2512 @item -fpermissive
2513 @opindex fpermissive
2514 Downgrade some diagnostics about nonconformant code from errors to
2515 warnings.  Thus, using @option{-fpermissive} allows some
2516 nonconforming code to compile.
2518 @item -fno-pretty-templates
2519 @opindex fno-pretty-templates
2520 When an error message refers to a specialization of a function
2521 template, the compiler normally prints the signature of the
2522 template followed by the template arguments and any typedefs or
2523 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2524 rather than @code{void f(int)}) so that it's clear which template is
2525 involved.  When an error message refers to a specialization of a class
2526 template, the compiler omits any template arguments that match
2527 the default template arguments for that template.  If either of these
2528 behaviors make it harder to understand the error message rather than
2529 easier, you can use @option{-fno-pretty-templates} to disable them.
2531 @item -frepo
2532 @opindex frepo
2533 Enable automatic template instantiation at link time.  This option also
2534 implies @option{-fno-implicit-templates}.  @xref{Template
2535 Instantiation}, for more information.
2537 @item -fno-rtti
2538 @opindex fno-rtti
2539 Disable generation of information about every class with virtual
2540 functions for use by the C++ run-time type identification features
2541 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2542 of the language, you can save some space by using this flag.  Note that
2543 exception handling uses the same information, but G++ generates it as
2544 needed. The @code{dynamic_cast} operator can still be used for casts that
2545 do not require run-time type information, i.e.@: casts to @code{void *} or to
2546 unambiguous base classes.
2548 @item -fsized-deallocation
2549 @opindex fsized-deallocation
2550 Enable the built-in global declarations
2551 @smallexample
2552 void operator delete (void *, std::size_t) noexcept;
2553 void operator delete[] (void *, std::size_t) noexcept;
2554 @end smallexample
2555 as introduced in C++14.  This is useful for user-defined replacement
2556 deallocation functions that, for example, use the size of the object
2557 to make deallocation faster.  Enabled by default under
2558 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2559 warns about places that might want to add a definition.
2561 @item -fstrict-enums
2562 @opindex fstrict-enums
2563 Allow the compiler to optimize using the assumption that a value of
2564 enumerated type can only be one of the values of the enumeration (as
2565 defined in the C++ standard; basically, a value that can be
2566 represented in the minimum number of bits needed to represent all the
2567 enumerators).  This assumption may not be valid if the program uses a
2568 cast to convert an arbitrary integer value to the enumerated type.
2570 @item -fstrong-eval-order
2571 @opindex fstrong-eval-order
2572 Evaluate member access, array subscripting, and shift expressions in
2573 left-to-right order, and evaluate assignment in right-to-left order,
2574 as adopted for C++17.  Enabled by default with @option{-std=c++1z}.
2575 @option{-fstrong-eval-order=some} enables just the ordering of member
2576 access and shift expressions, and is the default without
2577 @option{-std=c++1z}.
2579 @item -ftemplate-backtrace-limit=@var{n}
2580 @opindex ftemplate-backtrace-limit
2581 Set the maximum number of template instantiation notes for a single
2582 warning or error to @var{n}.  The default value is 10.
2584 @item -ftemplate-depth=@var{n}
2585 @opindex ftemplate-depth
2586 Set the maximum instantiation depth for template classes to @var{n}.
2587 A limit on the template instantiation depth is needed to detect
2588 endless recursions during template class instantiation.  ANSI/ISO C++
2589 conforming programs must not rely on a maximum depth greater than 17
2590 (changed to 1024 in C++11).  The default value is 900, as the compiler
2591 can run out of stack space before hitting 1024 in some situations.
2593 @item -fno-threadsafe-statics
2594 @opindex fno-threadsafe-statics
2595 Do not emit the extra code to use the routines specified in the C++
2596 ABI for thread-safe initialization of local statics.  You can use this
2597 option to reduce code size slightly in code that doesn't need to be
2598 thread-safe.
2600 @item -fuse-cxa-atexit
2601 @opindex fuse-cxa-atexit
2602 Register destructors for objects with static storage duration with the
2603 @code{__cxa_atexit} function rather than the @code{atexit} function.
2604 This option is required for fully standards-compliant handling of static
2605 destructors, but only works if your C library supports
2606 @code{__cxa_atexit}.
2608 @item -fno-use-cxa-get-exception-ptr
2609 @opindex fno-use-cxa-get-exception-ptr
2610 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2611 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2612 if the runtime routine is not available.
2614 @item -fvisibility-inlines-hidden
2615 @opindex fvisibility-inlines-hidden
2616 This switch declares that the user does not attempt to compare
2617 pointers to inline functions or methods where the addresses of the two functions
2618 are taken in different shared objects.
2620 The effect of this is that GCC may, effectively, mark inline methods with
2621 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2622 appear in the export table of a DSO and do not require a PLT indirection
2623 when used within the DSO@.  Enabling this option can have a dramatic effect
2624 on load and link times of a DSO as it massively reduces the size of the
2625 dynamic export table when the library makes heavy use of templates.
2627 The behavior of this switch is not quite the same as marking the
2628 methods as hidden directly, because it does not affect static variables
2629 local to the function or cause the compiler to deduce that
2630 the function is defined in only one shared object.
2632 You may mark a method as having a visibility explicitly to negate the
2633 effect of the switch for that method.  For example, if you do want to
2634 compare pointers to a particular inline method, you might mark it as
2635 having default visibility.  Marking the enclosing class with explicit
2636 visibility has no effect.
2638 Explicitly instantiated inline methods are unaffected by this option
2639 as their linkage might otherwise cross a shared library boundary.
2640 @xref{Template Instantiation}.
2642 @item -fvisibility-ms-compat
2643 @opindex fvisibility-ms-compat
2644 This flag attempts to use visibility settings to make GCC's C++
2645 linkage model compatible with that of Microsoft Visual Studio.
2647 The flag makes these changes to GCC's linkage model:
2649 @enumerate
2650 @item
2651 It sets the default visibility to @code{hidden}, like
2652 @option{-fvisibility=hidden}.
2654 @item
2655 Types, but not their members, are not hidden by default.
2657 @item
2658 The One Definition Rule is relaxed for types without explicit
2659 visibility specifications that are defined in more than one
2660 shared object: those declarations are permitted if they are
2661 permitted when this option is not used.
2662 @end enumerate
2664 In new code it is better to use @option{-fvisibility=hidden} and
2665 export those classes that are intended to be externally visible.
2666 Unfortunately it is possible for code to rely, perhaps accidentally,
2667 on the Visual Studio behavior.
2669 Among the consequences of these changes are that static data members
2670 of the same type with the same name but defined in different shared
2671 objects are different, so changing one does not change the other;
2672 and that pointers to function members defined in different shared
2673 objects may not compare equal.  When this flag is given, it is a
2674 violation of the ODR to define types with the same name differently.
2676 @item -fno-weak
2677 @opindex fno-weak
2678 Do not use weak symbol support, even if it is provided by the linker.
2679 By default, G++ uses weak symbols if they are available.  This
2680 option exists only for testing, and should not be used by end-users;
2681 it results in inferior code and has no benefits.  This option may
2682 be removed in a future release of G++.
2684 @item -nostdinc++
2685 @opindex nostdinc++
2686 Do not search for header files in the standard directories specific to
2687 C++, but do still search the other standard directories.  (This option
2688 is used when building the C++ library.)
2689 @end table
2691 In addition, these optimization, warning, and code generation options
2692 have meanings only for C++ programs:
2694 @table @gcctabopt
2695 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2696 @opindex Wabi
2697 @opindex Wno-abi
2698 Warn when G++ it generates code that is probably not compatible with
2699 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2700 ABI with each major release, normally @option{-Wabi} will warn only if
2701 there is a check added later in a release series for an ABI issue
2702 discovered since the initial release.  @option{-Wabi} will warn about
2703 more things if an older ABI version is selected (with
2704 @option{-fabi-version=@var{n}}).
2706 @option{-Wabi} can also be used with an explicit version number to
2707 warn about compatibility with a particular @option{-fabi-version}
2708 level, e.g. @option{-Wabi=2} to warn about changes relative to
2709 @option{-fabi-version=2}.
2711 If an explicit version number is provided and
2712 @option{-fabi-compat-version} is not specified, the version number
2713 from this option is used for compatibility aliases.  If no explicit
2714 version number is provided with this option, but
2715 @option{-fabi-compat-version} is specified, that version number is
2716 used for ABI warnings.
2718 Although an effort has been made to warn about
2719 all such cases, there are probably some cases that are not warned about,
2720 even though G++ is generating incompatible code.  There may also be
2721 cases where warnings are emitted even though the code that is generated
2722 is compatible.
2724 You should rewrite your code to avoid these warnings if you are
2725 concerned about the fact that code generated by G++ may not be binary
2726 compatible with code generated by other compilers.
2728 Known incompatibilities in @option{-fabi-version=2} (which was the
2729 default from GCC 3.4 to 4.9) include:
2731 @itemize @bullet
2733 @item
2734 A template with a non-type template parameter of reference type was
2735 mangled incorrectly:
2736 @smallexample
2737 extern int N;
2738 template <int &> struct S @{@};
2739 void n (S<N>) @{2@}
2740 @end smallexample
2742 This was fixed in @option{-fabi-version=3}.
2744 @item
2745 SIMD vector types declared using @code{__attribute ((vector_size))} were
2746 mangled in a non-standard way that does not allow for overloading of
2747 functions taking vectors of different sizes.
2749 The mangling was changed in @option{-fabi-version=4}.
2751 @item
2752 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2753 qualifiers, and @code{decltype} of a plain declaration was folded away.
2755 These mangling issues were fixed in @option{-fabi-version=5}.
2757 @item
2758 Scoped enumerators passed as arguments to a variadic function are
2759 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2760 On most targets this does not actually affect the parameter passing
2761 ABI, as there is no way to pass an argument smaller than @code{int}.
2763 Also, the ABI changed the mangling of template argument packs,
2764 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2765 a class scope function used as a template argument.
2767 These issues were corrected in @option{-fabi-version=6}.
2769 @item
2770 Lambdas in default argument scope were mangled incorrectly, and the
2771 ABI changed the mangling of @code{nullptr_t}.
2773 These issues were corrected in @option{-fabi-version=7}.
2775 @item
2776 When mangling a function type with function-cv-qualifiers, the
2777 un-qualified function type was incorrectly treated as a substitution
2778 candidate.
2780 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2782 @item
2783 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2784 unaligned accesses.  Note that this did not affect the ABI of a
2785 function with a @code{nullptr_t} parameter, as parameters have a
2786 minimum alignment.
2788 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2790 @item
2791 Target-specific attributes that affect the identity of a type, such as
2792 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2793 did not affect the mangled name, leading to name collisions when
2794 function pointers were used as template arguments.
2796 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2798 @end itemize
2800 It also warns about psABI-related changes.  The known psABI changes at this
2801 point include:
2803 @itemize @bullet
2805 @item
2806 For SysV/x86-64, unions with @code{long double} members are 
2807 passed in memory as specified in psABI.  For example:
2809 @smallexample
2810 union U @{
2811   long double ld;
2812   int i;
2814 @end smallexample
2816 @noindent
2817 @code{union U} is always passed in memory.
2819 @end itemize
2821 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2822 @opindex Wabi-tag
2823 @opindex -Wabi-tag
2824 Warn when a type with an ABI tag is used in a context that does not
2825 have that ABI tag.  See @ref{C++ Attributes} for more information
2826 about ABI tags.
2828 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2829 @opindex Wctor-dtor-privacy
2830 @opindex Wno-ctor-dtor-privacy
2831 Warn when a class seems unusable because all the constructors or
2832 destructors in that class are private, and it has neither friends nor
2833 public static member functions.  Also warn if there are no non-private
2834 methods, and there's at least one private member function that isn't
2835 a constructor or destructor.
2837 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2838 @opindex Wdelete-non-virtual-dtor
2839 @opindex Wno-delete-non-virtual-dtor
2840 Warn when @code{delete} is used to destroy an instance of a class that
2841 has virtual functions and non-virtual destructor. It is unsafe to delete
2842 an instance of a derived class through a pointer to a base class if the
2843 base class does not have a virtual destructor.  This warning is enabled
2844 by @option{-Wall}.
2846 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2847 @opindex Wliteral-suffix
2848 @opindex Wno-literal-suffix
2849 Warn when a string or character literal is followed by a ud-suffix which does
2850 not begin with an underscore.  As a conforming extension, GCC treats such
2851 suffixes as separate preprocessing tokens in order to maintain backwards
2852 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2853 For example:
2855 @smallexample
2856 #define __STDC_FORMAT_MACROS
2857 #include <inttypes.h>
2858 #include <stdio.h>
2860 int main() @{
2861   int64_t i64 = 123;
2862   printf("My int64: %" PRId64"\n", i64);
2864 @end smallexample
2866 In this case, @code{PRId64} is treated as a separate preprocessing token.
2868 Additionally, warn when a user-defined literal operator is declared with
2869 a literal suffix identifier that doesn't begin with an underscore. Literal
2870 suffix identifiers that don't begin with an underscore are reserved for
2871 future standardization.
2873 This warning is enabled by default.
2875 @item -Wlto-type-mismatch
2876 @opindex Wlto-type-mismatch
2877 @opindex Wno-lto-type-mismatch
2879 During the link-time optimization warn about type mismatches in
2880 global declarations from different compilation units.
2881 Requires @option{-flto} to be enabled.  Enabled by default.
2883 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2884 @opindex Wnarrowing
2885 @opindex Wno-narrowing
2886 For C++11 and later standards, narrowing conversions are diagnosed by default,
2887 as required by the standard.  A narrowing conversion from a constant produces
2888 an error, and a narrowing conversion from a non-constant produces a warning,
2889 but @option{-Wno-narrowing} suppresses the diagnostic.
2890 Note that this does not affect the meaning of well-formed code;
2891 narrowing conversions are still considered ill-formed in SFINAE contexts.
2893 With @option{-Wnarrowing} in C++98, warn when a narrowing
2894 conversion prohibited by C++11 occurs within
2895 @samp{@{ @}}, e.g.
2897 @smallexample
2898 int i = @{ 2.2 @}; // error: narrowing from double to int
2899 @end smallexample
2901 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2903 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2904 @opindex Wnoexcept
2905 @opindex Wno-noexcept
2906 Warn when a noexcept-expression evaluates to false because of a call
2907 to a function that does not have a non-throwing exception
2908 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2909 the compiler to never throw an exception.
2911 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2912 @opindex Wnoexcept-type
2913 @opindex Wno-noexcept-type
2914 Warn if the C++1z feature making @code{noexcept} part of a function
2915 type changes the mangled name of a symbol relative to C++14.  Enabled
2916 by @option{-Wabi} and @option{-Wc++1z-compat}.
2918 @smallexample
2919 template <class T> void f(T t) @{ t(); @};
2920 void g() noexcept;
2921 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++1z calls f<void(*)()noexcept>
2922 @end smallexample
2924 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2925 @opindex Wclass-memaccess
2926 Warn when the destination of a call to a raw memory function such as
2927 @code{memset} or @code{memcpy} is an object of class type writing into which
2928 might bypass the class non-trivial or deleted constructor or copy assignment,
2929 violate const-correctness or encapsulation, or corrupt the virtual table.
2930 Modifying the representation of such objects may violate invariants maintained
2931 by member functions of the class.  For example, the call to @code{memset}
2932 below is undefined becase it modifies a non-trivial class object and is,
2933 therefore, diagnosed.  The safe way to either initialize or clear the storage
2934 of objects of such types is by using the appropriate constructor or assignment
2935 operator, if one is available.
2936 @smallexample
2937 std::string str = "abc";
2938 memset (&str, 0, 3);
2939 @end smallexample
2940 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2942 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2943 @opindex Wnon-virtual-dtor
2944 @opindex Wno-non-virtual-dtor
2945 Warn when a class has virtual functions and an accessible non-virtual
2946 destructor itself or in an accessible polymorphic base class, in which
2947 case it is possible but unsafe to delete an instance of a derived
2948 class through a pointer to the class itself or base class.  This
2949 warning is automatically enabled if @option{-Weffc++} is specified.
2951 @item -Wregister @r{(C++ and Objective-C++ only)}
2952 @opindex Wregister
2953 @opindex Wno-register
2954 Warn on uses of the @code{register} storage class specifier, except
2955 when it is part of the GNU @ref{Explicit Register Variables} extension.
2956 The use of the @code{register} keyword as storage class specifier has
2957 been deprecated in C++11 and removed in C++17.
2958 Enabled by default with @option{-std=c++1z}.
2960 @item -Wreorder @r{(C++ and Objective-C++ only)}
2961 @opindex Wreorder
2962 @opindex Wno-reorder
2963 @cindex reordering, warning
2964 @cindex warning for reordering of member initializers
2965 Warn when the order of member initializers given in the code does not
2966 match the order in which they must be executed.  For instance:
2968 @smallexample
2969 struct A @{
2970   int i;
2971   int j;
2972   A(): j (0), i (1) @{ @}
2974 @end smallexample
2976 @noindent
2977 The compiler rearranges the member initializers for @code{i}
2978 and @code{j} to match the declaration order of the members, emitting
2979 a warning to that effect.  This warning is enabled by @option{-Wall}.
2981 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2982 @opindex fext-numeric-literals
2983 @opindex fno-ext-numeric-literals
2984 Accept imaginary, fixed-point, or machine-defined
2985 literal number suffixes as GNU extensions.
2986 When this option is turned off these suffixes are treated
2987 as C++11 user-defined literal numeric suffixes.
2988 This is on by default for all pre-C++11 dialects and all GNU dialects:
2989 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2990 @option{-std=gnu++14}.
2991 This option is off by default
2992 for ISO C++11 onwards (@option{-std=c++11}, ...).
2993 @end table
2995 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2997 @table @gcctabopt
2998 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2999 @opindex Weffc++
3000 @opindex Wno-effc++
3001 Warn about violations of the following style guidelines from Scott Meyers'
3002 @cite{Effective C++} series of books:
3004 @itemize @bullet
3005 @item
3006 Define a copy constructor and an assignment operator for classes
3007 with dynamically-allocated memory.
3009 @item
3010 Prefer initialization to assignment in constructors.
3012 @item
3013 Have @code{operator=} return a reference to @code{*this}.
3015 @item
3016 Don't try to return a reference when you must return an object.
3018 @item
3019 Distinguish between prefix and postfix forms of increment and
3020 decrement operators.
3022 @item
3023 Never overload @code{&&}, @code{||}, or @code{,}.
3025 @end itemize
3027 This option also enables @option{-Wnon-virtual-dtor}, which is also
3028 one of the effective C++ recommendations.  However, the check is
3029 extended to warn about the lack of virtual destructor in accessible
3030 non-polymorphic bases classes too.
3032 When selecting this option, be aware that the standard library
3033 headers do not obey all of these guidelines; use @samp{grep -v}
3034 to filter out those warnings.
3036 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3037 @opindex Wstrict-null-sentinel
3038 @opindex Wno-strict-null-sentinel
3039 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3040 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3041 to @code{__null}.  Although it is a null pointer constant rather than a
3042 null pointer, it is guaranteed to be of the same size as a pointer.
3043 But this use is not portable across different compilers.
3045 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3046 @opindex Wno-non-template-friend
3047 @opindex Wnon-template-friend
3048 Disable warnings when non-template friend functions are declared
3049 within a template.  In very old versions of GCC that predate implementation
3050 of the ISO standard, declarations such as 
3051 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3052 could be interpreted as a particular specialization of a template
3053 function; the warning exists to diagnose compatibility problems, 
3054 and is enabled by default.
3056 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3057 @opindex Wold-style-cast
3058 @opindex Wno-old-style-cast
3059 Warn if an old-style (C-style) cast to a non-void type is used within
3060 a C++ program.  The new-style casts (@code{dynamic_cast},
3061 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3062 less vulnerable to unintended effects and much easier to search for.
3064 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3065 @opindex Woverloaded-virtual
3066 @opindex Wno-overloaded-virtual
3067 @cindex overloaded virtual function, warning
3068 @cindex warning for overloaded virtual function
3069 Warn when a function declaration hides virtual functions from a
3070 base class.  For example, in:
3072 @smallexample
3073 struct A @{
3074   virtual void f();
3077 struct B: public A @{
3078   void f(int);
3080 @end smallexample
3082 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3083 like:
3085 @smallexample
3086 B* b;
3087 b->f();
3088 @end smallexample
3090 @noindent
3091 fails to compile.
3093 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3094 @opindex Wno-pmf-conversions
3095 @opindex Wpmf-conversions
3096 Disable the diagnostic for converting a bound pointer to member function
3097 to a plain pointer.
3099 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3100 @opindex Wsign-promo
3101 @opindex Wno-sign-promo
3102 Warn when overload resolution chooses a promotion from unsigned or
3103 enumerated type to a signed type, over a conversion to an unsigned type of
3104 the same size.  Previous versions of G++ tried to preserve
3105 unsignedness, but the standard mandates the current behavior.
3107 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3108 @opindex Wtemplates
3109 Warn when a primary template declaration is encountered.  Some coding
3110 rules disallow templates, and this may be used to enforce that rule.
3111 The warning is inactive inside a system header file, such as the STL, so
3112 one can still use the STL.  One may also instantiate or specialize
3113 templates.
3115 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3116 @opindex Wmultiple-inheritance
3117 Warn when a class is defined with multiple direct base classes.  Some
3118 coding rules disallow multiple inheritance, and this may be used to
3119 enforce that rule.  The warning is inactive inside a system header file,
3120 such as the STL, so one can still use the STL.  One may also define
3121 classes that indirectly use multiple inheritance.
3123 @item -Wvirtual-inheritance
3124 @opindex Wvirtual-inheritance
3125 Warn when a class is defined with a virtual direct base class.  Some
3126 coding rules disallow multiple inheritance, and this may be used to
3127 enforce that rule.  The warning is inactive inside a system header file,
3128 such as the STL, so one can still use the STL.  One may also define
3129 classes that indirectly use virtual inheritance.
3131 @item -Wnamespaces
3132 @opindex Wnamespaces
3133 Warn when a namespace definition is opened.  Some coding rules disallow
3134 namespaces, and this may be used to enforce that rule.  The warning is
3135 inactive inside a system header file, such as the STL, so one can still
3136 use the STL.  One may also use using directives and qualified names.
3138 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3139 @opindex Wterminate
3140 @opindex Wno-terminate
3141 Disable the warning about a throw-expression that will immediately
3142 result in a call to @code{terminate}.
3143 @end table
3145 @node Objective-C and Objective-C++ Dialect Options
3146 @section Options Controlling Objective-C and Objective-C++ Dialects
3148 @cindex compiler options, Objective-C and Objective-C++
3149 @cindex Objective-C and Objective-C++ options, command-line
3150 @cindex options, Objective-C and Objective-C++
3151 (NOTE: This manual does not describe the Objective-C and Objective-C++
3152 languages themselves.  @xref{Standards,,Language Standards
3153 Supported by GCC}, for references.)
3155 This section describes the command-line options that are only meaningful
3156 for Objective-C and Objective-C++ programs.  You can also use most of
3157 the language-independent GNU compiler options.
3158 For example, you might compile a file @file{some_class.m} like this:
3160 @smallexample
3161 gcc -g -fgnu-runtime -O -c some_class.m
3162 @end smallexample
3164 @noindent
3165 In this example, @option{-fgnu-runtime} is an option meant only for
3166 Objective-C and Objective-C++ programs; you can use the other options with
3167 any language supported by GCC@.
3169 Note that since Objective-C is an extension of the C language, Objective-C
3170 compilations may also use options specific to the C front-end (e.g.,
3171 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3172 C++-specific options (e.g., @option{-Wabi}).
3174 Here is a list of options that are @emph{only} for compiling Objective-C
3175 and Objective-C++ programs:
3177 @table @gcctabopt
3178 @item -fconstant-string-class=@var{class-name}
3179 @opindex fconstant-string-class
3180 Use @var{class-name} as the name of the class to instantiate for each
3181 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3182 class name is @code{NXConstantString} if the GNU runtime is being used, and
3183 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3184 @option{-fconstant-cfstrings} option, if also present, overrides the
3185 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3186 to be laid out as constant CoreFoundation strings.
3188 @item -fgnu-runtime
3189 @opindex fgnu-runtime
3190 Generate object code compatible with the standard GNU Objective-C
3191 runtime.  This is the default for most types of systems.
3193 @item -fnext-runtime
3194 @opindex fnext-runtime
3195 Generate output compatible with the NeXT runtime.  This is the default
3196 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3197 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3198 used.
3200 @item -fno-nil-receivers
3201 @opindex fno-nil-receivers
3202 Assume that all Objective-C message dispatches (@code{[receiver
3203 message:arg]}) in this translation unit ensure that the receiver is
3204 not @code{nil}.  This allows for more efficient entry points in the
3205 runtime to be used.  This option is only available in conjunction with
3206 the NeXT runtime and ABI version 0 or 1.
3208 @item -fobjc-abi-version=@var{n}
3209 @opindex fobjc-abi-version
3210 Use version @var{n} of the Objective-C ABI for the selected runtime.
3211 This option is currently supported only for the NeXT runtime.  In that
3212 case, Version 0 is the traditional (32-bit) ABI without support for
3213 properties and other Objective-C 2.0 additions.  Version 1 is the
3214 traditional (32-bit) ABI with support for properties and other
3215 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3216 nothing is specified, the default is Version 0 on 32-bit target
3217 machines, and Version 2 on 64-bit target machines.
3219 @item -fobjc-call-cxx-cdtors
3220 @opindex fobjc-call-cxx-cdtors
3221 For each Objective-C class, check if any of its instance variables is a
3222 C++ object with a non-trivial default constructor.  If so, synthesize a
3223 special @code{- (id) .cxx_construct} instance method which runs
3224 non-trivial default constructors on any such instance variables, in order,
3225 and then return @code{self}.  Similarly, check if any instance variable
3226 is a C++ object with a non-trivial destructor, and if so, synthesize a
3227 special @code{- (void) .cxx_destruct} method which runs
3228 all such default destructors, in reverse order.
3230 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3231 methods thusly generated only operate on instance variables
3232 declared in the current Objective-C class, and not those inherited
3233 from superclasses.  It is the responsibility of the Objective-C
3234 runtime to invoke all such methods in an object's inheritance
3235 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3236 by the runtime immediately after a new object instance is allocated;
3237 the @code{- (void) .cxx_destruct} methods are invoked immediately
3238 before the runtime deallocates an object instance.
3240 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3241 support for invoking the @code{- (id) .cxx_construct} and
3242 @code{- (void) .cxx_destruct} methods.
3244 @item -fobjc-direct-dispatch
3245 @opindex fobjc-direct-dispatch
3246 Allow fast jumps to the message dispatcher.  On Darwin this is
3247 accomplished via the comm page.
3249 @item -fobjc-exceptions
3250 @opindex fobjc-exceptions
3251 Enable syntactic support for structured exception handling in
3252 Objective-C, similar to what is offered by C++.  This option
3253 is required to use the Objective-C keywords @code{@@try},
3254 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3255 @code{@@synchronized}.  This option is available with both the GNU
3256 runtime and the NeXT runtime (but not available in conjunction with
3257 the NeXT runtime on Mac OS X 10.2 and earlier).
3259 @item -fobjc-gc
3260 @opindex fobjc-gc
3261 Enable garbage collection (GC) in Objective-C and Objective-C++
3262 programs.  This option is only available with the NeXT runtime; the
3263 GNU runtime has a different garbage collection implementation that
3264 does not require special compiler flags.
3266 @item -fobjc-nilcheck
3267 @opindex fobjc-nilcheck
3268 For the NeXT runtime with version 2 of the ABI, check for a nil
3269 receiver in method invocations before doing the actual method call.
3270 This is the default and can be disabled using
3271 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3272 checked for nil in this way no matter what this flag is set to.
3273 Currently this flag does nothing when the GNU runtime, or an older
3274 version of the NeXT runtime ABI, is used.
3276 @item -fobjc-std=objc1
3277 @opindex fobjc-std
3278 Conform to the language syntax of Objective-C 1.0, the language
3279 recognized by GCC 4.0.  This only affects the Objective-C additions to
3280 the C/C++ language; it does not affect conformance to C/C++ standards,
3281 which is controlled by the separate C/C++ dialect option flags.  When
3282 this option is used with the Objective-C or Objective-C++ compiler,
3283 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3284 This is useful if you need to make sure that your Objective-C code can
3285 be compiled with older versions of GCC@.
3287 @item -freplace-objc-classes
3288 @opindex freplace-objc-classes
3289 Emit a special marker instructing @command{ld(1)} not to statically link in
3290 the resulting object file, and allow @command{dyld(1)} to load it in at
3291 run time instead.  This is used in conjunction with the Fix-and-Continue
3292 debugging mode, where the object file in question may be recompiled and
3293 dynamically reloaded in the course of program execution, without the need
3294 to restart the program itself.  Currently, Fix-and-Continue functionality
3295 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3296 and later.
3298 @item -fzero-link
3299 @opindex fzero-link
3300 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3301 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3302 compile time) with static class references that get initialized at load time,
3303 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3304 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3305 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3306 for individual class implementations to be modified during program execution.
3307 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3308 regardless of command-line options.
3310 @item -fno-local-ivars
3311 @opindex fno-local-ivars
3312 @opindex flocal-ivars
3313 By default instance variables in Objective-C can be accessed as if
3314 they were local variables from within the methods of the class they're
3315 declared in.  This can lead to shadowing between instance variables
3316 and other variables declared either locally inside a class method or
3317 globally with the same name.  Specifying the @option{-fno-local-ivars}
3318 flag disables this behavior thus avoiding variable shadowing issues.
3320 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3321 @opindex fivar-visibility
3322 Set the default instance variable visibility to the specified option
3323 so that instance variables declared outside the scope of any access
3324 modifier directives default to the specified visibility.
3326 @item -gen-decls
3327 @opindex gen-decls
3328 Dump interface declarations for all classes seen in the source file to a
3329 file named @file{@var{sourcename}.decl}.
3331 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3332 @opindex Wassign-intercept
3333 @opindex Wno-assign-intercept
3334 Warn whenever an Objective-C assignment is being intercepted by the
3335 garbage collector.
3337 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3338 @opindex Wno-protocol
3339 @opindex Wprotocol
3340 If a class is declared to implement a protocol, a warning is issued for
3341 every method in the protocol that is not implemented by the class.  The
3342 default behavior is to issue a warning for every method not explicitly
3343 implemented in the class, even if a method implementation is inherited
3344 from the superclass.  If you use the @option{-Wno-protocol} option, then
3345 methods inherited from the superclass are considered to be implemented,
3346 and no warning is issued for them.
3348 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3349 @opindex Wselector
3350 @opindex Wno-selector
3351 Warn if multiple methods of different types for the same selector are
3352 found during compilation.  The check is performed on the list of methods
3353 in the final stage of compilation.  Additionally, a check is performed
3354 for each selector appearing in a @code{@@selector(@dots{})}
3355 expression, and a corresponding method for that selector has been found
3356 during compilation.  Because these checks scan the method table only at
3357 the end of compilation, these warnings are not produced if the final
3358 stage of compilation is not reached, for example because an error is
3359 found during compilation, or because the @option{-fsyntax-only} option is
3360 being used.
3362 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3363 @opindex Wstrict-selector-match
3364 @opindex Wno-strict-selector-match
3365 Warn if multiple methods with differing argument and/or return types are
3366 found for a given selector when attempting to send a message using this
3367 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3368 is off (which is the default behavior), the compiler omits such warnings
3369 if any differences found are confined to types that share the same size
3370 and alignment.
3372 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3373 @opindex Wundeclared-selector
3374 @opindex Wno-undeclared-selector
3375 Warn if a @code{@@selector(@dots{})} expression referring to an
3376 undeclared selector is found.  A selector is considered undeclared if no
3377 method with that name has been declared before the
3378 @code{@@selector(@dots{})} expression, either explicitly in an
3379 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3380 an @code{@@implementation} section.  This option always performs its
3381 checks as soon as a @code{@@selector(@dots{})} expression is found,
3382 while @option{-Wselector} only performs its checks in the final stage of
3383 compilation.  This also enforces the coding style convention
3384 that methods and selectors must be declared before being used.
3386 @item -print-objc-runtime-info
3387 @opindex print-objc-runtime-info
3388 Generate C header describing the largest structure that is passed by
3389 value, if any.
3391 @end table
3393 @node Diagnostic Message Formatting Options
3394 @section Options to Control Diagnostic Messages Formatting
3395 @cindex options to control diagnostics formatting
3396 @cindex diagnostic messages
3397 @cindex message formatting
3399 Traditionally, diagnostic messages have been formatted irrespective of
3400 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3401 options described below
3402 to control the formatting algorithm for diagnostic messages, 
3403 e.g.@: how many characters per line, how often source location
3404 information should be reported.  Note that some language front ends may not
3405 honor these options.
3407 @table @gcctabopt
3408 @item -fmessage-length=@var{n}
3409 @opindex fmessage-length
3410 Try to format error messages so that they fit on lines of about
3411 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3412 done; each error message appears on a single line.  This is the
3413 default for all front ends.
3415 @item -fdiagnostics-show-location=once
3416 @opindex fdiagnostics-show-location
3417 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3418 reporter to emit source location information @emph{once}; that is, in
3419 case the message is too long to fit on a single physical line and has to
3420 be wrapped, the source location won't be emitted (as prefix) again,
3421 over and over, in subsequent continuation lines.  This is the default
3422 behavior.
3424 @item -fdiagnostics-show-location=every-line
3425 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3426 messages reporter to emit the same source location information (as
3427 prefix) for physical lines that result from the process of breaking
3428 a message which is too long to fit on a single line.
3430 @item -fdiagnostics-color[=@var{WHEN}]
3431 @itemx -fno-diagnostics-color
3432 @opindex fdiagnostics-color
3433 @cindex highlight, color
3434 @vindex GCC_COLORS @r{environment variable}
3435 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3436 or @samp{auto}.  The default depends on how the compiler has been configured,
3437 it can be any of the above @var{WHEN} options or also @samp{never}
3438 if @env{GCC_COLORS} environment variable isn't present in the environment,
3439 and @samp{auto} otherwise.
3440 @samp{auto} means to use color only when the standard error is a terminal.
3441 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3442 aliases for @option{-fdiagnostics-color=always} and
3443 @option{-fdiagnostics-color=never}, respectively.
3445 The colors are defined by the environment variable @env{GCC_COLORS}.
3446 Its value is a colon-separated list of capabilities and Select Graphic
3447 Rendition (SGR) substrings. SGR commands are interpreted by the
3448 terminal or terminal emulator.  (See the section in the documentation
3449 of your text terminal for permitted values and their meanings as
3450 character attributes.)  These substring values are integers in decimal
3451 representation and can be concatenated with semicolons.
3452 Common values to concatenate include
3453 @samp{1} for bold,
3454 @samp{4} for underline,
3455 @samp{5} for blink,
3456 @samp{7} for inverse,
3457 @samp{39} for default foreground color,
3458 @samp{30} to @samp{37} for foreground colors,
3459 @samp{90} to @samp{97} for 16-color mode foreground colors,
3460 @samp{38;5;0} to @samp{38;5;255}
3461 for 88-color and 256-color modes foreground colors,
3462 @samp{49} for default background color,
3463 @samp{40} to @samp{47} for background colors,
3464 @samp{100} to @samp{107} for 16-color mode background colors,
3465 and @samp{48;5;0} to @samp{48;5;255}
3466 for 88-color and 256-color modes background colors.
3468 The default @env{GCC_COLORS} is
3469 @smallexample
3470 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3471 quote=01:fixit-insert=32:fixit-delete=31:\
3472 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3473 type-diff=01;32
3474 @end smallexample
3475 @noindent
3476 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3477 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3478 @samp{01} is bold, and @samp{31} is red.
3479 Setting @env{GCC_COLORS} to the empty string disables colors.
3480 Supported capabilities are as follows.
3482 @table @code
3483 @item error=
3484 @vindex error GCC_COLORS @r{capability}
3485 SGR substring for error: markers.
3487 @item warning=
3488 @vindex warning GCC_COLORS @r{capability}
3489 SGR substring for warning: markers.
3491 @item note=
3492 @vindex note GCC_COLORS @r{capability}
3493 SGR substring for note: markers.
3495 @item range1=
3496 @vindex range1 GCC_COLORS @r{capability}
3497 SGR substring for first additional range.
3499 @item range2=
3500 @vindex range2 GCC_COLORS @r{capability}
3501 SGR substring for second additional range.
3503 @item locus=
3504 @vindex locus GCC_COLORS @r{capability}
3505 SGR substring for location information, @samp{file:line} or
3506 @samp{file:line:column} etc.
3508 @item quote=
3509 @vindex quote GCC_COLORS @r{capability}
3510 SGR substring for information printed within quotes.
3512 @item fixit-insert=
3513 @vindex fixit-insert GCC_COLORS @r{capability}
3514 SGR substring for fix-it hints suggesting text to
3515 be inserted or replaced.
3517 @item fixit-delete=
3518 @vindex fixit-delete GCC_COLORS @r{capability}
3519 SGR substring for fix-it hints suggesting text to
3520 be deleted.
3522 @item diff-filename=
3523 @vindex diff-filename GCC_COLORS @r{capability}
3524 SGR substring for filename headers within generated patches.
3526 @item diff-hunk=
3527 @vindex diff-hunk GCC_COLORS @r{capability}
3528 SGR substring for the starts of hunks within generated patches.
3530 @item diff-delete=
3531 @vindex diff-delete GCC_COLORS @r{capability}
3532 SGR substring for deleted lines within generated patches.
3534 @item diff-insert=
3535 @vindex diff-insert GCC_COLORS @r{capability}
3536 SGR substring for inserted lines within generated patches.
3538 @item type-diff=
3539 @vindex type-diff GCC_COLORS @r{capability}
3540 SGR substring for highlighting mismatching types within template
3541 arguments in the C++ frontend.
3542 @end table
3544 @item -fno-diagnostics-show-option
3545 @opindex fno-diagnostics-show-option
3546 @opindex fdiagnostics-show-option
3547 By default, each diagnostic emitted includes text indicating the
3548 command-line option that directly controls the diagnostic (if such an
3549 option is known to the diagnostic machinery).  Specifying the
3550 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3552 @item -fno-diagnostics-show-caret
3553 @opindex fno-diagnostics-show-caret
3554 @opindex fdiagnostics-show-caret
3555 By default, each diagnostic emitted includes the original source line
3556 and a caret @samp{^} indicating the column.  This option suppresses this
3557 information.  The source line is truncated to @var{n} characters, if
3558 the @option{-fmessage-length=n} option is given.  When the output is done
3559 to the terminal, the width is limited to the width given by the
3560 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3562 @item -fdiagnostics-parseable-fixits
3563 @opindex fdiagnostics-parseable-fixits
3564 Emit fix-it hints in a machine-parseable format, suitable for consumption
3565 by IDEs.  For each fix-it, a line will be printed after the relevant
3566 diagnostic, starting with the string ``fix-it:''.  For example:
3568 @smallexample
3569 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3570 @end smallexample
3572 The location is expressed as a half-open range, expressed as a count of
3573 bytes, starting at byte 1 for the initial column.  In the above example,
3574 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3575 given string:
3577 @smallexample
3578 00000000011111111112222222222
3579 12345678901234567890123456789
3580   gtk_widget_showall (dlg);
3581   ^^^^^^^^^^^^^^^^^^
3582   gtk_widget_show_all
3583 @end smallexample
3585 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3586 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3587 (e.g. vertical tab as ``\013'').
3589 An empty replacement string indicates that the given range is to be removed.
3590 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3591 be inserted at the given position.
3593 @item -fdiagnostics-generate-patch
3594 @opindex fdiagnostics-generate-patch
3595 Print fix-it hints to stderr in unified diff format, after any diagnostics
3596 are printed.  For example:
3598 @smallexample
3599 --- test.c
3600 +++ test.c
3601 @@ -42,5 +42,5 @@
3603  void show_cb(GtkDialog *dlg)
3604  @{
3605 -  gtk_widget_showall(dlg);
3606 +  gtk_widget_show_all(dlg);
3607  @}
3609 @end smallexample
3611 The diff may or may not be colorized, following the same rules
3612 as for diagnostics (see @option{-fdiagnostics-color}).
3614 @item -fdiagnostics-show-template-tree
3615 @opindex fdiagnostics-show-template-tree
3617 In the C++ frontend, when printing diagnostics showing mismatching
3618 template types, such as:
3620 @smallexample
3621   could not convert 'std::map<int, std::vector<double> >()'
3622     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3623 @end smallexample
3625 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3626 tree-like structure showing the common and differing parts of the types,
3627 such as:
3629 @smallexample
3630   map<
3631     [...],
3632     vector<
3633       [double != float]>>
3634 @end smallexample
3636 The parts that differ are highlighted with color (``double'' and
3637 ``float'' in this case).
3639 @item -fno-elide-type
3640 @opindex fno-elide-type
3641 @opindex felide-type
3642 By default when the C++ frontend prints diagnostics showing mismatching
3643 template types, common parts of the types are printed as ``[...]'' to
3644 simplify the error message.  For example:
3646 @smallexample
3647   could not convert 'std::map<int, std::vector<double> >()'
3648     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3649 @end smallexample
3651 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3652 This flag also affects the output of the
3653 @option{-fdiagnostics-show-template-tree} flag.
3655 @item -fno-show-column
3656 @opindex fno-show-column
3657 Do not print column numbers in diagnostics.  This may be necessary if
3658 diagnostics are being scanned by a program that does not understand the
3659 column numbers, such as @command{dejagnu}.
3661 @end table
3663 @node Warning Options
3664 @section Options to Request or Suppress Warnings
3665 @cindex options to control warnings
3666 @cindex warning messages
3667 @cindex messages, warning
3668 @cindex suppressing warnings
3670 Warnings are diagnostic messages that report constructions that
3671 are not inherently erroneous but that are risky or suggest there
3672 may have been an error.
3674 The following language-independent options do not enable specific
3675 warnings but control the kinds of diagnostics produced by GCC@.
3677 @table @gcctabopt
3678 @cindex syntax checking
3679 @item -fsyntax-only
3680 @opindex fsyntax-only
3681 Check the code for syntax errors, but don't do anything beyond that.
3683 @item -fmax-errors=@var{n}
3684 @opindex fmax-errors
3685 Limits the maximum number of error messages to @var{n}, at which point
3686 GCC bails out rather than attempting to continue processing the source
3687 code.  If @var{n} is 0 (the default), there is no limit on the number
3688 of error messages produced.  If @option{-Wfatal-errors} is also
3689 specified, then @option{-Wfatal-errors} takes precedence over this
3690 option.
3692 @item -w
3693 @opindex w
3694 Inhibit all warning messages.
3696 @item -Werror
3697 @opindex Werror
3698 @opindex Wno-error
3699 Make all warnings into errors.
3701 @item -Werror=
3702 @opindex Werror=
3703 @opindex Wno-error=
3704 Make the specified warning into an error.  The specifier for a warning
3705 is appended; for example @option{-Werror=switch} turns the warnings
3706 controlled by @option{-Wswitch} into errors.  This switch takes a
3707 negative form, to be used to negate @option{-Werror} for specific
3708 warnings; for example @option{-Wno-error=switch} makes
3709 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3710 is in effect.
3712 The warning message for each controllable warning includes the
3713 option that controls the warning.  That option can then be used with
3714 @option{-Werror=} and @option{-Wno-error=} as described above.
3715 (Printing of the option in the warning message can be disabled using the
3716 @option{-fno-diagnostics-show-option} flag.)
3718 Note that specifying @option{-Werror=}@var{foo} automatically implies
3719 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3720 imply anything.
3722 @item -Wfatal-errors
3723 @opindex Wfatal-errors
3724 @opindex Wno-fatal-errors
3725 This option causes the compiler to abort compilation on the first error
3726 occurred rather than trying to keep going and printing further error
3727 messages.
3729 @end table
3731 You can request many specific warnings with options beginning with
3732 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3733 implicit declarations.  Each of these specific warning options also
3734 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3735 example, @option{-Wno-implicit}.  This manual lists only one of the
3736 two forms, whichever is not the default.  For further
3737 language-specific options also refer to @ref{C++ Dialect Options} and
3738 @ref{Objective-C and Objective-C++ Dialect Options}.
3740 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3741 options, such as @option{-Wunused}, which may turn on further options,
3742 such as @option{-Wunused-value}. The combined effect of positive and
3743 negative forms is that more specific options have priority over less
3744 specific ones, independently of their position in the command-line. For
3745 options of the same specificity, the last one takes effect. Options
3746 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3747 as if they appeared at the end of the command-line.
3749 When an unrecognized warning option is requested (e.g.,
3750 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3751 that the option is not recognized.  However, if the @option{-Wno-} form
3752 is used, the behavior is slightly different: no diagnostic is
3753 produced for @option{-Wno-unknown-warning} unless other diagnostics
3754 are being produced.  This allows the use of new @option{-Wno-} options
3755 with old compilers, but if something goes wrong, the compiler
3756 warns that an unrecognized option is present.
3758 @table @gcctabopt
3759 @item -Wpedantic
3760 @itemx -pedantic
3761 @opindex pedantic
3762 @opindex Wpedantic
3763 Issue all the warnings demanded by strict ISO C and ISO C++;
3764 reject all programs that use forbidden extensions, and some other
3765 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3766 version of the ISO C standard specified by any @option{-std} option used.
3768 Valid ISO C and ISO C++ programs should compile properly with or without
3769 this option (though a rare few require @option{-ansi} or a
3770 @option{-std} option specifying the required version of ISO C)@.  However,
3771 without this option, certain GNU extensions and traditional C and C++
3772 features are supported as well.  With this option, they are rejected.
3774 @option{-Wpedantic} does not cause warning messages for use of the
3775 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3776 warnings are also disabled in the expression that follows
3777 @code{__extension__}.  However, only system header files should use
3778 these escape routes; application programs should avoid them.
3779 @xref{Alternate Keywords}.
3781 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3782 C conformance.  They soon find that it does not do quite what they want:
3783 it finds some non-ISO practices, but not all---only those for which
3784 ISO C @emph{requires} a diagnostic, and some others for which
3785 diagnostics have been added.
3787 A feature to report any failure to conform to ISO C might be useful in
3788 some instances, but would require considerable additional work and would
3789 be quite different from @option{-Wpedantic}.  We don't have plans to
3790 support such a feature in the near future.
3792 Where the standard specified with @option{-std} represents a GNU
3793 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3794 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3795 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3796 where they are required by the base standard.  (It does not make sense
3797 for such warnings to be given only for features not in the specified GNU
3798 C dialect, since by definition the GNU dialects of C include all
3799 features the compiler supports with the given option, and there would be
3800 nothing to warn about.)
3802 @item -pedantic-errors
3803 @opindex pedantic-errors
3804 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3805 requires a diagnostic, in some cases where there is undefined behavior
3806 at compile-time and in some other cases that do not prevent compilation
3807 of programs that are valid according to the standard. This is not
3808 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3809 by this option and not enabled by the latter and vice versa.
3811 @item -Wall
3812 @opindex Wall
3813 @opindex Wno-all
3814 This enables all the warnings about constructions that some users
3815 consider questionable, and that are easy to avoid (or modify to
3816 prevent the warning), even in conjunction with macros.  This also
3817 enables some language-specific warnings described in @ref{C++ Dialect
3818 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3820 @option{-Wall} turns on the following warning flags:
3822 @gccoptlist{-Waddress   @gol
3823 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3824 -Wbool-compare  @gol
3825 -Wbool-operation  @gol
3826 -Wc++11-compat  -Wc++14-compat  @gol
3827 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3828 -Wchar-subscripts  @gol
3829 -Wcomment  @gol
3830 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3831 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3832 -Wformat   @gol
3833 -Wint-in-bool-context  @gol
3834 -Wimplicit @r{(C and Objective-C only)} @gol
3835 -Wimplicit-int @r{(C and Objective-C only)} @gol
3836 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3837 -Winit-self @r{(only for C++)} @gol
3838 -Wlogical-not-parentheses @gol
3839 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3840 -Wmaybe-uninitialized @gol
3841 -Wmemset-elt-size @gol
3842 -Wmemset-transposed-args @gol
3843 -Wmisleading-indentation @r{(only for C/C++)} @gol
3844 -Wmissing-braces @r{(only for C/ObjC)} @gol
3845 -Wnarrowing @r{(only for C++)}  @gol
3846 -Wnonnull  @gol
3847 -Wnonnull-compare  @gol
3848 -Wopenmp-simd @gol
3849 -Wparentheses  @gol
3850 -Wpointer-sign  @gol
3851 -Wreorder   @gol
3852 -Wreturn-type  @gol
3853 -Wsequence-point  @gol
3854 -Wsign-compare @r{(only in C++)}  @gol
3855 -Wsizeof-pointer-div @gol
3856 -Wsizeof-pointer-memaccess @gol
3857 -Wstrict-aliasing  @gol
3858 -Wstrict-overflow=1  @gol
3859 -Wswitch  @gol
3860 -Wtautological-compare  @gol
3861 -Wtrigraphs  @gol
3862 -Wuninitialized  @gol
3863 -Wunknown-pragmas  @gol
3864 -Wunused-function  @gol
3865 -Wunused-label     @gol
3866 -Wunused-value     @gol
3867 -Wunused-variable  @gol
3868 -Wvolatile-register-var @gol
3871 Note that some warning flags are not implied by @option{-Wall}.  Some of
3872 them warn about constructions that users generally do not consider
3873 questionable, but which occasionally you might wish to check for;
3874 others warn about constructions that are necessary or hard to avoid in
3875 some cases, and there is no simple way to modify the code to suppress
3876 the warning. Some of them are enabled by @option{-Wextra} but many of
3877 them must be enabled individually.
3879 @item -Wextra
3880 @opindex W
3881 @opindex Wextra
3882 @opindex Wno-extra
3883 This enables some extra warning flags that are not enabled by
3884 @option{-Wall}. (This option used to be called @option{-W}.  The older
3885 name is still supported, but the newer name is more descriptive.)
3887 @gccoptlist{-Wclobbered  @gol
3888 -Wempty-body  @gol
3889 -Wignored-qualifiers @gol
3890 -Wimplicit-fallthrough=3 @gol
3891 -Wmissing-field-initializers  @gol
3892 -Wmissing-parameter-type @r{(C only)}  @gol
3893 -Wold-style-declaration @r{(C only)}  @gol
3894 -Woverride-init  @gol
3895 -Wsign-compare @r{(C only)} @gol
3896 -Wtype-limits  @gol
3897 -Wuninitialized  @gol
3898 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3899 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3900 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3903 The option @option{-Wextra} also prints warning messages for the
3904 following cases:
3906 @itemize @bullet
3908 @item
3909 A pointer is compared against integer zero with @code{<}, @code{<=},
3910 @code{>}, or @code{>=}.
3912 @item
3913 (C++ only) An enumerator and a non-enumerator both appear in a
3914 conditional expression.
3916 @item
3917 (C++ only) Ambiguous virtual bases.
3919 @item
3920 (C++ only) Subscripting an array that has been declared @code{register}.
3922 @item
3923 (C++ only) Taking the address of a variable that has been declared
3924 @code{register}.
3926 @item
3927 (C++ only) A base class is not initialized in the copy constructor
3928 of a derived class.
3930 @end itemize
3932 @item -Wchar-subscripts
3933 @opindex Wchar-subscripts
3934 @opindex Wno-char-subscripts
3935 Warn if an array subscript has type @code{char}.  This is a common cause
3936 of error, as programmers often forget that this type is signed on some
3937 machines.
3938 This warning is enabled by @option{-Wall}.
3940 @item -Wchkp
3941 @opindex Wchkp
3942 Warn about an invalid memory access that is found by Pointer Bounds Checker
3943 (@option{-fcheck-pointer-bounds}).
3945 @item -Wno-coverage-mismatch
3946 @opindex Wno-coverage-mismatch
3947 Warn if feedback profiles do not match when using the
3948 @option{-fprofile-use} option.
3949 If a source file is changed between compiling with @option{-fprofile-gen} and
3950 with @option{-fprofile-use}, the files with the profile feedback can fail
3951 to match the source file and GCC cannot use the profile feedback
3952 information.  By default, this warning is enabled and is treated as an
3953 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3954 warning or @option{-Wno-error=coverage-mismatch} can be used to
3955 disable the error.  Disabling the error for this warning can result in
3956 poorly optimized code and is useful only in the
3957 case of very minor changes such as bug fixes to an existing code-base.
3958 Completely disabling the warning is not recommended.
3960 @item -Wno-cpp
3961 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3963 Suppress warning messages emitted by @code{#warning} directives.
3965 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3966 @opindex Wdouble-promotion
3967 @opindex Wno-double-promotion
3968 Give a warning when a value of type @code{float} is implicitly
3969 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3970 floating-point unit implement @code{float} in hardware, but emulate
3971 @code{double} in software.  On such a machine, doing computations
3972 using @code{double} values is much more expensive because of the
3973 overhead required for software emulation.
3975 It is easy to accidentally do computations with @code{double} because
3976 floating-point literals are implicitly of type @code{double}.  For
3977 example, in:
3978 @smallexample
3979 @group
3980 float area(float radius)
3982    return 3.14159 * radius * radius;
3984 @end group
3985 @end smallexample
3986 the compiler performs the entire computation with @code{double}
3987 because the floating-point literal is a @code{double}.
3989 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
3990 @opindex Wduplicate-decl-specifier
3991 @opindex Wno-duplicate-decl-specifier
3992 Warn if a declaration has duplicate @code{const}, @code{volatile},
3993 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
3994 @option{-Wall}.
3996 @item -Wformat
3997 @itemx -Wformat=@var{n}
3998 @opindex Wformat
3999 @opindex Wno-format
4000 @opindex ffreestanding
4001 @opindex fno-builtin
4002 @opindex Wformat=
4003 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4004 the arguments supplied have types appropriate to the format string
4005 specified, and that the conversions specified in the format string make
4006 sense.  This includes standard functions, and others specified by format
4007 attributes (@pxref{Function Attributes}), in the @code{printf},
4008 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4009 not in the C standard) families (or other target-specific families).
4010 Which functions are checked without format attributes having been
4011 specified depends on the standard version selected, and such checks of
4012 functions without the attribute specified are disabled by
4013 @option{-ffreestanding} or @option{-fno-builtin}.
4015 The formats are checked against the format features supported by GNU
4016 libc version 2.2.  These include all ISO C90 and C99 features, as well
4017 as features from the Single Unix Specification and some BSD and GNU
4018 extensions.  Other library implementations may not support all these
4019 features; GCC does not support warning about features that go beyond a
4020 particular library's limitations.  However, if @option{-Wpedantic} is used
4021 with @option{-Wformat}, warnings are given about format features not
4022 in the selected standard version (but not for @code{strfmon} formats,
4023 since those are not in any version of the C standard).  @xref{C Dialect
4024 Options,,Options Controlling C Dialect}.
4026 @table @gcctabopt
4027 @item -Wformat=1
4028 @itemx -Wformat
4029 @opindex Wformat
4030 @opindex Wformat=1
4031 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4032 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4033 @option{-Wformat} also checks for null format arguments for several
4034 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4035 aspects of this level of format checking can be disabled by the
4036 options: @option{-Wno-format-contains-nul},
4037 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4038 @option{-Wformat} is enabled by @option{-Wall}.
4040 @item -Wno-format-contains-nul
4041 @opindex Wno-format-contains-nul
4042 @opindex Wformat-contains-nul
4043 If @option{-Wformat} is specified, do not warn about format strings that
4044 contain NUL bytes.
4046 @item -Wno-format-extra-args
4047 @opindex Wno-format-extra-args
4048 @opindex Wformat-extra-args
4049 If @option{-Wformat} is specified, do not warn about excess arguments to a
4050 @code{printf} or @code{scanf} format function.  The C standard specifies
4051 that such arguments are ignored.
4053 Where the unused arguments lie between used arguments that are
4054 specified with @samp{$} operand number specifications, normally
4055 warnings are still given, since the implementation could not know what
4056 type to pass to @code{va_arg} to skip the unused arguments.  However,
4057 in the case of @code{scanf} formats, this option suppresses the
4058 warning if the unused arguments are all pointers, since the Single
4059 Unix Specification says that such unused arguments are allowed.
4061 @item -Wformat-overflow
4062 @itemx -Wformat-overflow=@var{level}
4063 @opindex Wformat-overflow
4064 @opindex Wno-format-overflow
4065 Warn about calls to formatted input/output functions such as @code{sprintf}
4066 and @code{vsprintf} that might overflow the destination buffer.  When the
4067 exact number of bytes written by a format directive cannot be determined
4068 at compile-time it is estimated based on heuristics that depend on the
4069 @var{level} argument and on optimization.  While enabling optimization
4070 will in most cases improve the accuracy of the warning, it may also
4071 result in false positives.
4073 @table @gcctabopt
4074 @item -Wformat-overflow
4075 @item -Wformat-overflow=1
4076 @opindex Wformat-overflow
4077 @opindex Wno-format-overflow
4078 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4079 employs a conservative approach that warns only about calls that most
4080 likely overflow the buffer.  At this level, numeric arguments to format
4081 directives with unknown values are assumed to have the value of one, and
4082 strings of unknown length to be empty.  Numeric arguments that are known
4083 to be bounded to a subrange of their type, or string arguments whose output
4084 is bounded either by their directive's precision or by a finite set of
4085 string literals, are assumed to take on the value within the range that
4086 results in the most bytes on output.  For example, the call to @code{sprintf}
4087 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4088 the terminating NUL character (@code{'\0'}) appended by the function
4089 to the destination buffer will be written past its end.  Increasing
4090 the size of the buffer by a single byte is sufficient to avoid the
4091 warning, though it may not be sufficient to avoid the overflow.
4093 @smallexample
4094 void f (int a, int b)
4096   char buf [12];
4097   sprintf (buf, "a = %i, b = %i\n", a, b);
4099 @end smallexample
4101 @item -Wformat-overflow=2
4102 Level @var{2} warns also about calls that might overflow the destination
4103 buffer given an argument of sufficient length or magnitude.  At level
4104 @var{2}, unknown numeric arguments are assumed to have the minimum
4105 representable value for signed types with a precision greater than 1, and
4106 the maximum representable value otherwise.  Unknown string arguments whose
4107 length cannot be assumed to be bounded either by the directive's precision,
4108 or by a finite set of string literals they may evaluate to, or the character
4109 array they may point to, are assumed to be 1 character long.
4111 At level @var{2}, the call in the example above is again diagnosed, but
4112 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4113 @code{%i} directive will write some of its digits beyond the end of
4114 the destination buffer.  To make the call safe regardless of the values
4115 of the two variables, the size of the destination buffer must be increased
4116 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4117 an informational note following the warning.
4119 An alternative to increasing the size of the destination buffer is to
4120 constrain the range of formatted values.  The maximum length of string
4121 arguments can be bounded by specifying the precision in the format
4122 directive.  When numeric arguments of format directives can be assumed
4123 to be bounded by less than the precision of their type, choosing
4124 an appropriate length modifier to the format specifier will reduce
4125 the required buffer size.  For example, if @var{a} and @var{b} in the
4126 example above can be assumed to be within the precision of
4127 the @code{short int} type then using either the @code{%hi} format
4128 directive or casting the argument to @code{short} reduces the maximum
4129 required size of the buffer to 24 bytes.
4131 @smallexample
4132 void f (int a, int b)
4134   char buf [23];
4135   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4137 @end smallexample
4138 @end table
4140 @item -Wno-format-zero-length
4141 @opindex Wno-format-zero-length
4142 @opindex Wformat-zero-length
4143 If @option{-Wformat} is specified, do not warn about zero-length formats.
4144 The C standard specifies that zero-length formats are allowed.
4147 @item -Wformat=2
4148 @opindex Wformat=2
4149 Enable @option{-Wformat} plus additional format checks.  Currently
4150 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4151 -Wformat-y2k}.
4153 @item -Wformat-nonliteral
4154 @opindex Wformat-nonliteral
4155 @opindex Wno-format-nonliteral
4156 If @option{-Wformat} is specified, also warn if the format string is not a
4157 string literal and so cannot be checked, unless the format function
4158 takes its format arguments as a @code{va_list}.
4160 @item -Wformat-security
4161 @opindex Wformat-security
4162 @opindex Wno-format-security
4163 If @option{-Wformat} is specified, also warn about uses of format
4164 functions that represent possible security problems.  At present, this
4165 warns about calls to @code{printf} and @code{scanf} functions where the
4166 format string is not a string literal and there are no format arguments,
4167 as in @code{printf (foo);}.  This may be a security hole if the format
4168 string came from untrusted input and contains @samp{%n}.  (This is
4169 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4170 in future warnings may be added to @option{-Wformat-security} that are not
4171 included in @option{-Wformat-nonliteral}.)
4173 @item -Wformat-signedness
4174 @opindex Wformat-signedness
4175 @opindex Wno-format-signedness
4176 If @option{-Wformat} is specified, also warn if the format string
4177 requires an unsigned argument and the argument is signed and vice versa.
4179 @item -Wformat-truncation
4180 @itemx -Wformat-truncation=@var{level}
4181 @opindex Wformat-truncation
4182 @opindex Wno-format-truncation
4183 Warn about calls to formatted input/output functions such as @code{snprintf}
4184 and @code{vsnprintf} that might result in output truncation.  When the exact
4185 number of bytes written by a format directive cannot be determined at
4186 compile-time it is estimated based on heuristics that depend on
4187 the @var{level} argument and on optimization.  While enabling optimization
4188 will in most cases improve the accuracy of the warning, it may also result
4189 in false positives.  Except as noted otherwise, the option uses the same
4190 logic @option{-Wformat-overflow}.
4192 @table @gcctabopt
4193 @item -Wformat-truncation
4194 @item -Wformat-truncation=1
4195 @opindex Wformat-truncation
4196 @opindex Wno-format-overflow
4197 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4198 employs a conservative approach that warns only about calls to bounded
4199 functions whose return value is unused and that will most likely result
4200 in output truncation.
4202 @item -Wformat-truncation=2
4203 Level @var{2} warns also about calls to bounded functions whose return
4204 value is used and that might result in truncation given an argument of
4205 sufficient length or magnitude.
4206 @end table
4208 @item -Wformat-y2k
4209 @opindex Wformat-y2k
4210 @opindex Wno-format-y2k
4211 If @option{-Wformat} is specified, also warn about @code{strftime}
4212 formats that may yield only a two-digit year.
4213 @end table
4215 @item -Wnonnull
4216 @opindex Wnonnull
4217 @opindex Wno-nonnull
4218 Warn about passing a null pointer for arguments marked as
4219 requiring a non-null value by the @code{nonnull} function attribute.
4221 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4222 can be disabled with the @option{-Wno-nonnull} option.
4224 @item -Wnonnull-compare
4225 @opindex Wnonnull-compare
4226 @opindex Wno-nonnull-compare
4227 Warn when comparing an argument marked with the @code{nonnull}
4228 function attribute against null inside the function.
4230 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4231 can be disabled with the @option{-Wno-nonnull-compare} option.
4233 @item -Wnull-dereference
4234 @opindex Wnull-dereference
4235 @opindex Wno-null-dereference
4236 Warn if the compiler detects paths that trigger erroneous or
4237 undefined behavior due to dereferencing a null pointer.  This option
4238 is only active when @option{-fdelete-null-pointer-checks} is active,
4239 which is enabled by optimizations in most targets.  The precision of
4240 the warnings depends on the optimization options used.
4242 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4243 @opindex Winit-self
4244 @opindex Wno-init-self
4245 Warn about uninitialized variables that are initialized with themselves.
4246 Note this option can only be used with the @option{-Wuninitialized} option.
4248 For example, GCC warns about @code{i} being uninitialized in the
4249 following snippet only when @option{-Winit-self} has been specified:
4250 @smallexample
4251 @group
4252 int f()
4254   int i = i;
4255   return i;
4257 @end group
4258 @end smallexample
4260 This warning is enabled by @option{-Wall} in C++.
4262 @item -Wimplicit-int @r{(C and Objective-C only)}
4263 @opindex Wimplicit-int
4264 @opindex Wno-implicit-int
4265 Warn when a declaration does not specify a type.
4266 This warning is enabled by @option{-Wall}.
4268 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4269 @opindex Wimplicit-function-declaration
4270 @opindex Wno-implicit-function-declaration
4271 Give a warning whenever a function is used before being declared. In
4272 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4273 enabled by default and it is made into an error by
4274 @option{-pedantic-errors}. This warning is also enabled by
4275 @option{-Wall}.
4277 @item -Wimplicit @r{(C and Objective-C only)}
4278 @opindex Wimplicit
4279 @opindex Wno-implicit
4280 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4281 This warning is enabled by @option{-Wall}.
4283 @item -Wimplicit-fallthrough
4284 @opindex Wimplicit-fallthrough
4285 @opindex Wno-implicit-fallthrough
4286 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4287 and @option{-Wno-implicit-fallthrough} is the same as
4288 @option{-Wimplicit-fallthrough=0}.
4290 @item -Wimplicit-fallthrough=@var{n}
4291 @opindex Wimplicit-fallthrough=
4292 Warn when a switch case falls through.  For example:
4294 @smallexample
4295 @group
4296 switch (cond)
4297   @{
4298   case 1:
4299     a = 1;
4300     break;
4301   case 2:
4302     a = 2;
4303   case 3:
4304     a = 3;
4305     break;
4306   @}
4307 @end group
4308 @end smallexample
4310 This warning does not warn when the last statement of a case cannot
4311 fall through, e.g. when there is a return statement or a call to function
4312 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4313 also takes into account control flow statements, such as ifs, and only
4314 warns when appropriate.  E.g.@:
4316 @smallexample
4317 @group
4318 switch (cond)
4319   @{
4320   case 1:
4321     if (i > 3) @{
4322       bar (5);
4323       break;
4324     @} else if (i < 1) @{
4325       bar (0);
4326     @} else
4327       return;
4328   default:
4329     @dots{}
4330   @}
4331 @end group
4332 @end smallexample
4334 Since there are occasions where a switch case fall through is desirable,
4335 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4336 to be used along with a null statement to suppress this warning that
4337 would normally occur:
4339 @smallexample
4340 @group
4341 switch (cond)
4342   @{
4343   case 1:
4344     bar (0);
4345     __attribute__ ((fallthrough));
4346   default:
4347     @dots{}
4348   @}
4349 @end group
4350 @end smallexample
4352 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4353 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4354 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4355 Instead of these attributes, it is also possible to add a fallthrough comment
4356 to silence the warning.  The whole body of the C or C++ style comment should
4357 match the given regular expressions listed below.  The option argument @var{n}
4358 specifies what kind of comments are accepted:
4360 @itemize @bullet
4362 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4364 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4365 expression, any comment is used as fallthrough comment.
4367 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4368 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4370 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4371 following regular expressions:
4373 @itemize @bullet
4375 @item @code{-fallthrough}
4377 @item @code{@@fallthrough@@}
4379 @item @code{lint -fallthrough[ \t]*}
4381 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4383 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4385 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4387 @end itemize
4389 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4390 following regular expressions:
4392 @itemize @bullet
4394 @item @code{-fallthrough}
4396 @item @code{@@fallthrough@@}
4398 @item @code{lint -fallthrough[ \t]*}
4400 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4402 @end itemize
4404 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4405 fallthrough comments, only attributes disable the warning.
4407 @end itemize
4409 The comment needs to be followed after optional whitespace and other comments
4410 by @code{case} or @code{default} keywords or by a user label that precedes some
4411 @code{case} or @code{default} label.
4413 @smallexample
4414 @group
4415 switch (cond)
4416   @{
4417   case 1:
4418     bar (0);
4419     /* FALLTHRU */
4420   default:
4421     @dots{}
4422   @}
4423 @end group
4424 @end smallexample
4426 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4428 @item -Wignored-qualifiers @r{(C and C++ only)}
4429 @opindex Wignored-qualifiers
4430 @opindex Wno-ignored-qualifiers
4431 Warn if the return type of a function has a type qualifier
4432 such as @code{const}.  For ISO C such a type qualifier has no effect,
4433 since the value returned by a function is not an lvalue.
4434 For C++, the warning is only emitted for scalar types or @code{void}.
4435 ISO C prohibits qualified @code{void} return types on function
4436 definitions, so such return types always receive a warning
4437 even without this option.
4439 This warning is also enabled by @option{-Wextra}.
4441 @item -Wignored-attributes @r{(C and C++ only)}
4442 @opindex Wignored-attributes
4443 @opindex Wno-ignored-attributes
4444 Warn when an attribute is ignored.  This is different from the
4445 @option{-Wattributes} option in that it warns whenever the compiler decides
4446 to drop an attribute, not that the attribute is either unknown, used in a
4447 wrong place, etc.  This warning is enabled by default.
4449 @item -Wmain
4450 @opindex Wmain
4451 @opindex Wno-main
4452 Warn if the type of @code{main} is suspicious.  @code{main} should be
4453 a function with external linkage, returning int, taking either zero
4454 arguments, two, or three arguments of appropriate types.  This warning
4455 is enabled by default in C++ and is enabled by either @option{-Wall}
4456 or @option{-Wpedantic}.
4458 @item -Wmisleading-indentation @r{(C and C++ only)}
4459 @opindex Wmisleading-indentation
4460 @opindex Wno-misleading-indentation
4461 Warn when the indentation of the code does not reflect the block structure.
4462 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4463 @code{for} clauses with a guarded statement that does not use braces,
4464 followed by an unguarded statement with the same indentation.
4466 In the following example, the call to ``bar'' is misleadingly indented as
4467 if it were guarded by the ``if'' conditional.
4469 @smallexample
4470   if (some_condition ())
4471     foo ();
4472     bar ();  /* Gotcha: this is not guarded by the "if".  */
4473 @end smallexample
4475 In the case of mixed tabs and spaces, the warning uses the
4476 @option{-ftabstop=} option to determine if the statements line up
4477 (defaulting to 8).
4479 The warning is not issued for code involving multiline preprocessor logic
4480 such as the following example.
4482 @smallexample
4483   if (flagA)
4484     foo (0);
4485 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4486   if (flagB)
4487 #endif
4488     foo (1);
4489 @end smallexample
4491 The warning is not issued after a @code{#line} directive, since this
4492 typically indicates autogenerated code, and no assumptions can be made
4493 about the layout of the file that the directive references.
4495 This warning is enabled by @option{-Wall} in C and C++.
4497 @item -Wmissing-braces
4498 @opindex Wmissing-braces
4499 @opindex Wno-missing-braces
4500 Warn if an aggregate or union initializer is not fully bracketed.  In
4501 the following example, the initializer for @code{a} is not fully
4502 bracketed, but that for @code{b} is fully bracketed.  This warning is
4503 enabled by @option{-Wall} in C.
4505 @smallexample
4506 int a[2][2] = @{ 0, 1, 2, 3 @};
4507 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4508 @end smallexample
4510 This warning is enabled by @option{-Wall}.
4512 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4513 @opindex Wmissing-include-dirs
4514 @opindex Wno-missing-include-dirs
4515 Warn if a user-supplied include directory does not exist.
4517 @item -Wparentheses
4518 @opindex Wparentheses
4519 @opindex Wno-parentheses
4520 Warn if parentheses are omitted in certain contexts, such
4521 as when there is an assignment in a context where a truth value
4522 is expected, or when operators are nested whose precedence people
4523 often get confused about.
4525 Also warn if a comparison like @code{x<=y<=z} appears; this is
4526 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4527 interpretation from that of ordinary mathematical notation.
4529 Also warn for dangerous uses of the GNU extension to
4530 @code{?:} with omitted middle operand. When the condition
4531 in the @code{?}: operator is a boolean expression, the omitted value is
4532 always 1.  Often programmers expect it to be a value computed
4533 inside the conditional expression instead.
4535 This warning is enabled by @option{-Wall}.
4537 @item -Wsequence-point
4538 @opindex Wsequence-point
4539 @opindex Wno-sequence-point
4540 Warn about code that may have undefined semantics because of violations
4541 of sequence point rules in the C and C++ standards.
4543 The C and C++ standards define the order in which expressions in a C/C++
4544 program are evaluated in terms of @dfn{sequence points}, which represent
4545 a partial ordering between the execution of parts of the program: those
4546 executed before the sequence point, and those executed after it.  These
4547 occur after the evaluation of a full expression (one which is not part
4548 of a larger expression), after the evaluation of the first operand of a
4549 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4550 function is called (but after the evaluation of its arguments and the
4551 expression denoting the called function), and in certain other places.
4552 Other than as expressed by the sequence point rules, the order of
4553 evaluation of subexpressions of an expression is not specified.  All
4554 these rules describe only a partial order rather than a total order,
4555 since, for example, if two functions are called within one expression
4556 with no sequence point between them, the order in which the functions
4557 are called is not specified.  However, the standards committee have
4558 ruled that function calls do not overlap.
4560 It is not specified when between sequence points modifications to the
4561 values of objects take effect.  Programs whose behavior depends on this
4562 have undefined behavior; the C and C++ standards specify that ``Between
4563 the previous and next sequence point an object shall have its stored
4564 value modified at most once by the evaluation of an expression.
4565 Furthermore, the prior value shall be read only to determine the value
4566 to be stored.''.  If a program breaks these rules, the results on any
4567 particular implementation are entirely unpredictable.
4569 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4570 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4571 diagnosed by this option, and it may give an occasional false positive
4572 result, but in general it has been found fairly effective at detecting
4573 this sort of problem in programs.
4575 The C++17 standard will define the order of evaluation of operands in
4576 more cases: in particular it requires that the right-hand side of an
4577 assignment be evaluated before the left-hand side, so the above
4578 examples are no longer undefined.  But this warning will still warn
4579 about them, to help people avoid writing code that is undefined in C
4580 and earlier revisions of C++.
4582 The standard is worded confusingly, therefore there is some debate
4583 over the precise meaning of the sequence point rules in subtle cases.
4584 Links to discussions of the problem, including proposed formal
4585 definitions, may be found on the GCC readings page, at
4586 @uref{http://gcc.gnu.org/@/readings.html}.
4588 This warning is enabled by @option{-Wall} for C and C++.
4590 @item -Wno-return-local-addr
4591 @opindex Wno-return-local-addr
4592 @opindex Wreturn-local-addr
4593 Do not warn about returning a pointer (or in C++, a reference) to a
4594 variable that goes out of scope after the function returns.
4596 @item -Wreturn-type
4597 @opindex Wreturn-type
4598 @opindex Wno-return-type
4599 Warn whenever a function is defined with a return type that defaults
4600 to @code{int}.  Also warn about any @code{return} statement with no
4601 return value in a function whose return type is not @code{void}
4602 (falling off the end of the function body is considered returning
4603 without a value).
4605 For C only, warn about a @code{return} statement with an expression in a
4606 function whose return type is @code{void}, unless the expression type is
4607 also @code{void}.  As a GNU extension, the latter case is accepted
4608 without a warning unless @option{-Wpedantic} is used.
4610 For C++, a function without return type always produces a diagnostic
4611 message, even when @option{-Wno-return-type} is specified.  The only
4612 exceptions are @code{main} and functions defined in system headers.
4614 This warning is enabled by @option{-Wall}.
4616 @item -Wshift-count-negative
4617 @opindex Wshift-count-negative
4618 @opindex Wno-shift-count-negative
4619 Warn if shift count is negative. This warning is enabled by default.
4621 @item -Wshift-count-overflow
4622 @opindex Wshift-count-overflow
4623 @opindex Wno-shift-count-overflow
4624 Warn if shift count >= width of type. This warning is enabled by default.
4626 @item -Wshift-negative-value
4627 @opindex Wshift-negative-value
4628 @opindex Wno-shift-negative-value
4629 Warn if left shifting a negative value.  This warning is enabled by
4630 @option{-Wextra} in C99 and C++11 modes (and newer).
4632 @item -Wshift-overflow
4633 @itemx -Wshift-overflow=@var{n}
4634 @opindex Wshift-overflow
4635 @opindex Wno-shift-overflow
4636 Warn about left shift overflows.  This warning is enabled by
4637 default in C99 and C++11 modes (and newer).
4639 @table @gcctabopt
4640 @item -Wshift-overflow=1
4641 This is the warning level of @option{-Wshift-overflow} and is enabled
4642 by default in C99 and C++11 modes (and newer).  This warning level does
4643 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4644 an overflow is still rejected in contexts where an integer constant expression
4645 is required.)
4647 @item -Wshift-overflow=2
4648 This warning level also warns about left-shifting 1 into the sign bit,
4649 unless C++14 mode is active.
4650 @end table
4652 @item -Wswitch
4653 @opindex Wswitch
4654 @opindex Wno-switch
4655 Warn whenever a @code{switch} statement has an index of enumerated type
4656 and lacks a @code{case} for one or more of the named codes of that
4657 enumeration.  (The presence of a @code{default} label prevents this
4658 warning.)  @code{case} labels outside the enumeration range also
4659 provoke warnings when this option is used (even if there is a
4660 @code{default} label).
4661 This warning is enabled by @option{-Wall}.
4663 @item -Wswitch-default
4664 @opindex Wswitch-default
4665 @opindex Wno-switch-default
4666 Warn whenever a @code{switch} statement does not have a @code{default}
4667 case.
4669 @item -Wswitch-enum
4670 @opindex Wswitch-enum
4671 @opindex Wno-switch-enum
4672 Warn whenever a @code{switch} statement has an index of enumerated type
4673 and lacks a @code{case} for one or more of the named codes of that
4674 enumeration.  @code{case} labels outside the enumeration range also
4675 provoke warnings when this option is used.  The only difference
4676 between @option{-Wswitch} and this option is that this option gives a
4677 warning about an omitted enumeration code even if there is a
4678 @code{default} label.
4680 @item -Wswitch-bool
4681 @opindex Wswitch-bool
4682 @opindex Wno-switch-bool
4683 Warn whenever a @code{switch} statement has an index of boolean type
4684 and the case values are outside the range of a boolean type.
4685 It is possible to suppress this warning by casting the controlling
4686 expression to a type other than @code{bool}.  For example:
4687 @smallexample
4688 @group
4689 switch ((int) (a == 4))
4690   @{
4691   @dots{}
4692   @}
4693 @end group
4694 @end smallexample
4695 This warning is enabled by default for C and C++ programs.
4697 @item -Wswitch-unreachable
4698 @opindex Wswitch-unreachable
4699 @opindex Wno-switch-unreachable
4700 Warn whenever a @code{switch} statement contains statements between the
4701 controlling expression and the first case label, which will never be
4702 executed.  For example:
4703 @smallexample
4704 @group
4705 switch (cond)
4706   @{
4707    i = 15;
4708   @dots{}
4709    case 5:
4710   @dots{}
4711   @}
4712 @end group
4713 @end smallexample
4714 @option{-Wswitch-unreachable} does not warn if the statement between the
4715 controlling expression and the first case label is just a declaration:
4716 @smallexample
4717 @group
4718 switch (cond)
4719   @{
4720    int i;
4721   @dots{}
4722    case 5:
4723    i = 5;
4724   @dots{}
4725   @}
4726 @end group
4727 @end smallexample
4728 This warning is enabled by default for C and C++ programs.
4730 @item -Wsync-nand @r{(C and C++ only)}
4731 @opindex Wsync-nand
4732 @opindex Wno-sync-nand
4733 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4734 built-in functions are used.  These functions changed semantics in GCC 4.4.
4736 @item -Wunused-but-set-parameter
4737 @opindex Wunused-but-set-parameter
4738 @opindex Wno-unused-but-set-parameter
4739 Warn whenever a function parameter is assigned to, but otherwise unused
4740 (aside from its declaration).
4742 To suppress this warning use the @code{unused} attribute
4743 (@pxref{Variable Attributes}).
4745 This warning is also enabled by @option{-Wunused} together with
4746 @option{-Wextra}.
4748 @item -Wunused-but-set-variable
4749 @opindex Wunused-but-set-variable
4750 @opindex Wno-unused-but-set-variable
4751 Warn whenever a local variable is assigned to, but otherwise unused
4752 (aside from its declaration).
4753 This warning is enabled by @option{-Wall}.
4755 To suppress this warning use the @code{unused} attribute
4756 (@pxref{Variable Attributes}).
4758 This warning is also enabled by @option{-Wunused}, which is enabled
4759 by @option{-Wall}.
4761 @item -Wunused-function
4762 @opindex Wunused-function
4763 @opindex Wno-unused-function
4764 Warn whenever a static function is declared but not defined or a
4765 non-inline static function is unused.
4766 This warning is enabled by @option{-Wall}.
4768 @item -Wunused-label
4769 @opindex Wunused-label
4770 @opindex Wno-unused-label
4771 Warn whenever a label is declared but not used.
4772 This warning is enabled by @option{-Wall}.
4774 To suppress this warning use the @code{unused} attribute
4775 (@pxref{Variable Attributes}).
4777 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4778 @opindex Wunused-local-typedefs
4779 Warn when a typedef locally defined in a function is not used.
4780 This warning is enabled by @option{-Wall}.
4782 @item -Wunused-parameter
4783 @opindex Wunused-parameter
4784 @opindex Wno-unused-parameter
4785 Warn whenever a function parameter is unused aside from its declaration.
4787 To suppress this warning use the @code{unused} attribute
4788 (@pxref{Variable Attributes}).
4790 @item -Wno-unused-result
4791 @opindex Wunused-result
4792 @opindex Wno-unused-result
4793 Do not warn if a caller of a function marked with attribute
4794 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4795 its return value. The default is @option{-Wunused-result}.
4797 @item -Wunused-variable
4798 @opindex Wunused-variable
4799 @opindex Wno-unused-variable
4800 Warn whenever a local or static variable is unused aside from its
4801 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4802 but not for C++. This warning is enabled by @option{-Wall}.
4804 To suppress this warning use the @code{unused} attribute
4805 (@pxref{Variable Attributes}).
4807 @item -Wunused-const-variable
4808 @itemx -Wunused-const-variable=@var{n}
4809 @opindex Wunused-const-variable
4810 @opindex Wno-unused-const-variable
4811 Warn whenever a constant static variable is unused aside from its declaration.
4812 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4813 for C, but not for C++. In C this declares variable storage, but in C++ this
4814 is not an error since const variables take the place of @code{#define}s.
4816 To suppress this warning use the @code{unused} attribute
4817 (@pxref{Variable Attributes}).
4819 @table @gcctabopt
4820 @item -Wunused-const-variable=1
4821 This is the warning level that is enabled by @option{-Wunused-variable} for
4822 C.  It warns only about unused static const variables defined in the main
4823 compilation unit, but not about static const variables declared in any
4824 header included.
4826 @item -Wunused-const-variable=2
4827 This warning level also warns for unused constant static variables in
4828 headers (excluding system headers).  This is the warning level of
4829 @option{-Wunused-const-variable} and must be explicitly requested since
4830 in C++ this isn't an error and in C it might be harder to clean up all
4831 headers included.
4832 @end table
4834 @item -Wunused-value
4835 @opindex Wunused-value
4836 @opindex Wno-unused-value
4837 Warn whenever a statement computes a result that is explicitly not
4838 used. To suppress this warning cast the unused expression to
4839 @code{void}. This includes an expression-statement or the left-hand
4840 side of a comma expression that contains no side effects. For example,
4841 an expression such as @code{x[i,j]} causes a warning, while
4842 @code{x[(void)i,j]} does not.
4844 This warning is enabled by @option{-Wall}.
4846 @item -Wunused
4847 @opindex Wunused
4848 @opindex Wno-unused
4849 All the above @option{-Wunused} options combined.
4851 In order to get a warning about an unused function parameter, you must
4852 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4853 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4855 @item -Wuninitialized
4856 @opindex Wuninitialized
4857 @opindex Wno-uninitialized
4858 Warn if an automatic variable is used without first being initialized
4859 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4860 warn if a non-static reference or non-static @code{const} member
4861 appears in a class without constructors.
4863 If you want to warn about code that uses the uninitialized value of the
4864 variable in its own initializer, use the @option{-Winit-self} option.
4866 These warnings occur for individual uninitialized or clobbered
4867 elements of structure, union or array variables as well as for
4868 variables that are uninitialized or clobbered as a whole.  They do
4869 not occur for variables or elements declared @code{volatile}.  Because
4870 these warnings depend on optimization, the exact variables or elements
4871 for which there are warnings depends on the precise optimization
4872 options and version of GCC used.
4874 Note that there may be no warning about a variable that is used only
4875 to compute a value that itself is never used, because such
4876 computations may be deleted by data flow analysis before the warnings
4877 are printed.
4879 @item -Winvalid-memory-model
4880 @opindex Winvalid-memory-model
4881 @opindex Wno-invalid-memory-model
4882 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4883 and the C11 atomic generic functions with a memory consistency argument
4884 that is either invalid for the operation or outside the range of values
4885 of the @code{memory_order} enumeration.  For example, since the
4886 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4887 defined for the relaxed, release, and sequentially consistent memory
4888 orders the following code is diagnosed:
4890 @smallexample
4891 void store (int *i)
4893   __atomic_store_n (i, 0, memory_order_consume);
4895 @end smallexample
4897 @option{-Winvalid-memory-model} is enabled by default.
4899 @item -Wmaybe-uninitialized
4900 @opindex Wmaybe-uninitialized
4901 @opindex Wno-maybe-uninitialized
4902 For an automatic variable, if there exists a path from the function
4903 entry to a use of the variable that is initialized, but there exist
4904 some other paths for which the variable is not initialized, the compiler
4905 emits a warning if it cannot prove the uninitialized paths are not
4906 executed at run time. These warnings are made optional because GCC is
4907 not smart enough to see all the reasons why the code might be correct
4908 in spite of appearing to have an error.  Here is one example of how
4909 this can happen:
4911 @smallexample
4912 @group
4914   int x;
4915   switch (y)
4916     @{
4917     case 1: x = 1;
4918       break;
4919     case 2: x = 4;
4920       break;
4921     case 3: x = 5;
4922     @}
4923   foo (x);
4925 @end group
4926 @end smallexample
4928 @noindent
4929 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4930 always initialized, but GCC doesn't know this. To suppress the
4931 warning, you need to provide a default case with assert(0) or
4932 similar code.
4934 @cindex @code{longjmp} warnings
4935 This option also warns when a non-volatile automatic variable might be
4936 changed by a call to @code{longjmp}.  These warnings as well are possible
4937 only in optimizing compilation.
4939 The compiler sees only the calls to @code{setjmp}.  It cannot know
4940 where @code{longjmp} will be called; in fact, a signal handler could
4941 call it at any point in the code.  As a result, you may get a warning
4942 even when there is in fact no problem because @code{longjmp} cannot
4943 in fact be called at the place that would cause a problem.
4945 Some spurious warnings can be avoided if you declare all the functions
4946 you use that never return as @code{noreturn}.  @xref{Function
4947 Attributes}.
4949 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4951 @item -Wunknown-pragmas
4952 @opindex Wunknown-pragmas
4953 @opindex Wno-unknown-pragmas
4954 @cindex warning for unknown pragmas
4955 @cindex unknown pragmas, warning
4956 @cindex pragmas, warning of unknown
4957 Warn when a @code{#pragma} directive is encountered that is not understood by 
4958 GCC@.  If this command-line option is used, warnings are even issued
4959 for unknown pragmas in system header files.  This is not the case if
4960 the warnings are only enabled by the @option{-Wall} command-line option.
4962 @item -Wno-pragmas
4963 @opindex Wno-pragmas
4964 @opindex Wpragmas
4965 Do not warn about misuses of pragmas, such as incorrect parameters,
4966 invalid syntax, or conflicts between pragmas.  See also
4967 @option{-Wunknown-pragmas}.
4969 @item -Wstrict-aliasing
4970 @opindex Wstrict-aliasing
4971 @opindex Wno-strict-aliasing
4972 This option is only active when @option{-fstrict-aliasing} is active.
4973 It warns about code that might break the strict aliasing rules that the
4974 compiler is using for optimization.  The warning does not catch all
4975 cases, but does attempt to catch the more common pitfalls.  It is
4976 included in @option{-Wall}.
4977 It is equivalent to @option{-Wstrict-aliasing=3}
4979 @item -Wstrict-aliasing=n
4980 @opindex Wstrict-aliasing=n
4981 This option is only active when @option{-fstrict-aliasing} is active.
4982 It warns about code that might break the strict aliasing rules that the
4983 compiler is using for optimization.
4984 Higher levels correspond to higher accuracy (fewer false positives).
4985 Higher levels also correspond to more effort, similar to the way @option{-O} 
4986 works.
4987 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4989 Level 1: Most aggressive, quick, least accurate.
4990 Possibly useful when higher levels
4991 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4992 false negatives.  However, it has many false positives.
4993 Warns for all pointer conversions between possibly incompatible types,
4994 even if never dereferenced.  Runs in the front end only.
4996 Level 2: Aggressive, quick, not too precise.
4997 May still have many false positives (not as many as level 1 though),
4998 and few false negatives (but possibly more than level 1).
4999 Unlike level 1, it only warns when an address is taken.  Warns about
5000 incomplete types.  Runs in the front end only.
5002 Level 3 (default for @option{-Wstrict-aliasing}):
5003 Should have very few false positives and few false
5004 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5005 Takes care of the common pun+dereference pattern in the front end:
5006 @code{*(int*)&some_float}.
5007 If optimization is enabled, it also runs in the back end, where it deals
5008 with multiple statement cases using flow-sensitive points-to information.
5009 Only warns when the converted pointer is dereferenced.
5010 Does not warn about incomplete types.
5012 @item -Wstrict-overflow
5013 @itemx -Wstrict-overflow=@var{n}
5014 @opindex Wstrict-overflow
5015 @opindex Wno-strict-overflow
5016 This option is only active when signed overflow is undefined.
5017 It warns about cases where the compiler optimizes based on the
5018 assumption that signed overflow does not occur.  Note that it does not
5019 warn about all cases where the code might overflow: it only warns
5020 about cases where the compiler implements some optimization.  Thus
5021 this warning depends on the optimization level.
5023 An optimization that assumes that signed overflow does not occur is
5024 perfectly safe if the values of the variables involved are such that
5025 overflow never does, in fact, occur.  Therefore this warning can
5026 easily give a false positive: a warning about code that is not
5027 actually a problem.  To help focus on important issues, several
5028 warning levels are defined.  No warnings are issued for the use of
5029 undefined signed overflow when estimating how many iterations a loop
5030 requires, in particular when determining whether a loop will be
5031 executed at all.
5033 @table @gcctabopt
5034 @item -Wstrict-overflow=1
5035 Warn about cases that are both questionable and easy to avoid.  For
5036 example the compiler simplifies
5037 @code{x + 1 > x} to @code{1}.  This level of
5038 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5039 are not, and must be explicitly requested.
5041 @item -Wstrict-overflow=2
5042 Also warn about other cases where a comparison is simplified to a
5043 constant.  For example: @code{abs (x) >= 0}.  This can only be
5044 simplified when signed integer overflow is undefined, because
5045 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5046 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5047 @option{-Wstrict-overflow=2}.
5049 @item -Wstrict-overflow=3
5050 Also warn about other cases where a comparison is simplified.  For
5051 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5053 @item -Wstrict-overflow=4
5054 Also warn about other simplifications not covered by the above cases.
5055 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5057 @item -Wstrict-overflow=5
5058 Also warn about cases where the compiler reduces the magnitude of a
5059 constant involved in a comparison.  For example: @code{x + 2 > y} is
5060 simplified to @code{x + 1 >= y}.  This is reported only at the
5061 highest warning level because this simplification applies to many
5062 comparisons, so this warning level gives a very large number of
5063 false positives.
5064 @end table
5066 @item -Wstringop-overflow
5067 @itemx -Wstringop-overflow=@var{type}
5068 @opindex Wstringop-overflow
5069 @opindex Wno-stringop-overflow
5070 Warn for calls to string manipulation functions such as @code{memcpy} and
5071 @code{strcpy} that are determined to overflow the destination buffer.  The
5072 optional argument is one greater than the type of Object Size Checking to
5073 perform to determine the size of the destination.  @xref{Object Size Checking}.
5074 The argument is meaningful only for functions that operate on character arrays
5075 but not for raw memory functions like @code{memcpy} which always make use
5076 of Object Size type-0.  The option also warns for calls that specify a size
5077 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5078 The option produces the best results with optimization enabled but can detect
5079 a small subset of simple buffer overflows even without optimization in
5080 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5081 correspond to the standard functions.  In any case, the option warns about
5082 just a subset of buffer overflows detected by the corresponding overflow
5083 checking built-ins.  For example, the option will issue a warning for
5084 the @code{strcpy} call below because it copies at least 5 characters
5085 (the string @code{"blue"} including the terminating NUL) into the buffer
5086 of size 4.
5088 @smallexample
5089 enum Color @{ blue, purple, yellow @};
5090 const char* f (enum Color clr)
5092   static char buf [4];
5093   const char *str;
5094   switch (clr)
5095     @{
5096       case blue: str = "blue"; break;
5097       case purple: str = "purple"; break;
5098       case yellow: str = "yellow"; break;
5099     @}
5101   return strcpy (buf, str);   // warning here
5103 @end smallexample
5105 Option @option{-Wstringop-overflow=2} is enabled by default.
5107 @table @gcctabopt
5108 @item -Wstringop-overflow
5109 @item -Wstringop-overflow=1
5110 @opindex Wstringop-overflow
5111 @opindex Wno-stringop-overflow
5112 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5113 to determine the sizes of destination objects.  This is the default setting
5114 of the option.  At this setting the option will not warn for writes past
5115 the end of subobjects of larger objects accessed by pointers unless the
5116 size of the largest surrounding object is known.  When the destination may
5117 be one of several objects it is assumed to be the largest one of them.  On
5118 Linux systems, when optimization is enabled at this setting the option warns
5119 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5120 a non-zero value.
5122 @item -Wstringop-overflow=2
5123 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5124 to determine the sizes of destination objects.  At this setting the option
5125 will warn about overflows when writing to members of the largest complete
5126 objects whose exact size is known.  It will, however, not warn for excessive
5127 writes to the same members of unknown objects referenced by pointers since
5128 they may point to arrays containing unknown numbers of elements.
5130 @item -Wstringop-overflow=3
5131 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5132 to determine the sizes of destination objects.  At this setting the option
5133 warns about overflowing the smallest object or data member.  This is the
5134 most restrictive setting of the option that may result in warnings for safe
5135 code.
5137 @item -Wstringop-overflow=4
5138 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5139 to determine the sizes of destination objects.  At this setting the option
5140 will warn about overflowing any data members, and when the destination is
5141 one of several objects it uses the size of the largest of them to decide
5142 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5143 setting of the option may result in warnings for benign code.
5144 @end table
5146 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5147 @opindex Wsuggest-attribute=
5148 @opindex Wno-suggest-attribute=
5149 Warn for cases where adding an attribute may be beneficial. The
5150 attributes currently supported are listed below.
5152 @table @gcctabopt
5153 @item -Wsuggest-attribute=pure
5154 @itemx -Wsuggest-attribute=const
5155 @itemx -Wsuggest-attribute=noreturn
5156 @opindex Wsuggest-attribute=pure
5157 @opindex Wno-suggest-attribute=pure
5158 @opindex Wsuggest-attribute=const
5159 @opindex Wno-suggest-attribute=const
5160 @opindex Wsuggest-attribute=noreturn
5161 @opindex Wno-suggest-attribute=noreturn
5163 Warn about functions that might be candidates for attributes
5164 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5165 functions visible in other compilation units or (in the case of @code{pure} and
5166 @code{const}) if it cannot prove that the function returns normally. A function
5167 returns normally if it doesn't contain an infinite loop or return abnormally
5168 by throwing, calling @code{abort} or trapping.  This analysis requires option
5169 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5170 higher.  Higher optimization levels improve the accuracy of the analysis.
5172 @item -Wsuggest-attribute=format
5173 @itemx -Wmissing-format-attribute
5174 @opindex Wsuggest-attribute=format
5175 @opindex Wmissing-format-attribute
5176 @opindex Wno-suggest-attribute=format
5177 @opindex Wno-missing-format-attribute
5178 @opindex Wformat
5179 @opindex Wno-format
5181 Warn about function pointers that might be candidates for @code{format}
5182 attributes.  Note these are only possible candidates, not absolute ones.
5183 GCC guesses that function pointers with @code{format} attributes that
5184 are used in assignment, initialization, parameter passing or return
5185 statements should have a corresponding @code{format} attribute in the
5186 resulting type.  I.e.@: the left-hand side of the assignment or
5187 initialization, the type of the parameter variable, or the return type
5188 of the containing function respectively should also have a @code{format}
5189 attribute to avoid the warning.
5191 GCC also warns about function definitions that might be
5192 candidates for @code{format} attributes.  Again, these are only
5193 possible candidates.  GCC guesses that @code{format} attributes
5194 might be appropriate for any function that calls a function like
5195 @code{vprintf} or @code{vscanf}, but this might not always be the
5196 case, and some functions for which @code{format} attributes are
5197 appropriate may not be detected.
5198 @end table
5200 @item -Wsuggest-final-types
5201 @opindex Wno-suggest-final-types
5202 @opindex Wsuggest-final-types
5203 Warn about types with virtual methods where code quality would be improved
5204 if the type were declared with the C++11 @code{final} specifier, 
5205 or, if possible,
5206 declared in an anonymous namespace. This allows GCC to more aggressively
5207 devirtualize the polymorphic calls. This warning is more effective with link
5208 time optimization, where the information about the class hierarchy graph is
5209 more complete.
5211 @item -Wsuggest-final-methods
5212 @opindex Wno-suggest-final-methods
5213 @opindex Wsuggest-final-methods
5214 Warn about virtual methods where code quality would be improved if the method
5215 were declared with the C++11 @code{final} specifier, 
5216 or, if possible, its type were
5217 declared in an anonymous namespace or with the @code{final} specifier.
5218 This warning is
5219 more effective with link-time optimization, where the information about the
5220 class hierarchy graph is more complete. It is recommended to first consider
5221 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5222 annotations.
5224 @item -Wsuggest-override
5225 Warn about overriding virtual functions that are not marked with the override
5226 keyword.
5228 @item -Walloc-zero
5229 @opindex Wno-alloc-zero
5230 @opindex Walloc-zero
5231 Warn about calls to allocation functions decorated with attribute
5232 @code{alloc_size} that specify zero bytes, including those to the built-in
5233 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5234 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5235 when called with a zero size differs among implementations (and in the case
5236 of @code{realloc} has been deprecated) relying on it may result in subtle
5237 portability bugs and should be avoided.
5239 @item -Walloc-size-larger-than=@var{n}
5240 Warn about calls to functions decorated with attribute @code{alloc_size}
5241 that attempt to allocate objects larger than the specified number of bytes,
5242 or where the result of the size computation in an integer type with infinite
5243 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5244 may end in one of the standard suffixes designating a multiple of bytes
5245 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5246 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5247 @xref{Function Attributes}.
5249 @item -Walloca
5250 @opindex Wno-alloca
5251 @opindex Walloca
5252 This option warns on all uses of @code{alloca} in the source.
5254 @item -Walloca-larger-than=@var{n}
5255 This option warns on calls to @code{alloca} that are not bounded by a
5256 controlling predicate limiting its argument of integer type to at most
5257 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5258 Arguments of non-integer types are considered unbounded even if they
5259 appear to be constrained to the expected range.
5261 For example, a bounded case of @code{alloca} could be:
5263 @smallexample
5264 void func (size_t n)
5266   void *p;
5267   if (n <= 1000)
5268     p = alloca (n);
5269   else
5270     p = malloc (n);
5271   f (p);
5273 @end smallexample
5275 In the above example, passing @code{-Walloca-larger-than=1000} would not
5276 issue a warning because the call to @code{alloca} is known to be at most
5277 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5278 the compiler would emit a warning.
5280 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5281 controlling predicate constraining its integer argument.  For example:
5283 @smallexample
5284 void func ()
5286   void *p = alloca (n);
5287   f (p);
5289 @end smallexample
5291 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5292 a warning, but this time because of the lack of bounds checking.
5294 Note, that even seemingly correct code involving signed integers could
5295 cause a warning:
5297 @smallexample
5298 void func (signed int n)
5300   if (n < 500)
5301     @{
5302       p = alloca (n);
5303       f (p);
5304     @}
5306 @end smallexample
5308 In the above example, @var{n} could be negative, causing a larger than
5309 expected argument to be implicitly cast into the @code{alloca} call.
5311 This option also warns when @code{alloca} is used in a loop.
5313 This warning is not enabled by @option{-Wall}, and is only active when
5314 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5316 See also @option{-Wvla-larger-than=@var{n}}.
5318 @item -Warray-bounds
5319 @itemx -Warray-bounds=@var{n}
5320 @opindex Wno-array-bounds
5321 @opindex Warray-bounds
5322 This option is only active when @option{-ftree-vrp} is active
5323 (default for @option{-O2} and above). It warns about subscripts to arrays
5324 that are always out of bounds. This warning is enabled by @option{-Wall}.
5326 @table @gcctabopt
5327 @item -Warray-bounds=1
5328 This is the warning level of @option{-Warray-bounds} and is enabled
5329 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5331 @item -Warray-bounds=2
5332 This warning level also warns about out of bounds access for
5333 arrays at the end of a struct and for arrays accessed through
5334 pointers. This warning level may give a larger number of
5335 false positives and is deactivated by default.
5336 @end table
5338 @item -Wbool-compare
5339 @opindex Wno-bool-compare
5340 @opindex Wbool-compare
5341 Warn about boolean expression compared with an integer value different from
5342 @code{true}/@code{false}.  For instance, the following comparison is
5343 always false:
5344 @smallexample
5345 int n = 5;
5346 @dots{}
5347 if ((n > 1) == 2) @{ @dots{} @}
5348 @end smallexample
5349 This warning is enabled by @option{-Wall}.
5351 @item -Wbool-operation
5352 @opindex Wno-bool-operation
5353 @opindex Wbool-operation
5354 Warn about suspicious operations on expressions of a boolean type.  For
5355 instance, bitwise negation of a boolean is very likely a bug in the program.
5356 For C, this warning also warns about incrementing or decrementing a boolean,
5357 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5358 Incrementing a boolean is invalid in C++1z, and deprecated otherwise.)
5360 This warning is enabled by @option{-Wall}.
5362 @item -Wduplicated-branches
5363 @opindex Wno-duplicated-branches
5364 @opindex Wduplicated-branches
5365 Warn when an if-else has identical branches.  This warning detects cases like
5366 @smallexample
5367 if (p != NULL)
5368   return 0;
5369 else
5370   return 0;
5371 @end smallexample
5372 It doesn't warn when both branches contain just a null statement.  This warning
5373 also warn for conditional operators:
5374 @smallexample
5375   int i = x ? *p : *p;
5376 @end smallexample
5378 @item -Wduplicated-cond
5379 @opindex Wno-duplicated-cond
5380 @opindex Wduplicated-cond
5381 Warn about duplicated conditions in an if-else-if chain.  For instance,
5382 warn for the following code:
5383 @smallexample
5384 if (p->q != NULL) @{ @dots{} @}
5385 else if (p->q != NULL) @{ @dots{} @}
5386 @end smallexample
5388 @item -Wframe-address
5389 @opindex Wno-frame-address
5390 @opindex Wframe-address
5391 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5392 is called with an argument greater than 0.  Such calls may return indeterminate
5393 values or crash the program.  The warning is included in @option{-Wall}.
5395 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5396 @opindex Wno-discarded-qualifiers
5397 @opindex Wdiscarded-qualifiers
5398 Do not warn if type qualifiers on pointers are being discarded.
5399 Typically, the compiler warns if a @code{const char *} variable is
5400 passed to a function that takes a @code{char *} parameter.  This option
5401 can be used to suppress such a warning.
5403 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5404 @opindex Wno-discarded-array-qualifiers
5405 @opindex Wdiscarded-array-qualifiers
5406 Do not warn if type qualifiers on arrays which are pointer targets
5407 are being discarded. Typically, the compiler warns if a
5408 @code{const int (*)[]} variable is passed to a function that
5409 takes a @code{int (*)[]} parameter.  This option can be used to
5410 suppress such a warning.
5412 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5413 @opindex Wno-incompatible-pointer-types
5414 @opindex Wincompatible-pointer-types
5415 Do not warn when there is a conversion between pointers that have incompatible
5416 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5417 which warns for pointer argument passing or assignment with different
5418 signedness.
5420 @item -Wno-int-conversion @r{(C and Objective-C only)}
5421 @opindex Wno-int-conversion
5422 @opindex Wint-conversion
5423 Do not warn about incompatible integer to pointer and pointer to integer
5424 conversions.  This warning is about implicit conversions; for explicit
5425 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5426 @option{-Wno-pointer-to-int-cast} may be used.
5428 @item -Wno-div-by-zero
5429 @opindex Wno-div-by-zero
5430 @opindex Wdiv-by-zero
5431 Do not warn about compile-time integer division by zero.  Floating-point
5432 division by zero is not warned about, as it can be a legitimate way of
5433 obtaining infinities and NaNs.
5435 @item -Wsystem-headers
5436 @opindex Wsystem-headers
5437 @opindex Wno-system-headers
5438 @cindex warnings from system headers
5439 @cindex system headers, warnings from
5440 Print warning messages for constructs found in system header files.
5441 Warnings from system headers are normally suppressed, on the assumption
5442 that they usually do not indicate real problems and would only make the
5443 compiler output harder to read.  Using this command-line option tells
5444 GCC to emit warnings from system headers as if they occurred in user
5445 code.  However, note that using @option{-Wall} in conjunction with this
5446 option does @emph{not} warn about unknown pragmas in system
5447 headers---for that, @option{-Wunknown-pragmas} must also be used.
5449 @item -Wtautological-compare
5450 @opindex Wtautological-compare
5451 @opindex Wno-tautological-compare
5452 Warn if a self-comparison always evaluates to true or false.  This
5453 warning detects various mistakes such as:
5454 @smallexample
5455 int i = 1;
5456 @dots{}
5457 if (i > i) @{ @dots{} @}
5458 @end smallexample
5459 This warning is enabled by @option{-Wall}.
5461 @item -Wtrampolines
5462 @opindex Wtrampolines
5463 @opindex Wno-trampolines
5464 Warn about trampolines generated for pointers to nested functions.
5465 A trampoline is a small piece of data or code that is created at run
5466 time on the stack when the address of a nested function is taken, and is
5467 used to call the nested function indirectly.  For some targets, it is
5468 made up of data only and thus requires no special treatment.  But, for
5469 most targets, it is made up of code and thus requires the stack to be
5470 made executable in order for the program to work properly.
5472 @item -Wfloat-equal
5473 @opindex Wfloat-equal
5474 @opindex Wno-float-equal
5475 Warn if floating-point values are used in equality comparisons.
5477 The idea behind this is that sometimes it is convenient (for the
5478 programmer) to consider floating-point values as approximations to
5479 infinitely precise real numbers.  If you are doing this, then you need
5480 to compute (by analyzing the code, or in some other way) the maximum or
5481 likely maximum error that the computation introduces, and allow for it
5482 when performing comparisons (and when producing output, but that's a
5483 different problem).  In particular, instead of testing for equality, you
5484 should check to see whether the two values have ranges that overlap; and
5485 this is done with the relational operators, so equality comparisons are
5486 probably mistaken.
5488 @item -Wtraditional @r{(C and Objective-C only)}
5489 @opindex Wtraditional
5490 @opindex Wno-traditional
5491 Warn about certain constructs that behave differently in traditional and
5492 ISO C@.  Also warn about ISO C constructs that have no traditional C
5493 equivalent, and/or problematic constructs that should be avoided.
5495 @itemize @bullet
5496 @item
5497 Macro parameters that appear within string literals in the macro body.
5498 In traditional C macro replacement takes place within string literals,
5499 but in ISO C it does not.
5501 @item
5502 In traditional C, some preprocessor directives did not exist.
5503 Traditional preprocessors only considered a line to be a directive
5504 if the @samp{#} appeared in column 1 on the line.  Therefore
5505 @option{-Wtraditional} warns about directives that traditional C
5506 understands but ignores because the @samp{#} does not appear as the
5507 first character on the line.  It also suggests you hide directives like
5508 @code{#pragma} not understood by traditional C by indenting them.  Some
5509 traditional implementations do not recognize @code{#elif}, so this option
5510 suggests avoiding it altogether.
5512 @item
5513 A function-like macro that appears without arguments.
5515 @item
5516 The unary plus operator.
5518 @item
5519 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5520 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5521 constants.)  Note, these suffixes appear in macros defined in the system
5522 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5523 Use of these macros in user code might normally lead to spurious
5524 warnings, however GCC's integrated preprocessor has enough context to
5525 avoid warning in these cases.
5527 @item
5528 A function declared external in one block and then used after the end of
5529 the block.
5531 @item
5532 A @code{switch} statement has an operand of type @code{long}.
5534 @item
5535 A non-@code{static} function declaration follows a @code{static} one.
5536 This construct is not accepted by some traditional C compilers.
5538 @item
5539 The ISO type of an integer constant has a different width or
5540 signedness from its traditional type.  This warning is only issued if
5541 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5542 typically represent bit patterns, are not warned about.
5544 @item
5545 Usage of ISO string concatenation is detected.
5547 @item
5548 Initialization of automatic aggregates.
5550 @item
5551 Identifier conflicts with labels.  Traditional C lacks a separate
5552 namespace for labels.
5554 @item
5555 Initialization of unions.  If the initializer is zero, the warning is
5556 omitted.  This is done under the assumption that the zero initializer in
5557 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5558 initializer warnings and relies on default initialization to zero in the
5559 traditional C case.
5561 @item
5562 Conversions by prototypes between fixed/floating-point values and vice
5563 versa.  The absence of these prototypes when compiling with traditional
5564 C causes serious problems.  This is a subset of the possible
5565 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5567 @item
5568 Use of ISO C style function definitions.  This warning intentionally is
5569 @emph{not} issued for prototype declarations or variadic functions
5570 because these ISO C features appear in your code when using
5571 libiberty's traditional C compatibility macros, @code{PARAMS} and
5572 @code{VPARAMS}.  This warning is also bypassed for nested functions
5573 because that feature is already a GCC extension and thus not relevant to
5574 traditional C compatibility.
5575 @end itemize
5577 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5578 @opindex Wtraditional-conversion
5579 @opindex Wno-traditional-conversion
5580 Warn if a prototype causes a type conversion that is different from what
5581 would happen to the same argument in the absence of a prototype.  This
5582 includes conversions of fixed point to floating and vice versa, and
5583 conversions changing the width or signedness of a fixed-point argument
5584 except when the same as the default promotion.
5586 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5587 @opindex Wdeclaration-after-statement
5588 @opindex Wno-declaration-after-statement
5589 Warn when a declaration is found after a statement in a block.  This
5590 construct, known from C++, was introduced with ISO C99 and is by default
5591 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5593 @item -Wshadow
5594 @opindex Wshadow
5595 @opindex Wno-shadow
5596 Warn whenever a local variable or type declaration shadows another
5597 variable, parameter, type, class member (in C++), or instance variable
5598 (in Objective-C) or whenever a built-in function is shadowed. Note
5599 that in C++, the compiler warns if a local variable shadows an
5600 explicit typedef, but not if it shadows a struct/class/enum.
5601 Same as @option{-Wshadow=global}.
5603 @item -Wno-shadow-ivar @r{(Objective-C only)}
5604 @opindex Wno-shadow-ivar
5605 @opindex Wshadow-ivar
5606 Do not warn whenever a local variable shadows an instance variable in an
5607 Objective-C method.
5609 @item -Wshadow=global
5610 @opindex Wshadow=local
5611 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5613 @item -Wshadow=local
5614 @opindex Wshadow=local
5615 Warn when a local variable shadows another local variable or parameter.
5616 This warning is enabled by @option{-Wshadow=global}.
5618 @item -Wshadow=compatible-local
5619 @opindex Wshadow=compatible-local
5620 Warn when a local variable shadows another local variable or parameter
5621 whose type is compatible with that of the shadowing variable. In C++,
5622 type compatibility here means the type of the shadowing variable can be
5623 converted to that of the shadowed variable. The creation of this flag
5624 (in addition to @option{-Wshadow=local}) is based on the idea that when
5625 a local variable shadows another one of incompatible type, it is most
5626 likely intentional, not a bug or typo, as shown in the following example:
5628 @smallexample
5629 @group
5630 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5632   for (int i = 0; i < N; ++i)
5633   @{
5634     ...
5635   @}
5636   ...
5638 @end group
5639 @end smallexample
5641 Since the two variable @code{i} in the example above have incompatible types,
5642 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5643 Because their types are incompatible, if a programmer accidentally uses one
5644 in place of the other, type checking will catch that and emit an error or
5645 warning. So not warning (about shadowing) in this case will not lead to
5646 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5647 possibly reduce the number of warnings triggered by intentional shadowing.
5649 This warning is enabled by @option{-Wshadow=local}.
5651 @item -Wlarger-than=@var{len}
5652 @opindex Wlarger-than=@var{len}
5653 @opindex Wlarger-than-@var{len}
5654 Warn whenever an object of larger than @var{len} bytes is defined.
5656 @item -Wframe-larger-than=@var{len}
5657 @opindex Wframe-larger-than
5658 Warn if the size of a function frame is larger than @var{len} bytes.
5659 The computation done to determine the stack frame size is approximate
5660 and not conservative.
5661 The actual requirements may be somewhat greater than @var{len}
5662 even if you do not get a warning.  In addition, any space allocated
5663 via @code{alloca}, variable-length arrays, or related constructs
5664 is not included by the compiler when determining
5665 whether or not to issue a warning.
5667 @item -Wno-free-nonheap-object
5668 @opindex Wno-free-nonheap-object
5669 @opindex Wfree-nonheap-object
5670 Do not warn when attempting to free an object that was not allocated
5671 on the heap.
5673 @item -Wstack-usage=@var{len}
5674 @opindex Wstack-usage
5675 Warn if the stack usage of a function might be larger than @var{len} bytes.
5676 The computation done to determine the stack usage is conservative.
5677 Any space allocated via @code{alloca}, variable-length arrays, or related
5678 constructs is included by the compiler when determining whether or not to
5679 issue a warning.
5681 The message is in keeping with the output of @option{-fstack-usage}.
5683 @itemize
5684 @item
5685 If the stack usage is fully static but exceeds the specified amount, it's:
5687 @smallexample
5688   warning: stack usage is 1120 bytes
5689 @end smallexample
5690 @item
5691 If the stack usage is (partly) dynamic but bounded, it's:
5693 @smallexample
5694   warning: stack usage might be 1648 bytes
5695 @end smallexample
5696 @item
5697 If the stack usage is (partly) dynamic and not bounded, it's:
5699 @smallexample
5700   warning: stack usage might be unbounded
5701 @end smallexample
5702 @end itemize
5704 @item -Wunsafe-loop-optimizations
5705 @opindex Wunsafe-loop-optimizations
5706 @opindex Wno-unsafe-loop-optimizations
5707 Warn if the loop cannot be optimized because the compiler cannot
5708 assume anything on the bounds of the loop indices.  With
5709 @option{-funsafe-loop-optimizations} warn if the compiler makes
5710 such assumptions.
5712 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5713 @opindex Wno-pedantic-ms-format
5714 @opindex Wpedantic-ms-format
5715 When used in combination with @option{-Wformat}
5716 and @option{-pedantic} without GNU extensions, this option
5717 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5718 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5719 which depend on the MS runtime.
5721 @item -Waligned-new
5722 @opindex Waligned-new
5723 @opindex Wno-aligned-new
5724 Warn about a new-expression of a type that requires greater alignment
5725 than the @code{alignof(std::max_align_t)} but uses an allocation
5726 function without an explicit alignment parameter. This option is
5727 enabled by @option{-Wall}.
5729 Normally this only warns about global allocation functions, but
5730 @option{-Waligned-new=all} also warns about class member allocation
5731 functions.
5733 @item -Wplacement-new
5734 @itemx -Wplacement-new=@var{n}
5735 @opindex Wplacement-new
5736 @opindex Wno-placement-new
5737 Warn about placement new expressions with undefined behavior, such as
5738 constructing an object in a buffer that is smaller than the type of
5739 the object.  For example, the placement new expression below is diagnosed
5740 because it attempts to construct an array of 64 integers in a buffer only
5741 64 bytes large.
5742 @smallexample
5743 char buf [64];
5744 new (buf) int[64];
5745 @end smallexample
5746 This warning is enabled by default.
5748 @table @gcctabopt
5749 @item -Wplacement-new=1
5750 This is the default warning level of @option{-Wplacement-new}.  At this
5751 level the warning is not issued for some strictly undefined constructs that
5752 GCC allows as extensions for compatibility with legacy code.  For example,
5753 the following @code{new} expression is not diagnosed at this level even
5754 though it has undefined behavior according to the C++ standard because
5755 it writes past the end of the one-element array.
5756 @smallexample
5757 struct S @{ int n, a[1]; @};
5758 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5759 new (s->a)int [32]();
5760 @end smallexample
5762 @item -Wplacement-new=2
5763 At this level, in addition to diagnosing all the same constructs as at level
5764 1, a diagnostic is also issued for placement new expressions that construct
5765 an object in the last member of structure whose type is an array of a single
5766 element and whose size is less than the size of the object being constructed.
5767 While the previous example would be diagnosed, the following construct makes
5768 use of the flexible member array extension to avoid the warning at level 2.
5769 @smallexample
5770 struct S @{ int n, a[]; @};
5771 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5772 new (s->a)int [32]();
5773 @end smallexample
5775 @end table
5777 @item -Wpointer-arith
5778 @opindex Wpointer-arith
5779 @opindex Wno-pointer-arith
5780 Warn about anything that depends on the ``size of'' a function type or
5781 of @code{void}.  GNU C assigns these types a size of 1, for
5782 convenience in calculations with @code{void *} pointers and pointers
5783 to functions.  In C++, warn also when an arithmetic operation involves
5784 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5786 @item -Wpointer-compare
5787 @opindex Wpointer-compare
5788 @opindex Wno-pointer-compare
5789 Warn if a pointer is compared with a zero character constant.  This usually
5790 means that the pointer was meant to be dereferenced.  For example:
5792 @smallexample
5793 const char *p = foo ();
5794 if (p == '\0')
5795   return 42;
5796 @end smallexample
5798 Note that the code above is invalid in C++11.
5800 This warning is enabled by default.
5802 @item -Wtype-limits
5803 @opindex Wtype-limits
5804 @opindex Wno-type-limits
5805 Warn if a comparison is always true or always false due to the limited
5806 range of the data type, but do not warn for constant expressions.  For
5807 example, warn if an unsigned variable is compared against zero with
5808 @code{<} or @code{>=}.  This warning is also enabled by
5809 @option{-Wextra}.
5811 @include cppwarnopts.texi
5813 @item -Wbad-function-cast @r{(C and Objective-C only)}
5814 @opindex Wbad-function-cast
5815 @opindex Wno-bad-function-cast
5816 Warn when a function call is cast to a non-matching type.
5817 For example, warn if a call to a function returning an integer type 
5818 is cast to a pointer type.
5820 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5821 @opindex Wc90-c99-compat
5822 @opindex Wno-c90-c99-compat
5823 Warn about features not present in ISO C90, but present in ISO C99.
5824 For instance, warn about use of variable length arrays, @code{long long}
5825 type, @code{bool} type, compound literals, designated initializers, and so
5826 on.  This option is independent of the standards mode.  Warnings are disabled
5827 in the expression that follows @code{__extension__}.
5829 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5830 @opindex Wc99-c11-compat
5831 @opindex Wno-c99-c11-compat
5832 Warn about features not present in ISO C99, but present in ISO C11.
5833 For instance, warn about use of anonymous structures and unions,
5834 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5835 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5836 and so on.  This option is independent of the standards mode.  Warnings are
5837 disabled in the expression that follows @code{__extension__}.
5839 @item -Wc++-compat @r{(C and Objective-C only)}
5840 @opindex Wc++-compat
5841 Warn about ISO C constructs that are outside of the common subset of
5842 ISO C and ISO C++, e.g.@: request for implicit conversion from
5843 @code{void *} to a pointer to non-@code{void} type.
5845 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5846 @opindex Wc++11-compat
5847 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5848 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5849 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5850 enabled by @option{-Wall}.
5852 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5853 @opindex Wc++14-compat
5854 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5855 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5857 @item -Wc++1z-compat @r{(C++ and Objective-C++ only)}
5858 @opindex Wc++1z-compat
5859 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5860 and the forthoming ISO C++ 2017(?).  This warning is enabled by @option{-Wall}.
5862 @item -Wcast-qual
5863 @opindex Wcast-qual
5864 @opindex Wno-cast-qual
5865 Warn whenever a pointer is cast so as to remove a type qualifier from
5866 the target type.  For example, warn if a @code{const char *} is cast
5867 to an ordinary @code{char *}.
5869 Also warn when making a cast that introduces a type qualifier in an
5870 unsafe way.  For example, casting @code{char **} to @code{const char **}
5871 is unsafe, as in this example:
5873 @smallexample
5874   /* p is char ** value.  */
5875   const char **q = (const char **) p;
5876   /* Assignment of readonly string to const char * is OK.  */
5877   *q = "string";
5878   /* Now char** pointer points to read-only memory.  */
5879   **p = 'b';
5880 @end smallexample
5882 @item -Wcast-align
5883 @opindex Wcast-align
5884 @opindex Wno-cast-align
5885 Warn whenever a pointer is cast such that the required alignment of the
5886 target is increased.  For example, warn if a @code{char *} is cast to
5887 an @code{int *} on machines where integers can only be accessed at
5888 two- or four-byte boundaries.
5890 @item -Wwrite-strings
5891 @opindex Wwrite-strings
5892 @opindex Wno-write-strings
5893 When compiling C, give string constants the type @code{const
5894 char[@var{length}]} so that copying the address of one into a
5895 non-@code{const} @code{char *} pointer produces a warning.  These
5896 warnings help you find at compile time code that can try to write
5897 into a string constant, but only if you have been very careful about
5898 using @code{const} in declarations and prototypes.  Otherwise, it is
5899 just a nuisance. This is why we did not make @option{-Wall} request
5900 these warnings.
5902 When compiling C++, warn about the deprecated conversion from string
5903 literals to @code{char *}.  This warning is enabled by default for C++
5904 programs.
5906 @item -Wcatch-value
5907 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5908 @opindex Wcatch-value
5909 @opindex Wno-catch-value
5910 Warn about catch handlers that do not catch via reference.
5911 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5912 warn about polymorphic class types that are caught by value.
5913 With @option{-Wcatch-value=2} warn about all class types that are caught
5914 by value. With @option{-Wcatch-value=3} warn about all types that are
5915 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5917 @item -Wclobbered
5918 @opindex Wclobbered
5919 @opindex Wno-clobbered
5920 Warn for variables that might be changed by @code{longjmp} or
5921 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5923 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5924 @opindex Wconditionally-supported
5925 @opindex Wno-conditionally-supported
5926 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5928 @item -Wconversion
5929 @opindex Wconversion
5930 @opindex Wno-conversion
5931 Warn for implicit conversions that may alter a value. This includes
5932 conversions between real and integer, like @code{abs (x)} when
5933 @code{x} is @code{double}; conversions between signed and unsigned,
5934 like @code{unsigned ui = -1}; and conversions to smaller types, like
5935 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5936 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5937 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5938 conversions between signed and unsigned integers can be disabled by
5939 using @option{-Wno-sign-conversion}.
5941 For C++, also warn for confusing overload resolution for user-defined
5942 conversions; and conversions that never use a type conversion
5943 operator: conversions to @code{void}, the same type, a base class or a
5944 reference to them. Warnings about conversions between signed and
5945 unsigned integers are disabled by default in C++ unless
5946 @option{-Wsign-conversion} is explicitly enabled.
5948 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5949 @opindex Wconversion-null
5950 @opindex Wno-conversion-null
5951 Do not warn for conversions between @code{NULL} and non-pointer
5952 types. @option{-Wconversion-null} is enabled by default.
5954 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5955 @opindex Wzero-as-null-pointer-constant
5956 @opindex Wno-zero-as-null-pointer-constant
5957 Warn when a literal @samp{0} is used as null pointer constant.  This can
5958 be useful to facilitate the conversion to @code{nullptr} in C++11.
5960 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5961 @opindex Wsubobject-linkage
5962 @opindex Wno-subobject-linkage
5963 Warn if a class type has a base or a field whose type uses the anonymous
5964 namespace or depends on a type with no linkage.  If a type A depends on
5965 a type B with no or internal linkage, defining it in multiple
5966 translation units would be an ODR violation because the meaning of B
5967 is different in each translation unit.  If A only appears in a single
5968 translation unit, the best way to silence the warning is to give it
5969 internal linkage by putting it in an anonymous namespace as well.  The
5970 compiler doesn't give this warning for types defined in the main .C
5971 file, as those are unlikely to have multiple definitions.
5972 @option{-Wsubobject-linkage} is enabled by default.
5974 @item -Wdangling-else
5975 @opindex Wdangling-else
5976 @opindex Wno-dangling-else
5977 Warn about constructions where there may be confusion to which
5978 @code{if} statement an @code{else} branch belongs.  Here is an example of
5979 such a case:
5981 @smallexample
5982 @group
5984   if (a)
5985     if (b)
5986       foo ();
5987   else
5988     bar ();
5990 @end group
5991 @end smallexample
5993 In C/C++, every @code{else} branch belongs to the innermost possible
5994 @code{if} statement, which in this example is @code{if (b)}.  This is
5995 often not what the programmer expected, as illustrated in the above
5996 example by indentation the programmer chose.  When there is the
5997 potential for this confusion, GCC issues a warning when this flag
5998 is specified.  To eliminate the warning, add explicit braces around
5999 the innermost @code{if} statement so there is no way the @code{else}
6000 can belong to the enclosing @code{if}.  The resulting code
6001 looks like this:
6003 @smallexample
6004 @group
6006   if (a)
6007     @{
6008       if (b)
6009         foo ();
6010       else
6011         bar ();
6012     @}
6014 @end group
6015 @end smallexample
6017 This warning is enabled by @option{-Wparentheses}.
6019 @item -Wdate-time
6020 @opindex Wdate-time
6021 @opindex Wno-date-time
6022 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6023 are encountered as they might prevent bit-wise-identical reproducible
6024 compilations.
6026 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6027 @opindex Wdelete-incomplete
6028 @opindex Wno-delete-incomplete
6029 Warn when deleting a pointer to incomplete type, which may cause
6030 undefined behavior at runtime.  This warning is enabled by default.
6032 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6033 @opindex Wuseless-cast
6034 @opindex Wno-useless-cast
6035 Warn when an expression is casted to its own type.
6037 @item -Wempty-body
6038 @opindex Wempty-body
6039 @opindex Wno-empty-body
6040 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6041 while} statement.  This warning is also enabled by @option{-Wextra}.
6043 @item -Wenum-compare
6044 @opindex Wenum-compare
6045 @opindex Wno-enum-compare
6046 Warn about a comparison between values of different enumerated types.
6047 In C++ enumerated type mismatches in conditional expressions are also
6048 diagnosed and the warning is enabled by default.  In C this warning is 
6049 enabled by @option{-Wall}.
6051 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6052 @opindex Wextra-semi
6053 @opindex Wno-extra-semi
6054 Warn about redundant semicolon after in-class function definition.
6056 @item -Wjump-misses-init @r{(C, Objective-C only)}
6057 @opindex Wjump-misses-init
6058 @opindex Wno-jump-misses-init
6059 Warn if a @code{goto} statement or a @code{switch} statement jumps
6060 forward across the initialization of a variable, or jumps backward to a
6061 label after the variable has been initialized.  This only warns about
6062 variables that are initialized when they are declared.  This warning is
6063 only supported for C and Objective-C; in C++ this sort of branch is an
6064 error in any case.
6066 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6067 can be disabled with the @option{-Wno-jump-misses-init} option.
6069 @item -Wsign-compare
6070 @opindex Wsign-compare
6071 @opindex Wno-sign-compare
6072 @cindex warning for comparison of signed and unsigned values
6073 @cindex comparison of signed and unsigned values, warning
6074 @cindex signed and unsigned values, comparison warning
6075 Warn when a comparison between signed and unsigned values could produce
6076 an incorrect result when the signed value is converted to unsigned.
6077 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6078 also enabled by @option{-Wextra}.
6080 @item -Wsign-conversion
6081 @opindex Wsign-conversion
6082 @opindex Wno-sign-conversion
6083 Warn for implicit conversions that may change the sign of an integer
6084 value, like assigning a signed integer expression to an unsigned
6085 integer variable. An explicit cast silences the warning. In C, this
6086 option is enabled also by @option{-Wconversion}.
6088 @item -Wfloat-conversion
6089 @opindex Wfloat-conversion
6090 @opindex Wno-float-conversion
6091 Warn for implicit conversions that reduce the precision of a real value.
6092 This includes conversions from real to integer, and from higher precision
6093 real to lower precision real values.  This option is also enabled by
6094 @option{-Wconversion}.
6096 @item -Wno-scalar-storage-order
6097 @opindex -Wno-scalar-storage-order
6098 @opindex -Wscalar-storage-order
6099 Do not warn on suspicious constructs involving reverse scalar storage order.
6101 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6102 @opindex Wsized-deallocation
6103 @opindex Wno-sized-deallocation
6104 Warn about a definition of an unsized deallocation function
6105 @smallexample
6106 void operator delete (void *) noexcept;
6107 void operator delete[] (void *) noexcept;
6108 @end smallexample
6109 without a definition of the corresponding sized deallocation function
6110 @smallexample
6111 void operator delete (void *, std::size_t) noexcept;
6112 void operator delete[] (void *, std::size_t) noexcept;
6113 @end smallexample
6114 or vice versa.  Enabled by @option{-Wextra} along with
6115 @option{-fsized-deallocation}.
6117 @item -Wsizeof-pointer-div
6118 @opindex Wsizeof-pointer-div
6119 @opindex Wno-sizeof-pointer-div
6120 Warn for suspicious divisions of two sizeof expressions that divide
6121 the pointer size by the element size, which is the usual way to compute
6122 the array size but won't work out correctly with pointers.  This warning
6123 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6124 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6126 @item -Wsizeof-pointer-memaccess
6127 @opindex Wsizeof-pointer-memaccess
6128 @opindex Wno-sizeof-pointer-memaccess
6129 Warn for suspicious length parameters to certain string and memory built-in
6130 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6131 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6132 but a pointer, and suggests a possible fix, or about
6133 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6134 @option{-Wall}.
6136 @item -Wsizeof-array-argument
6137 @opindex Wsizeof-array-argument
6138 @opindex Wno-sizeof-array-argument
6139 Warn when the @code{sizeof} operator is applied to a parameter that is
6140 declared as an array in a function definition.  This warning is enabled by
6141 default for C and C++ programs.
6143 @item -Wmemset-elt-size
6144 @opindex Wmemset-elt-size
6145 @opindex Wno-memset-elt-size
6146 Warn for suspicious calls to the @code{memset} built-in function, if the
6147 first argument references an array, and the third argument is a number
6148 equal to the number of elements, but not equal to the size of the array
6149 in memory.  This indicates that the user has omitted a multiplication by
6150 the element size.  This warning is enabled by @option{-Wall}.
6152 @item -Wmemset-transposed-args
6153 @opindex Wmemset-transposed-args
6154 @opindex Wno-memset-transposed-args
6155 Warn for suspicious calls to the @code{memset} built-in function, if the
6156 second argument is not zero and the third argument is zero.  This warns e.g.@
6157 about @code{memset (buf, sizeof buf, 0)} where most probably
6158 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6159 is only emitted if the third argument is literal zero.  If it is some
6160 expression that is folded to zero, a cast of zero to some type, etc., 
6161 it is far less likely that the user has mistakenly exchanged the arguments 
6162 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6164 @item -Waddress
6165 @opindex Waddress
6166 @opindex Wno-address
6167 Warn about suspicious uses of memory addresses. These include using
6168 the address of a function in a conditional expression, such as
6169 @code{void func(void); if (func)}, and comparisons against the memory
6170 address of a string literal, such as @code{if (x == "abc")}.  Such
6171 uses typically indicate a programmer error: the address of a function
6172 always evaluates to true, so their use in a conditional usually
6173 indicate that the programmer forgot the parentheses in a function
6174 call; and comparisons against string literals result in unspecified
6175 behavior and are not portable in C, so they usually indicate that the
6176 programmer intended to use @code{strcmp}.  This warning is enabled by
6177 @option{-Wall}.
6179 @item -Wlogical-op
6180 @opindex Wlogical-op
6181 @opindex Wno-logical-op
6182 Warn about suspicious uses of logical operators in expressions.
6183 This includes using logical operators in contexts where a
6184 bit-wise operator is likely to be expected.  Also warns when
6185 the operands of a logical operator are the same:
6186 @smallexample
6187 extern int a;
6188 if (a < 0 && a < 0) @{ @dots{} @}
6189 @end smallexample
6191 @item -Wlogical-not-parentheses
6192 @opindex Wlogical-not-parentheses
6193 @opindex Wno-logical-not-parentheses
6194 Warn about logical not used on the left hand side operand of a comparison.
6195 This option does not warn if the right operand is considered to be a boolean
6196 expression.  Its purpose is to detect suspicious code like the following:
6197 @smallexample
6198 int a;
6199 @dots{}
6200 if (!a > 1) @{ @dots{} @}
6201 @end smallexample
6203 It is possible to suppress the warning by wrapping the LHS into
6204 parentheses:
6205 @smallexample
6206 if ((!a) > 1) @{ @dots{} @}
6207 @end smallexample
6209 This warning is enabled by @option{-Wall}.
6211 @item -Waggregate-return
6212 @opindex Waggregate-return
6213 @opindex Wno-aggregate-return
6214 Warn if any functions that return structures or unions are defined or
6215 called.  (In languages where you can return an array, this also elicits
6216 a warning.)
6218 @item -Wno-aggressive-loop-optimizations
6219 @opindex Wno-aggressive-loop-optimizations
6220 @opindex Waggressive-loop-optimizations
6221 Warn if in a loop with constant number of iterations the compiler detects
6222 undefined behavior in some statement during one or more of the iterations.
6224 @item -Wno-attributes
6225 @opindex Wno-attributes
6226 @opindex Wattributes
6227 Do not warn if an unexpected @code{__attribute__} is used, such as
6228 unrecognized attributes, function attributes applied to variables,
6229 etc.  This does not stop errors for incorrect use of supported
6230 attributes.
6232 @item -Wno-builtin-declaration-mismatch
6233 @opindex Wno-builtin-declaration-mismatch
6234 @opindex Wbuiltin-declaration-mismatch
6235 Warn if a built-in function is declared with the wrong signature.
6236 This warning is enabled by default.
6238 @item -Wno-builtin-macro-redefined
6239 @opindex Wno-builtin-macro-redefined
6240 @opindex Wbuiltin-macro-redefined
6241 Do not warn if certain built-in macros are redefined.  This suppresses
6242 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6243 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6245 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6246 @opindex Wstrict-prototypes
6247 @opindex Wno-strict-prototypes
6248 Warn if a function is declared or defined without specifying the
6249 argument types.  (An old-style function definition is permitted without
6250 a warning if preceded by a declaration that specifies the argument
6251 types.)
6253 @item -Wold-style-declaration @r{(C and Objective-C only)}
6254 @opindex Wold-style-declaration
6255 @opindex Wno-old-style-declaration
6256 Warn for obsolescent usages, according to the C Standard, in a
6257 declaration. For example, warn if storage-class specifiers like
6258 @code{static} are not the first things in a declaration.  This warning
6259 is also enabled by @option{-Wextra}.
6261 @item -Wold-style-definition @r{(C and Objective-C only)}
6262 @opindex Wold-style-definition
6263 @opindex Wno-old-style-definition
6264 Warn if an old-style function definition is used.  A warning is given
6265 even if there is a previous prototype.
6267 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6268 @opindex Wmissing-parameter-type
6269 @opindex Wno-missing-parameter-type
6270 A function parameter is declared without a type specifier in K&R-style
6271 functions:
6273 @smallexample
6274 void foo(bar) @{ @}
6275 @end smallexample
6277 This warning is also enabled by @option{-Wextra}.
6279 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6280 @opindex Wmissing-prototypes
6281 @opindex Wno-missing-prototypes
6282 Warn if a global function is defined without a previous prototype
6283 declaration.  This warning is issued even if the definition itself
6284 provides a prototype.  Use this option to detect global functions
6285 that do not have a matching prototype declaration in a header file.
6286 This option is not valid for C++ because all function declarations
6287 provide prototypes and a non-matching declaration declares an
6288 overload rather than conflict with an earlier declaration.
6289 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6291 @item -Wmissing-declarations
6292 @opindex Wmissing-declarations
6293 @opindex Wno-missing-declarations
6294 Warn if a global function is defined without a previous declaration.
6295 Do so even if the definition itself provides a prototype.
6296 Use this option to detect global functions that are not declared in
6297 header files.  In C, no warnings are issued for functions with previous
6298 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6299 missing prototypes.  In C++, no warnings are issued for function templates,
6300 or for inline functions, or for functions in anonymous namespaces.
6302 @item -Wmissing-field-initializers
6303 @opindex Wmissing-field-initializers
6304 @opindex Wno-missing-field-initializers
6305 @opindex W
6306 @opindex Wextra
6307 @opindex Wno-extra
6308 Warn if a structure's initializer has some fields missing.  For
6309 example, the following code causes such a warning, because
6310 @code{x.h} is implicitly zero:
6312 @smallexample
6313 struct s @{ int f, g, h; @};
6314 struct s x = @{ 3, 4 @};
6315 @end smallexample
6317 This option does not warn about designated initializers, so the following
6318 modification does not trigger a warning:
6320 @smallexample
6321 struct s @{ int f, g, h; @};
6322 struct s x = @{ .f = 3, .g = 4 @};
6323 @end smallexample
6325 In C this option does not warn about the universal zero initializer
6326 @samp{@{ 0 @}}:
6328 @smallexample
6329 struct s @{ int f, g, h; @};
6330 struct s x = @{ 0 @};
6331 @end smallexample
6333 Likewise, in C++ this option does not warn about the empty @{ @}
6334 initializer, for example:
6336 @smallexample
6337 struct s @{ int f, g, h; @};
6338 s x = @{ @};
6339 @end smallexample
6341 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6342 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6344 @item -Wno-multichar
6345 @opindex Wno-multichar
6346 @opindex Wmultichar
6347 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6348 Usually they indicate a typo in the user's code, as they have
6349 implementation-defined values, and should not be used in portable code.
6351 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6352 @opindex Wnormalized=
6353 @opindex Wnormalized
6354 @opindex Wno-normalized
6355 @cindex NFC
6356 @cindex NFKC
6357 @cindex character set, input normalization
6358 In ISO C and ISO C++, two identifiers are different if they are
6359 different sequences of characters.  However, sometimes when characters
6360 outside the basic ASCII character set are used, you can have two
6361 different character sequences that look the same.  To avoid confusion,
6362 the ISO 10646 standard sets out some @dfn{normalization rules} which
6363 when applied ensure that two sequences that look the same are turned into
6364 the same sequence.  GCC can warn you if you are using identifiers that
6365 have not been normalized; this option controls that warning.
6367 There are four levels of warning supported by GCC@.  The default is
6368 @option{-Wnormalized=nfc}, which warns about any identifier that is
6369 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6370 recommended form for most uses.  It is equivalent to
6371 @option{-Wnormalized}.
6373 Unfortunately, there are some characters allowed in identifiers by
6374 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6375 identifiers.  That is, there's no way to use these symbols in portable
6376 ISO C or C++ and have all your identifiers in NFC@.
6377 @option{-Wnormalized=id} suppresses the warning for these characters.
6378 It is hoped that future versions of the standards involved will correct
6379 this, which is why this option is not the default.
6381 You can switch the warning off for all characters by writing
6382 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6383 only do this if you are using some other normalization scheme (like
6384 ``D''), because otherwise you can easily create bugs that are
6385 literally impossible to see.
6387 Some characters in ISO 10646 have distinct meanings but look identical
6388 in some fonts or display methodologies, especially once formatting has
6389 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6390 LETTER N'', displays just like a regular @code{n} that has been
6391 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6392 normalization scheme to convert all these into a standard form as
6393 well, and GCC warns if your code is not in NFKC if you use
6394 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6395 about every identifier that contains the letter O because it might be
6396 confused with the digit 0, and so is not the default, but may be
6397 useful as a local coding convention if the programming environment 
6398 cannot be fixed to display these characters distinctly.
6400 @item -Wno-deprecated
6401 @opindex Wno-deprecated
6402 @opindex Wdeprecated
6403 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6405 @item -Wno-deprecated-declarations
6406 @opindex Wno-deprecated-declarations
6407 @opindex Wdeprecated-declarations
6408 Do not warn about uses of functions (@pxref{Function Attributes}),
6409 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6410 Attributes}) marked as deprecated by using the @code{deprecated}
6411 attribute.
6413 @item -Wno-overflow
6414 @opindex Wno-overflow
6415 @opindex Woverflow
6416 Do not warn about compile-time overflow in constant expressions.
6418 @item -Wno-odr
6419 @opindex Wno-odr
6420 @opindex Wodr
6421 Warn about One Definition Rule violations during link-time optimization.
6422 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6424 @item -Wopenmp-simd
6425 @opindex Wopenm-simd
6426 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6427 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6428 option can be used to relax the cost model.
6430 @item -Woverride-init @r{(C and Objective-C only)}
6431 @opindex Woverride-init
6432 @opindex Wno-override-init
6433 @opindex W
6434 @opindex Wextra
6435 @opindex Wno-extra
6436 Warn if an initialized field without side effects is overridden when
6437 using designated initializers (@pxref{Designated Inits, , Designated
6438 Initializers}).
6440 This warning is included in @option{-Wextra}.  To get other
6441 @option{-Wextra} warnings without this one, use @option{-Wextra
6442 -Wno-override-init}.
6444 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6445 @opindex Woverride-init-side-effects
6446 @opindex Wno-override-init-side-effects
6447 Warn if an initialized field with side effects is overridden when
6448 using designated initializers (@pxref{Designated Inits, , Designated
6449 Initializers}).  This warning is enabled by default.
6451 @item -Wpacked
6452 @opindex Wpacked
6453 @opindex Wno-packed
6454 Warn if a structure is given the packed attribute, but the packed
6455 attribute has no effect on the layout or size of the structure.
6456 Such structures may be mis-aligned for little benefit.  For
6457 instance, in this code, the variable @code{f.x} in @code{struct bar}
6458 is misaligned even though @code{struct bar} does not itself
6459 have the packed attribute:
6461 @smallexample
6462 @group
6463 struct foo @{
6464   int x;
6465   char a, b, c, d;
6466 @} __attribute__((packed));
6467 struct bar @{
6468   char z;
6469   struct foo f;
6471 @end group
6472 @end smallexample
6474 @item -Wpacked-bitfield-compat
6475 @opindex Wpacked-bitfield-compat
6476 @opindex Wno-packed-bitfield-compat
6477 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6478 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6479 the change can lead to differences in the structure layout.  GCC
6480 informs you when the offset of such a field has changed in GCC 4.4.
6481 For example there is no longer a 4-bit padding between field @code{a}
6482 and @code{b} in this structure:
6484 @smallexample
6485 struct foo
6487   char a:4;
6488   char b:8;
6489 @} __attribute__ ((packed));
6490 @end smallexample
6492 This warning is enabled by default.  Use
6493 @option{-Wno-packed-bitfield-compat} to disable this warning.
6495 @item -Wpadded
6496 @opindex Wpadded
6497 @opindex Wno-padded
6498 Warn if padding is included in a structure, either to align an element
6499 of the structure or to align the whole structure.  Sometimes when this
6500 happens it is possible to rearrange the fields of the structure to
6501 reduce the padding and so make the structure smaller.
6503 @item -Wredundant-decls
6504 @opindex Wredundant-decls
6505 @opindex Wno-redundant-decls
6506 Warn if anything is declared more than once in the same scope, even in
6507 cases where multiple declaration is valid and changes nothing.
6509 @item -Wrestrict
6510 @opindex Wrestrict
6511 @opindex Wno-restrict
6512 Warn when an argument passed to a restrict-qualified parameter
6513 aliases with another argument.
6515 @item -Wnested-externs @r{(C and Objective-C only)}
6516 @opindex Wnested-externs
6517 @opindex Wno-nested-externs
6518 Warn if an @code{extern} declaration is encountered within a function.
6520 @item -Wno-inherited-variadic-ctor
6521 @opindex Winherited-variadic-ctor
6522 @opindex Wno-inherited-variadic-ctor
6523 Suppress warnings about use of C++11 inheriting constructors when the
6524 base class inherited from has a C variadic constructor; the warning is
6525 on by default because the ellipsis is not inherited.
6527 @item -Winline
6528 @opindex Winline
6529 @opindex Wno-inline
6530 Warn if a function that is declared as inline cannot be inlined.
6531 Even with this option, the compiler does not warn about failures to
6532 inline functions declared in system headers.
6534 The compiler uses a variety of heuristics to determine whether or not
6535 to inline a function.  For example, the compiler takes into account
6536 the size of the function being inlined and the amount of inlining
6537 that has already been done in the current function.  Therefore,
6538 seemingly insignificant changes in the source program can cause the
6539 warnings produced by @option{-Winline} to appear or disappear.
6541 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6542 @opindex Wno-invalid-offsetof
6543 @opindex Winvalid-offsetof
6544 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6545 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6546 to a non-standard-layout type is undefined.  In existing C++ implementations,
6547 however, @code{offsetof} typically gives meaningful results.
6548 This flag is for users who are aware that they are
6549 writing nonportable code and who have deliberately chosen to ignore the
6550 warning about it.
6552 The restrictions on @code{offsetof} may be relaxed in a future version
6553 of the C++ standard.
6555 @item -Wint-in-bool-context
6556 @opindex Wint-in-bool-context
6557 @opindex Wno-int-in-bool-context
6558 Warn for suspicious use of integer values where boolean values are expected,
6559 such as conditional expressions (?:) using non-boolean integer constants in
6560 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6561 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6562 for all kinds of multiplications regardless of the data type.
6563 This warning is enabled by @option{-Wall}.
6565 @item -Wno-int-to-pointer-cast
6566 @opindex Wno-int-to-pointer-cast
6567 @opindex Wint-to-pointer-cast
6568 Suppress warnings from casts to pointer type of an integer of a
6569 different size. In C++, casting to a pointer type of smaller size is
6570 an error. @option{Wint-to-pointer-cast} is enabled by default.
6573 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6574 @opindex Wno-pointer-to-int-cast
6575 @opindex Wpointer-to-int-cast
6576 Suppress warnings from casts from a pointer to an integer type of a
6577 different size.
6579 @item -Winvalid-pch
6580 @opindex Winvalid-pch
6581 @opindex Wno-invalid-pch
6582 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6583 the search path but cannot be used.
6585 @item -Wlong-long
6586 @opindex Wlong-long
6587 @opindex Wno-long-long
6588 Warn if @code{long long} type is used.  This is enabled by either
6589 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6590 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6592 @item -Wvariadic-macros
6593 @opindex Wvariadic-macros
6594 @opindex Wno-variadic-macros
6595 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6596 alternate syntax is used in ISO C99 mode.  This is enabled by either
6597 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6598 messages, use @option{-Wno-variadic-macros}.
6600 @item -Wvarargs
6601 @opindex Wvarargs
6602 @opindex Wno-varargs
6603 Warn upon questionable usage of the macros used to handle variable
6604 arguments like @code{va_start}.  This is default.  To inhibit the
6605 warning messages, use @option{-Wno-varargs}.
6607 @item -Wvector-operation-performance
6608 @opindex Wvector-operation-performance
6609 @opindex Wno-vector-operation-performance
6610 Warn if vector operation is not implemented via SIMD capabilities of the
6611 architecture.  Mainly useful for the performance tuning.
6612 Vector operation can be implemented @code{piecewise}, which means that the
6613 scalar operation is performed on every vector element; 
6614 @code{in parallel}, which means that the vector operation is implemented
6615 using scalars of wider type, which normally is more performance efficient;
6616 and @code{as a single scalar}, which means that vector fits into a
6617 scalar type.
6619 @item -Wno-virtual-move-assign
6620 @opindex Wvirtual-move-assign
6621 @opindex Wno-virtual-move-assign
6622 Suppress warnings about inheriting from a virtual base with a
6623 non-trivial C++11 move assignment operator.  This is dangerous because
6624 if the virtual base is reachable along more than one path, it is
6625 moved multiple times, which can mean both objects end up in the
6626 moved-from state.  If the move assignment operator is written to avoid
6627 moving from a moved-from object, this warning can be disabled.
6629 @item -Wvla
6630 @opindex Wvla
6631 @opindex Wno-vla
6632 Warn if a variable-length array is used in the code.
6633 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6634 the variable-length array.
6636 @item -Wvla-larger-than=@var{n}
6637 If this option is used, the compiler will warn on uses of
6638 variable-length arrays where the size is either unbounded, or bounded
6639 by an argument that can be larger than @var{n} bytes.  This is similar
6640 to how @option{-Walloca-larger-than=@var{n}} works, but with
6641 variable-length arrays.
6643 Note that GCC may optimize small variable-length arrays of a known
6644 value into plain arrays, so this warning may not get triggered for
6645 such arrays.
6647 This warning is not enabled by @option{-Wall}, and is only active when
6648 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6650 See also @option{-Walloca-larger-than=@var{n}}.
6652 @item -Wvolatile-register-var
6653 @opindex Wvolatile-register-var
6654 @opindex Wno-volatile-register-var
6655 Warn if a register variable is declared volatile.  The volatile
6656 modifier does not inhibit all optimizations that may eliminate reads
6657 and/or writes to register variables.  This warning is enabled by
6658 @option{-Wall}.
6660 @item -Wdisabled-optimization
6661 @opindex Wdisabled-optimization
6662 @opindex Wno-disabled-optimization
6663 Warn if a requested optimization pass is disabled.  This warning does
6664 not generally indicate that there is anything wrong with your code; it
6665 merely indicates that GCC's optimizers are unable to handle the code
6666 effectively.  Often, the problem is that your code is too big or too
6667 complex; GCC refuses to optimize programs when the optimization
6668 itself is likely to take inordinate amounts of time.
6670 @item -Wpointer-sign @r{(C and Objective-C only)}
6671 @opindex Wpointer-sign
6672 @opindex Wno-pointer-sign
6673 Warn for pointer argument passing or assignment with different signedness.
6674 This option is only supported for C and Objective-C@.  It is implied by
6675 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6676 @option{-Wno-pointer-sign}.
6678 @item -Wstack-protector
6679 @opindex Wstack-protector
6680 @opindex Wno-stack-protector
6681 This option is only active when @option{-fstack-protector} is active.  It
6682 warns about functions that are not protected against stack smashing.
6684 @item -Woverlength-strings
6685 @opindex Woverlength-strings
6686 @opindex Wno-overlength-strings
6687 Warn about string constants that are longer than the ``minimum
6688 maximum'' length specified in the C standard.  Modern compilers
6689 generally allow string constants that are much longer than the
6690 standard's minimum limit, but very portable programs should avoid
6691 using longer strings.
6693 The limit applies @emph{after} string constant concatenation, and does
6694 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6695 C99, it was raised to 4095.  C++98 does not specify a normative
6696 minimum maximum, so we do not diagnose overlength strings in C++@.
6698 This option is implied by @option{-Wpedantic}, and can be disabled with
6699 @option{-Wno-overlength-strings}.
6701 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6702 @opindex Wunsuffixed-float-constants
6704 Issue a warning for any floating constant that does not have
6705 a suffix.  When used together with @option{-Wsystem-headers} it
6706 warns about such constants in system header files.  This can be useful
6707 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6708 from the decimal floating-point extension to C99.
6710 @item -Wno-designated-init @r{(C and Objective-C only)}
6711 Suppress warnings when a positional initializer is used to initialize
6712 a structure that has been marked with the @code{designated_init}
6713 attribute.
6715 @item -Whsa
6716 Issue a warning when HSAIL cannot be emitted for the compiled function or
6717 OpenMP construct.
6719 @end table
6721 @node Debugging Options
6722 @section Options for Debugging Your Program
6723 @cindex options, debugging
6724 @cindex debugging information options
6726 To tell GCC to emit extra information for use by a debugger, in almost 
6727 all cases you need only to add @option{-g} to your other options.
6729 GCC allows you to use @option{-g} with
6730 @option{-O}.  The shortcuts taken by optimized code may occasionally
6731 be surprising: some variables you declared may not exist
6732 at all; flow of control may briefly move where you did not expect it;
6733 some statements may not be executed because they compute constant
6734 results or their values are already at hand; some statements may
6735 execute in different places because they have been moved out of loops.
6736 Nevertheless it is possible to debug optimized output.  This makes
6737 it reasonable to use the optimizer for programs that might have bugs.
6739 If you are not using some other optimization option, consider
6740 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6741 With no @option{-O} option at all, some compiler passes that collect
6742 information useful for debugging do not run at all, so that
6743 @option{-Og} may result in a better debugging experience.
6745 @table @gcctabopt
6746 @item -g
6747 @opindex g
6748 Produce debugging information in the operating system's native format
6749 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6750 information.
6752 On most systems that use stabs format, @option{-g} enables use of extra
6753 debugging information that only GDB can use; this extra information
6754 makes debugging work better in GDB but probably makes other debuggers
6755 crash or
6756 refuse to read the program.  If you want to control for certain whether
6757 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6758 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6760 @item -ggdb
6761 @opindex ggdb
6762 Produce debugging information for use by GDB@.  This means to use the
6763 most expressive format available (DWARF, stabs, or the native format
6764 if neither of those are supported), including GDB extensions if at all
6765 possible.
6767 @item -gdwarf
6768 @itemx -gdwarf-@var{version}
6769 @opindex gdwarf
6770 Produce debugging information in DWARF format (if that is supported).
6771 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6772 for most targets is 4.  DWARF Version 5 is only experimental.
6774 Note that with DWARF Version 2, some ports require and always
6775 use some non-conflicting DWARF 3 extensions in the unwind tables.
6777 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6778 for maximum benefit.
6780 GCC no longer supports DWARF Version 1, which is substantially
6781 different than Version 2 and later.  For historical reasons, some
6782 other DWARF-related options (including @option{-feliminate-dwarf2-dups} 
6783 and @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6784 in their names, but apply to all currently-supported versions of DWARF.
6786 @item -gstabs
6787 @opindex gstabs
6788 Produce debugging information in stabs format (if that is supported),
6789 without GDB extensions.  This is the format used by DBX on most BSD
6790 systems.  On MIPS, Alpha and System V Release 4 systems this option
6791 produces stabs debugging output that is not understood by DBX or SDB@.
6792 On System V Release 4 systems this option requires the GNU assembler.
6794 @item -gstabs+
6795 @opindex gstabs+
6796 Produce debugging information in stabs format (if that is supported),
6797 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6798 use of these extensions is likely to make other debuggers crash or
6799 refuse to read the program.
6801 @item -gcoff
6802 @opindex gcoff
6803 Produce debugging information in COFF format (if that is supported).
6804 This is the format used by SDB on most System V systems prior to
6805 System V Release 4.
6807 @item -gxcoff
6808 @opindex gxcoff
6809 Produce debugging information in XCOFF format (if that is supported).
6810 This is the format used by the DBX debugger on IBM RS/6000 systems.
6812 @item -gxcoff+
6813 @opindex gxcoff+
6814 Produce debugging information in XCOFF format (if that is supported),
6815 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6816 use of these extensions is likely to make other debuggers crash or
6817 refuse to read the program, and may cause assemblers other than the GNU
6818 assembler (GAS) to fail with an error.
6820 @item -gvms
6821 @opindex gvms
6822 Produce debugging information in Alpha/VMS debug format (if that is
6823 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6825 @item -g@var{level}
6826 @itemx -ggdb@var{level}
6827 @itemx -gstabs@var{level}
6828 @itemx -gcoff@var{level}
6829 @itemx -gxcoff@var{level}
6830 @itemx -gvms@var{level}
6831 Request debugging information and also use @var{level} to specify how
6832 much information.  The default level is 2.
6834 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6835 @option{-g}.
6837 Level 1 produces minimal information, enough for making backtraces in
6838 parts of the program that you don't plan to debug.  This includes
6839 descriptions of functions and external variables, and line number
6840 tables, but no information about local variables.
6842 Level 3 includes extra information, such as all the macro definitions
6843 present in the program.  Some debuggers support macro expansion when
6844 you use @option{-g3}.
6846 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6847 confusion with @option{-gdwarf-@var{level}}.
6848 Instead use an additional @option{-g@var{level}} option to change the
6849 debug level for DWARF.
6851 @item -feliminate-unused-debug-symbols
6852 @opindex feliminate-unused-debug-symbols
6853 Produce debugging information in stabs format (if that is supported),
6854 for only symbols that are actually used.
6856 @item -femit-class-debug-always
6857 @opindex femit-class-debug-always
6858 Instead of emitting debugging information for a C++ class in only one
6859 object file, emit it in all object files using the class.  This option
6860 should be used only with debuggers that are unable to handle the way GCC
6861 normally emits debugging information for classes because using this
6862 option increases the size of debugging information by as much as a
6863 factor of two.
6865 @item -fno-merge-debug-strings
6866 @opindex fmerge-debug-strings
6867 @opindex fno-merge-debug-strings
6868 Direct the linker to not merge together strings in the debugging
6869 information that are identical in different object files.  Merging is
6870 not supported by all assemblers or linkers.  Merging decreases the size
6871 of the debug information in the output file at the cost of increasing
6872 link processing time.  Merging is enabled by default.
6874 @item -fdebug-prefix-map=@var{old}=@var{new}
6875 @opindex fdebug-prefix-map
6876 When compiling files in directory @file{@var{old}}, record debugging
6877 information describing them as in @file{@var{new}} instead.
6879 @item -fvar-tracking
6880 @opindex fvar-tracking
6881 Run variable tracking pass.  It computes where variables are stored at each
6882 position in code.  Better debugging information is then generated
6883 (if the debugging information format supports this information).
6885 It is enabled by default when compiling with optimization (@option{-Os},
6886 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6887 the debug info format supports it.
6889 @item -fvar-tracking-assignments
6890 @opindex fvar-tracking-assignments
6891 @opindex fno-var-tracking-assignments
6892 Annotate assignments to user variables early in the compilation and
6893 attempt to carry the annotations over throughout the compilation all the
6894 way to the end, in an attempt to improve debug information while
6895 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6897 It can be enabled even if var-tracking is disabled, in which case
6898 annotations are created and maintained, but discarded at the end.
6899 By default, this flag is enabled together with @option{-fvar-tracking},
6900 except when selective scheduling is enabled.
6902 @item -gsplit-dwarf
6903 @opindex gsplit-dwarf
6904 Separate as much DWARF debugging information as possible into a
6905 separate output file with the extension @file{.dwo}.  This option allows
6906 the build system to avoid linking files with debug information.  To
6907 be useful, this option requires a debugger capable of reading @file{.dwo}
6908 files.
6910 @item -gpubnames
6911 @opindex gpubnames
6912 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6914 @item -ggnu-pubnames
6915 @opindex ggnu-pubnames
6916 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6917 suitable for conversion into a GDB@ index.  This option is only useful
6918 with a linker that can produce GDB@ index version 7.
6920 @item -fdebug-types-section
6921 @opindex fdebug-types-section
6922 @opindex fno-debug-types-section
6923 When using DWARF Version 4 or higher, type DIEs can be put into
6924 their own @code{.debug_types} section instead of making them part of the
6925 @code{.debug_info} section.  It is more efficient to put them in a separate
6926 comdat sections since the linker can then remove duplicates.
6927 But not all DWARF consumers support @code{.debug_types} sections yet
6928 and on some objects @code{.debug_types} produces larger instead of smaller
6929 debugging information.
6931 @item -grecord-gcc-switches
6932 @item -gno-record-gcc-switches
6933 @opindex grecord-gcc-switches
6934 @opindex gno-record-gcc-switches
6935 This switch causes the command-line options used to invoke the
6936 compiler that may affect code generation to be appended to the
6937 DW_AT_producer attribute in DWARF debugging information.  The options
6938 are concatenated with spaces separating them from each other and from
6939 the compiler version.  
6940 It is enabled by default.
6941 See also @option{-frecord-gcc-switches} for another
6942 way of storing compiler options into the object file.  
6944 @item -gstrict-dwarf
6945 @opindex gstrict-dwarf
6946 Disallow using extensions of later DWARF standard version than selected
6947 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
6948 DWARF extensions from later standard versions is allowed.
6950 @item -gno-strict-dwarf
6951 @opindex gno-strict-dwarf
6952 Allow using extensions of later DWARF standard version than selected with
6953 @option{-gdwarf-@var{version}}.
6955 @item -gcolumn-info
6956 @item -gno-column-info
6957 @opindex gcolumn-info
6958 @opindex gno-column-info
6959 Emit location column information into DWARF debugging information, rather
6960 than just file and line.
6961 This option is disabled by default.
6963 @item -gz@r{[}=@var{type}@r{]}
6964 @opindex gz
6965 Produce compressed debug sections in DWARF format, if that is supported.
6966 If @var{type} is not given, the default type depends on the capabilities
6967 of the assembler and linker used.  @var{type} may be one of
6968 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
6969 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
6970 compression in traditional GNU format).  If the linker doesn't support
6971 writing compressed debug sections, the option is rejected.  Otherwise,
6972 if the assembler does not support them, @option{-gz} is silently ignored
6973 when producing object files.
6975 @item -feliminate-dwarf2-dups
6976 @opindex feliminate-dwarf2-dups
6977 Compress DWARF debugging information by eliminating duplicated
6978 information about each symbol.  This option only makes sense when
6979 generating DWARF debugging information.
6981 @item -femit-struct-debug-baseonly
6982 @opindex femit-struct-debug-baseonly
6983 Emit debug information for struct-like types
6984 only when the base name of the compilation source file
6985 matches the base name of file in which the struct is defined.
6987 This option substantially reduces the size of debugging information,
6988 but at significant potential loss in type information to the debugger.
6989 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6990 See @option{-femit-struct-debug-detailed} for more detailed control.
6992 This option works only with DWARF debug output.
6994 @item -femit-struct-debug-reduced
6995 @opindex femit-struct-debug-reduced
6996 Emit debug information for struct-like types
6997 only when the base name of the compilation source file
6998 matches the base name of file in which the type is defined,
6999 unless the struct is a template or defined in a system header.
7001 This option significantly reduces the size of debugging information,
7002 with some potential loss in type information to the debugger.
7003 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7004 See @option{-femit-struct-debug-detailed} for more detailed control.
7006 This option works only with DWARF debug output.
7008 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7009 @opindex femit-struct-debug-detailed
7010 Specify the struct-like types
7011 for which the compiler generates debug information.
7012 The intent is to reduce duplicate struct debug information
7013 between different object files within the same program.
7015 This option is a detailed version of
7016 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7017 which serves for most needs.
7019 A specification has the syntax@*
7020 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7022 The optional first word limits the specification to
7023 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7024 A struct type is used directly when it is the type of a variable, member.
7025 Indirect uses arise through pointers to structs.
7026 That is, when use of an incomplete struct is valid, the use is indirect.
7027 An example is
7028 @samp{struct one direct; struct two * indirect;}.
7030 The optional second word limits the specification to
7031 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7032 Generic structs are a bit complicated to explain.
7033 For C++, these are non-explicit specializations of template classes,
7034 or non-template classes within the above.
7035 Other programming languages have generics,
7036 but @option{-femit-struct-debug-detailed} does not yet implement them.
7038 The third word specifies the source files for those
7039 structs for which the compiler should emit debug information.
7040 The values @samp{none} and @samp{any} have the normal meaning.
7041 The value @samp{base} means that
7042 the base of name of the file in which the type declaration appears
7043 must match the base of the name of the main compilation file.
7044 In practice, this means that when compiling @file{foo.c}, debug information
7045 is generated for types declared in that file and @file{foo.h},
7046 but not other header files.
7047 The value @samp{sys} means those types satisfying @samp{base}
7048 or declared in system or compiler headers.
7050 You may need to experiment to determine the best settings for your application.
7052 The default is @option{-femit-struct-debug-detailed=all}.
7054 This option works only with DWARF debug output.
7056 @item -fno-dwarf2-cfi-asm
7057 @opindex fdwarf2-cfi-asm
7058 @opindex fno-dwarf2-cfi-asm
7059 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7060 instead of using GAS @code{.cfi_*} directives.
7062 @item -fno-eliminate-unused-debug-types
7063 @opindex feliminate-unused-debug-types
7064 @opindex fno-eliminate-unused-debug-types
7065 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7066 output for types that are nowhere used in the source file being compiled.
7067 Sometimes it is useful to have GCC emit debugging
7068 information for all types declared in a compilation
7069 unit, regardless of whether or not they are actually used
7070 in that compilation unit, for example 
7071 if, in the debugger, you want to cast a value to a type that is
7072 not actually used in your program (but is declared).  More often,
7073 however, this results in a significant amount of wasted space.
7074 @end table
7076 @node Optimize Options
7077 @section Options That Control Optimization
7078 @cindex optimize options
7079 @cindex options, optimization
7081 These options control various sorts of optimizations.
7083 Without any optimization option, the compiler's goal is to reduce the
7084 cost of compilation and to make debugging produce the expected
7085 results.  Statements are independent: if you stop the program with a
7086 breakpoint between statements, you can then assign a new value to any
7087 variable or change the program counter to any other statement in the
7088 function and get exactly the results you expect from the source
7089 code.
7091 Turning on optimization flags makes the compiler attempt to improve
7092 the performance and/or code size at the expense of compilation time
7093 and possibly the ability to debug the program.
7095 The compiler performs optimization based on the knowledge it has of the
7096 program.  Compiling multiple files at once to a single output file mode allows
7097 the compiler to use information gained from all of the files when compiling
7098 each of them.
7100 Not all optimizations are controlled directly by a flag.  Only
7101 optimizations that have a flag are listed in this section.
7103 Most optimizations are only enabled if an @option{-O} level is set on
7104 the command line.  Otherwise they are disabled, even if individual
7105 optimization flags are specified.
7107 Depending on the target and how GCC was configured, a slightly different
7108 set of optimizations may be enabled at each @option{-O} level than
7109 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7110 to find out the exact set of optimizations that are enabled at each level.
7111 @xref{Overall Options}, for examples.
7113 @table @gcctabopt
7114 @item -O
7115 @itemx -O1
7116 @opindex O
7117 @opindex O1
7118 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7119 more memory for a large function.
7121 With @option{-O}, the compiler tries to reduce code size and execution
7122 time, without performing any optimizations that take a great deal of
7123 compilation time.
7125 @option{-O} turns on the following optimization flags:
7126 @gccoptlist{
7127 -fauto-inc-dec @gol
7128 -fbranch-count-reg @gol
7129 -fcombine-stack-adjustments @gol
7130 -fcompare-elim @gol
7131 -fcprop-registers @gol
7132 -fdce @gol
7133 -fdefer-pop @gol
7134 -fdelayed-branch @gol
7135 -fdse @gol
7136 -fforward-propagate @gol
7137 -fguess-branch-probability @gol
7138 -fif-conversion2 @gol
7139 -fif-conversion @gol
7140 -finline-functions-called-once @gol
7141 -fipa-pure-const @gol
7142 -fipa-profile @gol
7143 -fipa-reference @gol
7144 -fmerge-constants @gol
7145 -fmove-loop-invariants @gol
7146 -freorder-blocks @gol
7147 -fshrink-wrap @gol
7148 -fshrink-wrap-separate @gol
7149 -fsplit-wide-types @gol
7150 -fssa-backprop @gol
7151 -fssa-phiopt @gol
7152 -ftree-bit-ccp @gol
7153 -ftree-ccp @gol
7154 -ftree-ch @gol
7155 -ftree-coalesce-vars @gol
7156 -ftree-copy-prop @gol
7157 -ftree-dce @gol
7158 -ftree-dominator-opts @gol
7159 -ftree-dse @gol
7160 -ftree-forwprop @gol
7161 -ftree-fre @gol
7162 -ftree-phiprop @gol
7163 -ftree-sink @gol
7164 -ftree-slsr @gol
7165 -ftree-sra @gol
7166 -ftree-pta @gol
7167 -ftree-ter @gol
7168 -funit-at-a-time}
7170 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7171 where doing so does not interfere with debugging.
7173 @item -O2
7174 @opindex O2
7175 Optimize even more.  GCC performs nearly all supported optimizations
7176 that do not involve a space-speed tradeoff.
7177 As compared to @option{-O}, this option increases both compilation time
7178 and the performance of the generated code.
7180 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7181 also turns on the following optimization flags:
7182 @gccoptlist{-fthread-jumps @gol
7183 -falign-functions  -falign-jumps @gol
7184 -falign-loops  -falign-labels @gol
7185 -fcaller-saves @gol
7186 -fcrossjumping @gol
7187 -fcse-follow-jumps  -fcse-skip-blocks @gol
7188 -fdelete-null-pointer-checks @gol
7189 -fdevirtualize -fdevirtualize-speculatively @gol
7190 -fexpensive-optimizations @gol
7191 -fgcse  -fgcse-lm  @gol
7192 -fhoist-adjacent-loads @gol
7193 -finline-small-functions @gol
7194 -findirect-inlining @gol
7195 -fipa-cp @gol
7196 -fipa-bit-cp @gol
7197 -fipa-vrp @gol
7198 -fipa-sra @gol
7199 -fipa-icf @gol
7200 -fisolate-erroneous-paths-dereference @gol
7201 -flra-remat @gol
7202 -foptimize-sibling-calls @gol
7203 -foptimize-strlen @gol
7204 -fpartial-inlining @gol
7205 -fpeephole2 @gol
7206 -freorder-blocks-algorithm=stc @gol
7207 -freorder-blocks-and-partition -freorder-functions @gol
7208 -frerun-cse-after-loop  @gol
7209 -fsched-interblock  -fsched-spec @gol
7210 -fschedule-insns  -fschedule-insns2 @gol
7211 -fstore-merging @gol
7212 -fstrict-aliasing @gol
7213 -ftree-builtin-call-dce @gol
7214 -ftree-switch-conversion -ftree-tail-merge @gol
7215 -fcode-hoisting @gol
7216 -ftree-pre @gol
7217 -ftree-vrp @gol
7218 -fipa-ra}
7220 Please note the warning under @option{-fgcse} about
7221 invoking @option{-O2} on programs that use computed gotos.
7223 @item -O3
7224 @opindex O3
7225 Optimize yet more.  @option{-O3} turns on all optimizations specified
7226 by @option{-O2} and also turns on the @option{-finline-functions},
7227 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7228 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7229 @option{-ftree-loop-distribute-patterns}, @option{-fsplit-paths}
7230 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7231 @option{-ftree-partial-pre}, @option{-fpeel-loops}
7232 and @option{-fipa-cp-clone} options.
7234 @item -O0
7235 @opindex O0
7236 Reduce compilation time and make debugging produce the expected
7237 results.  This is the default.
7239 @item -Os
7240 @opindex Os
7241 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7242 do not typically increase code size.  It also performs further
7243 optimizations designed to reduce code size.
7245 @option{-Os} disables the following optimization flags:
7246 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7247 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7248 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7250 @item -Ofast
7251 @opindex Ofast
7252 Disregard strict standards compliance.  @option{-Ofast} enables all
7253 @option{-O3} optimizations.  It also enables optimizations that are not
7254 valid for all standard-compliant programs.
7255 It turns on @option{-ffast-math} and the Fortran-specific
7256 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7258 @item -Og
7259 @opindex Og
7260 Optimize debugging experience.  @option{-Og} enables optimizations
7261 that do not interfere with debugging. It should be the optimization
7262 level of choice for the standard edit-compile-debug cycle, offering
7263 a reasonable level of optimization while maintaining fast compilation
7264 and a good debugging experience.
7265 @end table
7267 If you use multiple @option{-O} options, with or without level numbers,
7268 the last such option is the one that is effective.
7270 Options of the form @option{-f@var{flag}} specify machine-independent
7271 flags.  Most flags have both positive and negative forms; the negative
7272 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7273 below, only one of the forms is listed---the one you typically 
7274 use.  You can figure out the other form by either removing @samp{no-}
7275 or adding it.
7277 The following options control specific optimizations.  They are either
7278 activated by @option{-O} options or are related to ones that are.  You
7279 can use the following flags in the rare cases when ``fine-tuning'' of
7280 optimizations to be performed is desired.
7282 @table @gcctabopt
7283 @item -fno-defer-pop
7284 @opindex fno-defer-pop
7285 Always pop the arguments to each function call as soon as that function
7286 returns.  For machines that must pop arguments after a function call,
7287 the compiler normally lets arguments accumulate on the stack for several
7288 function calls and pops them all at once.
7290 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7292 @item -fforward-propagate
7293 @opindex fforward-propagate
7294 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7295 instructions and checks if the result can be simplified.  If loop unrolling
7296 is active, two passes are performed and the second is scheduled after
7297 loop unrolling.
7299 This option is enabled by default at optimization levels @option{-O},
7300 @option{-O2}, @option{-O3}, @option{-Os}.
7302 @item -ffp-contract=@var{style}
7303 @opindex ffp-contract
7304 @option{-ffp-contract=off} disables floating-point expression contraction.
7305 @option{-ffp-contract=fast} enables floating-point expression contraction
7306 such as forming of fused multiply-add operations if the target has
7307 native support for them.
7308 @option{-ffp-contract=on} enables floating-point expression contraction
7309 if allowed by the language standard.  This is currently not implemented
7310 and treated equal to @option{-ffp-contract=off}.
7312 The default is @option{-ffp-contract=fast}.
7314 @item -fomit-frame-pointer
7315 @opindex fomit-frame-pointer
7316 Don't keep the frame pointer in a register for functions that
7317 don't need one.  This avoids the instructions to save, set up and
7318 restore frame pointers; it also makes an extra register available
7319 in many functions.  @strong{It also makes debugging impossible on
7320 some machines.}
7322 On some machines, such as the VAX, this flag has no effect, because
7323 the standard calling sequence automatically handles the frame pointer
7324 and nothing is saved by pretending it doesn't exist.  The
7325 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7326 whether a target machine supports this flag.  @xref{Registers,,Register
7327 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7329 The default setting (when not optimizing for
7330 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7331 @option{-fomit-frame-pointer}.  You can configure GCC with the
7332 @option{--enable-frame-pointer} configure option to change the default.
7334 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7336 @item -foptimize-sibling-calls
7337 @opindex foptimize-sibling-calls
7338 Optimize sibling and tail recursive calls.
7340 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7342 @item -foptimize-strlen
7343 @opindex foptimize-strlen
7344 Optimize various standard C string functions (e.g. @code{strlen},
7345 @code{strchr} or @code{strcpy}) and
7346 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7348 Enabled at levels @option{-O2}, @option{-O3}.
7350 @item -fno-inline
7351 @opindex fno-inline
7352 Do not expand any functions inline apart from those marked with
7353 the @code{always_inline} attribute.  This is the default when not
7354 optimizing.
7356 Single functions can be exempted from inlining by marking them
7357 with the @code{noinline} attribute.
7359 @item -finline-small-functions
7360 @opindex finline-small-functions
7361 Integrate functions into their callers when their body is smaller than expected
7362 function call code (so overall size of program gets smaller).  The compiler
7363 heuristically decides which functions are simple enough to be worth integrating
7364 in this way.  This inlining applies to all functions, even those not declared
7365 inline.
7367 Enabled at level @option{-O2}.
7369 @item -findirect-inlining
7370 @opindex findirect-inlining
7371 Inline also indirect calls that are discovered to be known at compile
7372 time thanks to previous inlining.  This option has any effect only
7373 when inlining itself is turned on by the @option{-finline-functions}
7374 or @option{-finline-small-functions} options.
7376 Enabled at level @option{-O2}.
7378 @item -finline-functions
7379 @opindex finline-functions
7380 Consider all functions for inlining, even if they are not declared inline.
7381 The compiler heuristically decides which functions are worth integrating
7382 in this way.
7384 If all calls to a given function are integrated, and the function is
7385 declared @code{static}, then the function is normally not output as
7386 assembler code in its own right.
7388 Enabled at level @option{-O3}.
7390 @item -finline-functions-called-once
7391 @opindex finline-functions-called-once
7392 Consider all @code{static} functions called once for inlining into their
7393 caller even if they are not marked @code{inline}.  If a call to a given
7394 function is integrated, then the function is not output as assembler code
7395 in its own right.
7397 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7399 @item -fearly-inlining
7400 @opindex fearly-inlining
7401 Inline functions marked by @code{always_inline} and functions whose body seems
7402 smaller than the function call overhead early before doing
7403 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7404 makes profiling significantly cheaper and usually inlining faster on programs
7405 having large chains of nested wrapper functions.
7407 Enabled by default.
7409 @item -fipa-sra
7410 @opindex fipa-sra
7411 Perform interprocedural scalar replacement of aggregates, removal of
7412 unused parameters and replacement of parameters passed by reference
7413 by parameters passed by value.
7415 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7417 @item -finline-limit=@var{n}
7418 @opindex finline-limit
7419 By default, GCC limits the size of functions that can be inlined.  This flag
7420 allows coarse control of this limit.  @var{n} is the size of functions that
7421 can be inlined in number of pseudo instructions.
7423 Inlining is actually controlled by a number of parameters, which may be
7424 specified individually by using @option{--param @var{name}=@var{value}}.
7425 The @option{-finline-limit=@var{n}} option sets some of these parameters
7426 as follows:
7428 @table @gcctabopt
7429 @item max-inline-insns-single
7430 is set to @var{n}/2.
7431 @item max-inline-insns-auto
7432 is set to @var{n}/2.
7433 @end table
7435 See below for a documentation of the individual
7436 parameters controlling inlining and for the defaults of these parameters.
7438 @emph{Note:} there may be no value to @option{-finline-limit} that results
7439 in default behavior.
7441 @emph{Note:} pseudo instruction represents, in this particular context, an
7442 abstract measurement of function's size.  In no way does it represent a count
7443 of assembly instructions and as such its exact meaning might change from one
7444 release to an another.
7446 @item -fno-keep-inline-dllexport
7447 @opindex fno-keep-inline-dllexport
7448 This is a more fine-grained version of @option{-fkeep-inline-functions},
7449 which applies only to functions that are declared using the @code{dllexport}
7450 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7451 Functions}.
7453 @item -fkeep-inline-functions
7454 @opindex fkeep-inline-functions
7455 In C, emit @code{static} functions that are declared @code{inline}
7456 into the object file, even if the function has been inlined into all
7457 of its callers.  This switch does not affect functions using the
7458 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7459 inline functions into the object file.
7461 @item -fkeep-static-functions
7462 @opindex fkeep-static-functions
7463 Emit @code{static} functions into the object file, even if the function
7464 is never used.
7466 @item -fkeep-static-consts
7467 @opindex fkeep-static-consts
7468 Emit variables declared @code{static const} when optimization isn't turned
7469 on, even if the variables aren't referenced.
7471 GCC enables this option by default.  If you want to force the compiler to
7472 check if a variable is referenced, regardless of whether or not
7473 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7475 @item -fmerge-constants
7476 @opindex fmerge-constants
7477 Attempt to merge identical constants (string constants and floating-point
7478 constants) across compilation units.
7480 This option is the default for optimized compilation if the assembler and
7481 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7482 behavior.
7484 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7486 @item -fmerge-all-constants
7487 @opindex fmerge-all-constants
7488 Attempt to merge identical constants and identical variables.
7490 This option implies @option{-fmerge-constants}.  In addition to
7491 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7492 arrays or initialized constant variables with integral or floating-point
7493 types.  Languages like C or C++ require each variable, including multiple
7494 instances of the same variable in recursive calls, to have distinct locations,
7495 so using this option results in non-conforming
7496 behavior.
7498 @item -fmodulo-sched
7499 @opindex fmodulo-sched
7500 Perform swing modulo scheduling immediately before the first scheduling
7501 pass.  This pass looks at innermost loops and reorders their
7502 instructions by overlapping different iterations.
7504 @item -fmodulo-sched-allow-regmoves
7505 @opindex fmodulo-sched-allow-regmoves
7506 Perform more aggressive SMS-based modulo scheduling with register moves
7507 allowed.  By setting this flag certain anti-dependences edges are
7508 deleted, which triggers the generation of reg-moves based on the
7509 life-range analysis.  This option is effective only with
7510 @option{-fmodulo-sched} enabled.
7512 @item -fno-branch-count-reg
7513 @opindex fno-branch-count-reg
7514 Avoid running a pass scanning for opportunities to use ``decrement and
7515 branch'' instructions on a count register instead of generating sequences
7516 of instructions that decrement a register, compare it against zero, and
7517 then branch based upon the result.  This option is only meaningful on
7518 architectures that support such instructions, which include x86, PowerPC,
7519 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7520 doesn't remove the decrement and branch instructions from the generated
7521 instruction stream introduced by other optimization passes.
7523 Enabled by default at @option{-O1} and higher.
7525 The default is @option{-fbranch-count-reg}.
7527 @item -fno-function-cse
7528 @opindex fno-function-cse
7529 Do not put function addresses in registers; make each instruction that
7530 calls a constant function contain the function's address explicitly.
7532 This option results in less efficient code, but some strange hacks
7533 that alter the assembler output may be confused by the optimizations
7534 performed when this option is not used.
7536 The default is @option{-ffunction-cse}
7538 @item -fno-zero-initialized-in-bss
7539 @opindex fno-zero-initialized-in-bss
7540 If the target supports a BSS section, GCC by default puts variables that
7541 are initialized to zero into BSS@.  This can save space in the resulting
7542 code.
7544 This option turns off this behavior because some programs explicitly
7545 rely on variables going to the data section---e.g., so that the
7546 resulting executable can find the beginning of that section and/or make
7547 assumptions based on that.
7549 The default is @option{-fzero-initialized-in-bss}.
7551 @item -fthread-jumps
7552 @opindex fthread-jumps
7553 Perform optimizations that check to see if a jump branches to a
7554 location where another comparison subsumed by the first is found.  If
7555 so, the first branch is redirected to either the destination of the
7556 second branch or a point immediately following it, depending on whether
7557 the condition is known to be true or false.
7559 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7561 @item -fsplit-wide-types
7562 @opindex fsplit-wide-types
7563 When using a type that occupies multiple registers, such as @code{long
7564 long} on a 32-bit system, split the registers apart and allocate them
7565 independently.  This normally generates better code for those types,
7566 but may make debugging more difficult.
7568 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7569 @option{-Os}.
7571 @item -fcse-follow-jumps
7572 @opindex fcse-follow-jumps
7573 In common subexpression elimination (CSE), scan through jump instructions
7574 when the target of the jump is not reached by any other path.  For
7575 example, when CSE encounters an @code{if} statement with an
7576 @code{else} clause, CSE follows the jump when the condition
7577 tested is false.
7579 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7581 @item -fcse-skip-blocks
7582 @opindex fcse-skip-blocks
7583 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7584 follow jumps that conditionally skip over blocks.  When CSE
7585 encounters a simple @code{if} statement with no else clause,
7586 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7587 body of the @code{if}.
7589 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7591 @item -frerun-cse-after-loop
7592 @opindex frerun-cse-after-loop
7593 Re-run common subexpression elimination after loop optimizations are
7594 performed.
7596 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7598 @item -fgcse
7599 @opindex fgcse
7600 Perform a global common subexpression elimination pass.
7601 This pass also performs global constant and copy propagation.
7603 @emph{Note:} When compiling a program using computed gotos, a GCC
7604 extension, you may get better run-time performance if you disable
7605 the global common subexpression elimination pass by adding
7606 @option{-fno-gcse} to the command line.
7608 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7610 @item -fgcse-lm
7611 @opindex fgcse-lm
7612 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7613 attempts to move loads that are only killed by stores into themselves.  This
7614 allows a loop containing a load/store sequence to be changed to a load outside
7615 the loop, and a copy/store within the loop.
7617 Enabled by default when @option{-fgcse} is enabled.
7619 @item -fgcse-sm
7620 @opindex fgcse-sm
7621 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7622 global common subexpression elimination.  This pass attempts to move
7623 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7624 loops containing a load/store sequence can be changed to a load before
7625 the loop and a store after the loop.
7627 Not enabled at any optimization level.
7629 @item -fgcse-las
7630 @opindex fgcse-las
7631 When @option{-fgcse-las} is enabled, the global common subexpression
7632 elimination pass eliminates redundant loads that come after stores to the
7633 same memory location (both partial and full redundancies).
7635 Not enabled at any optimization level.
7637 @item -fgcse-after-reload
7638 @opindex fgcse-after-reload
7639 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7640 pass is performed after reload.  The purpose of this pass is to clean up
7641 redundant spilling.
7643 @item -faggressive-loop-optimizations
7644 @opindex faggressive-loop-optimizations
7645 This option tells the loop optimizer to use language constraints to
7646 derive bounds for the number of iterations of a loop.  This assumes that
7647 loop code does not invoke undefined behavior by for example causing signed
7648 integer overflows or out-of-bound array accesses.  The bounds for the
7649 number of iterations of a loop are used to guide loop unrolling and peeling
7650 and loop exit test optimizations.
7651 This option is enabled by default.
7653 @item -funconstrained-commons
7654 @opindex funconstrained-commons
7655 This option tells the compiler that variables declared in common blocks
7656 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7657 prevents certain optimizations that depend on knowing the array bounds.
7659 @item -fcrossjumping
7660 @opindex fcrossjumping
7661 Perform cross-jumping transformation.
7662 This transformation unifies equivalent code and saves code size.  The
7663 resulting code may or may not perform better than without cross-jumping.
7665 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7667 @item -fauto-inc-dec
7668 @opindex fauto-inc-dec
7669 Combine increments or decrements of addresses with memory accesses.
7670 This pass is always skipped on architectures that do not have
7671 instructions to support this.  Enabled by default at @option{-O} and
7672 higher on architectures that support this.
7674 @item -fdce
7675 @opindex fdce
7676 Perform dead code elimination (DCE) on RTL@.
7677 Enabled by default at @option{-O} and higher.
7679 @item -fdse
7680 @opindex fdse
7681 Perform dead store elimination (DSE) on RTL@.
7682 Enabled by default at @option{-O} and higher.
7684 @item -fif-conversion
7685 @opindex fif-conversion
7686 Attempt to transform conditional jumps into branch-less equivalents.  This
7687 includes use of conditional moves, min, max, set flags and abs instructions, and
7688 some tricks doable by standard arithmetics.  The use of conditional execution
7689 on chips where it is available is controlled by @option{-fif-conversion2}.
7691 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7693 @item -fif-conversion2
7694 @opindex fif-conversion2
7695 Use conditional execution (where available) to transform conditional jumps into
7696 branch-less equivalents.
7698 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7700 @item -fdeclone-ctor-dtor
7701 @opindex fdeclone-ctor-dtor
7702 The C++ ABI requires multiple entry points for constructors and
7703 destructors: one for a base subobject, one for a complete object, and
7704 one for a virtual destructor that calls operator delete afterwards.
7705 For a hierarchy with virtual bases, the base and complete variants are
7706 clones, which means two copies of the function.  With this option, the
7707 base and complete variants are changed to be thunks that call a common
7708 implementation.
7710 Enabled by @option{-Os}.
7712 @item -fdelete-null-pointer-checks
7713 @opindex fdelete-null-pointer-checks
7714 Assume that programs cannot safely dereference null pointers, and that
7715 no code or data element resides at address zero.
7716 This option enables simple constant
7717 folding optimizations at all optimization levels.  In addition, other
7718 optimization passes in GCC use this flag to control global dataflow
7719 analyses that eliminate useless checks for null pointers; these assume
7720 that a memory access to address zero always results in a trap, so
7721 that if a pointer is checked after it has already been dereferenced,
7722 it cannot be null.
7724 Note however that in some environments this assumption is not true.
7725 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7726 for programs that depend on that behavior.
7728 This option is enabled by default on most targets.  On Nios II ELF, it
7729 defaults to off.  On AVR and CR16, this option is completely disabled.  
7731 Passes that use the dataflow information
7732 are enabled independently at different optimization levels.
7734 @item -fdevirtualize
7735 @opindex fdevirtualize
7736 Attempt to convert calls to virtual functions to direct calls.  This
7737 is done both within a procedure and interprocedurally as part of
7738 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7739 propagation (@option{-fipa-cp}).
7740 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7742 @item -fdevirtualize-speculatively
7743 @opindex fdevirtualize-speculatively
7744 Attempt to convert calls to virtual functions to speculative direct calls.
7745 Based on the analysis of the type inheritance graph, determine for a given call
7746 the set of likely targets. If the set is small, preferably of size 1, change
7747 the call into a conditional deciding between direct and indirect calls.  The
7748 speculative calls enable more optimizations, such as inlining.  When they seem
7749 useless after further optimization, they are converted back into original form.
7751 @item -fdevirtualize-at-ltrans
7752 @opindex fdevirtualize-at-ltrans
7753 Stream extra information needed for aggressive devirtualization when running
7754 the link-time optimizer in local transformation mode.  
7755 This option enables more devirtualization but
7756 significantly increases the size of streamed data. For this reason it is
7757 disabled by default.
7759 @item -fexpensive-optimizations
7760 @opindex fexpensive-optimizations
7761 Perform a number of minor optimizations that are relatively expensive.
7763 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7765 @item -free
7766 @opindex free
7767 Attempt to remove redundant extension instructions.  This is especially
7768 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7769 registers after writing to their lower 32-bit half.
7771 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7772 @option{-O3}, @option{-Os}.
7774 @item -fno-lifetime-dse
7775 @opindex fno-lifetime-dse
7776 In C++ the value of an object is only affected by changes within its
7777 lifetime: when the constructor begins, the object has an indeterminate
7778 value, and any changes during the lifetime of the object are dead when
7779 the object is destroyed.  Normally dead store elimination will take
7780 advantage of this; if your code relies on the value of the object
7781 storage persisting beyond the lifetime of the object, you can use this
7782 flag to disable this optimization.  To preserve stores before the
7783 constructor starts (e.g. because your operator new clears the object
7784 storage) but still treat the object as dead after the destructor you,
7785 can use @option{-flifetime-dse=1}.  The default behavior can be
7786 explicitly selected with @option{-flifetime-dse=2}.
7787 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7789 @item -flive-range-shrinkage
7790 @opindex flive-range-shrinkage
7791 Attempt to decrease register pressure through register live range
7792 shrinkage.  This is helpful for fast processors with small or moderate
7793 size register sets.
7795 @item -fira-algorithm=@var{algorithm}
7796 @opindex fira-algorithm
7797 Use the specified coloring algorithm for the integrated register
7798 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7799 specifies Chow's priority coloring, or @samp{CB}, which specifies
7800 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7801 for all architectures, but for those targets that do support it, it is
7802 the default because it generates better code.
7804 @item -fira-region=@var{region}
7805 @opindex fira-region
7806 Use specified regions for the integrated register allocator.  The
7807 @var{region} argument should be one of the following:
7809 @table @samp
7811 @item all
7812 Use all loops as register allocation regions.
7813 This can give the best results for machines with a small and/or
7814 irregular register set.
7816 @item mixed
7817 Use all loops except for loops with small register pressure 
7818 as the regions.  This value usually gives
7819 the best results in most cases and for most architectures,
7820 and is enabled by default when compiling with optimization for speed
7821 (@option{-O}, @option{-O2}, @dots{}).
7823 @item one
7824 Use all functions as a single region.  
7825 This typically results in the smallest code size, and is enabled by default for
7826 @option{-Os} or @option{-O0}.
7828 @end table
7830 @item -fira-hoist-pressure
7831 @opindex fira-hoist-pressure
7832 Use IRA to evaluate register pressure in the code hoisting pass for
7833 decisions to hoist expressions.  This option usually results in smaller
7834 code, but it can slow the compiler down.
7836 This option is enabled at level @option{-Os} for all targets.
7838 @item -fira-loop-pressure
7839 @opindex fira-loop-pressure
7840 Use IRA to evaluate register pressure in loops for decisions to move
7841 loop invariants.  This option usually results in generation
7842 of faster and smaller code on machines with large register files (>= 32
7843 registers), but it can slow the compiler down.
7845 This option is enabled at level @option{-O3} for some targets.
7847 @item -fno-ira-share-save-slots
7848 @opindex fno-ira-share-save-slots
7849 Disable sharing of stack slots used for saving call-used hard
7850 registers living through a call.  Each hard register gets a
7851 separate stack slot, and as a result function stack frames are
7852 larger.
7854 @item -fno-ira-share-spill-slots
7855 @opindex fno-ira-share-spill-slots
7856 Disable sharing of stack slots allocated for pseudo-registers.  Each
7857 pseudo-register that does not get a hard register gets a separate
7858 stack slot, and as a result function stack frames are larger.
7860 @item -flra-remat
7861 @opindex flra-remat
7862 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7863 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7864 values if it is profitable.
7866 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7868 @item -fdelayed-branch
7869 @opindex fdelayed-branch
7870 If supported for the target machine, attempt to reorder instructions
7871 to exploit instruction slots available after delayed branch
7872 instructions.
7874 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7876 @item -fschedule-insns
7877 @opindex fschedule-insns
7878 If supported for the target machine, attempt to reorder instructions to
7879 eliminate execution stalls due to required data being unavailable.  This
7880 helps machines that have slow floating point or memory load instructions
7881 by allowing other instructions to be issued until the result of the load
7882 or floating-point instruction is required.
7884 Enabled at levels @option{-O2}, @option{-O3}.
7886 @item -fschedule-insns2
7887 @opindex fschedule-insns2
7888 Similar to @option{-fschedule-insns}, but requests an additional pass of
7889 instruction scheduling after register allocation has been done.  This is
7890 especially useful on machines with a relatively small number of
7891 registers and where memory load instructions take more than one cycle.
7893 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7895 @item -fno-sched-interblock
7896 @opindex fno-sched-interblock
7897 Don't schedule instructions across basic blocks.  This is normally
7898 enabled by default when scheduling before register allocation, i.e.@:
7899 with @option{-fschedule-insns} or at @option{-O2} or higher.
7901 @item -fno-sched-spec
7902 @opindex fno-sched-spec
7903 Don't allow speculative motion of non-load instructions.  This is normally
7904 enabled by default when scheduling before register allocation, i.e.@:
7905 with @option{-fschedule-insns} or at @option{-O2} or higher.
7907 @item -fsched-pressure
7908 @opindex fsched-pressure
7909 Enable register pressure sensitive insn scheduling before register
7910 allocation.  This only makes sense when scheduling before register
7911 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7912 @option{-O2} or higher.  Usage of this option can improve the
7913 generated code and decrease its size by preventing register pressure
7914 increase above the number of available hard registers and subsequent
7915 spills in register allocation.
7917 @item -fsched-spec-load
7918 @opindex fsched-spec-load
7919 Allow speculative motion of some load instructions.  This only makes
7920 sense when scheduling before register allocation, i.e.@: with
7921 @option{-fschedule-insns} or at @option{-O2} or higher.
7923 @item -fsched-spec-load-dangerous
7924 @opindex fsched-spec-load-dangerous
7925 Allow speculative motion of more load instructions.  This only makes
7926 sense when scheduling before register allocation, i.e.@: with
7927 @option{-fschedule-insns} or at @option{-O2} or higher.
7929 @item -fsched-stalled-insns
7930 @itemx -fsched-stalled-insns=@var{n}
7931 @opindex fsched-stalled-insns
7932 Define how many insns (if any) can be moved prematurely from the queue
7933 of stalled insns into the ready list during the second scheduling pass.
7934 @option{-fno-sched-stalled-insns} means that no insns are moved
7935 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7936 on how many queued insns can be moved prematurely.
7937 @option{-fsched-stalled-insns} without a value is equivalent to
7938 @option{-fsched-stalled-insns=1}.
7940 @item -fsched-stalled-insns-dep
7941 @itemx -fsched-stalled-insns-dep=@var{n}
7942 @opindex fsched-stalled-insns-dep
7943 Define how many insn groups (cycles) are examined for a dependency
7944 on a stalled insn that is a candidate for premature removal from the queue
7945 of stalled insns.  This has an effect only during the second scheduling pass,
7946 and only if @option{-fsched-stalled-insns} is used.
7947 @option{-fno-sched-stalled-insns-dep} is equivalent to
7948 @option{-fsched-stalled-insns-dep=0}.
7949 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7950 @option{-fsched-stalled-insns-dep=1}.
7952 @item -fsched2-use-superblocks
7953 @opindex fsched2-use-superblocks
7954 When scheduling after register allocation, use superblock scheduling.
7955 This allows motion across basic block boundaries,
7956 resulting in faster schedules.  This option is experimental, as not all machine
7957 descriptions used by GCC model the CPU closely enough to avoid unreliable
7958 results from the algorithm.
7960 This only makes sense when scheduling after register allocation, i.e.@: with
7961 @option{-fschedule-insns2} or at @option{-O2} or higher.
7963 @item -fsched-group-heuristic
7964 @opindex fsched-group-heuristic
7965 Enable the group heuristic in the scheduler.  This heuristic favors
7966 the instruction that belongs to a schedule group.  This is enabled
7967 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7968 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7970 @item -fsched-critical-path-heuristic
7971 @opindex fsched-critical-path-heuristic
7972 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7973 instructions on the critical path.  This is enabled by default when
7974 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7975 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7977 @item -fsched-spec-insn-heuristic
7978 @opindex fsched-spec-insn-heuristic
7979 Enable the speculative instruction heuristic in the scheduler.  This
7980 heuristic favors speculative instructions with greater dependency weakness.
7981 This is enabled by default when scheduling is enabled, i.e.@:
7982 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7983 or at @option{-O2} or higher.
7985 @item -fsched-rank-heuristic
7986 @opindex fsched-rank-heuristic
7987 Enable the rank heuristic in the scheduler.  This heuristic favors
7988 the instruction belonging to a basic block with greater size or frequency.
7989 This is enabled by default when scheduling is enabled, i.e.@:
7990 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7991 at @option{-O2} or higher.
7993 @item -fsched-last-insn-heuristic
7994 @opindex fsched-last-insn-heuristic
7995 Enable the last-instruction heuristic in the scheduler.  This heuristic
7996 favors the instruction that is less dependent on the last instruction
7997 scheduled.  This is enabled by default when scheduling is enabled,
7998 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7999 at @option{-O2} or higher.
8001 @item -fsched-dep-count-heuristic
8002 @opindex fsched-dep-count-heuristic
8003 Enable the dependent-count heuristic in the scheduler.  This heuristic
8004 favors the instruction that has more instructions depending on it.
8005 This is enabled by default when scheduling is enabled, i.e.@:
8006 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8007 at @option{-O2} or higher.
8009 @item -freschedule-modulo-scheduled-loops
8010 @opindex freschedule-modulo-scheduled-loops
8011 Modulo scheduling is performed before traditional scheduling.  If a loop
8012 is modulo scheduled, later scheduling passes may change its schedule.  
8013 Use this option to control that behavior.
8015 @item -fselective-scheduling
8016 @opindex fselective-scheduling
8017 Schedule instructions using selective scheduling algorithm.  Selective
8018 scheduling runs instead of the first scheduler pass.
8020 @item -fselective-scheduling2
8021 @opindex fselective-scheduling2
8022 Schedule instructions using selective scheduling algorithm.  Selective
8023 scheduling runs instead of the second scheduler pass.
8025 @item -fsel-sched-pipelining
8026 @opindex fsel-sched-pipelining
8027 Enable software pipelining of innermost loops during selective scheduling.
8028 This option has no effect unless one of @option{-fselective-scheduling} or
8029 @option{-fselective-scheduling2} is turned on.
8031 @item -fsel-sched-pipelining-outer-loops
8032 @opindex fsel-sched-pipelining-outer-loops
8033 When pipelining loops during selective scheduling, also pipeline outer loops.
8034 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8036 @item -fsemantic-interposition
8037 @opindex fsemantic-interposition
8038 Some object formats, like ELF, allow interposing of symbols by the 
8039 dynamic linker.
8040 This means that for symbols exported from the DSO, the compiler cannot perform
8041 interprocedural propagation, inlining and other optimizations in anticipation
8042 that the function or variable in question may change. While this feature is
8043 useful, for example, to rewrite memory allocation functions by a debugging
8044 implementation, it is expensive in the terms of code quality.
8045 With @option{-fno-semantic-interposition} the compiler assumes that 
8046 if interposition happens for functions the overwriting function will have 
8047 precisely the same semantics (and side effects). 
8048 Similarly if interposition happens
8049 for variables, the constructor of the variable will be the same. The flag
8050 has no effect for functions explicitly declared inline 
8051 (where it is never allowed for interposition to change semantics) 
8052 and for symbols explicitly declared weak.
8054 @item -fshrink-wrap
8055 @opindex fshrink-wrap
8056 Emit function prologues only before parts of the function that need it,
8057 rather than at the top of the function.  This flag is enabled by default at
8058 @option{-O} and higher.
8060 @item -fshrink-wrap-separate
8061 @opindex fshrink-wrap-separate
8062 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8063 those parts are only executed when needed.
8064 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8065 is also turned on and the target supports this.
8067 @item -fcaller-saves
8068 @opindex fcaller-saves
8069 Enable allocation of values to registers that are clobbered by
8070 function calls, by emitting extra instructions to save and restore the
8071 registers around such calls.  Such allocation is done only when it
8072 seems to result in better code.
8074 This option is always enabled by default on certain machines, usually
8075 those which have no call-preserved registers to use instead.
8077 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8079 @item -fcombine-stack-adjustments
8080 @opindex fcombine-stack-adjustments
8081 Tracks stack adjustments (pushes and pops) and stack memory references
8082 and then tries to find ways to combine them.
8084 Enabled by default at @option{-O1} and higher.
8086 @item -fipa-ra
8087 @opindex fipa-ra
8088 Use caller save registers for allocation if those registers are not used by
8089 any called function.  In that case it is not necessary to save and restore
8090 them around calls.  This is only possible if called functions are part of
8091 same compilation unit as current function and they are compiled before it.
8093 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8094 is disabled if generated code will be instrumented for profiling
8095 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8096 exactly (this happens on targets that do not expose prologues
8097 and epilogues in RTL).
8099 @item -fconserve-stack
8100 @opindex fconserve-stack
8101 Attempt to minimize stack usage.  The compiler attempts to use less
8102 stack space, even if that makes the program slower.  This option
8103 implies setting the @option{large-stack-frame} parameter to 100
8104 and the @option{large-stack-frame-growth} parameter to 400.
8106 @item -ftree-reassoc
8107 @opindex ftree-reassoc
8108 Perform reassociation on trees.  This flag is enabled by default
8109 at @option{-O} and higher.
8111 @item -fcode-hoisting
8112 @opindex fcode-hoisting
8113 Perform code hoisting.  Code hoisting tries to move the
8114 evaluation of expressions executed on all paths to the function exit
8115 as early as possible.  This is especially useful as a code size
8116 optimization, but it often helps for code speed as well.
8117 This flag is enabled by default at @option{-O2} and higher.
8119 @item -ftree-pre
8120 @opindex ftree-pre
8121 Perform partial redundancy elimination (PRE) on trees.  This flag is
8122 enabled by default at @option{-O2} and @option{-O3}.
8124 @item -ftree-partial-pre
8125 @opindex ftree-partial-pre
8126 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8127 enabled by default at @option{-O3}.
8129 @item -ftree-forwprop
8130 @opindex ftree-forwprop
8131 Perform forward propagation on trees.  This flag is enabled by default
8132 at @option{-O} and higher.
8134 @item -ftree-fre
8135 @opindex ftree-fre
8136 Perform full redundancy elimination (FRE) on trees.  The difference
8137 between FRE and PRE is that FRE only considers expressions
8138 that are computed on all paths leading to the redundant computation.
8139 This analysis is faster than PRE, though it exposes fewer redundancies.
8140 This flag is enabled by default at @option{-O} and higher.
8142 @item -ftree-phiprop
8143 @opindex ftree-phiprop
8144 Perform hoisting of loads from conditional pointers on trees.  This
8145 pass is enabled by default at @option{-O} and higher.
8147 @item -fhoist-adjacent-loads
8148 @opindex fhoist-adjacent-loads
8149 Speculatively hoist loads from both branches of an if-then-else if the
8150 loads are from adjacent locations in the same structure and the target
8151 architecture has a conditional move instruction.  This flag is enabled
8152 by default at @option{-O2} and higher.
8154 @item -ftree-copy-prop
8155 @opindex ftree-copy-prop
8156 Perform copy propagation on trees.  This pass eliminates unnecessary
8157 copy operations.  This flag is enabled by default at @option{-O} and
8158 higher.
8160 @item -fipa-pure-const
8161 @opindex fipa-pure-const
8162 Discover which functions are pure or constant.
8163 Enabled by default at @option{-O} and higher.
8165 @item -fipa-reference
8166 @opindex fipa-reference
8167 Discover which static variables do not escape the
8168 compilation unit.
8169 Enabled by default at @option{-O} and higher.
8171 @item -fipa-pta
8172 @opindex fipa-pta
8173 Perform interprocedural pointer analysis and interprocedural modification
8174 and reference analysis.  This option can cause excessive memory and
8175 compile-time usage on large compilation units.  It is not enabled by
8176 default at any optimization level.
8178 @item -fipa-profile
8179 @opindex fipa-profile
8180 Perform interprocedural profile propagation.  The functions called only from
8181 cold functions are marked as cold. Also functions executed once (such as
8182 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8183 functions and loop less parts of functions executed once are then optimized for
8184 size.
8185 Enabled by default at @option{-O} and higher.
8187 @item -fipa-cp
8188 @opindex fipa-cp
8189 Perform interprocedural constant propagation.
8190 This optimization analyzes the program to determine when values passed
8191 to functions are constants and then optimizes accordingly.
8192 This optimization can substantially increase performance
8193 if the application has constants passed to functions.
8194 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8196 @item -fipa-cp-clone
8197 @opindex fipa-cp-clone
8198 Perform function cloning to make interprocedural constant propagation stronger.
8199 When enabled, interprocedural constant propagation performs function cloning
8200 when externally visible function can be called with constant arguments.
8201 Because this optimization can create multiple copies of functions,
8202 it may significantly increase code size
8203 (see @option{--param ipcp-unit-growth=@var{value}}).
8204 This flag is enabled by default at @option{-O3}.
8206 @item -fipa-bit-cp
8207 @opindex -fipa-bit-cp
8208 When enabled, perform interprocedural bitwise constant
8209 propagation. This flag is enabled by default at @option{-O2}. It
8210 requires that @option{-fipa-cp} is enabled.
8212 @item -fipa-vrp
8213 @opindex -fipa-vrp
8214 When enabled, perform interprocedural propagation of value
8215 ranges. This flag is enabled by default at @option{-O2}. It requires
8216 that @option{-fipa-cp} is enabled.
8218 @item -fipa-icf
8219 @opindex fipa-icf
8220 Perform Identical Code Folding for functions and read-only variables.
8221 The optimization reduces code size and may disturb unwind stacks by replacing
8222 a function by equivalent one with a different name. The optimization works
8223 more effectively with link-time optimization enabled.
8225 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8226 works on different levels and thus the optimizations are not same - there are
8227 equivalences that are found only by GCC and equivalences found only by Gold.
8229 This flag is enabled by default at @option{-O2} and @option{-Os}.
8231 @item -fisolate-erroneous-paths-dereference
8232 @opindex fisolate-erroneous-paths-dereference
8233 Detect paths that trigger erroneous or undefined behavior due to
8234 dereferencing a null pointer.  Isolate those paths from the main control
8235 flow and turn the statement with erroneous or undefined behavior into a trap.
8236 This flag is enabled by default at @option{-O2} and higher and depends on
8237 @option{-fdelete-null-pointer-checks} also being enabled.
8239 @item -fisolate-erroneous-paths-attribute
8240 @opindex fisolate-erroneous-paths-attribute
8241 Detect paths that trigger erroneous or undefined behavior due a null value
8242 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8243 attribute.  Isolate those paths from the main control flow and turn the
8244 statement with erroneous or undefined behavior into a trap.  This is not
8245 currently enabled, but may be enabled by @option{-O2} in the future.
8247 @item -ftree-sink
8248 @opindex ftree-sink
8249 Perform forward store motion on trees.  This flag is
8250 enabled by default at @option{-O} and higher.
8252 @item -ftree-bit-ccp
8253 @opindex ftree-bit-ccp
8254 Perform sparse conditional bit constant propagation on trees and propagate
8255 pointer alignment information.
8256 This pass only operates on local scalar variables and is enabled by default
8257 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8259 @item -ftree-ccp
8260 @opindex ftree-ccp
8261 Perform sparse conditional constant propagation (CCP) on trees.  This
8262 pass only operates on local scalar variables and is enabled by default
8263 at @option{-O} and higher.
8265 @item -fssa-backprop
8266 @opindex fssa-backprop
8267 Propagate information about uses of a value up the definition chain
8268 in order to simplify the definitions.  For example, this pass strips
8269 sign operations if the sign of a value never matters.  The flag is
8270 enabled by default at @option{-O} and higher.
8272 @item -fssa-phiopt
8273 @opindex fssa-phiopt
8274 Perform pattern matching on SSA PHI nodes to optimize conditional
8275 code.  This pass is enabled by default at @option{-O} and higher.
8277 @item -ftree-switch-conversion
8278 @opindex ftree-switch-conversion
8279 Perform conversion of simple initializations in a switch to
8280 initializations from a scalar array.  This flag is enabled by default
8281 at @option{-O2} and higher.
8283 @item -ftree-tail-merge
8284 @opindex ftree-tail-merge
8285 Look for identical code sequences.  When found, replace one with a jump to the
8286 other.  This optimization is known as tail merging or cross jumping.  This flag
8287 is enabled by default at @option{-O2} and higher.  The compilation time
8288 in this pass can
8289 be limited using @option{max-tail-merge-comparisons} parameter and
8290 @option{max-tail-merge-iterations} parameter.
8292 @item -ftree-dce
8293 @opindex ftree-dce
8294 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8295 default at @option{-O} and higher.
8297 @item -ftree-builtin-call-dce
8298 @opindex ftree-builtin-call-dce
8299 Perform conditional dead code elimination (DCE) for calls to built-in functions
8300 that may set @code{errno} but are otherwise side-effect free.  This flag is
8301 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8302 specified.
8304 @item -ftree-dominator-opts
8305 @opindex ftree-dominator-opts
8306 Perform a variety of simple scalar cleanups (constant/copy
8307 propagation, redundancy elimination, range propagation and expression
8308 simplification) based on a dominator tree traversal.  This also
8309 performs jump threading (to reduce jumps to jumps). This flag is
8310 enabled by default at @option{-O} and higher.
8312 @item -ftree-dse
8313 @opindex ftree-dse
8314 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8315 a memory location that is later overwritten by another store without
8316 any intervening loads.  In this case the earlier store can be deleted.  This
8317 flag is enabled by default at @option{-O} and higher.
8319 @item -ftree-ch
8320 @opindex ftree-ch
8321 Perform loop header copying on trees.  This is beneficial since it increases
8322 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8323 is enabled by default at @option{-O} and higher.  It is not enabled
8324 for @option{-Os}, since it usually increases code size.
8326 @item -ftree-loop-optimize
8327 @opindex ftree-loop-optimize
8328 Perform loop optimizations on trees.  This flag is enabled by default
8329 at @option{-O} and higher.
8331 @item -ftree-loop-linear
8332 @itemx -floop-interchange
8333 @itemx -floop-strip-mine
8334 @itemx -floop-block
8335 @itemx -floop-unroll-and-jam
8336 @opindex ftree-loop-linear
8337 @opindex floop-interchange
8338 @opindex floop-strip-mine
8339 @opindex floop-block
8340 @opindex floop-unroll-and-jam
8341 Perform loop nest optimizations.  Same as
8342 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8343 to be configured with @option{--with-isl} to enable the Graphite loop
8344 transformation infrastructure.
8346 @item -fgraphite-identity
8347 @opindex fgraphite-identity
8348 Enable the identity transformation for graphite.  For every SCoP we generate
8349 the polyhedral representation and transform it back to gimple.  Using
8350 @option{-fgraphite-identity} we can check the costs or benefits of the
8351 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8352 are also performed by the code generator isl, like index splitting and
8353 dead code elimination in loops.
8355 @item -floop-nest-optimize
8356 @opindex floop-nest-optimize
8357 Enable the isl based loop nest optimizer.  This is a generic loop nest
8358 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8359 structure optimized for data-locality and parallelism.  This option
8360 is experimental.
8362 @item -floop-parallelize-all
8363 @opindex floop-parallelize-all
8364 Use the Graphite data dependence analysis to identify loops that can
8365 be parallelized.  Parallelize all the loops that can be analyzed to
8366 not contain loop carried dependences without checking that it is
8367 profitable to parallelize the loops.
8369 @item -ftree-coalesce-vars
8370 @opindex ftree-coalesce-vars
8371 While transforming the program out of the SSA representation, attempt to
8372 reduce copying by coalescing versions of different user-defined
8373 variables, instead of just compiler temporaries.  This may severely
8374 limit the ability to debug an optimized program compiled with
8375 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8376 prevents SSA coalescing of user variables.  This option is enabled by
8377 default if optimization is enabled, and it does very little otherwise.
8379 @item -ftree-loop-if-convert
8380 @opindex ftree-loop-if-convert
8381 Attempt to transform conditional jumps in the innermost loops to
8382 branch-less equivalents.  The intent is to remove control-flow from
8383 the innermost loops in order to improve the ability of the
8384 vectorization pass to handle these loops.  This is enabled by default
8385 if vectorization is enabled.
8387 @item -ftree-loop-distribution
8388 @opindex ftree-loop-distribution
8389 Perform loop distribution.  This flag can improve cache performance on
8390 big loop bodies and allow further loop optimizations, like
8391 parallelization or vectorization, to take place.  For example, the loop
8392 @smallexample
8393 DO I = 1, N
8394   A(I) = B(I) + C
8395   D(I) = E(I) * F
8396 ENDDO
8397 @end smallexample
8398 is transformed to
8399 @smallexample
8400 DO I = 1, N
8401    A(I) = B(I) + C
8402 ENDDO
8403 DO I = 1, N
8404    D(I) = E(I) * F
8405 ENDDO
8406 @end smallexample
8408 @item -ftree-loop-distribute-patterns
8409 @opindex ftree-loop-distribute-patterns
8410 Perform loop distribution of patterns that can be code generated with
8411 calls to a library.  This flag is enabled by default at @option{-O3}.
8413 This pass distributes the initialization loops and generates a call to
8414 memset zero.  For example, the loop
8415 @smallexample
8416 DO I = 1, N
8417   A(I) = 0
8418   B(I) = A(I) + I
8419 ENDDO
8420 @end smallexample
8421 is transformed to
8422 @smallexample
8423 DO I = 1, N
8424    A(I) = 0
8425 ENDDO
8426 DO I = 1, N
8427    B(I) = A(I) + I
8428 ENDDO
8429 @end smallexample
8430 and the initialization loop is transformed into a call to memset zero.
8432 @item -ftree-loop-im
8433 @opindex ftree-loop-im
8434 Perform loop invariant motion on trees.  This pass moves only invariants that
8435 are hard to handle at RTL level (function calls, operations that expand to
8436 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8437 operands of conditions that are invariant out of the loop, so that we can use
8438 just trivial invariantness analysis in loop unswitching.  The pass also includes
8439 store motion.
8441 @item -ftree-loop-ivcanon
8442 @opindex ftree-loop-ivcanon
8443 Create a canonical counter for number of iterations in loops for which
8444 determining number of iterations requires complicated analysis.  Later
8445 optimizations then may determine the number easily.  Useful especially
8446 in connection with unrolling.
8448 @item -fivopts
8449 @opindex fivopts
8450 Perform induction variable optimizations (strength reduction, induction
8451 variable merging and induction variable elimination) on trees.
8453 @item -ftree-parallelize-loops=n
8454 @opindex ftree-parallelize-loops
8455 Parallelize loops, i.e., split their iteration space to run in n threads.
8456 This is only possible for loops whose iterations are independent
8457 and can be arbitrarily reordered.  The optimization is only
8458 profitable on multiprocessor machines, for loops that are CPU-intensive,
8459 rather than constrained e.g.@: by memory bandwidth.  This option
8460 implies @option{-pthread}, and thus is only supported on targets
8461 that have support for @option{-pthread}.
8463 @item -ftree-pta
8464 @opindex ftree-pta
8465 Perform function-local points-to analysis on trees.  This flag is
8466 enabled by default at @option{-O} and higher.
8468 @item -ftree-sra
8469 @opindex ftree-sra
8470 Perform scalar replacement of aggregates.  This pass replaces structure
8471 references with scalars to prevent committing structures to memory too
8472 early.  This flag is enabled by default at @option{-O} and higher.
8474 @item -fstore-merging
8475 @opindex fstore-merging
8476 Perform merging of narrow stores to consecutive memory addresses.  This pass
8477 merges contiguous stores of immediate values narrower than a word into fewer
8478 wider stores to reduce the number of instructions.  This is enabled by default
8479 at @option{-O2} and higher as well as @option{-Os}.
8481 @item -ftree-ter
8482 @opindex ftree-ter
8483 Perform temporary expression replacement during the SSA->normal phase.  Single
8484 use/single def temporaries are replaced at their use location with their
8485 defining expression.  This results in non-GIMPLE code, but gives the expanders
8486 much more complex trees to work on resulting in better RTL generation.  This is
8487 enabled by default at @option{-O} and higher.
8489 @item -ftree-slsr
8490 @opindex ftree-slsr
8491 Perform straight-line strength reduction on trees.  This recognizes related
8492 expressions involving multiplications and replaces them by less expensive
8493 calculations when possible.  This is enabled by default at @option{-O} and
8494 higher.
8496 @item -ftree-vectorize
8497 @opindex ftree-vectorize
8498 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8499 and @option{-ftree-slp-vectorize} if not explicitly specified.
8501 @item -ftree-loop-vectorize
8502 @opindex ftree-loop-vectorize
8503 Perform loop vectorization on trees. This flag is enabled by default at
8504 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8506 @item -ftree-slp-vectorize
8507 @opindex ftree-slp-vectorize
8508 Perform basic block vectorization on trees. This flag is enabled by default at
8509 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8511 @item -fvect-cost-model=@var{model}
8512 @opindex fvect-cost-model
8513 Alter the cost model used for vectorization.  The @var{model} argument
8514 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8515 With the @samp{unlimited} model the vectorized code-path is assumed
8516 to be profitable while with the @samp{dynamic} model a runtime check
8517 guards the vectorized code-path to enable it only for iteration
8518 counts that will likely execute faster than when executing the original
8519 scalar loop.  The @samp{cheap} model disables vectorization of
8520 loops where doing so would be cost prohibitive for example due to
8521 required runtime checks for data dependence or alignment but otherwise
8522 is equal to the @samp{dynamic} model.
8523 The default cost model depends on other optimization flags and is
8524 either @samp{dynamic} or @samp{cheap}.
8526 @item -fsimd-cost-model=@var{model}
8527 @opindex fsimd-cost-model
8528 Alter the cost model used for vectorization of loops marked with the OpenMP
8529 or Cilk Plus simd directive.  The @var{model} argument should be one of
8530 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8531 have the same meaning as described in @option{-fvect-cost-model} and by
8532 default a cost model defined with @option{-fvect-cost-model} is used.
8534 @item -ftree-vrp
8535 @opindex ftree-vrp
8536 Perform Value Range Propagation on trees.  This is similar to the
8537 constant propagation pass, but instead of values, ranges of values are
8538 propagated.  This allows the optimizers to remove unnecessary range
8539 checks like array bound checks and null pointer checks.  This is
8540 enabled by default at @option{-O2} and higher.  Null pointer check
8541 elimination is only done if @option{-fdelete-null-pointer-checks} is
8542 enabled.
8544 @item -fsplit-paths
8545 @opindex fsplit-paths
8546 Split paths leading to loop backedges.  This can improve dead code
8547 elimination and common subexpression elimination.  This is enabled by
8548 default at @option{-O2} and above.
8550 @item -fsplit-ivs-in-unroller
8551 @opindex fsplit-ivs-in-unroller
8552 Enables expression of values of induction variables in later iterations
8553 of the unrolled loop using the value in the first iteration.  This breaks
8554 long dependency chains, thus improving efficiency of the scheduling passes.
8556 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8557 same effect.  However, that is not reliable in cases where the loop body
8558 is more complicated than a single basic block.  It also does not work at all
8559 on some architectures due to restrictions in the CSE pass.
8561 This optimization is enabled by default.
8563 @item -fvariable-expansion-in-unroller
8564 @opindex fvariable-expansion-in-unroller
8565 With this option, the compiler creates multiple copies of some
8566 local variables when unrolling a loop, which can result in superior code.
8568 @item -fpartial-inlining
8569 @opindex fpartial-inlining
8570 Inline parts of functions.  This option has any effect only
8571 when inlining itself is turned on by the @option{-finline-functions}
8572 or @option{-finline-small-functions} options.
8574 Enabled at level @option{-O2}.
8576 @item -fpredictive-commoning
8577 @opindex fpredictive-commoning
8578 Perform predictive commoning optimization, i.e., reusing computations
8579 (especially memory loads and stores) performed in previous
8580 iterations of loops.
8582 This option is enabled at level @option{-O3}.
8584 @item -fprefetch-loop-arrays
8585 @opindex fprefetch-loop-arrays
8586 If supported by the target machine, generate instructions to prefetch
8587 memory to improve the performance of loops that access large arrays.
8589 This option may generate better or worse code; results are highly
8590 dependent on the structure of loops within the source code.
8592 Disabled at level @option{-Os}.
8594 @item -fno-printf-return-value
8595 @opindex fno-printf-return-value
8596 Do not substitute constants for known return value of formatted output
8597 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8598 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8599 transformation allows GCC to optimize or even eliminate branches based
8600 on the known return value of these functions called with arguments that
8601 are either constant, or whose values are known to be in a range that
8602 makes determining the exact return value possible.  For example, when
8603 @option{-fprintf-return-value} is in effect, both the branch and the
8604 body of the @code{if} statement (but not the call to @code{snprint})
8605 can be optimized away when @code{i} is a 32-bit or smaller integer
8606 because the return value is guaranteed to be at most 8.
8608 @smallexample
8609 char buf[9];
8610 if (snprintf (buf, "%08x", i) >= sizeof buf)
8611   @dots{}
8612 @end smallexample
8614 The @option{-fprintf-return-value} option relies on other optimizations
8615 and yields best results with @option{-O2}.  It works in tandem with the
8616 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8617 The @option{-fprintf-return-value} option is enabled by default.
8619 @item -fno-peephole
8620 @itemx -fno-peephole2
8621 @opindex fno-peephole
8622 @opindex fno-peephole2
8623 Disable any machine-specific peephole optimizations.  The difference
8624 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8625 are implemented in the compiler; some targets use one, some use the
8626 other, a few use both.
8628 @option{-fpeephole} is enabled by default.
8629 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8631 @item -fno-guess-branch-probability
8632 @opindex fno-guess-branch-probability
8633 Do not guess branch probabilities using heuristics.
8635 GCC uses heuristics to guess branch probabilities if they are
8636 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8637 heuristics are based on the control flow graph.  If some branch probabilities
8638 are specified by @code{__builtin_expect}, then the heuristics are
8639 used to guess branch probabilities for the rest of the control flow graph,
8640 taking the @code{__builtin_expect} info into account.  The interactions
8641 between the heuristics and @code{__builtin_expect} can be complex, and in
8642 some cases, it may be useful to disable the heuristics so that the effects
8643 of @code{__builtin_expect} are easier to understand.
8645 The default is @option{-fguess-branch-probability} at levels
8646 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8648 @item -freorder-blocks
8649 @opindex freorder-blocks
8650 Reorder basic blocks in the compiled function in order to reduce number of
8651 taken branches and improve code locality.
8653 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8655 @item -freorder-blocks-algorithm=@var{algorithm}
8656 @opindex freorder-blocks-algorithm
8657 Use the specified algorithm for basic block reordering.  The
8658 @var{algorithm} argument can be @samp{simple}, which does not increase
8659 code size (except sometimes due to secondary effects like alignment),
8660 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8661 put all often executed code together, minimizing the number of branches
8662 executed by making extra copies of code.
8664 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8665 @samp{stc} at levels @option{-O2}, @option{-O3}.
8667 @item -freorder-blocks-and-partition
8668 @opindex freorder-blocks-and-partition
8669 In addition to reordering basic blocks in the compiled function, in order
8670 to reduce number of taken branches, partitions hot and cold basic blocks
8671 into separate sections of the assembly and @file{.o} files, to improve
8672 paging and cache locality performance.
8674 This optimization is automatically turned off in the presence of
8675 exception handling, for linkonce sections, for functions with a user-defined
8676 section attribute and on any architecture that does not support named
8677 sections.  When @option{-fsplit-stack} is used this option is not
8678 enabled by default (to avoid linker errors), but may be enabled
8679 explicitly (if using a working linker).
8681 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8683 @item -freorder-functions
8684 @opindex freorder-functions
8685 Reorder functions in the object file in order to
8686 improve code locality.  This is implemented by using special
8687 subsections @code{.text.hot} for most frequently executed functions and
8688 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8689 the linker so object file format must support named sections and linker must
8690 place them in a reasonable way.
8692 Also profile feedback must be available to make this option effective.  See
8693 @option{-fprofile-arcs} for details.
8695 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8697 @item -fstrict-aliasing
8698 @opindex fstrict-aliasing
8699 Allow the compiler to assume the strictest aliasing rules applicable to
8700 the language being compiled.  For C (and C++), this activates
8701 optimizations based on the type of expressions.  In particular, an
8702 object of one type is assumed never to reside at the same address as an
8703 object of a different type, unless the types are almost the same.  For
8704 example, an @code{unsigned int} can alias an @code{int}, but not a
8705 @code{void*} or a @code{double}.  A character type may alias any other
8706 type.
8708 @anchor{Type-punning}Pay special attention to code like this:
8709 @smallexample
8710 union a_union @{
8711   int i;
8712   double d;
8715 int f() @{
8716   union a_union t;
8717   t.d = 3.0;
8718   return t.i;
8720 @end smallexample
8721 The practice of reading from a different union member than the one most
8722 recently written to (called ``type-punning'') is common.  Even with
8723 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8724 is accessed through the union type.  So, the code above works as
8725 expected.  @xref{Structures unions enumerations and bit-fields
8726 implementation}.  However, this code might not:
8727 @smallexample
8728 int f() @{
8729   union a_union t;
8730   int* ip;
8731   t.d = 3.0;
8732   ip = &t.i;
8733   return *ip;
8735 @end smallexample
8737 Similarly, access by taking the address, casting the resulting pointer
8738 and dereferencing the result has undefined behavior, even if the cast
8739 uses a union type, e.g.:
8740 @smallexample
8741 int f() @{
8742   double d = 3.0;
8743   return ((union a_union *) &d)->i;
8745 @end smallexample
8747 The @option{-fstrict-aliasing} option is enabled at levels
8748 @option{-O2}, @option{-O3}, @option{-Os}.
8750 @item -falign-functions
8751 @itemx -falign-functions=@var{n}
8752 @opindex falign-functions
8753 Align the start of functions to the next power-of-two greater than
8754 @var{n}, skipping up to @var{n} bytes.  For instance,
8755 @option{-falign-functions=32} aligns functions to the next 32-byte
8756 boundary, but @option{-falign-functions=24} aligns to the next
8757 32-byte boundary only if this can be done by skipping 23 bytes or less.
8759 @option{-fno-align-functions} and @option{-falign-functions=1} are
8760 equivalent and mean that functions are not aligned.
8762 Some assemblers only support this flag when @var{n} is a power of two;
8763 in that case, it is rounded up.
8765 If @var{n} is not specified or is zero, use a machine-dependent default.
8767 Enabled at levels @option{-O2}, @option{-O3}.
8769 @item -flimit-function-alignment
8770 If this option is enabled, the compiler tries to avoid unnecessarily
8771 overaligning functions. It attempts to instruct the assembler to align
8772 by the amount specified by @option{-falign-functions}, but not to
8773 skip more bytes than the size of the function.
8775 @item -falign-labels
8776 @itemx -falign-labels=@var{n}
8777 @opindex falign-labels
8778 Align all branch targets to a power-of-two boundary, skipping up to
8779 @var{n} bytes like @option{-falign-functions}.  This option can easily
8780 make code slower, because it must insert dummy operations for when the
8781 branch target is reached in the usual flow of the code.
8783 @option{-fno-align-labels} and @option{-falign-labels=1} are
8784 equivalent and mean that labels are not aligned.
8786 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8787 are greater than this value, then their values are used instead.
8789 If @var{n} is not specified or is zero, use a machine-dependent default
8790 which is very likely to be @samp{1}, meaning no alignment.
8792 Enabled at levels @option{-O2}, @option{-O3}.
8794 @item -falign-loops
8795 @itemx -falign-loops=@var{n}
8796 @opindex falign-loops
8797 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8798 like @option{-falign-functions}.  If the loops are
8799 executed many times, this makes up for any execution of the dummy
8800 operations.
8802 @option{-fno-align-loops} and @option{-falign-loops=1} are
8803 equivalent and mean that loops are not aligned.
8805 If @var{n} is not specified or is zero, use a machine-dependent default.
8807 Enabled at levels @option{-O2}, @option{-O3}.
8809 @item -falign-jumps
8810 @itemx -falign-jumps=@var{n}
8811 @opindex falign-jumps
8812 Align branch targets to a power-of-two boundary, for branch targets
8813 where the targets can only be reached by jumping, skipping up to @var{n}
8814 bytes like @option{-falign-functions}.  In this case, no dummy operations
8815 need be executed.
8817 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8818 equivalent and mean that loops are not aligned.
8820 If @var{n} is not specified or is zero, use a machine-dependent default.
8822 Enabled at levels @option{-O2}, @option{-O3}.
8824 @item -funit-at-a-time
8825 @opindex funit-at-a-time
8826 This option is left for compatibility reasons. @option{-funit-at-a-time}
8827 has no effect, while @option{-fno-unit-at-a-time} implies
8828 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8830 Enabled by default.
8832 @item -fno-toplevel-reorder
8833 @opindex fno-toplevel-reorder
8834 Do not reorder top-level functions, variables, and @code{asm}
8835 statements.  Output them in the same order that they appear in the
8836 input file.  When this option is used, unreferenced static variables
8837 are not removed.  This option is intended to support existing code
8838 that relies on a particular ordering.  For new code, it is better to
8839 use attributes when possible.
8841 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8842 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8843 targets.
8845 @item -fweb
8846 @opindex fweb
8847 Constructs webs as commonly used for register allocation purposes and assign
8848 each web individual pseudo register.  This allows the register allocation pass
8849 to operate on pseudos directly, but also strengthens several other optimization
8850 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8851 however, make debugging impossible, since variables no longer stay in a
8852 ``home register''.
8854 Enabled by default with @option{-funroll-loops}.
8856 @item -fwhole-program
8857 @opindex fwhole-program
8858 Assume that the current compilation unit represents the whole program being
8859 compiled.  All public functions and variables with the exception of @code{main}
8860 and those merged by attribute @code{externally_visible} become static functions
8861 and in effect are optimized more aggressively by interprocedural optimizers.
8863 This option should not be used in combination with @option{-flto}.
8864 Instead relying on a linker plugin should provide safer and more precise
8865 information.
8867 @item -flto[=@var{n}]
8868 @opindex flto
8869 This option runs the standard link-time optimizer.  When invoked
8870 with source code, it generates GIMPLE (one of GCC's internal
8871 representations) and writes it to special ELF sections in the object
8872 file.  When the object files are linked together, all the function
8873 bodies are read from these ELF sections and instantiated as if they
8874 had been part of the same translation unit.
8876 To use the link-time optimizer, @option{-flto} and optimization
8877 options should be specified at compile time and during the final link.
8878 It is recommended that you compile all the files participating in the
8879 same link with the same options and also specify those options at
8880 link time.  
8881 For example:
8883 @smallexample
8884 gcc -c -O2 -flto foo.c
8885 gcc -c -O2 -flto bar.c
8886 gcc -o myprog -flto -O2 foo.o bar.o
8887 @end smallexample
8889 The first two invocations to GCC save a bytecode representation
8890 of GIMPLE into special ELF sections inside @file{foo.o} and
8891 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8892 @file{foo.o} and @file{bar.o}, merges the two files into a single
8893 internal image, and compiles the result as usual.  Since both
8894 @file{foo.o} and @file{bar.o} are merged into a single image, this
8895 causes all the interprocedural analyses and optimizations in GCC to
8896 work across the two files as if they were a single one.  This means,
8897 for example, that the inliner is able to inline functions in
8898 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8900 Another (simpler) way to enable link-time optimization is:
8902 @smallexample
8903 gcc -o myprog -flto -O2 foo.c bar.c
8904 @end smallexample
8906 The above generates bytecode for @file{foo.c} and @file{bar.c},
8907 merges them together into a single GIMPLE representation and optimizes
8908 them as usual to produce @file{myprog}.
8910 The only important thing to keep in mind is that to enable link-time
8911 optimizations you need to use the GCC driver to perform the link step.
8912 GCC then automatically performs link-time optimization if any of the
8913 objects involved were compiled with the @option{-flto} command-line option.  
8914 You generally
8915 should specify the optimization options to be used for link-time
8916 optimization though GCC tries to be clever at guessing an
8917 optimization level to use from the options used at compile time
8918 if you fail to specify one at link time.  You can always override
8919 the automatic decision to do link-time optimization
8920 by passing @option{-fno-lto} to the link command.
8922 To make whole program optimization effective, it is necessary to make
8923 certain whole program assumptions.  The compiler needs to know
8924 what functions and variables can be accessed by libraries and runtime
8925 outside of the link-time optimized unit.  When supported by the linker,
8926 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8927 to the compiler about used and externally visible symbols.  When
8928 the linker plugin is not available, @option{-fwhole-program} should be
8929 used to allow the compiler to make these assumptions, which leads
8930 to more aggressive optimization decisions.
8932 When @option{-fuse-linker-plugin} is not enabled, when a file is
8933 compiled with @option{-flto}, the generated object file is larger than
8934 a regular object file because it contains GIMPLE bytecodes and the usual
8935 final code (see @option{-ffat-lto-objects}.  This means that
8936 object files with LTO information can be linked as normal object
8937 files; if @option{-fno-lto} is passed to the linker, no
8938 interprocedural optimizations are applied.  Note that when
8939 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
8940 but you cannot perform a regular, non-LTO link on them.
8942 Additionally, the optimization flags used to compile individual files
8943 are not necessarily related to those used at link time.  For instance,
8945 @smallexample
8946 gcc -c -O0 -ffat-lto-objects -flto foo.c
8947 gcc -c -O0 -ffat-lto-objects -flto bar.c
8948 gcc -o myprog -O3 foo.o bar.o
8949 @end smallexample
8951 This produces individual object files with unoptimized assembler
8952 code, but the resulting binary @file{myprog} is optimized at
8953 @option{-O3}.  If, instead, the final binary is generated with
8954 @option{-fno-lto}, then @file{myprog} is not optimized.
8956 When producing the final binary, GCC only
8957 applies link-time optimizations to those files that contain bytecode.
8958 Therefore, you can mix and match object files and libraries with
8959 GIMPLE bytecodes and final object code.  GCC automatically selects
8960 which files to optimize in LTO mode and which files to link without
8961 further processing.
8963 There are some code generation flags preserved by GCC when
8964 generating bytecodes, as they need to be used during the final link
8965 stage.  Generally options specified at link time override those
8966 specified at compile time.
8968 If you do not specify an optimization level option @option{-O} at
8969 link time, then GCC uses the highest optimization level 
8970 used when compiling the object files.
8972 Currently, the following options and their settings are taken from
8973 the first object file that explicitly specifies them: 
8974 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8975 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8976 and all the @option{-m} target flags.
8978 Certain ABI-changing flags are required to match in all compilation units,
8979 and trying to override this at link time with a conflicting value
8980 is ignored.  This includes options such as @option{-freg-struct-return}
8981 and @option{-fpcc-struct-return}. 
8983 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8984 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8985 are passed through to the link stage and merged conservatively for
8986 conflicting translation units.  Specifically
8987 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8988 precedence; and for example @option{-ffp-contract=off} takes precedence
8989 over @option{-ffp-contract=fast}.  You can override them at link time.
8991 If LTO encounters objects with C linkage declared with incompatible
8992 types in separate translation units to be linked together (undefined
8993 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8994 issued.  The behavior is still undefined at run time.  Similar
8995 diagnostics may be raised for other languages.
8997 Another feature of LTO is that it is possible to apply interprocedural
8998 optimizations on files written in different languages:
9000 @smallexample
9001 gcc -c -flto foo.c
9002 g++ -c -flto bar.cc
9003 gfortran -c -flto baz.f90
9004 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9005 @end smallexample
9007 Notice that the final link is done with @command{g++} to get the C++
9008 runtime libraries and @option{-lgfortran} is added to get the Fortran
9009 runtime libraries.  In general, when mixing languages in LTO mode, you
9010 should use the same link command options as when mixing languages in a
9011 regular (non-LTO) compilation.
9013 If object files containing GIMPLE bytecode are stored in a library archive, say
9014 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9015 are using a linker with plugin support.  To create static libraries suitable
9016 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9017 and @command{ranlib}; 
9018 to show the symbols of object files with GIMPLE bytecode, use
9019 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9020 and @command{nm} have been compiled with plugin support.  At link time, use the the
9021 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9022 the LTO optimization process:
9024 @smallexample
9025 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9026 @end smallexample
9028 With the linker plugin enabled, the linker extracts the needed
9029 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9030 to make them part of the aggregated GIMPLE image to be optimized.
9032 If you are not using a linker with plugin support and/or do not
9033 enable the linker plugin, then the objects inside @file{libfoo.a}
9034 are extracted and linked as usual, but they do not participate
9035 in the LTO optimization process.  In order to make a static library suitable
9036 for both LTO optimization and usual linkage, compile its object files with
9037 @option{-flto} @option{-ffat-lto-objects}.
9039 Link-time optimizations do not require the presence of the whole program to
9040 operate.  If the program does not require any symbols to be exported, it is
9041 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9042 the interprocedural optimizers to use more aggressive assumptions which may
9043 lead to improved optimization opportunities.
9044 Use of @option{-fwhole-program} is not needed when linker plugin is
9045 active (see @option{-fuse-linker-plugin}).
9047 The current implementation of LTO makes no
9048 attempt to generate bytecode that is portable between different
9049 types of hosts.  The bytecode files are versioned and there is a
9050 strict version check, so bytecode files generated in one version of
9051 GCC do not work with an older or newer version of GCC.
9053 Link-time optimization does not work well with generation of debugging
9054 information.  Combining @option{-flto} with
9055 @option{-g} is currently experimental and expected to produce unexpected
9056 results.
9058 If you specify the optional @var{n}, the optimization and code
9059 generation done at link time is executed in parallel using @var{n}
9060 parallel jobs by utilizing an installed @command{make} program.  The
9061 environment variable @env{MAKE} may be used to override the program
9062 used.  The default value for @var{n} is 1.
9064 You can also specify @option{-flto=jobserver} to use GNU make's
9065 job server mode to determine the number of parallel jobs. This
9066 is useful when the Makefile calling GCC is already executing in parallel.
9067 You must prepend a @samp{+} to the command recipe in the parent Makefile
9068 for this to work.  This option likely only works if @env{MAKE} is
9069 GNU make.
9071 @item -flto-partition=@var{alg}
9072 @opindex flto-partition
9073 Specify the partitioning algorithm used by the link-time optimizer.
9074 The value is either @samp{1to1} to specify a partitioning mirroring
9075 the original source files or @samp{balanced} to specify partitioning
9076 into equally sized chunks (whenever possible) or @samp{max} to create
9077 new partition for every symbol where possible.  Specifying @samp{none}
9078 as an algorithm disables partitioning and streaming completely. 
9079 The default value is @samp{balanced}. While @samp{1to1} can be used
9080 as an workaround for various code ordering issues, the @samp{max}
9081 partitioning is intended for internal testing only.
9082 The value @samp{one} specifies that exactly one partition should be
9083 used while the value @samp{none} bypasses partitioning and executes
9084 the link-time optimization step directly from the WPA phase.
9086 @item -flto-odr-type-merging
9087 @opindex flto-odr-type-merging
9088 Enable streaming of mangled types names of C++ types and their unification
9089 at link time.  This increases size of LTO object files, but enables
9090 diagnostics about One Definition Rule violations.
9092 @item -flto-compression-level=@var{n}
9093 @opindex flto-compression-level
9094 This option specifies the level of compression used for intermediate
9095 language written to LTO object files, and is only meaningful in
9096 conjunction with LTO mode (@option{-flto}).  Valid
9097 values are 0 (no compression) to 9 (maximum compression).  Values
9098 outside this range are clamped to either 0 or 9.  If the option is not
9099 given, a default balanced compression setting is used.
9101 @item -fuse-linker-plugin
9102 @opindex fuse-linker-plugin
9103 Enables the use of a linker plugin during link-time optimization.  This
9104 option relies on plugin support in the linker, which is available in gold
9105 or in GNU ld 2.21 or newer.
9107 This option enables the extraction of object files with GIMPLE bytecode out
9108 of library archives. This improves the quality of optimization by exposing
9109 more code to the link-time optimizer.  This information specifies what
9110 symbols can be accessed externally (by non-LTO object or during dynamic
9111 linking).  Resulting code quality improvements on binaries (and shared
9112 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9113 See @option{-flto} for a description of the effect of this flag and how to
9114 use it.
9116 This option is enabled by default when LTO support in GCC is enabled
9117 and GCC was configured for use with
9118 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9120 @item -ffat-lto-objects
9121 @opindex ffat-lto-objects
9122 Fat LTO objects are object files that contain both the intermediate language
9123 and the object code. This makes them usable for both LTO linking and normal
9124 linking. This option is effective only when compiling with @option{-flto}
9125 and is ignored at link time.
9127 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9128 requires the complete toolchain to be aware of LTO. It requires a linker with
9129 linker plugin support for basic functionality.  Additionally,
9130 @command{nm}, @command{ar} and @command{ranlib}
9131 need to support linker plugins to allow a full-featured build environment
9132 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9133 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9134 to these tools. With non fat LTO makefiles need to be modified to use them.
9136 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9137 support.
9139 @item -fcompare-elim
9140 @opindex fcompare-elim
9141 After register allocation and post-register allocation instruction splitting,
9142 identify arithmetic instructions that compute processor flags similar to a
9143 comparison operation based on that arithmetic.  If possible, eliminate the
9144 explicit comparison operation.
9146 This pass only applies to certain targets that cannot explicitly represent
9147 the comparison operation before register allocation is complete.
9149 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9151 @item -fcprop-registers
9152 @opindex fcprop-registers
9153 After register allocation and post-register allocation instruction splitting,
9154 perform a copy-propagation pass to try to reduce scheduling dependencies
9155 and occasionally eliminate the copy.
9157 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9159 @item -fprofile-correction
9160 @opindex fprofile-correction
9161 Profiles collected using an instrumented binary for multi-threaded programs may
9162 be inconsistent due to missed counter updates. When this option is specified,
9163 GCC uses heuristics to correct or smooth out such inconsistencies. By
9164 default, GCC emits an error message when an inconsistent profile is detected.
9166 @item -fprofile-use
9167 @itemx -fprofile-use=@var{path}
9168 @opindex fprofile-use
9169 Enable profile feedback-directed optimizations, 
9170 and the following optimizations
9171 which are generally profitable only with profile feedback available:
9172 @option{-fbranch-probabilities}, @option{-fvpt},
9173 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9174 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9176 Before you can use this option, you must first generate profiling information.
9177 @xref{Instrumentation Options}, for information about the
9178 @option{-fprofile-generate} option.
9180 By default, GCC emits an error message if the feedback profiles do not
9181 match the source code.  This error can be turned into a warning by using
9182 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9183 code.
9185 If @var{path} is specified, GCC looks at the @var{path} to find
9186 the profile feedback data files. See @option{-fprofile-dir}.
9188 @item -fauto-profile
9189 @itemx -fauto-profile=@var{path}
9190 @opindex fauto-profile
9191 Enable sampling-based feedback-directed optimizations, 
9192 and the following optimizations
9193 which are generally profitable only with profile feedback available:
9194 @option{-fbranch-probabilities}, @option{-fvpt},
9195 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9196 @option{-ftree-vectorize},
9197 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9198 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9199 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9201 @var{path} is the name of a file containing AutoFDO profile information.
9202 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9204 Producing an AutoFDO profile data file requires running your program
9205 with the @command{perf} utility on a supported GNU/Linux target system.
9206 For more information, see @uref{https://perf.wiki.kernel.org/}.
9208 E.g.
9209 @smallexample
9210 perf record -e br_inst_retired:near_taken -b -o perf.data \
9211     -- your_program
9212 @end smallexample
9214 Then use the @command{create_gcov} tool to convert the raw profile data
9215 to a format that can be used by GCC.@  You must also supply the 
9216 unstripped binary for your program to this tool.  
9217 See @uref{https://github.com/google/autofdo}.
9219 E.g.
9220 @smallexample
9221 create_gcov --binary=your_program.unstripped --profile=perf.data \
9222     --gcov=profile.afdo
9223 @end smallexample
9224 @end table
9226 The following options control compiler behavior regarding floating-point 
9227 arithmetic.  These options trade off between speed and
9228 correctness.  All must be specifically enabled.
9230 @table @gcctabopt
9231 @item -ffloat-store
9232 @opindex ffloat-store
9233 Do not store floating-point variables in registers, and inhibit other
9234 options that might change whether a floating-point value is taken from a
9235 register or memory.
9237 @cindex floating-point precision
9238 This option prevents undesirable excess precision on machines such as
9239 the 68000 where the floating registers (of the 68881) keep more
9240 precision than a @code{double} is supposed to have.  Similarly for the
9241 x86 architecture.  For most programs, the excess precision does only
9242 good, but a few programs rely on the precise definition of IEEE floating
9243 point.  Use @option{-ffloat-store} for such programs, after modifying
9244 them to store all pertinent intermediate computations into variables.
9246 @item -fexcess-precision=@var{style}
9247 @opindex fexcess-precision
9248 This option allows further control over excess precision on machines
9249 where floating-point operations occur in a format with more precision or
9250 range than the IEEE standard and interchange floating-point types.  By
9251 default, @option{-fexcess-precision=fast} is in effect; this means that
9252 operations may be carried out in a wider precision than the types specified
9253 in the source if that would result in faster code, and it is unpredictable
9254 when rounding to the types specified in the source code takes place.
9255 When compiling C, if @option{-fexcess-precision=standard} is specified then
9256 excess precision follows the rules specified in ISO C99; in particular,
9257 both casts and assignments cause values to be rounded to their
9258 semantic types (whereas @option{-ffloat-store} only affects
9259 assignments).  This option is enabled by default for C if a strict
9260 conformance option such as @option{-std=c99} is used.
9261 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9262 regardless of whether a strict conformance option is used.
9264 @opindex mfpmath
9265 @option{-fexcess-precision=standard} is not implemented for languages
9266 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9267 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9268 semantics apply without excess precision, and in the latter, rounding
9269 is unpredictable.
9271 @item -ffast-math
9272 @opindex ffast-math
9273 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9274 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9275 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9276 @option{-fexcess-precision=fast}.
9278 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9280 This option is not turned on by any @option{-O} option besides
9281 @option{-Ofast} since it can result in incorrect output for programs
9282 that depend on an exact implementation of IEEE or ISO rules/specifications
9283 for math functions. It may, however, yield faster code for programs
9284 that do not require the guarantees of these specifications.
9286 @item -fno-math-errno
9287 @opindex fno-math-errno
9288 Do not set @code{errno} after calling math functions that are executed
9289 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9290 IEEE exceptions for math error handling may want to use this flag
9291 for speed while maintaining IEEE arithmetic compatibility.
9293 This option is not turned on by any @option{-O} option since
9294 it can result in incorrect output for programs that depend on
9295 an exact implementation of IEEE or ISO rules/specifications for
9296 math functions. It may, however, yield faster code for programs
9297 that do not require the guarantees of these specifications.
9299 The default is @option{-fmath-errno}.
9301 On Darwin systems, the math library never sets @code{errno}.  There is
9302 therefore no reason for the compiler to consider the possibility that
9303 it might, and @option{-fno-math-errno} is the default.
9305 @item -funsafe-math-optimizations
9306 @opindex funsafe-math-optimizations
9308 Allow optimizations for floating-point arithmetic that (a) assume
9309 that arguments and results are valid and (b) may violate IEEE or
9310 ANSI standards.  When used at link time, it may include libraries
9311 or startup files that change the default FPU control word or other
9312 similar optimizations.
9314 This option is not turned on by any @option{-O} option since
9315 it can result in incorrect output for programs that depend on
9316 an exact implementation of IEEE or ISO rules/specifications for
9317 math functions. It may, however, yield faster code for programs
9318 that do not require the guarantees of these specifications.
9319 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9320 @option{-fassociative-math} and @option{-freciprocal-math}.
9322 The default is @option{-fno-unsafe-math-optimizations}.
9324 @item -fassociative-math
9325 @opindex fassociative-math
9327 Allow re-association of operands in series of floating-point operations.
9328 This violates the ISO C and C++ language standard by possibly changing
9329 computation result.  NOTE: re-ordering may change the sign of zero as
9330 well as ignore NaNs and inhibit or create underflow or overflow (and
9331 thus cannot be used on code that relies on rounding behavior like
9332 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9333 and thus may not be used when ordered comparisons are required.
9334 This option requires that both @option{-fno-signed-zeros} and
9335 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9336 much sense with @option{-frounding-math}. For Fortran the option
9337 is automatically enabled when both @option{-fno-signed-zeros} and
9338 @option{-fno-trapping-math} are in effect.
9340 The default is @option{-fno-associative-math}.
9342 @item -freciprocal-math
9343 @opindex freciprocal-math
9345 Allow the reciprocal of a value to be used instead of dividing by
9346 the value if this enables optimizations.  For example @code{x / y}
9347 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9348 is subject to common subexpression elimination.  Note that this loses
9349 precision and increases the number of flops operating on the value.
9351 The default is @option{-fno-reciprocal-math}.
9353 @item -ffinite-math-only
9354 @opindex ffinite-math-only
9355 Allow optimizations for floating-point arithmetic that assume
9356 that arguments and results are not NaNs or +-Infs.
9358 This option is not turned on by any @option{-O} option since
9359 it can result in incorrect output for programs that depend on
9360 an exact implementation of IEEE or ISO rules/specifications for
9361 math functions. It may, however, yield faster code for programs
9362 that do not require the guarantees of these specifications.
9364 The default is @option{-fno-finite-math-only}.
9366 @item -fno-signed-zeros
9367 @opindex fno-signed-zeros
9368 Allow optimizations for floating-point arithmetic that ignore the
9369 signedness of zero.  IEEE arithmetic specifies the behavior of
9370 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9371 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9372 This option implies that the sign of a zero result isn't significant.
9374 The default is @option{-fsigned-zeros}.
9376 @item -fno-trapping-math
9377 @opindex fno-trapping-math
9378 Compile code assuming that floating-point operations cannot generate
9379 user-visible traps.  These traps include division by zero, overflow,
9380 underflow, inexact result and invalid operation.  This option requires
9381 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9382 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9384 This option should never be turned on by any @option{-O} option since
9385 it can result in incorrect output for programs that depend on
9386 an exact implementation of IEEE or ISO rules/specifications for
9387 math functions.
9389 The default is @option{-ftrapping-math}.
9391 @item -frounding-math
9392 @opindex frounding-math
9393 Disable transformations and optimizations that assume default floating-point
9394 rounding behavior.  This is round-to-zero for all floating point
9395 to integer conversions, and round-to-nearest for all other arithmetic
9396 truncations.  This option should be specified for programs that change
9397 the FP rounding mode dynamically, or that may be executed with a
9398 non-default rounding mode.  This option disables constant folding of
9399 floating-point expressions at compile time (which may be affected by
9400 rounding mode) and arithmetic transformations that are unsafe in the
9401 presence of sign-dependent rounding modes.
9403 The default is @option{-fno-rounding-math}.
9405 This option is experimental and does not currently guarantee to
9406 disable all GCC optimizations that are affected by rounding mode.
9407 Future versions of GCC may provide finer control of this setting
9408 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9409 will be used to specify the default state for @code{FENV_ACCESS}.
9411 @item -fsignaling-nans
9412 @opindex fsignaling-nans
9413 Compile code assuming that IEEE signaling NaNs may generate user-visible
9414 traps during floating-point operations.  Setting this option disables
9415 optimizations that may change the number of exceptions visible with
9416 signaling NaNs.  This option implies @option{-ftrapping-math}.
9418 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9419 be defined.
9421 The default is @option{-fno-signaling-nans}.
9423 This option is experimental and does not currently guarantee to
9424 disable all GCC optimizations that affect signaling NaN behavior.
9426 @item -fno-fp-int-builtin-inexact
9427 @opindex fno-fp-int-builtin-inexact
9428 Do not allow the built-in functions @code{ceil}, @code{floor},
9429 @code{round} and @code{trunc}, and their @code{float} and @code{long
9430 double} variants, to generate code that raises the ``inexact''
9431 floating-point exception for noninteger arguments.  ISO C99 and C11
9432 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9433 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9434 functions to do so.
9436 The default is @option{-ffp-int-builtin-inexact}, allowing the
9437 exception to be raised.  This option does nothing unless
9438 @option{-ftrapping-math} is in effect.
9440 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9441 generate a call to a library function then the ``inexact'' exception
9442 may be raised if the library implementation does not follow TS 18661.
9444 @item -fsingle-precision-constant
9445 @opindex fsingle-precision-constant
9446 Treat floating-point constants as single precision instead of
9447 implicitly converting them to double-precision constants.
9449 @item -fcx-limited-range
9450 @opindex fcx-limited-range
9451 When enabled, this option states that a range reduction step is not
9452 needed when performing complex division.  Also, there is no checking
9453 whether the result of a complex multiplication or division is @code{NaN
9454 + I*NaN}, with an attempt to rescue the situation in that case.  The
9455 default is @option{-fno-cx-limited-range}, but is enabled by
9456 @option{-ffast-math}.
9458 This option controls the default setting of the ISO C99
9459 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9460 all languages.
9462 @item -fcx-fortran-rules
9463 @opindex fcx-fortran-rules
9464 Complex multiplication and division follow Fortran rules.  Range
9465 reduction is done as part of complex division, but there is no checking
9466 whether the result of a complex multiplication or division is @code{NaN
9467 + I*NaN}, with an attempt to rescue the situation in that case.
9469 The default is @option{-fno-cx-fortran-rules}.
9471 @end table
9473 The following options control optimizations that may improve
9474 performance, but are not enabled by any @option{-O} options.  This
9475 section includes experimental options that may produce broken code.
9477 @table @gcctabopt
9478 @item -fbranch-probabilities
9479 @opindex fbranch-probabilities
9480 After running a program compiled with @option{-fprofile-arcs}
9481 (@pxref{Instrumentation Options}),
9482 you can compile it a second time using
9483 @option{-fbranch-probabilities}, to improve optimizations based on
9484 the number of times each branch was taken.  When a program
9485 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9486 counts to a file called @file{@var{sourcename}.gcda} for each source
9487 file.  The information in this data file is very dependent on the
9488 structure of the generated code, so you must use the same source code
9489 and the same optimization options for both compilations.
9491 With @option{-fbranch-probabilities}, GCC puts a
9492 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9493 These can be used to improve optimization.  Currently, they are only
9494 used in one place: in @file{reorg.c}, instead of guessing which path a
9495 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9496 exactly determine which path is taken more often.
9498 @item -fprofile-values
9499 @opindex fprofile-values
9500 If combined with @option{-fprofile-arcs}, it adds code so that some
9501 data about values of expressions in the program is gathered.
9503 With @option{-fbranch-probabilities}, it reads back the data gathered
9504 from profiling values of expressions for usage in optimizations.
9506 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9508 @item -fprofile-reorder-functions
9509 @opindex fprofile-reorder-functions
9510 Function reordering based on profile instrumentation collects
9511 first time of execution of a function and orders these functions
9512 in ascending order.
9514 Enabled with @option{-fprofile-use}.
9516 @item -fvpt
9517 @opindex fvpt
9518 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9519 to add code to gather information about values of expressions.
9521 With @option{-fbranch-probabilities}, it reads back the data gathered
9522 and actually performs the optimizations based on them.
9523 Currently the optimizations include specialization of division operations
9524 using the knowledge about the value of the denominator.
9526 @item -frename-registers
9527 @opindex frename-registers
9528 Attempt to avoid false dependencies in scheduled code by making use
9529 of registers left over after register allocation.  This optimization
9530 most benefits processors with lots of registers.  Depending on the
9531 debug information format adopted by the target, however, it can
9532 make debugging impossible, since variables no longer stay in
9533 a ``home register''.
9535 Enabled by default with @option{-funroll-loops}.
9537 @item -fschedule-fusion
9538 @opindex fschedule-fusion
9539 Performs a target dependent pass over the instruction stream to schedule
9540 instructions of same type together because target machine can execute them
9541 more efficiently if they are adjacent to each other in the instruction flow.
9543 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9545 @item -ftracer
9546 @opindex ftracer
9547 Perform tail duplication to enlarge superblock size.  This transformation
9548 simplifies the control flow of the function allowing other optimizations to do
9549 a better job.
9551 Enabled with @option{-fprofile-use}.
9553 @item -funroll-loops
9554 @opindex funroll-loops
9555 Unroll loops whose number of iterations can be determined at compile time or
9556 upon entry to the loop.  @option{-funroll-loops} implies
9557 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9558 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9559 a small constant number of iterations).  This option makes code larger, and may
9560 or may not make it run faster.
9562 Enabled with @option{-fprofile-use}.
9564 @item -funroll-all-loops
9565 @opindex funroll-all-loops
9566 Unroll all loops, even if their number of iterations is uncertain when
9567 the loop is entered.  This usually makes programs run more slowly.
9568 @option{-funroll-all-loops} implies the same options as
9569 @option{-funroll-loops}.
9571 @item -fpeel-loops
9572 @opindex fpeel-loops
9573 Peels loops for which there is enough information that they do not
9574 roll much (from profile feedback or static analysis).  It also turns on
9575 complete loop peeling (i.e.@: complete removal of loops with small constant
9576 number of iterations).
9578 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9580 @item -fmove-loop-invariants
9581 @opindex fmove-loop-invariants
9582 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9583 at level @option{-O1}
9585 @item -fsplit-loops
9586 @opindex fsplit-loops
9587 Split a loop into two if it contains a condition that's always true
9588 for one side of the iteration space and false for the other.
9590 @item -funswitch-loops
9591 @opindex funswitch-loops
9592 Move branches with loop invariant conditions out of the loop, with duplicates
9593 of the loop on both branches (modified according to result of the condition).
9595 @item -ffunction-sections
9596 @itemx -fdata-sections
9597 @opindex ffunction-sections
9598 @opindex fdata-sections
9599 Place each function or data item into its own section in the output
9600 file if the target supports arbitrary sections.  The name of the
9601 function or the name of the data item determines the section's name
9602 in the output file.
9604 Use these options on systems where the linker can perform optimizations
9605 to improve locality of reference in the instruction space.  Most systems
9606 using the ELF object format and SPARC processors running Solaris 2 have
9607 linkers with such optimizations.  AIX may have these optimizations in
9608 the future.
9610 Only use these options when there are significant benefits from doing
9611 so.  When you specify these options, the assembler and linker
9612 create larger object and executable files and are also slower.
9613 You cannot use @command{gprof} on all systems if you
9614 specify this option, and you may have problems with debugging if
9615 you specify both this option and @option{-g}.
9617 @item -fbranch-target-load-optimize
9618 @opindex fbranch-target-load-optimize
9619 Perform branch target register load optimization before prologue / epilogue
9620 threading.
9621 The use of target registers can typically be exposed only during reload,
9622 thus hoisting loads out of loops and doing inter-block scheduling needs
9623 a separate optimization pass.
9625 @item -fbranch-target-load-optimize2
9626 @opindex fbranch-target-load-optimize2
9627 Perform branch target register load optimization after prologue / epilogue
9628 threading.
9630 @item -fbtr-bb-exclusive
9631 @opindex fbtr-bb-exclusive
9632 When performing branch target register load optimization, don't reuse
9633 branch target registers within any basic block.
9635 @item -fstdarg-opt
9636 @opindex fstdarg-opt
9637 Optimize the prologue of variadic argument functions with respect to usage of
9638 those arguments.
9640 @item -fsection-anchors
9641 @opindex fsection-anchors
9642 Try to reduce the number of symbolic address calculations by using
9643 shared ``anchor'' symbols to address nearby objects.  This transformation
9644 can help to reduce the number of GOT entries and GOT accesses on some
9645 targets.
9647 For example, the implementation of the following function @code{foo}:
9649 @smallexample
9650 static int a, b, c;
9651 int foo (void) @{ return a + b + c; @}
9652 @end smallexample
9654 @noindent
9655 usually calculates the addresses of all three variables, but if you
9656 compile it with @option{-fsection-anchors}, it accesses the variables
9657 from a common anchor point instead.  The effect is similar to the
9658 following pseudocode (which isn't valid C):
9660 @smallexample
9661 int foo (void)
9663   register int *xr = &x;
9664   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9666 @end smallexample
9668 Not all targets support this option.
9670 @item --param @var{name}=@var{value}
9671 @opindex param
9672 In some places, GCC uses various constants to control the amount of
9673 optimization that is done.  For example, GCC does not inline functions
9674 that contain more than a certain number of instructions.  You can
9675 control some of these constants on the command line using the
9676 @option{--param} option.
9678 The names of specific parameters, and the meaning of the values, are
9679 tied to the internals of the compiler, and are subject to change
9680 without notice in future releases.
9682 In each case, the @var{value} is an integer.  The allowable choices for
9683 @var{name} are:
9685 @table @gcctabopt
9686 @item predictable-branch-outcome
9687 When branch is predicted to be taken with probability lower than this threshold
9688 (in percent), then it is considered well predictable. The default is 10.
9690 @item max-rtl-if-conversion-insns
9691 RTL if-conversion tries to remove conditional branches around a block and
9692 replace them with conditionally executed instructions.  This parameter
9693 gives the maximum number of instructions in a block which should be
9694 considered for if-conversion.  The default is 10, though the compiler will
9695 also use other heuristics to decide whether if-conversion is likely to be
9696 profitable.
9698 @item max-rtl-if-conversion-predictable-cost
9699 @item max-rtl-if-conversion-unpredictable-cost
9700 RTL if-conversion will try to remove conditional branches around a block
9701 and replace them with conditionally executed instructions.  These parameters
9702 give the maximum permissible cost for the sequence that would be generated
9703 by if-conversion depending on whether the branch is statically determined
9704 to be predictable or not.  The units for this parameter are the same as
9705 those for the GCC internal seq_cost metric.  The compiler will try to
9706 provide a reasonable default for this parameter using the BRANCH_COST
9707 target macro.
9709 @item max-crossjump-edges
9710 The maximum number of incoming edges to consider for cross-jumping.
9711 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9712 the number of edges incoming to each block.  Increasing values mean
9713 more aggressive optimization, making the compilation time increase with
9714 probably small improvement in executable size.
9716 @item min-crossjump-insns
9717 The minimum number of instructions that must be matched at the end
9718 of two blocks before cross-jumping is performed on them.  This
9719 value is ignored in the case where all instructions in the block being
9720 cross-jumped from are matched.  The default value is 5.
9722 @item max-grow-copy-bb-insns
9723 The maximum code size expansion factor when copying basic blocks
9724 instead of jumping.  The expansion is relative to a jump instruction.
9725 The default value is 8.
9727 @item max-goto-duplication-insns
9728 The maximum number of instructions to duplicate to a block that jumps
9729 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9730 passes, GCC factors computed gotos early in the compilation process,
9731 and unfactors them as late as possible.  Only computed jumps at the
9732 end of a basic blocks with no more than max-goto-duplication-insns are
9733 unfactored.  The default value is 8.
9735 @item max-delay-slot-insn-search
9736 The maximum number of instructions to consider when looking for an
9737 instruction to fill a delay slot.  If more than this arbitrary number of
9738 instructions are searched, the time savings from filling the delay slot
9739 are minimal, so stop searching.  Increasing values mean more
9740 aggressive optimization, making the compilation time increase with probably
9741 small improvement in execution time.
9743 @item max-delay-slot-live-search
9744 When trying to fill delay slots, the maximum number of instructions to
9745 consider when searching for a block with valid live register
9746 information.  Increasing this arbitrarily chosen value means more
9747 aggressive optimization, increasing the compilation time.  This parameter
9748 should be removed when the delay slot code is rewritten to maintain the
9749 control-flow graph.
9751 @item max-gcse-memory
9752 The approximate maximum amount of memory that can be allocated in
9753 order to perform the global common subexpression elimination
9754 optimization.  If more memory than specified is required, the
9755 optimization is not done.
9757 @item max-gcse-insertion-ratio
9758 If the ratio of expression insertions to deletions is larger than this value
9759 for any expression, then RTL PRE inserts or removes the expression and thus
9760 leaves partially redundant computations in the instruction stream.  The default value is 20.
9762 @item max-pending-list-length
9763 The maximum number of pending dependencies scheduling allows
9764 before flushing the current state and starting over.  Large functions
9765 with few branches or calls can create excessively large lists which
9766 needlessly consume memory and resources.
9768 @item max-modulo-backtrack-attempts
9769 The maximum number of backtrack attempts the scheduler should make
9770 when modulo scheduling a loop.  Larger values can exponentially increase
9771 compilation time.
9773 @item max-inline-insns-single
9774 Several parameters control the tree inliner used in GCC@.
9775 This number sets the maximum number of instructions (counted in GCC's
9776 internal representation) in a single function that the tree inliner
9777 considers for inlining.  This only affects functions declared
9778 inline and methods implemented in a class declaration (C++).
9779 The default value is 400.
9781 @item max-inline-insns-auto
9782 When you use @option{-finline-functions} (included in @option{-O3}),
9783 a lot of functions that would otherwise not be considered for inlining
9784 by the compiler are investigated.  To those functions, a different
9785 (more restrictive) limit compared to functions declared inline can
9786 be applied.
9787 The default value is 40.
9789 @item inline-min-speedup
9790 When estimated performance improvement of caller + callee runtime exceeds this
9791 threshold (in percent), the function can be inlined regardless of the limit on
9792 @option{--param max-inline-insns-single} and @option{--param
9793 max-inline-insns-auto}.
9795 @item large-function-insns
9796 The limit specifying really large functions.  For functions larger than this
9797 limit after inlining, inlining is constrained by
9798 @option{--param large-function-growth}.  This parameter is useful primarily
9799 to avoid extreme compilation time caused by non-linear algorithms used by the
9800 back end.
9801 The default value is 2700.
9803 @item large-function-growth
9804 Specifies maximal growth of large function caused by inlining in percents.
9805 The default value is 100 which limits large function growth to 2.0 times
9806 the original size.
9808 @item large-unit-insns
9809 The limit specifying large translation unit.  Growth caused by inlining of
9810 units larger than this limit is limited by @option{--param inline-unit-growth}.
9811 For small units this might be too tight.
9812 For example, consider a unit consisting of function A
9813 that is inline and B that just calls A three times.  If B is small relative to
9814 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9815 large units consisting of small inlineable functions, however, the overall unit
9816 growth limit is needed to avoid exponential explosion of code size.  Thus for
9817 smaller units, the size is increased to @option{--param large-unit-insns}
9818 before applying @option{--param inline-unit-growth}.  The default is 10000.
9820 @item inline-unit-growth
9821 Specifies maximal overall growth of the compilation unit caused by inlining.
9822 The default value is 20 which limits unit growth to 1.2 times the original
9823 size. Cold functions (either marked cold via an attribute or by profile
9824 feedback) are not accounted into the unit size.
9826 @item ipcp-unit-growth
9827 Specifies maximal overall growth of the compilation unit caused by
9828 interprocedural constant propagation.  The default value is 10 which limits
9829 unit growth to 1.1 times the original size.
9831 @item large-stack-frame
9832 The limit specifying large stack frames.  While inlining the algorithm is trying
9833 to not grow past this limit too much.  The default value is 256 bytes.
9835 @item large-stack-frame-growth
9836 Specifies maximal growth of large stack frames caused by inlining in percents.
9837 The default value is 1000 which limits large stack frame growth to 11 times
9838 the original size.
9840 @item max-inline-insns-recursive
9841 @itemx max-inline-insns-recursive-auto
9842 Specifies the maximum number of instructions an out-of-line copy of a
9843 self-recursive inline
9844 function can grow into by performing recursive inlining.
9846 @option{--param max-inline-insns-recursive} applies to functions
9847 declared inline.
9848 For functions not declared inline, recursive inlining
9849 happens only when @option{-finline-functions} (included in @option{-O3}) is
9850 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9851 default value is 450.
9853 @item max-inline-recursive-depth
9854 @itemx max-inline-recursive-depth-auto
9855 Specifies the maximum recursion depth used for recursive inlining.
9857 @option{--param max-inline-recursive-depth} applies to functions
9858 declared inline.  For functions not declared inline, recursive inlining
9859 happens only when @option{-finline-functions} (included in @option{-O3}) is
9860 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9861 default value is 8.
9863 @item min-inline-recursive-probability
9864 Recursive inlining is profitable only for function having deep recursion
9865 in average and can hurt for function having little recursion depth by
9866 increasing the prologue size or complexity of function body to other
9867 optimizers.
9869 When profile feedback is available (see @option{-fprofile-generate}) the actual
9870 recursion depth can be guessed from the probability that function recurses
9871 via a given call expression.  This parameter limits inlining only to call
9872 expressions whose probability exceeds the given threshold (in percents).
9873 The default value is 10.
9875 @item early-inlining-insns
9876 Specify growth that the early inliner can make.  In effect it increases
9877 the amount of inlining for code having a large abstraction penalty.
9878 The default value is 14.
9880 @item max-early-inliner-iterations
9881 Limit of iterations of the early inliner.  This basically bounds
9882 the number of nested indirect calls the early inliner can resolve.
9883 Deeper chains are still handled by late inlining.
9885 @item comdat-sharing-probability
9886 Probability (in percent) that C++ inline function with comdat visibility
9887 are shared across multiple compilation units.  The default value is 20.
9889 @item profile-func-internal-id
9890 A parameter to control whether to use function internal id in profile
9891 database lookup. If the value is 0, the compiler uses an id that
9892 is based on function assembler name and filename, which makes old profile
9893 data more tolerant to source changes such as function reordering etc.
9894 The default value is 0.
9896 @item min-vect-loop-bound
9897 The minimum number of iterations under which loops are not vectorized
9898 when @option{-ftree-vectorize} is used.  The number of iterations after
9899 vectorization needs to be greater than the value specified by this option
9900 to allow vectorization.  The default value is 0.
9902 @item gcse-cost-distance-ratio
9903 Scaling factor in calculation of maximum distance an expression
9904 can be moved by GCSE optimizations.  This is currently supported only in the
9905 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9906 is with simple expressions, i.e., the expressions that have cost
9907 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9908 hoisting of simple expressions.  The default value is 10.
9910 @item gcse-unrestricted-cost
9911 Cost, roughly measured as the cost of a single typical machine
9912 instruction, at which GCSE optimizations do not constrain
9913 the distance an expression can travel.  This is currently
9914 supported only in the code hoisting pass.  The lesser the cost,
9915 the more aggressive code hoisting is.  Specifying 0 
9916 allows all expressions to travel unrestricted distances.
9917 The default value is 3.
9919 @item max-hoist-depth
9920 The depth of search in the dominator tree for expressions to hoist.
9921 This is used to avoid quadratic behavior in hoisting algorithm.
9922 The value of 0 does not limit on the search, but may slow down compilation
9923 of huge functions.  The default value is 30.
9925 @item max-tail-merge-comparisons
9926 The maximum amount of similar bbs to compare a bb with.  This is used to
9927 avoid quadratic behavior in tree tail merging.  The default value is 10.
9929 @item max-tail-merge-iterations
9930 The maximum amount of iterations of the pass over the function.  This is used to
9931 limit compilation time in tree tail merging.  The default value is 2.
9933 @item store-merging-allow-unaligned
9934 Allow the store merging pass to introduce unaligned stores if it is legal to
9935 do so.  The default value is 1.
9937 @item max-stores-to-merge
9938 The maximum number of stores to attempt to merge into wider stores in the store
9939 merging pass.  The minimum value is 2 and the default is 64.
9941 @item max-unrolled-insns
9942 The maximum number of instructions that a loop may have to be unrolled.
9943 If a loop is unrolled, this parameter also determines how many times
9944 the loop code is unrolled.
9946 @item max-average-unrolled-insns
9947 The maximum number of instructions biased by probabilities of their execution
9948 that a loop may have to be unrolled.  If a loop is unrolled,
9949 this parameter also determines how many times the loop code is unrolled.
9951 @item max-unroll-times
9952 The maximum number of unrollings of a single loop.
9954 @item max-peeled-insns
9955 The maximum number of instructions that a loop may have to be peeled.
9956 If a loop is peeled, this parameter also determines how many times
9957 the loop code is peeled.
9959 @item max-peel-times
9960 The maximum number of peelings of a single loop.
9962 @item max-peel-branches
9963 The maximum number of branches on the hot path through the peeled sequence.
9965 @item max-completely-peeled-insns
9966 The maximum number of insns of a completely peeled loop.
9968 @item max-completely-peel-times
9969 The maximum number of iterations of a loop to be suitable for complete peeling.
9971 @item max-completely-peel-loop-nest-depth
9972 The maximum depth of a loop nest suitable for complete peeling.
9974 @item max-unswitch-insns
9975 The maximum number of insns of an unswitched loop.
9977 @item max-unswitch-level
9978 The maximum number of branches unswitched in a single loop.
9980 @item max-loop-headers-insns
9981 The maximum number of insns in loop header duplicated by the copy loop headers
9982 pass.
9984 @item lim-expensive
9985 The minimum cost of an expensive expression in the loop invariant motion.
9987 @item iv-consider-all-candidates-bound
9988 Bound on number of candidates for induction variables, below which
9989 all candidates are considered for each use in induction variable
9990 optimizations.  If there are more candidates than this,
9991 only the most relevant ones are considered to avoid quadratic time complexity.
9993 @item iv-max-considered-uses
9994 The induction variable optimizations give up on loops that contain more
9995 induction variable uses.
9997 @item iv-always-prune-cand-set-bound
9998 If the number of candidates in the set is smaller than this value,
9999 always try to remove unnecessary ivs from the set
10000 when adding a new one.
10002 @item avg-loop-niter
10003 Average number of iterations of a loop.
10005 @item dse-max-object-size
10006 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10007 Larger values may result in larger compilation times.
10009 @item scev-max-expr-size
10010 Bound on size of expressions used in the scalar evolutions analyzer.
10011 Large expressions slow the analyzer.
10013 @item scev-max-expr-complexity
10014 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10015 Complex expressions slow the analyzer.
10017 @item max-tree-if-conversion-phi-args
10018 Maximum number of arguments in a PHI supported by TREE if conversion
10019 unless the loop is marked with simd pragma.
10021 @item vect-max-version-for-alignment-checks
10022 The maximum number of run-time checks that can be performed when
10023 doing loop versioning for alignment in the vectorizer.
10025 @item vect-max-version-for-alias-checks
10026 The maximum number of run-time checks that can be performed when
10027 doing loop versioning for alias in the vectorizer.
10029 @item vect-max-peeling-for-alignment
10030 The maximum number of loop peels to enhance access alignment
10031 for vectorizer. Value -1 means no limit.
10033 @item max-iterations-to-track
10034 The maximum number of iterations of a loop the brute-force algorithm
10035 for analysis of the number of iterations of the loop tries to evaluate.
10037 @item hot-bb-count-ws-permille
10038 A basic block profile count is considered hot if it contributes to 
10039 the given permillage (i.e. 0...1000) of the entire profiled execution.
10041 @item hot-bb-frequency-fraction
10042 Select fraction of the entry block frequency of executions of basic block in
10043 function given basic block needs to have to be considered hot.
10045 @item max-predicted-iterations
10046 The maximum number of loop iterations we predict statically.  This is useful
10047 in cases where a function contains a single loop with known bound and
10048 another loop with unknown bound.
10049 The known number of iterations is predicted correctly, while
10050 the unknown number of iterations average to roughly 10.  This means that the
10051 loop without bounds appears artificially cold relative to the other one.
10053 @item builtin-expect-probability
10054 Control the probability of the expression having the specified value. This
10055 parameter takes a percentage (i.e. 0 ... 100) as input.
10056 The default probability of 90 is obtained empirically.
10058 @item align-threshold
10060 Select fraction of the maximal frequency of executions of a basic block in
10061 a function to align the basic block.
10063 @item align-loop-iterations
10065 A loop expected to iterate at least the selected number of iterations is
10066 aligned.
10068 @item tracer-dynamic-coverage
10069 @itemx tracer-dynamic-coverage-feedback
10071 This value is used to limit superblock formation once the given percentage of
10072 executed instructions is covered.  This limits unnecessary code size
10073 expansion.
10075 The @option{tracer-dynamic-coverage-feedback} parameter
10076 is used only when profile
10077 feedback is available.  The real profiles (as opposed to statically estimated
10078 ones) are much less balanced allowing the threshold to be larger value.
10080 @item tracer-max-code-growth
10081 Stop tail duplication once code growth has reached given percentage.  This is
10082 a rather artificial limit, as most of the duplicates are eliminated later in
10083 cross jumping, so it may be set to much higher values than is the desired code
10084 growth.
10086 @item tracer-min-branch-ratio
10088 Stop reverse growth when the reverse probability of best edge is less than this
10089 threshold (in percent).
10091 @item tracer-min-branch-probability
10092 @itemx tracer-min-branch-probability-feedback
10094 Stop forward growth if the best edge has probability lower than this
10095 threshold.
10097 Similarly to @option{tracer-dynamic-coverage} two parameters are
10098 provided.  @option{tracer-min-branch-probability-feedback} is used for
10099 compilation with profile feedback and @option{tracer-min-branch-probability}
10100 compilation without.  The value for compilation with profile feedback
10101 needs to be more conservative (higher) in order to make tracer
10102 effective.
10104 @item max-cse-path-length
10106 The maximum number of basic blocks on path that CSE considers.
10107 The default is 10.
10109 @item max-cse-insns
10110 The maximum number of instructions CSE processes before flushing.
10111 The default is 1000.
10113 @item ggc-min-expand
10115 GCC uses a garbage collector to manage its own memory allocation.  This
10116 parameter specifies the minimum percentage by which the garbage
10117 collector's heap should be allowed to expand between collections.
10118 Tuning this may improve compilation speed; it has no effect on code
10119 generation.
10121 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10122 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10123 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10124 GCC is not able to calculate RAM on a particular platform, the lower
10125 bound of 30% is used.  Setting this parameter and
10126 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10127 every opportunity.  This is extremely slow, but can be useful for
10128 debugging.
10130 @item ggc-min-heapsize
10132 Minimum size of the garbage collector's heap before it begins bothering
10133 to collect garbage.  The first collection occurs after the heap expands
10134 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10135 tuning this may improve compilation speed, and has no effect on code
10136 generation.
10138 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10139 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10140 with a lower bound of 4096 (four megabytes) and an upper bound of
10141 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10142 particular platform, the lower bound is used.  Setting this parameter
10143 very large effectively disables garbage collection.  Setting this
10144 parameter and @option{ggc-min-expand} to zero causes a full collection
10145 to occur at every opportunity.
10147 @item max-reload-search-insns
10148 The maximum number of instruction reload should look backward for equivalent
10149 register.  Increasing values mean more aggressive optimization, making the
10150 compilation time increase with probably slightly better performance.
10151 The default value is 100.
10153 @item max-cselib-memory-locations
10154 The maximum number of memory locations cselib should take into account.
10155 Increasing values mean more aggressive optimization, making the compilation time
10156 increase with probably slightly better performance.  The default value is 500.
10158 @item max-sched-ready-insns
10159 The maximum number of instructions ready to be issued the scheduler should
10160 consider at any given time during the first scheduling pass.  Increasing
10161 values mean more thorough searches, making the compilation time increase
10162 with probably little benefit.  The default value is 100.
10164 @item max-sched-region-blocks
10165 The maximum number of blocks in a region to be considered for
10166 interblock scheduling.  The default value is 10.
10168 @item max-pipeline-region-blocks
10169 The maximum number of blocks in a region to be considered for
10170 pipelining in the selective scheduler.  The default value is 15.
10172 @item max-sched-region-insns
10173 The maximum number of insns in a region to be considered for
10174 interblock scheduling.  The default value is 100.
10176 @item max-pipeline-region-insns
10177 The maximum number of insns in a region to be considered for
10178 pipelining in the selective scheduler.  The default value is 200.
10180 @item min-spec-prob
10181 The minimum probability (in percents) of reaching a source block
10182 for interblock speculative scheduling.  The default value is 40.
10184 @item max-sched-extend-regions-iters
10185 The maximum number of iterations through CFG to extend regions.
10186 A value of 0 (the default) disables region extensions.
10188 @item max-sched-insn-conflict-delay
10189 The maximum conflict delay for an insn to be considered for speculative motion.
10190 The default value is 3.
10192 @item sched-spec-prob-cutoff
10193 The minimal probability of speculation success (in percents), so that
10194 speculative insns are scheduled.
10195 The default value is 40.
10197 @item sched-state-edge-prob-cutoff
10198 The minimum probability an edge must have for the scheduler to save its
10199 state across it.
10200 The default value is 10.
10202 @item sched-mem-true-dep-cost
10203 Minimal distance (in CPU cycles) between store and load targeting same
10204 memory locations.  The default value is 1.
10206 @item selsched-max-lookahead
10207 The maximum size of the lookahead window of selective scheduling.  It is a
10208 depth of search for available instructions.
10209 The default value is 50.
10211 @item selsched-max-sched-times
10212 The maximum number of times that an instruction is scheduled during
10213 selective scheduling.  This is the limit on the number of iterations
10214 through which the instruction may be pipelined.  The default value is 2.
10216 @item selsched-insns-to-rename
10217 The maximum number of best instructions in the ready list that are considered
10218 for renaming in the selective scheduler.  The default value is 2.
10220 @item sms-min-sc
10221 The minimum value of stage count that swing modulo scheduler
10222 generates.  The default value is 2.
10224 @item max-last-value-rtl
10225 The maximum size measured as number of RTLs that can be recorded in an expression
10226 in combiner for a pseudo register as last known value of that register.  The default
10227 is 10000.
10229 @item max-combine-insns
10230 The maximum number of instructions the RTL combiner tries to combine.
10231 The default value is 2 at @option{-Og} and 4 otherwise.
10233 @item integer-share-limit
10234 Small integer constants can use a shared data structure, reducing the
10235 compiler's memory usage and increasing its speed.  This sets the maximum
10236 value of a shared integer constant.  The default value is 256.
10238 @item ssp-buffer-size
10239 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10240 protection when @option{-fstack-protection} is used.
10242 @item min-size-for-stack-sharing
10243 The minimum size of variables taking part in stack slot sharing when not
10244 optimizing. The default value is 32.
10246 @item max-jump-thread-duplication-stmts
10247 Maximum number of statements allowed in a block that needs to be
10248 duplicated when threading jumps.
10250 @item max-fields-for-field-sensitive
10251 Maximum number of fields in a structure treated in
10252 a field sensitive manner during pointer analysis.  The default is zero
10253 for @option{-O0} and @option{-O1},
10254 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10256 @item prefetch-latency
10257 Estimate on average number of instructions that are executed before
10258 prefetch finishes.  The distance prefetched ahead is proportional
10259 to this constant.  Increasing this number may also lead to less
10260 streams being prefetched (see @option{simultaneous-prefetches}).
10262 @item simultaneous-prefetches
10263 Maximum number of prefetches that can run at the same time.
10265 @item l1-cache-line-size
10266 The size of cache line in L1 cache, in bytes.
10268 @item l1-cache-size
10269 The size of L1 cache, in kilobytes.
10271 @item l2-cache-size
10272 The size of L2 cache, in kilobytes.
10274 @item min-insn-to-prefetch-ratio
10275 The minimum ratio between the number of instructions and the
10276 number of prefetches to enable prefetching in a loop.
10278 @item prefetch-min-insn-to-mem-ratio
10279 The minimum ratio between the number of instructions and the
10280 number of memory references to enable prefetching in a loop.
10282 @item use-canonical-types
10283 Whether the compiler should use the ``canonical'' type system.  By
10284 default, this should always be 1, which uses a more efficient internal
10285 mechanism for comparing types in C++ and Objective-C++.  However, if
10286 bugs in the canonical type system are causing compilation failures,
10287 set this value to 0 to disable canonical types.
10289 @item switch-conversion-max-branch-ratio
10290 Switch initialization conversion refuses to create arrays that are
10291 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10292 branches in the switch.
10294 @item max-partial-antic-length
10295 Maximum length of the partial antic set computed during the tree
10296 partial redundancy elimination optimization (@option{-ftree-pre}) when
10297 optimizing at @option{-O3} and above.  For some sorts of source code
10298 the enhanced partial redundancy elimination optimization can run away,
10299 consuming all of the memory available on the host machine.  This
10300 parameter sets a limit on the length of the sets that are computed,
10301 which prevents the runaway behavior.  Setting a value of 0 for
10302 this parameter allows an unlimited set length.
10304 @item sccvn-max-scc-size
10305 Maximum size of a strongly connected component (SCC) during SCCVN
10306 processing.  If this limit is hit, SCCVN processing for the whole
10307 function is not done and optimizations depending on it are
10308 disabled.  The default maximum SCC size is 10000.
10310 @item sccvn-max-alias-queries-per-access
10311 Maximum number of alias-oracle queries we perform when looking for
10312 redundancies for loads and stores.  If this limit is hit the search
10313 is aborted and the load or store is not considered redundant.  The
10314 number of queries is algorithmically limited to the number of
10315 stores on all paths from the load to the function entry.
10316 The default maximum number of queries is 1000.
10318 @item ira-max-loops-num
10319 IRA uses regional register allocation by default.  If a function
10320 contains more loops than the number given by this parameter, only at most
10321 the given number of the most frequently-executed loops form regions
10322 for regional register allocation.  The default value of the
10323 parameter is 100.
10325 @item ira-max-conflict-table-size 
10326 Although IRA uses a sophisticated algorithm to compress the conflict
10327 table, the table can still require excessive amounts of memory for
10328 huge functions.  If the conflict table for a function could be more
10329 than the size in MB given by this parameter, the register allocator
10330 instead uses a faster, simpler, and lower-quality
10331 algorithm that does not require building a pseudo-register conflict table.  
10332 The default value of the parameter is 2000.
10334 @item ira-loop-reserved-regs
10335 IRA can be used to evaluate more accurate register pressure in loops
10336 for decisions to move loop invariants (see @option{-O3}).  The number
10337 of available registers reserved for some other purposes is given
10338 by this parameter.  The default value of the parameter is 2, which is
10339 the minimal number of registers needed by typical instructions.
10340 This value is the best found from numerous experiments.
10342 @item lra-inheritance-ebb-probability-cutoff
10343 LRA tries to reuse values reloaded in registers in subsequent insns.
10344 This optimization is called inheritance.  EBB is used as a region to
10345 do this optimization.  The parameter defines a minimal fall-through
10346 edge probability in percentage used to add BB to inheritance EBB in
10347 LRA.  The default value of the parameter is 40.  The value was chosen
10348 from numerous runs of SPEC2000 on x86-64.
10350 @item loop-invariant-max-bbs-in-loop
10351 Loop invariant motion can be very expensive, both in compilation time and
10352 in amount of needed compile-time memory, with very large loops.  Loops
10353 with more basic blocks than this parameter won't have loop invariant
10354 motion optimization performed on them.  The default value of the
10355 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10357 @item loop-max-datarefs-for-datadeps
10358 Building data dependencies is expensive for very large loops.  This
10359 parameter limits the number of data references in loops that are
10360 considered for data dependence analysis.  These large loops are no
10361 handled by the optimizations using loop data dependencies.
10362 The default value is 1000.
10364 @item max-vartrack-size
10365 Sets a maximum number of hash table slots to use during variable
10366 tracking dataflow analysis of any function.  If this limit is exceeded
10367 with variable tracking at assignments enabled, analysis for that
10368 function is retried without it, after removing all debug insns from
10369 the function.  If the limit is exceeded even without debug insns, var
10370 tracking analysis is completely disabled for the function.  Setting
10371 the parameter to zero makes it unlimited.
10373 @item max-vartrack-expr-depth
10374 Sets a maximum number of recursion levels when attempting to map
10375 variable names or debug temporaries to value expressions.  This trades
10376 compilation time for more complete debug information.  If this is set too
10377 low, value expressions that are available and could be represented in
10378 debug information may end up not being used; setting this higher may
10379 enable the compiler to find more complex debug expressions, but compile
10380 time and memory use may grow.  The default is 12.
10382 @item min-nondebug-insn-uid
10383 Use uids starting at this parameter for nondebug insns.  The range below
10384 the parameter is reserved exclusively for debug insns created by
10385 @option{-fvar-tracking-assignments}, but debug insns may get
10386 (non-overlapping) uids above it if the reserved range is exhausted.
10388 @item ipa-sra-ptr-growth-factor
10389 IPA-SRA replaces a pointer to an aggregate with one or more new
10390 parameters only when their cumulative size is less or equal to
10391 @option{ipa-sra-ptr-growth-factor} times the size of the original
10392 pointer parameter.
10394 @item sra-max-scalarization-size-Ospeed
10395 @item sra-max-scalarization-size-Osize
10396 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10397 replace scalar parts of aggregates with uses of independent scalar
10398 variables.  These parameters control the maximum size, in storage units,
10399 of aggregate which is considered for replacement when compiling for
10400 speed
10401 (@option{sra-max-scalarization-size-Ospeed}) or size
10402 (@option{sra-max-scalarization-size-Osize}) respectively.
10404 @item tm-max-aggregate-size
10405 When making copies of thread-local variables in a transaction, this
10406 parameter specifies the size in bytes after which variables are
10407 saved with the logging functions as opposed to save/restore code
10408 sequence pairs.  This option only applies when using
10409 @option{-fgnu-tm}.
10411 @item graphite-max-nb-scop-params
10412 To avoid exponential effects in the Graphite loop transforms, the
10413 number of parameters in a Static Control Part (SCoP) is bounded.  The
10414 default value is 10 parameters.  A variable whose value is unknown at
10415 compilation time and defined outside a SCoP is a parameter of the SCoP.
10417 @item graphite-max-bbs-per-function
10418 To avoid exponential effects in the detection of SCoPs, the size of
10419 the functions analyzed by Graphite is bounded.  The default value is
10420 100 basic blocks.
10422 @item loop-block-tile-size
10423 Loop blocking or strip mining transforms, enabled with
10424 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10425 loop in the loop nest by a given number of iterations.  The strip
10426 length can be changed using the @option{loop-block-tile-size}
10427 parameter.  The default value is 51 iterations.
10429 @item loop-unroll-jam-size
10430 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10431 default value is 4.
10433 @item loop-unroll-jam-depth
10434 Specify the dimension to be unrolled (counting from the most inner loop)
10435 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10437 @item ipa-cp-value-list-size
10438 IPA-CP attempts to track all possible values and types passed to a function's
10439 parameter in order to propagate them and perform devirtualization.
10440 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10441 stores per one formal parameter of a function.
10443 @item ipa-cp-eval-threshold
10444 IPA-CP calculates its own score of cloning profitability heuristics
10445 and performs those cloning opportunities with scores that exceed
10446 @option{ipa-cp-eval-threshold}.
10448 @item ipa-cp-recursion-penalty
10449 Percentage penalty the recursive functions will receive when they
10450 are evaluated for cloning.
10452 @item ipa-cp-single-call-penalty
10453 Percentage penalty functions containing a single call to another
10454 function will receive when they are evaluated for cloning.
10457 @item ipa-max-agg-items
10458 IPA-CP is also capable to propagate a number of scalar values passed
10459 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10460 number of such values per one parameter.
10462 @item ipa-cp-loop-hint-bonus
10463 When IPA-CP determines that a cloning candidate would make the number
10464 of iterations of a loop known, it adds a bonus of
10465 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10466 the candidate.
10468 @item ipa-cp-array-index-hint-bonus
10469 When IPA-CP determines that a cloning candidate would make the index of
10470 an array access known, it adds a bonus of
10471 @option{ipa-cp-array-index-hint-bonus} to the profitability
10472 score of the candidate.
10474 @item ipa-max-aa-steps
10475 During its analysis of function bodies, IPA-CP employs alias analysis
10476 in order to track values pointed to by function parameters.  In order
10477 not spend too much time analyzing huge functions, it gives up and
10478 consider all memory clobbered after examining
10479 @option{ipa-max-aa-steps} statements modifying memory.
10481 @item lto-partitions
10482 Specify desired number of partitions produced during WHOPR compilation.
10483 The number of partitions should exceed the number of CPUs used for compilation.
10484 The default value is 32.
10486 @item lto-min-partition
10487 Size of minimal partition for WHOPR (in estimated instructions).
10488 This prevents expenses of splitting very small programs into too many
10489 partitions.
10491 @item lto-max-partition
10492 Size of max partition for WHOPR (in estimated instructions).
10493 to provide an upper bound for individual size of partition.
10494 Meant to be used only with balanced partitioning.
10496 @item cxx-max-namespaces-for-diagnostic-help
10497 The maximum number of namespaces to consult for suggestions when C++
10498 name lookup fails for an identifier.  The default is 1000.
10500 @item sink-frequency-threshold
10501 The maximum relative execution frequency (in percents) of the target block
10502 relative to a statement's original block to allow statement sinking of a
10503 statement.  Larger numbers result in more aggressive statement sinking.
10504 The default value is 75.  A small positive adjustment is applied for
10505 statements with memory operands as those are even more profitable so sink.
10507 @item max-stores-to-sink
10508 The maximum number of conditional store pairs that can be sunk.  Set to 0
10509 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10510 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10512 @item allow-store-data-races
10513 Allow optimizers to introduce new data races on stores.
10514 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10515 at optimization level @option{-Ofast}.
10517 @item case-values-threshold
10518 The smallest number of different values for which it is best to use a
10519 jump-table instead of a tree of conditional branches.  If the value is
10520 0, use the default for the machine.  The default is 0.
10522 @item tree-reassoc-width
10523 Set the maximum number of instructions executed in parallel in
10524 reassociated tree. This parameter overrides target dependent
10525 heuristics used by default if has non zero value.
10527 @item sched-pressure-algorithm
10528 Choose between the two available implementations of
10529 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10530 and is the more likely to prevent instructions from being reordered.
10531 Algorithm 2 was designed to be a compromise between the relatively
10532 conservative approach taken by algorithm 1 and the rather aggressive
10533 approach taken by the default scheduler.  It relies more heavily on
10534 having a regular register file and accurate register pressure classes.
10535 See @file{haifa-sched.c} in the GCC sources for more details.
10537 The default choice depends on the target.
10539 @item max-slsr-cand-scan
10540 Set the maximum number of existing candidates that are considered when
10541 seeking a basis for a new straight-line strength reduction candidate.
10543 @item asan-globals
10544 Enable buffer overflow detection for global objects.  This kind
10545 of protection is enabled by default if you are using
10546 @option{-fsanitize=address} option.
10547 To disable global objects protection use @option{--param asan-globals=0}.
10549 @item asan-stack
10550 Enable buffer overflow detection for stack objects.  This kind of
10551 protection is enabled by default when using @option{-fsanitize=address}.
10552 To disable stack protection use @option{--param asan-stack=0} option.
10554 @item asan-instrument-reads
10555 Enable buffer overflow detection for memory reads.  This kind of
10556 protection is enabled by default when using @option{-fsanitize=address}.
10557 To disable memory reads protection use
10558 @option{--param asan-instrument-reads=0}.
10560 @item asan-instrument-writes
10561 Enable buffer overflow detection for memory writes.  This kind of
10562 protection is enabled by default when using @option{-fsanitize=address}.
10563 To disable memory writes protection use
10564 @option{--param asan-instrument-writes=0} option.
10566 @item asan-memintrin
10567 Enable detection for built-in functions.  This kind of protection
10568 is enabled by default when using @option{-fsanitize=address}.
10569 To disable built-in functions protection use
10570 @option{--param asan-memintrin=0}.
10572 @item asan-use-after-return
10573 Enable detection of use-after-return.  This kind of protection
10574 is enabled by default when using the @option{-fsanitize=address} option.
10575 To disable it use @option{--param asan-use-after-return=0}.
10577 Note: By default the check is disabled at run time.  To enable it,
10578 add @code{detect_stack_use_after_return=1} to the environment variable
10579 @env{ASAN_OPTIONS}.
10581 @item asan-instrumentation-with-call-threshold
10582 If number of memory accesses in function being instrumented
10583 is greater or equal to this number, use callbacks instead of inline checks.
10584 E.g. to disable inline code use
10585 @option{--param asan-instrumentation-with-call-threshold=0}.
10587 @item use-after-scope-direct-emission-threshold
10588 If the size of a local variable in bytes is smaller or equal to this
10589 number, directly poison (or unpoison) shadow memory instead of using
10590 run-time callbacks.  The default value is 256.
10592 @item chkp-max-ctor-size
10593 Static constructors generated by Pointer Bounds Checker may become very
10594 large and significantly increase compile time at optimization level
10595 @option{-O1} and higher.  This parameter is a maximum number of statements
10596 in a single generated constructor.  Default value is 5000.
10598 @item max-fsm-thread-path-insns
10599 Maximum number of instructions to copy when duplicating blocks on a
10600 finite state automaton jump thread path.  The default is 100.
10602 @item max-fsm-thread-length
10603 Maximum number of basic blocks on a finite state automaton jump thread
10604 path.  The default is 10.
10606 @item max-fsm-thread-paths
10607 Maximum number of new jump thread paths to create for a finite state
10608 automaton.  The default is 50.
10610 @item parloops-chunk-size
10611 Chunk size of omp schedule for loops parallelized by parloops.  The default
10612 is 0.
10614 @item parloops-schedule
10615 Schedule type of omp schedule for loops parallelized by parloops (static,
10616 dynamic, guided, auto, runtime).  The default is static.
10618 @item max-ssa-name-query-depth
10619 Maximum depth of recursion when querying properties of SSA names in things
10620 like fold routines.  One level of recursion corresponds to following a
10621 use-def chain.
10623 @item hsa-gen-debug-stores
10624 Enable emission of special debug stores within HSA kernels which are
10625 then read and reported by libgomp plugin.  Generation of these stores
10626 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10627 enable it.
10629 @item max-speculative-devirt-maydefs
10630 The maximum number of may-defs we analyze when looking for a must-def
10631 specifying the dynamic type of an object that invokes a virtual call
10632 we may be able to devirtualize speculatively.
10634 @item max-vrp-switch-assertions
10635 The maximum number of assertions to add along the default edge of a switch
10636 statement during VRP.  The default is 10.
10637 @end table
10638 @end table
10640 @node Instrumentation Options
10641 @section Program Instrumentation Options
10642 @cindex instrumentation options
10643 @cindex program instrumentation options
10644 @cindex run-time error checking options
10645 @cindex profiling options
10646 @cindex options, program instrumentation
10647 @cindex options, run-time error checking
10648 @cindex options, profiling
10650 GCC supports a number of command-line options that control adding
10651 run-time instrumentation to the code it normally generates.  
10652 For example, one purpose of instrumentation is collect profiling
10653 statistics for use in finding program hot spots, code coverage
10654 analysis, or profile-guided optimizations.
10655 Another class of program instrumentation is adding run-time checking 
10656 to detect programming errors like invalid pointer
10657 dereferences or out-of-bounds array accesses, as well as deliberately
10658 hostile attacks such as stack smashing or C++ vtable hijacking.
10659 There is also a general hook which can be used to implement other
10660 forms of tracing or function-level instrumentation for debug or
10661 program analysis purposes.
10663 @table @gcctabopt
10664 @cindex @command{prof}
10665 @item -p
10666 @opindex p
10667 Generate extra code to write profile information suitable for the
10668 analysis program @command{prof}.  You must use this option when compiling
10669 the source files you want data about, and you must also use it when
10670 linking.
10672 @cindex @command{gprof}
10673 @item -pg
10674 @opindex pg
10675 Generate extra code to write profile information suitable for the
10676 analysis program @command{gprof}.  You must use this option when compiling
10677 the source files you want data about, and you must also use it when
10678 linking.
10680 @item -fprofile-arcs
10681 @opindex fprofile-arcs
10682 Add code so that program flow @dfn{arcs} are instrumented.  During
10683 execution the program records how many times each branch and call is
10684 executed and how many times it is taken or returns.  On targets that support
10685 constructors with priority support, profiling properly handles constructors,
10686 destructors and C++ constructors (and destructors) of classes which are used
10687 as a type of a global variable.
10689 When the compiled
10690 program exits it saves this data to a file called
10691 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10692 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10693 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10694 @var{auxname} is generated from the name of the output file, if
10695 explicitly specified and it is not the final executable, otherwise it is
10696 the basename of the source file.  In both cases any suffix is removed
10697 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10698 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10699 @xref{Cross-profiling}.
10701 @cindex @command{gcov}
10702 @item --coverage
10703 @opindex coverage
10705 This option is used to compile and link code instrumented for coverage
10706 analysis.  The option is a synonym for @option{-fprofile-arcs}
10707 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10708 linking).  See the documentation for those options for more details.
10710 @itemize
10712 @item
10713 Compile the source files with @option{-fprofile-arcs} plus optimization
10714 and code generation options.  For test coverage analysis, use the
10715 additional @option{-ftest-coverage} option.  You do not need to profile
10716 every source file in a program.
10718 @item
10719 Compile the source files additionally with @option{-fprofile-abs-path}
10720 to create absolute path names in the @file{.gcno} files.  This allows
10721 @command{gcov} to find the correct sources in projects where compilations
10722 occur with different working directories.
10724 @item
10725 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10726 (the latter implies the former).
10728 @item
10729 Run the program on a representative workload to generate the arc profile
10730 information.  This may be repeated any number of times.  You can run
10731 concurrent instances of your program, and provided that the file system
10732 supports locking, the data files will be correctly updated.  Also
10733 @code{fork} calls are detected and correctly handled (double counting
10734 will not happen).
10736 @item
10737 For profile-directed optimizations, compile the source files again with
10738 the same optimization and code generation options plus
10739 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10740 Control Optimization}).
10742 @item
10743 For test coverage analysis, use @command{gcov} to produce human readable
10744 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10745 @command{gcov} documentation for further information.
10747 @end itemize
10749 With @option{-fprofile-arcs}, for each function of your program GCC
10750 creates a program flow graph, then finds a spanning tree for the graph.
10751 Only arcs that are not on the spanning tree have to be instrumented: the
10752 compiler adds code to count the number of times that these arcs are
10753 executed.  When an arc is the only exit or only entrance to a block, the
10754 instrumentation code can be added to the block; otherwise, a new basic
10755 block must be created to hold the instrumentation code.
10757 @need 2000
10758 @item -ftest-coverage
10759 @opindex ftest-coverage
10760 Produce a notes file that the @command{gcov} code-coverage utility
10761 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10762 show program coverage.  Each source file's note file is called
10763 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10764 above for a description of @var{auxname} and instructions on how to
10765 generate test coverage data.  Coverage data matches the source files
10766 more closely if you do not optimize.
10768 @item -fprofile-abs-path
10769 @opindex fprofile-abs-path
10770 Automatically convert relative source file names to absolute path names
10771 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10772 sources in projects where compilations occur with different working
10773 directories.
10775 @item -fprofile-dir=@var{path}
10776 @opindex fprofile-dir
10778 Set the directory to search for the profile data files in to @var{path}.
10779 This option affects only the profile data generated by
10780 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10781 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10782 and its related options.  Both absolute and relative paths can be used.
10783 By default, GCC uses the current directory as @var{path}, thus the
10784 profile data file appears in the same directory as the object file.
10786 @item -fprofile-generate
10787 @itemx -fprofile-generate=@var{path}
10788 @opindex fprofile-generate
10790 Enable options usually used for instrumenting application to produce
10791 profile useful for later recompilation with profile feedback based
10792 optimization.  You must use @option{-fprofile-generate} both when
10793 compiling and when linking your program.
10795 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10797 If @var{path} is specified, GCC looks at the @var{path} to find
10798 the profile feedback data files. See @option{-fprofile-dir}.
10800 To optimize the program based on the collected profile information, use
10801 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10803 @item -fprofile-update=@var{method}
10804 @opindex fprofile-update
10806 Alter the update method for an application instrumented for profile
10807 feedback based optimization.  The @var{method} argument should be one of
10808 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10809 The first one is useful for single-threaded applications,
10810 while the second one prevents profile corruption by emitting thread-safe code.
10812 @strong{Warning:} When an application does not properly join all threads
10813 (or creates an detached thread), a profile file can be still corrupted.
10815 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10816 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10817 automatically selects @samp{prefer-atomic} when @option{-pthread}
10818 is present in the command line.
10820 @item -fsanitize=address
10821 @opindex fsanitize=address
10822 Enable AddressSanitizer, a fast memory error detector.
10823 Memory access instructions are instrumented to detect
10824 out-of-bounds and use-after-free bugs.
10825 The option enables @option{-fsanitize-address-use-after-scope}.
10826 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10827 more details.  The run-time behavior can be influenced using the
10828 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10829 the available options are shown at startup of the instrumented program.  See
10830 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10831 for a list of supported options.
10832 The option cannot be combined with @option{-fsanitize=thread}
10833 and/or @option{-fcheck-pointer-bounds}.
10835 @item -fsanitize=kernel-address
10836 @opindex fsanitize=kernel-address
10837 Enable AddressSanitizer for Linux kernel.
10838 See @uref{https://github.com/google/kasan/wiki} for more details.
10839 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10841 @item -fsanitize=thread
10842 @opindex fsanitize=thread
10843 Enable ThreadSanitizer, a fast data race detector.
10844 Memory access instructions are instrumented to detect
10845 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10846 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10847 environment variable; see
10848 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10849 supported options.
10850 The option cannot be combined with @option{-fsanitize=address},
10851 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10853 Note that sanitized atomic builtins cannot throw exceptions when
10854 operating on invalid memory addresses with non-call exceptions
10855 (@option{-fnon-call-exceptions}).
10857 @item -fsanitize=leak
10858 @opindex fsanitize=leak
10859 Enable LeakSanitizer, a memory leak detector.
10860 This option only matters for linking of executables and
10861 the executable is linked against a library that overrides @code{malloc}
10862 and other allocator functions.  See
10863 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10864 details.  The run-time behavior can be influenced using the
10865 @env{LSAN_OPTIONS} environment variable.
10866 The option cannot be combined with @option{-fsanitize=thread}.
10868 @item -fsanitize=undefined
10869 @opindex fsanitize=undefined
10870 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10871 Various computations are instrumented to detect undefined behavior
10872 at runtime.  Current suboptions are:
10874 @table @gcctabopt
10876 @item -fsanitize=shift
10877 @opindex fsanitize=shift
10878 This option enables checking that the result of a shift operation is
10879 not undefined.  Note that what exactly is considered undefined differs
10880 slightly between C and C++, as well as between ISO C90 and C99, etc.
10881 This option has two suboptions, @option{-fsanitize=shift-base} and
10882 @option{-fsanitize=shift-exponent}.
10884 @item -fsanitize=shift-exponent
10885 @opindex fsanitize=shift-exponent
10886 This option enables checking that the second argument of a shift operation
10887 is not negative and is smaller than the precision of the promoted first
10888 argument.
10890 @item -fsanitize=shift-base
10891 @opindex fsanitize=shift-base
10892 If the second argument of a shift operation is within range, check that the
10893 result of a shift operation is not undefined.  Note that what exactly is
10894 considered undefined differs slightly between C and C++, as well as between
10895 ISO C90 and C99, etc.
10897 @item -fsanitize=integer-divide-by-zero
10898 @opindex fsanitize=integer-divide-by-zero
10899 Detect integer division by zero as well as @code{INT_MIN / -1} division.
10901 @item -fsanitize=unreachable
10902 @opindex fsanitize=unreachable
10903 With this option, the compiler turns the @code{__builtin_unreachable}
10904 call into a diagnostics message call instead.  When reaching the
10905 @code{__builtin_unreachable} call, the behavior is undefined.
10907 @item -fsanitize=vla-bound
10908 @opindex fsanitize=vla-bound
10909 This option instructs the compiler to check that the size of a variable
10910 length array is positive.
10912 @item -fsanitize=null
10913 @opindex fsanitize=null
10914 This option enables pointer checking.  Particularly, the application
10915 built with this option turned on will issue an error message when it
10916 tries to dereference a NULL pointer, or if a reference (possibly an
10917 rvalue reference) is bound to a NULL pointer, or if a method is invoked
10918 on an object pointed by a NULL pointer.
10920 @item -fsanitize=return
10921 @opindex fsanitize=return
10922 This option enables return statement checking.  Programs
10923 built with this option turned on will issue an error message
10924 when the end of a non-void function is reached without actually
10925 returning a value.  This option works in C++ only.
10927 @item -fsanitize=signed-integer-overflow
10928 @opindex fsanitize=signed-integer-overflow
10929 This option enables signed integer overflow checking.  We check that
10930 the result of @code{+}, @code{*}, and both unary and binary @code{-}
10931 does not overflow in the signed arithmetics.  Note, integer promotion
10932 rules must be taken into account.  That is, the following is not an
10933 overflow:
10934 @smallexample
10935 signed char a = SCHAR_MAX;
10936 a++;
10937 @end smallexample
10939 @item -fsanitize=bounds
10940 @opindex fsanitize=bounds
10941 This option enables instrumentation of array bounds.  Various out of bounds
10942 accesses are detected.  Flexible array members, flexible array member-like
10943 arrays, and initializers of variables with static storage are not instrumented.
10944 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10946 @item -fsanitize=bounds-strict
10947 @opindex fsanitize=bounds-strict
10948 This option enables strict instrumentation of array bounds.  Most out of bounds
10949 accesses are detected, including flexible array members and flexible array
10950 member-like arrays.  Initializers of variables with static storage are not
10951 instrumented.  The option cannot be combined
10952 with @option{-fcheck-pointer-bounds}.
10954 @item -fsanitize=alignment
10955 @opindex fsanitize=alignment
10957 This option enables checking of alignment of pointers when they are
10958 dereferenced, or when a reference is bound to insufficiently aligned target,
10959 or when a method or constructor is invoked on insufficiently aligned object.
10961 @item -fsanitize=object-size
10962 @opindex fsanitize=object-size
10963 This option enables instrumentation of memory references using the
10964 @code{__builtin_object_size} function.  Various out of bounds pointer
10965 accesses are detected.
10967 @item -fsanitize=float-divide-by-zero
10968 @opindex fsanitize=float-divide-by-zero
10969 Detect floating-point division by zero.  Unlike other similar options,
10970 @option{-fsanitize=float-divide-by-zero} is not enabled by
10971 @option{-fsanitize=undefined}, since floating-point division by zero can
10972 be a legitimate way of obtaining infinities and NaNs.
10974 @item -fsanitize=float-cast-overflow
10975 @opindex fsanitize=float-cast-overflow
10976 This option enables floating-point type to integer conversion checking.
10977 We check that the result of the conversion does not overflow.
10978 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
10979 not enabled by @option{-fsanitize=undefined}.
10980 This option does not work well with @code{FE_INVALID} exceptions enabled.
10982 @item -fsanitize=nonnull-attribute
10983 @opindex fsanitize=nonnull-attribute
10985 This option enables instrumentation of calls, checking whether null values
10986 are not passed to arguments marked as requiring a non-null value by the
10987 @code{nonnull} function attribute.
10989 @item -fsanitize=returns-nonnull-attribute
10990 @opindex fsanitize=returns-nonnull-attribute
10992 This option enables instrumentation of return statements in functions
10993 marked with @code{returns_nonnull} function attribute, to detect returning
10994 of null values from such functions.
10996 @item -fsanitize=bool
10997 @opindex fsanitize=bool
10999 This option enables instrumentation of loads from bool.  If a value other
11000 than 0/1 is loaded, a run-time error is issued.
11002 @item -fsanitize=enum
11003 @opindex fsanitize=enum
11005 This option enables instrumentation of loads from an enum type.  If
11006 a value outside the range of values for the enum type is loaded,
11007 a run-time error is issued.
11009 @item -fsanitize=vptr
11010 @opindex fsanitize=vptr
11012 This option enables instrumentation of C++ member function calls, member
11013 accesses and some conversions between pointers to base and derived classes,
11014 to verify the referenced object has the correct dynamic type.
11016 @end table
11018 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11019 @option{-fsanitize=undefined} gives a diagnostic message.
11020 This currently works only for the C family of languages.
11022 @item -fno-sanitize=all
11023 @opindex fno-sanitize=all
11025 This option disables all previously enabled sanitizers.
11026 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11027 together.
11029 @item -fasan-shadow-offset=@var{number}
11030 @opindex fasan-shadow-offset
11031 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11032 It is useful for experimenting with different shadow memory layouts in
11033 Kernel AddressSanitizer.
11035 @item -fsanitize-sections=@var{s1},@var{s2},...
11036 @opindex fsanitize-sections
11037 Sanitize global variables in selected user-defined sections.  @var{si} may
11038 contain wildcards.
11040 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11041 @opindex fsanitize-recover
11042 @opindex fno-sanitize-recover
11043 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11044 mentioned in comma-separated list of @var{opts}.  Enabling this option
11045 for a sanitizer component causes it to attempt to continue
11046 running the program as if no error happened.  This means multiple
11047 runtime errors can be reported in a single program run, and the exit
11048 code of the program may indicate success even when errors
11049 have been reported.  The @option{-fno-sanitize-recover=} option
11050 can be used to alter
11051 this behavior: only the first detected error is reported
11052 and program then exits with a non-zero exit code.
11054 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11055 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11056 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11057 @option{-fsanitize=bounds-strict},
11058 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11059 For these sanitizers error recovery is turned on by default,
11060 except @option{-fsanitize=address}, for which this feature is experimental.
11061 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11062 accepted, the former enables recovery for all sanitizers that support it,
11063 the latter disables recovery for all sanitizers that support it.
11065 Even if a recovery mode is turned on the compiler side, it needs to be also
11066 enabled on the runtime library side, otherwise the failures are still fatal.
11067 The runtime library defaults to @code{halt_on_error=0} for
11068 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11069 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11070 setting the @code{halt_on_error} flag in the corresponding environment variable.
11072 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11073 equivalent to specifying an @var{opts} list of:
11075 @smallexample
11076 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11077 @end smallexample
11079 @item -fsanitize-address-use-after-scope
11080 @opindex fsanitize-address-use-after-scope
11081 Enable sanitization of local variables to detect use-after-scope bugs.
11082 The option sets @option{-fstack-reuse} to @samp{none}.
11084 @item -fsanitize-undefined-trap-on-error
11085 @opindex fsanitize-undefined-trap-on-error
11086 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11087 report undefined behavior using @code{__builtin_trap} rather than
11088 a @code{libubsan} library routine.  The advantage of this is that the
11089 @code{libubsan} library is not needed and is not linked in, so this
11090 is usable even in freestanding environments.
11092 @item -fsanitize-coverage=trace-pc
11093 @opindex fsanitize-coverage=trace-pc
11094 Enable coverage-guided fuzzing code instrumentation.
11095 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11097 @item -fbounds-check
11098 @opindex fbounds-check
11099 For front ends that support it, generate additional code to check that
11100 indices used to access arrays are within the declared range.  This is
11101 currently only supported by the Fortran front end, where this option
11102 defaults to false.
11104 @item -fcheck-pointer-bounds
11105 @opindex fcheck-pointer-bounds
11106 @opindex fno-check-pointer-bounds
11107 @cindex Pointer Bounds Checker options
11108 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11109 is instrumented with checks of the pointer used for memory access against
11110 bounds associated with that pointer.  
11112 Currently there
11113 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11114 and @option{-mmpx} are required to enable this feature.  
11115 MPX-based instrumentation requires
11116 a runtime library to enable MPX in hardware and handle bounds
11117 violation signals.  By default when @option{-fcheck-pointer-bounds}
11118 and @option{-mmpx} options are used to link a program, the GCC driver
11119 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11120 Bounds checking on calls to dynamic libraries requires a linker
11121 with @option{-z bndplt} support; if GCC was configured with a linker
11122 without support for this option (including the Gold linker and older
11123 versions of ld), a warning is given if you link with @option{-mmpx}
11124 without also specifying @option{-static}, since the overall effectiveness
11125 of the bounds checking protection is reduced.
11126 See also @option{-static-libmpxwrappers}.
11128 MPX-based instrumentation
11129 may be used for debugging and also may be included in production code
11130 to increase program security.  Depending on usage, you may
11131 have different requirements for the runtime library.  The current version
11132 of the MPX runtime library is more oriented for use as a debugging
11133 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11134 also @option{-static-libmpx}.  The runtime library  behavior can be
11135 influenced using various @env{CHKP_RT_*} environment variables.  See
11136 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11137 for more details.
11139 Generated instrumentation may be controlled by various
11140 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11141 structure field attribute (@pxref{Type Attributes}) and
11142 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11143 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11144 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11145 Bounds Checker builtins}, for more information.
11147 @item -fchkp-check-incomplete-type
11148 @opindex fchkp-check-incomplete-type
11149 @opindex fno-chkp-check-incomplete-type
11150 Generate pointer bounds checks for variables with incomplete type.
11151 Enabled by default.
11153 @item -fchkp-narrow-bounds
11154 @opindex fchkp-narrow-bounds
11155 @opindex fno-chkp-narrow-bounds
11156 Controls bounds used by Pointer Bounds Checker for pointers to object
11157 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11158 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11159 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11161 @item -fchkp-first-field-has-own-bounds
11162 @opindex fchkp-first-field-has-own-bounds
11163 @opindex fno-chkp-first-field-has-own-bounds
11164 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11165 first field in the structure.  By default a pointer to the first field has
11166 the same bounds as a pointer to the whole structure.
11168 @item -fchkp-flexible-struct-trailing-arrays
11169 @opindex fchkp-flexible-struct-trailing-arrays
11170 @opindex fno-chkp-flexible-struct-trailing-arrays
11171 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11172 possibly flexible.  By default only array fields with zero length or that are
11173 marked with attribute bnd_variable_size are treated as flexible.
11175 @item -fchkp-narrow-to-innermost-array
11176 @opindex fchkp-narrow-to-innermost-array
11177 @opindex fno-chkp-narrow-to-innermost-array
11178 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11179 case of nested static array access.  By default this option is disabled and
11180 bounds of the outermost array are used.
11182 @item -fchkp-optimize
11183 @opindex fchkp-optimize
11184 @opindex fno-chkp-optimize
11185 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11186 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11188 @item -fchkp-use-fast-string-functions
11189 @opindex fchkp-use-fast-string-functions
11190 @opindex fno-chkp-use-fast-string-functions
11191 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11192 by Pointer Bounds Checker.  Disabled by default.
11194 @item -fchkp-use-nochk-string-functions
11195 @opindex fchkp-use-nochk-string-functions
11196 @opindex fno-chkp-use-nochk-string-functions
11197 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11198 by Pointer Bounds Checker.  Disabled by default.
11200 @item -fchkp-use-static-bounds
11201 @opindex fchkp-use-static-bounds
11202 @opindex fno-chkp-use-static-bounds
11203 Allow Pointer Bounds Checker to generate static bounds holding
11204 bounds of static variables.  Enabled by default.
11206 @item -fchkp-use-static-const-bounds
11207 @opindex fchkp-use-static-const-bounds
11208 @opindex fno-chkp-use-static-const-bounds
11209 Use statically-initialized bounds for constant bounds instead of
11210 generating them each time they are required.  By default enabled when
11211 @option{-fchkp-use-static-bounds} is enabled.
11213 @item -fchkp-treat-zero-dynamic-size-as-infinite
11214 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11215 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11216 With this option, objects with incomplete type whose
11217 dynamically-obtained size is zero are treated as having infinite size
11218 instead by Pointer Bounds
11219 Checker.  This option may be helpful if a program is linked with a library
11220 missing size information for some symbols.  Disabled by default.
11222 @item -fchkp-check-read
11223 @opindex fchkp-check-read
11224 @opindex fno-chkp-check-read
11225 Instructs Pointer Bounds Checker to generate checks for all read
11226 accesses to memory.  Enabled by default.
11228 @item -fchkp-check-write
11229 @opindex fchkp-check-write
11230 @opindex fno-chkp-check-write
11231 Instructs Pointer Bounds Checker to generate checks for all write
11232 accesses to memory.  Enabled by default.
11234 @item -fchkp-store-bounds
11235 @opindex fchkp-store-bounds
11236 @opindex fno-chkp-store-bounds
11237 Instructs Pointer Bounds Checker to generate bounds stores for
11238 pointer writes.  Enabled by default.
11240 @item -fchkp-instrument-calls
11241 @opindex fchkp-instrument-calls
11242 @opindex fno-chkp-instrument-calls
11243 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11244 Enabled by default.
11246 @item -fchkp-instrument-marked-only
11247 @opindex fchkp-instrument-marked-only
11248 @opindex fno-chkp-instrument-marked-only
11249 Instructs Pointer Bounds Checker to instrument only functions
11250 marked with the @code{bnd_instrument} attribute
11251 (@pxref{Function Attributes}).  Disabled by default.
11253 @item -fchkp-use-wrappers
11254 @opindex fchkp-use-wrappers
11255 @opindex fno-chkp-use-wrappers
11256 Allows Pointer Bounds Checker to replace calls to built-in functions
11257 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11258 is used to link a program, the GCC driver automatically links
11259 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11260 Enabled by default.
11262 @item -fstack-protector
11263 @opindex fstack-protector
11264 Emit extra code to check for buffer overflows, such as stack smashing
11265 attacks.  This is done by adding a guard variable to functions with
11266 vulnerable objects.  This includes functions that call @code{alloca}, and
11267 functions with buffers larger than 8 bytes.  The guards are initialized
11268 when a function is entered and then checked when the function exits.
11269 If a guard check fails, an error message is printed and the program exits.
11271 @item -fstack-protector-all
11272 @opindex fstack-protector-all
11273 Like @option{-fstack-protector} except that all functions are protected.
11275 @item -fstack-protector-strong
11276 @opindex fstack-protector-strong
11277 Like @option{-fstack-protector} but includes additional functions to
11278 be protected --- those that have local array definitions, or have
11279 references to local frame addresses.
11281 @item -fstack-protector-explicit
11282 @opindex fstack-protector-explicit
11283 Like @option{-fstack-protector} but only protects those functions which
11284 have the @code{stack_protect} attribute.
11286 @item -fstack-check
11287 @opindex fstack-check
11288 Generate code to verify that you do not go beyond the boundary of the
11289 stack.  You should specify this flag if you are running in an
11290 environment with multiple threads, but you only rarely need to specify it in
11291 a single-threaded environment since stack overflow is automatically
11292 detected on nearly all systems if there is only one stack.
11294 Note that this switch does not actually cause checking to be done; the
11295 operating system or the language runtime must do that.  The switch causes
11296 generation of code to ensure that they see the stack being extended.
11298 You can additionally specify a string parameter: @samp{no} means no
11299 checking, @samp{generic} means force the use of old-style checking,
11300 @samp{specific} means use the best checking method and is equivalent
11301 to bare @option{-fstack-check}.
11303 Old-style checking is a generic mechanism that requires no specific
11304 target support in the compiler but comes with the following drawbacks:
11306 @enumerate
11307 @item
11308 Modified allocation strategy for large objects: they are always
11309 allocated dynamically if their size exceeds a fixed threshold.
11311 @item
11312 Fixed limit on the size of the static frame of functions: when it is
11313 topped by a particular function, stack checking is not reliable and
11314 a warning is issued by the compiler.
11316 @item
11317 Inefficiency: because of both the modified allocation strategy and the
11318 generic implementation, code performance is hampered.
11319 @end enumerate
11321 Note that old-style stack checking is also the fallback method for
11322 @samp{specific} if no target support has been added in the compiler.
11324 @item -fstack-limit-register=@var{reg}
11325 @itemx -fstack-limit-symbol=@var{sym}
11326 @itemx -fno-stack-limit
11327 @opindex fstack-limit-register
11328 @opindex fstack-limit-symbol
11329 @opindex fno-stack-limit
11330 Generate code to ensure that the stack does not grow beyond a certain value,
11331 either the value of a register or the address of a symbol.  If a larger
11332 stack is required, a signal is raised at run time.  For most targets,
11333 the signal is raised before the stack overruns the boundary, so
11334 it is possible to catch the signal without taking special precautions.
11336 For instance, if the stack starts at absolute address @samp{0x80000000}
11337 and grows downwards, you can use the flags
11338 @option{-fstack-limit-symbol=__stack_limit} and
11339 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11340 of 128KB@.  Note that this may only work with the GNU linker.
11342 You can locally override stack limit checking by using the
11343 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11345 @item -fsplit-stack
11346 @opindex fsplit-stack
11347 Generate code to automatically split the stack before it overflows.
11348 The resulting program has a discontiguous stack which can only
11349 overflow if the program is unable to allocate any more memory.  This
11350 is most useful when running threaded programs, as it is no longer
11351 necessary to calculate a good stack size to use for each thread.  This
11352 is currently only implemented for the x86 targets running
11353 GNU/Linux.
11355 When code compiled with @option{-fsplit-stack} calls code compiled
11356 without @option{-fsplit-stack}, there may not be much stack space
11357 available for the latter code to run.  If compiling all code,
11358 including library code, with @option{-fsplit-stack} is not an option,
11359 then the linker can fix up these calls so that the code compiled
11360 without @option{-fsplit-stack} always has a large stack.  Support for
11361 this is implemented in the gold linker in GNU binutils release 2.21
11362 and later.
11364 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11365 @opindex fvtable-verify
11366 This option is only available when compiling C++ code.
11367 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11368 feature that verifies at run time, for every virtual call, that
11369 the vtable pointer through which the call is made is valid for the type of
11370 the object, and has not been corrupted or overwritten.  If an invalid vtable
11371 pointer is detected at run time, an error is reported and execution of the
11372 program is immediately halted.
11374 This option causes run-time data structures to be built at program startup,
11375 which are used for verifying the vtable pointers.  
11376 The options @samp{std} and @samp{preinit}
11377 control the timing of when these data structures are built.  In both cases the
11378 data structures are built before execution reaches @code{main}.  Using
11379 @option{-fvtable-verify=std} causes the data structures to be built after
11380 shared libraries have been loaded and initialized.
11381 @option{-fvtable-verify=preinit} causes them to be built before shared
11382 libraries have been loaded and initialized.
11384 If this option appears multiple times in the command line with different
11385 values specified, @samp{none} takes highest priority over both @samp{std} and
11386 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11388 @item -fvtv-debug
11389 @opindex fvtv-debug
11390 When used in conjunction with @option{-fvtable-verify=std} or 
11391 @option{-fvtable-verify=preinit}, causes debug versions of the 
11392 runtime functions for the vtable verification feature to be called.  
11393 This flag also causes the compiler to log information about which 
11394 vtable pointers it finds for each class.
11395 This information is written to a file named @file{vtv_set_ptr_data.log} 
11396 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11397 if that is defined or the current working directory otherwise.
11399 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11400 file, be sure to delete any existing one.
11402 @item -fvtv-counts
11403 @opindex fvtv-counts
11404 This is a debugging flag.  When used in conjunction with
11405 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11406 causes the compiler to keep track of the total number of virtual calls
11407 it encounters and the number of verifications it inserts.  It also
11408 counts the number of calls to certain run-time library functions
11409 that it inserts and logs this information for each compilation unit.
11410 The compiler writes this information to a file named
11411 @file{vtv_count_data.log} in the directory named by the environment
11412 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11413 directory otherwise.  It also counts the size of the vtable pointer sets
11414 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11415 in the same directory.
11417 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11418 files, be sure to delete any existing ones.
11420 @item -finstrument-functions
11421 @opindex finstrument-functions
11422 Generate instrumentation calls for entry and exit to functions.  Just
11423 after function entry and just before function exit, the following
11424 profiling functions are called with the address of the current
11425 function and its call site.  (On some platforms,
11426 @code{__builtin_return_address} does not work beyond the current
11427 function, so the call site information may not be available to the
11428 profiling functions otherwise.)
11430 @smallexample
11431 void __cyg_profile_func_enter (void *this_fn,
11432                                void *call_site);
11433 void __cyg_profile_func_exit  (void *this_fn,
11434                                void *call_site);
11435 @end smallexample
11437 The first argument is the address of the start of the current function,
11438 which may be looked up exactly in the symbol table.
11440 This instrumentation is also done for functions expanded inline in other
11441 functions.  The profiling calls indicate where, conceptually, the
11442 inline function is entered and exited.  This means that addressable
11443 versions of such functions must be available.  If all your uses of a
11444 function are expanded inline, this may mean an additional expansion of
11445 code size.  If you use @code{extern inline} in your C code, an
11446 addressable version of such functions must be provided.  (This is
11447 normally the case anyway, but if you get lucky and the optimizer always
11448 expands the functions inline, you might have gotten away without
11449 providing static copies.)
11451 A function may be given the attribute @code{no_instrument_function}, in
11452 which case this instrumentation is not done.  This can be used, for
11453 example, for the profiling functions listed above, high-priority
11454 interrupt routines, and any functions from which the profiling functions
11455 cannot safely be called (perhaps signal handlers, if the profiling
11456 routines generate output or allocate memory).
11458 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11459 @opindex finstrument-functions-exclude-file-list
11461 Set the list of functions that are excluded from instrumentation (see
11462 the description of @option{-finstrument-functions}).  If the file that
11463 contains a function definition matches with one of @var{file}, then
11464 that function is not instrumented.  The match is done on substrings:
11465 if the @var{file} parameter is a substring of the file name, it is
11466 considered to be a match.
11468 For example:
11470 @smallexample
11471 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11472 @end smallexample
11474 @noindent
11475 excludes any inline function defined in files whose pathnames
11476 contain @file{/bits/stl} or @file{include/sys}.
11478 If, for some reason, you want to include letter @samp{,} in one of
11479 @var{sym}, write @samp{\,}. For example,
11480 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11481 (note the single quote surrounding the option).
11483 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11484 @opindex finstrument-functions-exclude-function-list
11486 This is similar to @option{-finstrument-functions-exclude-file-list},
11487 but this option sets the list of function names to be excluded from
11488 instrumentation.  The function name to be matched is its user-visible
11489 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11490 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11491 match is done on substrings: if the @var{sym} parameter is a substring
11492 of the function name, it is considered to be a match.  For C99 and C++
11493 extended identifiers, the function name must be given in UTF-8, not
11494 using universal character names.
11496 @end table
11499 @node Preprocessor Options
11500 @section Options Controlling the Preprocessor
11501 @cindex preprocessor options
11502 @cindex options, preprocessor
11504 These options control the C preprocessor, which is run on each C source
11505 file before actual compilation.
11507 If you use the @option{-E} option, nothing is done except preprocessing.
11508 Some of these options make sense only together with @option{-E} because
11509 they cause the preprocessor output to be unsuitable for actual
11510 compilation.
11512 In addition to the options listed here, there are a number of options 
11513 to control search paths for include files documented in 
11514 @ref{Directory Options}.  
11515 Options to control preprocessor diagnostics are listed in 
11516 @ref{Warning Options}.
11518 @table @gcctabopt
11519 @include cppopts.texi
11521 @item -Wp,@var{option}
11522 @opindex Wp
11523 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11524 and pass @var{option} directly through to the preprocessor.  If
11525 @var{option} contains commas, it is split into multiple options at the
11526 commas.  However, many options are modified, translated or interpreted
11527 by the compiler driver before being passed to the preprocessor, and
11528 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11529 interface is undocumented and subject to change, so whenever possible
11530 you should avoid using @option{-Wp} and let the driver handle the
11531 options instead.
11533 @item -Xpreprocessor @var{option}
11534 @opindex Xpreprocessor
11535 Pass @var{option} as an option to the preprocessor.  You can use this to
11536 supply system-specific preprocessor options that GCC does not 
11537 recognize.
11539 If you want to pass an option that takes an argument, you must use
11540 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11542 @item -no-integrated-cpp
11543 @opindex no-integrated-cpp
11544 Perform preprocessing as a separate pass before compilation.
11545 By default, GCC performs preprocessing as an integrated part of
11546 input tokenization and parsing.
11547 If this option is provided, the appropriate language front end
11548 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11549 and Objective-C, respectively) is instead invoked twice,
11550 once for preprocessing only and once for actual compilation
11551 of the preprocessed input.
11552 This option may be useful in conjunction with the @option{-B} or
11553 @option{-wrapper} options to specify an alternate preprocessor or
11554 perform additional processing of the program source between
11555 normal preprocessing and compilation.
11557 @end table
11559 @node Assembler Options
11560 @section Passing Options to the Assembler
11562 @c prevent bad page break with this line
11563 You can pass options to the assembler.
11565 @table @gcctabopt
11566 @item -Wa,@var{option}
11567 @opindex Wa
11568 Pass @var{option} as an option to the assembler.  If @var{option}
11569 contains commas, it is split into multiple options at the commas.
11571 @item -Xassembler @var{option}
11572 @opindex Xassembler
11573 Pass @var{option} as an option to the assembler.  You can use this to
11574 supply system-specific assembler options that GCC does not
11575 recognize.
11577 If you want to pass an option that takes an argument, you must use
11578 @option{-Xassembler} twice, once for the option and once for the argument.
11580 @end table
11582 @node Link Options
11583 @section Options for Linking
11584 @cindex link options
11585 @cindex options, linking
11587 These options come into play when the compiler links object files into
11588 an executable output file.  They are meaningless if the compiler is
11589 not doing a link step.
11591 @table @gcctabopt
11592 @cindex file names
11593 @item @var{object-file-name}
11594 A file name that does not end in a special recognized suffix is
11595 considered to name an object file or library.  (Object files are
11596 distinguished from libraries by the linker according to the file
11597 contents.)  If linking is done, these object files are used as input
11598 to the linker.
11600 @item -c
11601 @itemx -S
11602 @itemx -E
11603 @opindex c
11604 @opindex S
11605 @opindex E
11606 If any of these options is used, then the linker is not run, and
11607 object file names should not be used as arguments.  @xref{Overall
11608 Options}.
11610 @item -fuse-ld=bfd
11611 @opindex fuse-ld=bfd
11612 Use the @command{bfd} linker instead of the default linker.
11614 @item -fuse-ld=gold
11615 @opindex fuse-ld=gold
11616 Use the @command{gold} linker instead of the default linker.
11618 @cindex Libraries
11619 @item -l@var{library}
11620 @itemx -l @var{library}
11621 @opindex l
11622 Search the library named @var{library} when linking.  (The second
11623 alternative with the library as a separate argument is only for
11624 POSIX compliance and is not recommended.)
11626 It makes a difference where in the command you write this option; the
11627 linker searches and processes libraries and object files in the order they
11628 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11629 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11630 to functions in @samp{z}, those functions may not be loaded.
11632 The linker searches a standard list of directories for the library,
11633 which is actually a file named @file{lib@var{library}.a}.  The linker
11634 then uses this file as if it had been specified precisely by name.
11636 The directories searched include several standard system directories
11637 plus any that you specify with @option{-L}.
11639 Normally the files found this way are library files---archive files
11640 whose members are object files.  The linker handles an archive file by
11641 scanning through it for members which define symbols that have so far
11642 been referenced but not defined.  But if the file that is found is an
11643 ordinary object file, it is linked in the usual fashion.  The only
11644 difference between using an @option{-l} option and specifying a file name
11645 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11646 and searches several directories.
11648 @item -lobjc
11649 @opindex lobjc
11650 You need this special case of the @option{-l} option in order to
11651 link an Objective-C or Objective-C++ program.
11653 @item -nostartfiles
11654 @opindex nostartfiles
11655 Do not use the standard system startup files when linking.
11656 The standard system libraries are used normally, unless @option{-nostdlib}
11657 or @option{-nodefaultlibs} is used.
11659 @item -nodefaultlibs
11660 @opindex nodefaultlibs
11661 Do not use the standard system libraries when linking.
11662 Only the libraries you specify are passed to the linker, and options
11663 specifying linkage of the system libraries, such as @option{-static-libgcc}
11664 or @option{-shared-libgcc}, are ignored.  
11665 The standard startup files are used normally, unless @option{-nostartfiles}
11666 is used.  
11668 The compiler may generate calls to @code{memcmp},
11669 @code{memset}, @code{memcpy} and @code{memmove}.
11670 These entries are usually resolved by entries in
11671 libc.  These entry points should be supplied through some other
11672 mechanism when this option is specified.
11674 @item -nostdlib
11675 @opindex nostdlib
11676 Do not use the standard system startup files or libraries when linking.
11677 No startup files and only the libraries you specify are passed to
11678 the linker, and options specifying linkage of the system libraries, such as
11679 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11681 The compiler may generate calls to @code{memcmp}, @code{memset},
11682 @code{memcpy} and @code{memmove}.
11683 These entries are usually resolved by entries in
11684 libc.  These entry points should be supplied through some other
11685 mechanism when this option is specified.
11687 @cindex @option{-lgcc}, use with @option{-nostdlib}
11688 @cindex @option{-nostdlib} and unresolved references
11689 @cindex unresolved references and @option{-nostdlib}
11690 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11691 @cindex @option{-nodefaultlibs} and unresolved references
11692 @cindex unresolved references and @option{-nodefaultlibs}
11693 One of the standard libraries bypassed by @option{-nostdlib} and
11694 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11695 which GCC uses to overcome shortcomings of particular machines, or special
11696 needs for some languages.
11697 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11698 Collection (GCC) Internals},
11699 for more discussion of @file{libgcc.a}.)
11700 In most cases, you need @file{libgcc.a} even when you want to avoid
11701 other standard libraries.  In other words, when you specify @option{-nostdlib}
11702 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11703 This ensures that you have no unresolved references to internal GCC
11704 library subroutines.
11705 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11706 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11707 GNU Compiler Collection (GCC) Internals}.)
11709 @item -pie
11710 @opindex pie
11711 Produce a position independent executable on targets that support it.
11712 For predictable results, you must also specify the same set of options
11713 used for compilation (@option{-fpie}, @option{-fPIE},
11714 or model suboptions) when you specify this linker option.
11716 @item -no-pie
11717 @opindex no-pie
11718 Don't produce a position independent executable.
11720 @item -pthread
11721 @opindex pthread
11722 Link with the POSIX threads library.  This option is supported on 
11723 GNU/Linux targets, most other Unix derivatives, and also on 
11724 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11725 flags for the preprocessor, so it should be used consistently for both
11726 compilation and linking.
11728 @item -rdynamic
11729 @opindex rdynamic
11730 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11731 that support it. This instructs the linker to add all symbols, not
11732 only used ones, to the dynamic symbol table. This option is needed
11733 for some uses of @code{dlopen} or to allow obtaining backtraces
11734 from within a program.
11736 @item -s
11737 @opindex s
11738 Remove all symbol table and relocation information from the executable.
11740 @item -static
11741 @opindex static
11742 On systems that support dynamic linking, this prevents linking with the shared
11743 libraries.  On other systems, this option has no effect.
11745 @item -shared
11746 @opindex shared
11747 Produce a shared object which can then be linked with other objects to
11748 form an executable.  Not all systems support this option.  For predictable
11749 results, you must also specify the same set of options used for compilation
11750 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11751 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11752 needs to build supplementary stub code for constructors to work.  On
11753 multi-libbed systems, @samp{gcc -shared} must select the correct support
11754 libraries to link against.  Failing to supply the correct flags may lead
11755 to subtle defects.  Supplying them in cases where they are not necessary
11756 is innocuous.}
11758 @item -shared-libgcc
11759 @itemx -static-libgcc
11760 @opindex shared-libgcc
11761 @opindex static-libgcc
11762 On systems that provide @file{libgcc} as a shared library, these options
11763 force the use of either the shared or static version, respectively.
11764 If no shared version of @file{libgcc} was built when the compiler was
11765 configured, these options have no effect.
11767 There are several situations in which an application should use the
11768 shared @file{libgcc} instead of the static version.  The most common
11769 of these is when the application wishes to throw and catch exceptions
11770 across different shared libraries.  In that case, each of the libraries
11771 as well as the application itself should use the shared @file{libgcc}.
11773 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11774  whenever you build a shared library or a main executable, because C++
11775  programs typically use exceptions, so this is the right thing to do.
11777 If, instead, you use the GCC driver to create shared libraries, you may
11778 find that they are not always linked with the shared @file{libgcc}.
11779 If GCC finds, at its configuration time, that you have a non-GNU linker
11780 or a GNU linker that does not support option @option{--eh-frame-hdr},
11781 it links the shared version of @file{libgcc} into shared libraries
11782 by default.  Otherwise, it takes advantage of the linker and optimizes
11783 away the linking with the shared version of @file{libgcc}, linking with
11784 the static version of libgcc by default.  This allows exceptions to
11785 propagate through such shared libraries, without incurring relocation
11786 costs at library load time.
11788 However, if a library or main executable is supposed to throw or catch
11789 exceptions, you must link it using the G++ driver, as appropriate
11790 for the languages used in the program, or using the option
11791 @option{-shared-libgcc}, such that it is linked with the shared
11792 @file{libgcc}.
11794 @item -static-libasan
11795 @opindex static-libasan
11796 When the @option{-fsanitize=address} option is used to link a program,
11797 the GCC driver automatically links against @option{libasan}.  If
11798 @file{libasan} is available as a shared library, and the @option{-static}
11799 option is not used, then this links against the shared version of
11800 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11801 driver to link @file{libasan} statically, without necessarily linking
11802 other libraries statically.
11804 @item -static-libtsan
11805 @opindex static-libtsan
11806 When the @option{-fsanitize=thread} option is used to link a program,
11807 the GCC driver automatically links against @option{libtsan}.  If
11808 @file{libtsan} is available as a shared library, and the @option{-static}
11809 option is not used, then this links against the shared version of
11810 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11811 driver to link @file{libtsan} statically, without necessarily linking
11812 other libraries statically.
11814 @item -static-liblsan
11815 @opindex static-liblsan
11816 When the @option{-fsanitize=leak} option is used to link a program,
11817 the GCC driver automatically links against @option{liblsan}.  If
11818 @file{liblsan} is available as a shared library, and the @option{-static}
11819 option is not used, then this links against the shared version of
11820 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11821 driver to link @file{liblsan} statically, without necessarily linking
11822 other libraries statically.
11824 @item -static-libubsan
11825 @opindex static-libubsan
11826 When the @option{-fsanitize=undefined} option is used to link a program,
11827 the GCC driver automatically links against @option{libubsan}.  If
11828 @file{libubsan} is available as a shared library, and the @option{-static}
11829 option is not used, then this links against the shared version of
11830 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11831 driver to link @file{libubsan} statically, without necessarily linking
11832 other libraries statically.
11834 @item -static-libmpx
11835 @opindex static-libmpx
11836 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11837 used to link a program, the GCC driver automatically links against
11838 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11839 and the @option{-static} option is not used, then this links against
11840 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11841 option directs the GCC driver to link @file{libmpx} statically,
11842 without necessarily linking other libraries statically.
11844 @item -static-libmpxwrappers
11845 @opindex static-libmpxwrappers
11846 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11847 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11848 GCC driver automatically links against @file{libmpxwrappers}.  If
11849 @file{libmpxwrappers} is available as a shared library, and the
11850 @option{-static} option is not used, then this links against the shared
11851 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11852 option directs the GCC driver to link @file{libmpxwrappers} statically,
11853 without necessarily linking other libraries statically.
11855 @item -static-libstdc++
11856 @opindex static-libstdc++
11857 When the @command{g++} program is used to link a C++ program, it
11858 normally automatically links against @option{libstdc++}.  If
11859 @file{libstdc++} is available as a shared library, and the
11860 @option{-static} option is not used, then this links against the
11861 shared version of @file{libstdc++}.  That is normally fine.  However, it
11862 is sometimes useful to freeze the version of @file{libstdc++} used by
11863 the program without going all the way to a fully static link.  The
11864 @option{-static-libstdc++} option directs the @command{g++} driver to
11865 link @file{libstdc++} statically, without necessarily linking other
11866 libraries statically.
11868 @item -symbolic
11869 @opindex symbolic
11870 Bind references to global symbols when building a shared object.  Warn
11871 about any unresolved references (unless overridden by the link editor
11872 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11873 this option.
11875 @item -T @var{script}
11876 @opindex T
11877 @cindex linker script
11878 Use @var{script} as the linker script.  This option is supported by most
11879 systems using the GNU linker.  On some targets, such as bare-board
11880 targets without an operating system, the @option{-T} option may be required
11881 when linking to avoid references to undefined symbols.
11883 @item -Xlinker @var{option}
11884 @opindex Xlinker
11885 Pass @var{option} as an option to the linker.  You can use this to
11886 supply system-specific linker options that GCC does not recognize.
11888 If you want to pass an option that takes a separate argument, you must use
11889 @option{-Xlinker} twice, once for the option and once for the argument.
11890 For example, to pass @option{-assert definitions}, you must write
11891 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11892 @option{-Xlinker "-assert definitions"}, because this passes the entire
11893 string as a single argument, which is not what the linker expects.
11895 When using the GNU linker, it is usually more convenient to pass
11896 arguments to linker options using the @option{@var{option}=@var{value}}
11897 syntax than as separate arguments.  For example, you can specify
11898 @option{-Xlinker -Map=output.map} rather than
11899 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11900 this syntax for command-line options.
11902 @item -Wl,@var{option}
11903 @opindex Wl
11904 Pass @var{option} as an option to the linker.  If @var{option} contains
11905 commas, it is split into multiple options at the commas.  You can use this
11906 syntax to pass an argument to the option.
11907 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11908 linker.  When using the GNU linker, you can also get the same effect with
11909 @option{-Wl,-Map=output.map}.
11911 @item -u @var{symbol}
11912 @opindex u
11913 Pretend the symbol @var{symbol} is undefined, to force linking of
11914 library modules to define it.  You can use @option{-u} multiple times with
11915 different symbols to force loading of additional library modules.
11917 @item -z @var{keyword}
11918 @opindex z
11919 @option{-z} is passed directly on to the linker along with the keyword
11920 @var{keyword}. See the section in the documentation of your linker for
11921 permitted values and their meanings.
11922 @end table
11924 @node Directory Options
11925 @section Options for Directory Search
11926 @cindex directory options
11927 @cindex options, directory search
11928 @cindex search path
11930 These options specify directories to search for header files, for
11931 libraries and for parts of the compiler:
11933 @table @gcctabopt
11934 @include cppdiropts.texi
11936 @item -iplugindir=@var{dir}
11937 @opindex iplugindir=
11938 Set the directory to search for plugins that are passed
11939 by @option{-fplugin=@var{name}} instead of
11940 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11941 to be used by the user, but only passed by the driver.
11943 @item -L@var{dir}
11944 @opindex L
11945 Add directory @var{dir} to the list of directories to be searched
11946 for @option{-l}.
11948 @item -B@var{prefix}
11949 @opindex B
11950 This option specifies where to find the executables, libraries,
11951 include files, and data files of the compiler itself.
11953 The compiler driver program runs one or more of the subprograms
11954 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11955 @var{prefix} as a prefix for each program it tries to run, both with and
11956 without @samp{@var{machine}/@var{version}/} for the corresponding target
11957 machine and compiler version.
11959 For each subprogram to be run, the compiler driver first tries the
11960 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11961 is not specified, the driver tries two standard prefixes, 
11962 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11963 those results in a file name that is found, the unmodified program
11964 name is searched for using the directories specified in your
11965 @env{PATH} environment variable.
11967 The compiler checks to see if the path provided by @option{-B}
11968 refers to a directory, and if necessary it adds a directory
11969 separator character at the end of the path.
11971 @option{-B} prefixes that effectively specify directory names also apply
11972 to libraries in the linker, because the compiler translates these
11973 options into @option{-L} options for the linker.  They also apply to
11974 include files in the preprocessor, because the compiler translates these
11975 options into @option{-isystem} options for the preprocessor.  In this case,
11976 the compiler appends @samp{include} to the prefix.
11978 The runtime support file @file{libgcc.a} can also be searched for using
11979 the @option{-B} prefix, if needed.  If it is not found there, the two
11980 standard prefixes above are tried, and that is all.  The file is left
11981 out of the link if it is not found by those means.
11983 Another way to specify a prefix much like the @option{-B} prefix is to use
11984 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11985 Variables}.
11987 As a special kludge, if the path provided by @option{-B} is
11988 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11989 9, then it is replaced by @file{[dir/]include}.  This is to help
11990 with boot-strapping the compiler.
11992 @item -no-canonical-prefixes
11993 @opindex no-canonical-prefixes
11994 Do not expand any symbolic links, resolve references to @samp{/../}
11995 or @samp{/./}, or make the path absolute when generating a relative
11996 prefix.
11998 @item --sysroot=@var{dir}
11999 @opindex sysroot
12000 Use @var{dir} as the logical root directory for headers and libraries.
12001 For example, if the compiler normally searches for headers in
12002 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12003 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12005 If you use both this option and the @option{-isysroot} option, then
12006 the @option{--sysroot} option applies to libraries, but the
12007 @option{-isysroot} option applies to header files.
12009 The GNU linker (beginning with version 2.16) has the necessary support
12010 for this option.  If your linker does not support this option, the
12011 header file aspect of @option{--sysroot} still works, but the
12012 library aspect does not.
12014 @item --no-sysroot-suffix
12015 @opindex no-sysroot-suffix
12016 For some targets, a suffix is added to the root directory specified
12017 with @option{--sysroot}, depending on the other options used, so that
12018 headers may for example be found in
12019 @file{@var{dir}/@var{suffix}/usr/include} instead of
12020 @file{@var{dir}/usr/include}.  This option disables the addition of
12021 such a suffix.
12023 @end table
12025 @node Code Gen Options
12026 @section Options for Code Generation Conventions
12027 @cindex code generation conventions
12028 @cindex options, code generation
12029 @cindex run-time options
12031 These machine-independent options control the interface conventions
12032 used in code generation.
12034 Most of them have both positive and negative forms; the negative form
12035 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12036 one of the forms is listed---the one that is not the default.  You
12037 can figure out the other form by either removing @samp{no-} or adding
12040 @table @gcctabopt
12041 @item -fstack-reuse=@var{reuse-level}
12042 @opindex fstack_reuse
12043 This option controls stack space reuse for user declared local/auto variables
12044 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12045 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12046 local variables and temporaries, @samp{named_vars} enables the reuse only for
12047 user defined local variables with names, and @samp{none} disables stack reuse
12048 completely. The default value is @samp{all}. The option is needed when the
12049 program extends the lifetime of a scoped local variable or a compiler generated
12050 temporary beyond the end point defined by the language.  When a lifetime of
12051 a variable ends, and if the variable lives in memory, the optimizing compiler
12052 has the freedom to reuse its stack space with other temporaries or scoped
12053 local variables whose live range does not overlap with it. Legacy code extending
12054 local lifetime is likely to break with the stack reuse optimization.
12056 For example,
12058 @smallexample
12059    int *p;
12060    @{
12061      int local1;
12063      p = &local1;
12064      local1 = 10;
12065      ....
12066    @}
12067    @{
12068       int local2;
12069       local2 = 20;
12070       ...
12071    @}
12073    if (*p == 10)  // out of scope use of local1
12074      @{
12076      @}
12077 @end smallexample
12079 Another example:
12080 @smallexample
12082    struct A
12083    @{
12084        A(int k) : i(k), j(k) @{ @}
12085        int i;
12086        int j;
12087    @};
12089    A *ap;
12091    void foo(const A& ar)
12092    @{
12093       ap = &ar;
12094    @}
12096    void bar()
12097    @{
12098       foo(A(10)); // temp object's lifetime ends when foo returns
12100       @{
12101         A a(20);
12102         ....
12103       @}
12104       ap->i+= 10;  // ap references out of scope temp whose space
12105                    // is reused with a. What is the value of ap->i?
12106    @}
12108 @end smallexample
12110 The lifetime of a compiler generated temporary is well defined by the C++
12111 standard. When a lifetime of a temporary ends, and if the temporary lives
12112 in memory, the optimizing compiler has the freedom to reuse its stack
12113 space with other temporaries or scoped local variables whose live range
12114 does not overlap with it. However some of the legacy code relies on
12115 the behavior of older compilers in which temporaries' stack space is
12116 not reused, the aggressive stack reuse can lead to runtime errors. This
12117 option is used to control the temporary stack reuse optimization.
12119 @item -ftrapv
12120 @opindex ftrapv
12121 This option generates traps for signed overflow on addition, subtraction,
12122 multiplication operations.
12123 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12124 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12125 @option{-fwrapv} being effective.  Note that only active options override, so
12126 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12127 results in @option{-ftrapv} being effective.
12129 @item -fwrapv
12130 @opindex fwrapv
12131 This option instructs the compiler to assume that signed arithmetic
12132 overflow of addition, subtraction and multiplication wraps around
12133 using twos-complement representation.  This flag enables some optimizations
12134 and disables others.
12135 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12136 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12137 @option{-fwrapv} being effective.  Note that only active options override, so
12138 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12139 results in @option{-ftrapv} being effective.
12141 @item -fexceptions
12142 @opindex fexceptions
12143 Enable exception handling.  Generates extra code needed to propagate
12144 exceptions.  For some targets, this implies GCC generates frame
12145 unwind information for all functions, which can produce significant data
12146 size overhead, although it does not affect execution.  If you do not
12147 specify this option, GCC enables it by default for languages like
12148 C++ that normally require exception handling, and disables it for
12149 languages like C that do not normally require it.  However, you may need
12150 to enable this option when compiling C code that needs to interoperate
12151 properly with exception handlers written in C++.  You may also wish to
12152 disable this option if you are compiling older C++ programs that don't
12153 use exception handling.
12155 @item -fnon-call-exceptions
12156 @opindex fnon-call-exceptions
12157 Generate code that allows trapping instructions to throw exceptions.
12158 Note that this requires platform-specific runtime support that does
12159 not exist everywhere.  Moreover, it only allows @emph{trapping}
12160 instructions to throw exceptions, i.e.@: memory references or floating-point
12161 instructions.  It does not allow exceptions to be thrown from
12162 arbitrary signal handlers such as @code{SIGALRM}.
12164 @item -fdelete-dead-exceptions
12165 @opindex fdelete-dead-exceptions
12166 Consider that instructions that may throw exceptions but don't otherwise
12167 contribute to the execution of the program can be optimized away.
12168 This option is enabled by default for the Ada front end, as permitted by
12169 the Ada language specification.
12170 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12172 @item -funwind-tables
12173 @opindex funwind-tables
12174 Similar to @option{-fexceptions}, except that it just generates any needed
12175 static data, but does not affect the generated code in any other way.
12176 You normally do not need to enable this option; instead, a language processor
12177 that needs this handling enables it on your behalf.
12179 @item -fasynchronous-unwind-tables
12180 @opindex fasynchronous-unwind-tables
12181 Generate unwind table in DWARF format, if supported by target machine.  The
12182 table is exact at each instruction boundary, so it can be used for stack
12183 unwinding from asynchronous events (such as debugger or garbage collector).
12185 @item -fno-gnu-unique
12186 @opindex fno-gnu-unique
12187 On systems with recent GNU assembler and C library, the C++ compiler
12188 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12189 of template static data members and static local variables in inline
12190 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12191 is necessary to avoid problems with a library used by two different
12192 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12193 therefore disagreeing with the other one about the binding of the
12194 symbol.  But this causes @code{dlclose} to be ignored for affected
12195 DSOs; if your program relies on reinitialization of a DSO via
12196 @code{dlclose} and @code{dlopen}, you can use
12197 @option{-fno-gnu-unique}.
12199 @item -fpcc-struct-return
12200 @opindex fpcc-struct-return
12201 Return ``short'' @code{struct} and @code{union} values in memory like
12202 longer ones, rather than in registers.  This convention is less
12203 efficient, but it has the advantage of allowing intercallability between
12204 GCC-compiled files and files compiled with other compilers, particularly
12205 the Portable C Compiler (pcc).
12207 The precise convention for returning structures in memory depends
12208 on the target configuration macros.
12210 Short structures and unions are those whose size and alignment match
12211 that of some integer type.
12213 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12214 switch is not binary compatible with code compiled with the
12215 @option{-freg-struct-return} switch.
12216 Use it to conform to a non-default application binary interface.
12218 @item -freg-struct-return
12219 @opindex freg-struct-return
12220 Return @code{struct} and @code{union} values in registers when possible.
12221 This is more efficient for small structures than
12222 @option{-fpcc-struct-return}.
12224 If you specify neither @option{-fpcc-struct-return} nor
12225 @option{-freg-struct-return}, GCC defaults to whichever convention is
12226 standard for the target.  If there is no standard convention, GCC
12227 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12228 the principal compiler.  In those cases, we can choose the standard, and
12229 we chose the more efficient register return alternative.
12231 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12232 switch is not binary compatible with code compiled with the
12233 @option{-fpcc-struct-return} switch.
12234 Use it to conform to a non-default application binary interface.
12236 @item -fshort-enums
12237 @opindex fshort-enums
12238 Allocate to an @code{enum} type only as many bytes as it needs for the
12239 declared range of possible values.  Specifically, the @code{enum} type
12240 is equivalent to the smallest integer type that has enough room.
12242 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12243 code that is not binary compatible with code generated without that switch.
12244 Use it to conform to a non-default application binary interface.
12246 @item -fshort-wchar
12247 @opindex fshort-wchar
12248 Override the underlying type for @code{wchar_t} to be @code{short
12249 unsigned int} instead of the default for the target.  This option is
12250 useful for building programs to run under WINE@.
12252 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12253 code that is not binary compatible with code generated without that switch.
12254 Use it to conform to a non-default application binary interface.
12256 @item -fno-common
12257 @opindex fno-common
12258 @cindex tentative definitions
12259 In C code, this option controls the placement of global variables 
12260 defined without an initializer, known as @dfn{tentative definitions} 
12261 in the C standard.  Tentative definitions are distinct from declarations 
12262 of a variable with the @code{extern} keyword, which do not allocate storage.
12264 Unix C compilers have traditionally allocated storage for
12265 uninitialized global variables in a common block.  This allows the
12266 linker to resolve all tentative definitions of the same variable
12267 in different compilation units to the same object, or to a non-tentative
12268 definition.  
12269 This is the behavior specified by @option{-fcommon}, and is the default for 
12270 GCC on most targets.  
12271 On the other hand, this behavior is not required by ISO
12272 C, and on some targets may carry a speed or code size penalty on
12273 variable references.
12275 The @option{-fno-common} option specifies that the compiler should instead
12276 place uninitialized global variables in the data section of the object file.
12277 This inhibits the merging of tentative definitions by the linker so
12278 you get a multiple-definition error if the same 
12279 variable is defined in more than one compilation unit.
12280 Compiling with @option{-fno-common} is useful on targets for which
12281 it provides better performance, or if you wish to verify that the
12282 program will work on other systems that always treat uninitialized
12283 variable definitions this way.
12285 @item -fno-ident
12286 @opindex fno-ident
12287 Ignore the @code{#ident} directive.
12289 @item -finhibit-size-directive
12290 @opindex finhibit-size-directive
12291 Don't output a @code{.size} assembler directive, or anything else that
12292 would cause trouble if the function is split in the middle, and the
12293 two halves are placed at locations far apart in memory.  This option is
12294 used when compiling @file{crtstuff.c}; you should not need to use it
12295 for anything else.
12297 @item -fverbose-asm
12298 @opindex fverbose-asm
12299 Put extra commentary information in the generated assembly code to
12300 make it more readable.  This option is generally only of use to those
12301 who actually need to read the generated assembly code (perhaps while
12302 debugging the compiler itself).
12304 @option{-fno-verbose-asm}, the default, causes the
12305 extra information to be omitted and is useful when comparing two assembler
12306 files.
12308 The added comments include:
12310 @itemize @bullet
12312 @item
12313 information on the compiler version and command-line options,
12315 @item
12316 the source code lines associated with the assembly instructions,
12317 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12319 @item
12320 hints on which high-level expressions correspond to
12321 the various assembly instruction operands.
12323 @end itemize
12325 For example, given this C source file:
12327 @smallexample
12328 int test (int n)
12330   int i;
12331   int total = 0;
12333   for (i = 0; i < n; i++)
12334     total += i * i;
12336   return total;
12338 @end smallexample
12340 compiling to (x86_64) assembly via @option{-S} and emitting the result
12341 direct to stdout via @option{-o} @option{-}
12343 @smallexample
12344 gcc -S test.c -fverbose-asm -Os -o -
12345 @end smallexample
12347 gives output similar to this:
12349 @smallexample
12350         .file   "test.c"
12351 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12352   [...snip...]
12353 # options passed:
12354   [...snip...]
12356         .text
12357         .globl  test
12358         .type   test, @@function
12359 test:
12360 .LFB0:
12361         .cfi_startproc
12362 # test.c:4:   int total = 0;
12363         xorl    %eax, %eax      # <retval>
12364 # test.c:6:   for (i = 0; i < n; i++)
12365         xorl    %edx, %edx      # i
12366 .L2:
12367 # test.c:6:   for (i = 0; i < n; i++)
12368         cmpl    %edi, %edx      # n, i
12369         jge     .L5     #,
12370 # test.c:7:     total += i * i;
12371         movl    %edx, %ecx      # i, tmp92
12372         imull   %edx, %ecx      # i, tmp92
12373 # test.c:6:   for (i = 0; i < n; i++)
12374         incl    %edx    # i
12375 # test.c:7:     total += i * i;
12376         addl    %ecx, %eax      # tmp92, <retval>
12377         jmp     .L2     #
12378 .L5:
12379 # test.c:10: @}
12380         ret
12381         .cfi_endproc
12382 .LFE0:
12383         .size   test, .-test
12384         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12385         .section        .note.GNU-stack,"",@@progbits
12386 @end smallexample
12388 The comments are intended for humans rather than machines and hence the
12389 precise format of the comments is subject to change.
12391 @item -frecord-gcc-switches
12392 @opindex frecord-gcc-switches
12393 This switch causes the command line used to invoke the
12394 compiler to be recorded into the object file that is being created.
12395 This switch is only implemented on some targets and the exact format
12396 of the recording is target and binary file format dependent, but it
12397 usually takes the form of a section containing ASCII text.  This
12398 switch is related to the @option{-fverbose-asm} switch, but that
12399 switch only records information in the assembler output file as
12400 comments, so it never reaches the object file.
12401 See also @option{-grecord-gcc-switches} for another
12402 way of storing compiler options into the object file.
12404 @item -fpic
12405 @opindex fpic
12406 @cindex global offset table
12407 @cindex PIC
12408 Generate position-independent code (PIC) suitable for use in a shared
12409 library, if supported for the target machine.  Such code accesses all
12410 constant addresses through a global offset table (GOT)@.  The dynamic
12411 loader resolves the GOT entries when the program starts (the dynamic
12412 loader is not part of GCC; it is part of the operating system).  If
12413 the GOT size for the linked executable exceeds a machine-specific
12414 maximum size, you get an error message from the linker indicating that
12415 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12416 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12417 on the m68k and RS/6000.  The x86 has no such limit.)
12419 Position-independent code requires special support, and therefore works
12420 only on certain machines.  For the x86, GCC supports PIC for System V
12421 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12422 position-independent.
12424 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12425 are defined to 1.
12427 @item -fPIC
12428 @opindex fPIC
12429 If supported for the target machine, emit position-independent code,
12430 suitable for dynamic linking and avoiding any limit on the size of the
12431 global offset table.  This option makes a difference on AArch64, m68k,
12432 PowerPC and SPARC@.
12434 Position-independent code requires special support, and therefore works
12435 only on certain machines.
12437 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12438 are defined to 2.
12440 @item -fpie
12441 @itemx -fPIE
12442 @opindex fpie
12443 @opindex fPIE
12444 These options are similar to @option{-fpic} and @option{-fPIC}, but
12445 generated position independent code can be only linked into executables.
12446 Usually these options are used when @option{-pie} GCC option is
12447 used during linking.
12449 @option{-fpie} and @option{-fPIE} both define the macros
12450 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12451 for @option{-fpie} and 2 for @option{-fPIE}.
12453 @item -fno-plt
12454 @opindex fno-plt
12455 Do not use the PLT for external function calls in position-independent code.
12456 Instead, load the callee address at call sites from the GOT and branch to it.
12457 This leads to more efficient code by eliminating PLT stubs and exposing
12458 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12459 PLT stubs expect the GOT pointer in a specific register, this gives more
12460 register allocation freedom to the compiler.
12461 Lazy binding requires use of the PLT; 
12462 with @option{-fno-plt} all external symbols are resolved at load time.
12464 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12465 through the PLT for specific external functions.
12467 In position-dependent code, a few targets also convert calls to
12468 functions that are marked to not use the PLT to use the GOT instead.
12470 @item -fno-jump-tables
12471 @opindex fno-jump-tables
12472 Do not use jump tables for switch statements even where it would be
12473 more efficient than other code generation strategies.  This option is
12474 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12475 building code that forms part of a dynamic linker and cannot
12476 reference the address of a jump table.  On some targets, jump tables
12477 do not require a GOT and this option is not needed.
12479 @item -ffixed-@var{reg}
12480 @opindex ffixed
12481 Treat the register named @var{reg} as a fixed register; generated code
12482 should never refer to it (except perhaps as a stack pointer, frame
12483 pointer or in some other fixed role).
12485 @var{reg} must be the name of a register.  The register names accepted
12486 are machine-specific and are defined in the @code{REGISTER_NAMES}
12487 macro in the machine description macro file.
12489 This flag does not have a negative form, because it specifies a
12490 three-way choice.
12492 @item -fcall-used-@var{reg}
12493 @opindex fcall-used
12494 Treat the register named @var{reg} as an allocable register that is
12495 clobbered by function calls.  It may be allocated for temporaries or
12496 variables that do not live across a call.  Functions compiled this way
12497 do not save and restore the register @var{reg}.
12499 It is an error to use this flag with the frame pointer or stack pointer.
12500 Use of this flag for other registers that have fixed pervasive roles in
12501 the machine's execution model produces disastrous results.
12503 This flag does not have a negative form, because it specifies a
12504 three-way choice.
12506 @item -fcall-saved-@var{reg}
12507 @opindex fcall-saved
12508 Treat the register named @var{reg} as an allocable register saved by
12509 functions.  It may be allocated even for temporaries or variables that
12510 live across a call.  Functions compiled this way save and restore
12511 the register @var{reg} if they use it.
12513 It is an error to use this flag with the frame pointer or stack pointer.
12514 Use of this flag for other registers that have fixed pervasive roles in
12515 the machine's execution model produces disastrous results.
12517 A different sort of disaster results from the use of this flag for
12518 a register in which function values may be returned.
12520 This flag does not have a negative form, because it specifies a
12521 three-way choice.
12523 @item -fpack-struct[=@var{n}]
12524 @opindex fpack-struct
12525 Without a value specified, pack all structure members together without
12526 holes.  When a value is specified (which must be a small power of two), pack
12527 structure members according to this value, representing the maximum
12528 alignment (that is, objects with default alignment requirements larger than
12529 this are output potentially unaligned at the next fitting location.
12531 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12532 code that is not binary compatible with code generated without that switch.
12533 Additionally, it makes the code suboptimal.
12534 Use it to conform to a non-default application binary interface.
12536 @item -fleading-underscore
12537 @opindex fleading-underscore
12538 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12539 change the way C symbols are represented in the object file.  One use
12540 is to help link with legacy assembly code.
12542 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12543 generate code that is not binary compatible with code generated without that
12544 switch.  Use it to conform to a non-default application binary interface.
12545 Not all targets provide complete support for this switch.
12547 @item -ftls-model=@var{model}
12548 @opindex ftls-model
12549 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12550 The @var{model} argument should be one of @samp{global-dynamic},
12551 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12552 Note that the choice is subject to optimization: the compiler may use
12553 a more efficient model for symbols not visible outside of the translation
12554 unit, or if @option{-fpic} is not given on the command line.
12556 The default without @option{-fpic} is @samp{initial-exec}; with
12557 @option{-fpic} the default is @samp{global-dynamic}.
12559 @item -ftrampolines
12560 @opindex ftrampolines
12561 For targets that normally need trampolines for nested functions, always
12562 generate them instead of using descriptors.  Otherwise, for targets that
12563 do not need them, like for example HP-PA or IA-64, do nothing.
12565 A trampoline is a small piece of code that is created at run time on the
12566 stack when the address of a nested function is taken, and is used to call
12567 the nested function indirectly.  Therefore, it requires the stack to be
12568 made executable in order for the program to work properly.
12570 @option{-fno-trampolines} is enabled by default on a language by language
12571 basis to let the compiler avoid generating them, if it computes that this
12572 is safe, and replace them with descriptors.  Descriptors are made up of data
12573 only, but the generated code must be prepared to deal with them.  As of this
12574 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12576 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12577 @option{-fno-trampolines} are not binary compatible if nested functions are
12578 present.  This option must therefore be used on a program-wide basis and be
12579 manipulated with extreme care.
12581 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12582 @opindex fvisibility
12583 Set the default ELF image symbol visibility to the specified option---all
12584 symbols are marked with this unless overridden within the code.
12585 Using this feature can very substantially improve linking and
12586 load times of shared object libraries, produce more optimized
12587 code, provide near-perfect API export and prevent symbol clashes.
12588 It is @strong{strongly} recommended that you use this in any shared objects
12589 you distribute.
12591 Despite the nomenclature, @samp{default} always means public; i.e.,
12592 available to be linked against from outside the shared object.
12593 @samp{protected} and @samp{internal} are pretty useless in real-world
12594 usage so the only other commonly used option is @samp{hidden}.
12595 The default if @option{-fvisibility} isn't specified is
12596 @samp{default}, i.e., make every symbol public.
12598 A good explanation of the benefits offered by ensuring ELF
12599 symbols have the correct visibility is given by ``How To Write
12600 Shared Libraries'' by Ulrich Drepper (which can be found at
12601 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12602 solution made possible by this option to marking things hidden when
12603 the default is public is to make the default hidden and mark things
12604 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12605 and @code{__attribute__ ((visibility("default")))} instead of
12606 @code{__declspec(dllexport)} you get almost identical semantics with
12607 identical syntax.  This is a great boon to those working with
12608 cross-platform projects.
12610 For those adding visibility support to existing code, you may find
12611 @code{#pragma GCC visibility} of use.  This works by you enclosing
12612 the declarations you wish to set visibility for with (for example)
12613 @code{#pragma GCC visibility push(hidden)} and
12614 @code{#pragma GCC visibility pop}.
12615 Bear in mind that symbol visibility should be viewed @strong{as
12616 part of the API interface contract} and thus all new code should
12617 always specify visibility when it is not the default; i.e., declarations
12618 only for use within the local DSO should @strong{always} be marked explicitly
12619 as hidden as so to avoid PLT indirection overheads---making this
12620 abundantly clear also aids readability and self-documentation of the code.
12621 Note that due to ISO C++ specification requirements, @code{operator new} and
12622 @code{operator delete} must always be of default visibility.
12624 Be aware that headers from outside your project, in particular system
12625 headers and headers from any other library you use, may not be
12626 expecting to be compiled with visibility other than the default.  You
12627 may need to explicitly say @code{#pragma GCC visibility push(default)}
12628 before including any such headers.
12630 @code{extern} declarations are not affected by @option{-fvisibility}, so
12631 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12632 no modifications.  However, this means that calls to @code{extern}
12633 functions with no explicit visibility use the PLT, so it is more
12634 effective to use @code{__attribute ((visibility))} and/or
12635 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12636 declarations should be treated as hidden.
12638 Note that @option{-fvisibility} does affect C++ vague linkage
12639 entities. This means that, for instance, an exception class that is
12640 be thrown between DSOs must be explicitly marked with default
12641 visibility so that the @samp{type_info} nodes are unified between
12642 the DSOs.
12644 An overview of these techniques, their benefits and how to use them
12645 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12647 @item -fstrict-volatile-bitfields
12648 @opindex fstrict-volatile-bitfields
12649 This option should be used if accesses to volatile bit-fields (or other
12650 structure fields, although the compiler usually honors those types
12651 anyway) should use a single access of the width of the
12652 field's type, aligned to a natural alignment if possible.  For
12653 example, targets with memory-mapped peripheral registers might require
12654 all such accesses to be 16 bits wide; with this flag you can
12655 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12656 is 16 bits on these targets) to force GCC to use 16-bit accesses
12657 instead of, perhaps, a more efficient 32-bit access.
12659 If this option is disabled, the compiler uses the most efficient
12660 instruction.  In the previous example, that might be a 32-bit load
12661 instruction, even though that accesses bytes that do not contain
12662 any portion of the bit-field, or memory-mapped registers unrelated to
12663 the one being updated.
12665 In some cases, such as when the @code{packed} attribute is applied to a 
12666 structure field, it may not be possible to access the field with a single
12667 read or write that is correctly aligned for the target machine.  In this
12668 case GCC falls back to generating multiple accesses rather than code that 
12669 will fault or truncate the result at run time.
12671 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12672 not allowed to touch non bit-field members.  It is therefore recommended
12673 to define all bits of the field's type as bit-field members.
12675 The default value of this option is determined by the application binary
12676 interface for the target processor.
12678 @item -fsync-libcalls
12679 @opindex fsync-libcalls
12680 This option controls whether any out-of-line instance of the @code{__sync}
12681 family of functions may be used to implement the C++11 @code{__atomic}
12682 family of functions.
12684 The default value of this option is enabled, thus the only useful form
12685 of the option is @option{-fno-sync-libcalls}.  This option is used in
12686 the implementation of the @file{libatomic} runtime library.
12688 @end table
12690 @node Developer Options
12691 @section GCC Developer Options
12692 @cindex developer options
12693 @cindex debugging GCC
12694 @cindex debug dump options
12695 @cindex dump options
12696 @cindex compilation statistics
12698 This section describes command-line options that are primarily of
12699 interest to GCC developers, including options to support compiler
12700 testing and investigation of compiler bugs and compile-time
12701 performance problems.  This includes options that produce debug dumps
12702 at various points in the compilation; that print statistics such as
12703 memory use and execution time; and that print information about GCC's
12704 configuration, such as where it searches for libraries.  You should
12705 rarely need to use any of these options for ordinary compilation and
12706 linking tasks.
12708 @table @gcctabopt
12710 @item -d@var{letters}
12711 @itemx -fdump-rtl-@var{pass}
12712 @itemx -fdump-rtl-@var{pass}=@var{filename}
12713 @opindex d
12714 @opindex fdump-rtl-@var{pass}
12715 Says to make debugging dumps during compilation at times specified by
12716 @var{letters}.  This is used for debugging the RTL-based passes of the
12717 compiler.  The file names for most of the dumps are made by appending
12718 a pass number and a word to the @var{dumpname}, and the files are
12719 created in the directory of the output file.  In case of
12720 @option{=@var{filename}} option, the dump is output on the given file
12721 instead of the pass numbered dump files.  Note that the pass number is
12722 assigned as passes are registered into the pass manager.  Most passes
12723 are registered in the order that they will execute and for these passes
12724 the number corresponds to the pass execution order.  However, passes
12725 registered by plugins, passes specific to compilation targets, or
12726 passes that are otherwise registered after all the other passes are
12727 numbered higher than a pass named "final", even if they are executed
12728 earlier.  @var{dumpname} is generated from the name of the output
12729 file if explicitly specified and not an executable, otherwise it is
12730 the basename of the source file.  
12732 Some @option{-d@var{letters}} switches have different meaning when
12733 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12734 for information about preprocessor-specific dump options.
12736 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12737 @option{-d} option @var{letters}.  Here are the possible
12738 letters for use in @var{pass} and @var{letters}, and their meanings:
12740 @table @gcctabopt
12742 @item -fdump-rtl-alignments
12743 @opindex fdump-rtl-alignments
12744 Dump after branch alignments have been computed.
12746 @item -fdump-rtl-asmcons
12747 @opindex fdump-rtl-asmcons
12748 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12750 @item -fdump-rtl-auto_inc_dec
12751 @opindex fdump-rtl-auto_inc_dec
12752 Dump after auto-inc-dec discovery.  This pass is only run on
12753 architectures that have auto inc or auto dec instructions.
12755 @item -fdump-rtl-barriers
12756 @opindex fdump-rtl-barriers
12757 Dump after cleaning up the barrier instructions.
12759 @item -fdump-rtl-bbpart
12760 @opindex fdump-rtl-bbpart
12761 Dump after partitioning hot and cold basic blocks.
12763 @item -fdump-rtl-bbro
12764 @opindex fdump-rtl-bbro
12765 Dump after block reordering.
12767 @item -fdump-rtl-btl1
12768 @itemx -fdump-rtl-btl2
12769 @opindex fdump-rtl-btl2
12770 @opindex fdump-rtl-btl2
12771 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12772 after the two branch
12773 target load optimization passes.
12775 @item -fdump-rtl-bypass
12776 @opindex fdump-rtl-bypass
12777 Dump after jump bypassing and control flow optimizations.
12779 @item -fdump-rtl-combine
12780 @opindex fdump-rtl-combine
12781 Dump after the RTL instruction combination pass.
12783 @item -fdump-rtl-compgotos
12784 @opindex fdump-rtl-compgotos
12785 Dump after duplicating the computed gotos.
12787 @item -fdump-rtl-ce1
12788 @itemx -fdump-rtl-ce2
12789 @itemx -fdump-rtl-ce3
12790 @opindex fdump-rtl-ce1
12791 @opindex fdump-rtl-ce2
12792 @opindex fdump-rtl-ce3
12793 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12794 @option{-fdump-rtl-ce3} enable dumping after the three
12795 if conversion passes.
12797 @item -fdump-rtl-cprop_hardreg
12798 @opindex fdump-rtl-cprop_hardreg
12799 Dump after hard register copy propagation.
12801 @item -fdump-rtl-csa
12802 @opindex fdump-rtl-csa
12803 Dump after combining stack adjustments.
12805 @item -fdump-rtl-cse1
12806 @itemx -fdump-rtl-cse2
12807 @opindex fdump-rtl-cse1
12808 @opindex fdump-rtl-cse2
12809 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12810 the two common subexpression elimination passes.
12812 @item -fdump-rtl-dce
12813 @opindex fdump-rtl-dce
12814 Dump after the standalone dead code elimination passes.
12816 @item -fdump-rtl-dbr
12817 @opindex fdump-rtl-dbr
12818 Dump after delayed branch scheduling.
12820 @item -fdump-rtl-dce1
12821 @itemx -fdump-rtl-dce2
12822 @opindex fdump-rtl-dce1
12823 @opindex fdump-rtl-dce2
12824 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
12825 the two dead store elimination passes.
12827 @item -fdump-rtl-eh
12828 @opindex fdump-rtl-eh
12829 Dump after finalization of EH handling code.
12831 @item -fdump-rtl-eh_ranges
12832 @opindex fdump-rtl-eh_ranges
12833 Dump after conversion of EH handling range regions.
12835 @item -fdump-rtl-expand
12836 @opindex fdump-rtl-expand
12837 Dump after RTL generation.
12839 @item -fdump-rtl-fwprop1
12840 @itemx -fdump-rtl-fwprop2
12841 @opindex fdump-rtl-fwprop1
12842 @opindex fdump-rtl-fwprop2
12843 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
12844 dumping after the two forward propagation passes.
12846 @item -fdump-rtl-gcse1
12847 @itemx -fdump-rtl-gcse2
12848 @opindex fdump-rtl-gcse1
12849 @opindex fdump-rtl-gcse2
12850 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
12851 after global common subexpression elimination.
12853 @item -fdump-rtl-init-regs
12854 @opindex fdump-rtl-init-regs
12855 Dump after the initialization of the registers.
12857 @item -fdump-rtl-initvals
12858 @opindex fdump-rtl-initvals
12859 Dump after the computation of the initial value sets.
12861 @item -fdump-rtl-into_cfglayout
12862 @opindex fdump-rtl-into_cfglayout
12863 Dump after converting to cfglayout mode.
12865 @item -fdump-rtl-ira
12866 @opindex fdump-rtl-ira
12867 Dump after iterated register allocation.
12869 @item -fdump-rtl-jump
12870 @opindex fdump-rtl-jump
12871 Dump after the second jump optimization.
12873 @item -fdump-rtl-loop2
12874 @opindex fdump-rtl-loop2
12875 @option{-fdump-rtl-loop2} enables dumping after the rtl
12876 loop optimization passes.
12878 @item -fdump-rtl-mach
12879 @opindex fdump-rtl-mach
12880 Dump after performing the machine dependent reorganization pass, if that
12881 pass exists.
12883 @item -fdump-rtl-mode_sw
12884 @opindex fdump-rtl-mode_sw
12885 Dump after removing redundant mode switches.
12887 @item -fdump-rtl-rnreg
12888 @opindex fdump-rtl-rnreg
12889 Dump after register renumbering.
12891 @item -fdump-rtl-outof_cfglayout
12892 @opindex fdump-rtl-outof_cfglayout
12893 Dump after converting from cfglayout mode.
12895 @item -fdump-rtl-peephole2
12896 @opindex fdump-rtl-peephole2
12897 Dump after the peephole pass.
12899 @item -fdump-rtl-postreload
12900 @opindex fdump-rtl-postreload
12901 Dump after post-reload optimizations.
12903 @item -fdump-rtl-pro_and_epilogue
12904 @opindex fdump-rtl-pro_and_epilogue
12905 Dump after generating the function prologues and epilogues.
12907 @item -fdump-rtl-sched1
12908 @itemx -fdump-rtl-sched2
12909 @opindex fdump-rtl-sched1
12910 @opindex fdump-rtl-sched2
12911 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
12912 after the basic block scheduling passes.
12914 @item -fdump-rtl-ree
12915 @opindex fdump-rtl-ree
12916 Dump after sign/zero extension elimination.
12918 @item -fdump-rtl-seqabstr
12919 @opindex fdump-rtl-seqabstr
12920 Dump after common sequence discovery.
12922 @item -fdump-rtl-shorten
12923 @opindex fdump-rtl-shorten
12924 Dump after shortening branches.
12926 @item -fdump-rtl-sibling
12927 @opindex fdump-rtl-sibling
12928 Dump after sibling call optimizations.
12930 @item -fdump-rtl-split1
12931 @itemx -fdump-rtl-split2
12932 @itemx -fdump-rtl-split3
12933 @itemx -fdump-rtl-split4
12934 @itemx -fdump-rtl-split5
12935 @opindex fdump-rtl-split1
12936 @opindex fdump-rtl-split2
12937 @opindex fdump-rtl-split3
12938 @opindex fdump-rtl-split4
12939 @opindex fdump-rtl-split5
12940 These options enable dumping after five rounds of
12941 instruction splitting.
12943 @item -fdump-rtl-sms
12944 @opindex fdump-rtl-sms
12945 Dump after modulo scheduling.  This pass is only run on some
12946 architectures.
12948 @item -fdump-rtl-stack
12949 @opindex fdump-rtl-stack
12950 Dump after conversion from GCC's ``flat register file'' registers to the
12951 x87's stack-like registers.  This pass is only run on x86 variants.
12953 @item -fdump-rtl-subreg1
12954 @itemx -fdump-rtl-subreg2
12955 @opindex fdump-rtl-subreg1
12956 @opindex fdump-rtl-subreg2
12957 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
12958 the two subreg expansion passes.
12960 @item -fdump-rtl-unshare
12961 @opindex fdump-rtl-unshare
12962 Dump after all rtl has been unshared.
12964 @item -fdump-rtl-vartrack
12965 @opindex fdump-rtl-vartrack
12966 Dump after variable tracking.
12968 @item -fdump-rtl-vregs
12969 @opindex fdump-rtl-vregs
12970 Dump after converting virtual registers to hard registers.
12972 @item -fdump-rtl-web
12973 @opindex fdump-rtl-web
12974 Dump after live range splitting.
12976 @item -fdump-rtl-regclass
12977 @itemx -fdump-rtl-subregs_of_mode_init
12978 @itemx -fdump-rtl-subregs_of_mode_finish
12979 @itemx -fdump-rtl-dfinit
12980 @itemx -fdump-rtl-dfinish
12981 @opindex fdump-rtl-regclass
12982 @opindex fdump-rtl-subregs_of_mode_init
12983 @opindex fdump-rtl-subregs_of_mode_finish
12984 @opindex fdump-rtl-dfinit
12985 @opindex fdump-rtl-dfinish
12986 These dumps are defined but always produce empty files.
12988 @item -da
12989 @itemx -fdump-rtl-all
12990 @opindex da
12991 @opindex fdump-rtl-all
12992 Produce all the dumps listed above.
12994 @item -dA
12995 @opindex dA
12996 Annotate the assembler output with miscellaneous debugging information.
12998 @item -dD
12999 @opindex dD
13000 Dump all macro definitions, at the end of preprocessing, in addition to
13001 normal output.
13003 @item -dH
13004 @opindex dH
13005 Produce a core dump whenever an error occurs.
13007 @item -dp
13008 @opindex dp
13009 Annotate the assembler output with a comment indicating which
13010 pattern and alternative is used.  The length of each instruction is
13011 also printed.
13013 @item -dP
13014 @opindex dP
13015 Dump the RTL in the assembler output as a comment before each instruction.
13016 Also turns on @option{-dp} annotation.
13018 @item -dx
13019 @opindex dx
13020 Just generate RTL for a function instead of compiling it.  Usually used
13021 with @option{-fdump-rtl-expand}.
13022 @end table
13024 @item -fdump-noaddr
13025 @opindex fdump-noaddr
13026 When doing debugging dumps, suppress address output.  This makes it more
13027 feasible to use diff on debugging dumps for compiler invocations with
13028 different compiler binaries and/or different
13029 text / bss / data / heap / stack / dso start locations.
13031 @item -freport-bug
13032 @opindex freport-bug
13033 Collect and dump debug information into a temporary file if an
13034 internal compiler error (ICE) occurs.
13036 @item -fdump-unnumbered
13037 @opindex fdump-unnumbered
13038 When doing debugging dumps, suppress instruction numbers and address output.
13039 This makes it more feasible to use diff on debugging dumps for compiler
13040 invocations with different options, in particular with and without
13041 @option{-g}.
13043 @item -fdump-unnumbered-links
13044 @opindex fdump-unnumbered-links
13045 When doing debugging dumps (see @option{-d} option above), suppress
13046 instruction numbers for the links to the previous and next instructions
13047 in a sequence.
13049 @item -fdump-ipa-@var{switch}
13050 @opindex fdump-ipa
13051 Control the dumping at various stages of inter-procedural analysis
13052 language tree to a file.  The file name is generated by appending a
13053 switch specific suffix to the source file name, and the file is created
13054 in the same directory as the output file.  The following dumps are
13055 possible:
13057 @table @samp
13058 @item all
13059 Enables all inter-procedural analysis dumps.
13061 @item cgraph
13062 Dumps information about call-graph optimization, unused function removal,
13063 and inlining decisions.
13065 @item inline
13066 Dump after function inlining.
13068 @end table
13070 @item -fdump-lang-all
13071 @itemx -fdump-lang-@var{switch}
13072 @itemx -fdump-lang-@var{switch}-@var{options}
13073 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13074 @opindex fdump-lang-all
13075 @opindex fdump-lang
13076 Control the dumping of language-specific information.  The @var{options}
13077 and @var{filename} portions behave as described in the
13078 @option{-fdump-tree} option.  The following @var{switch} values are
13079 accepted:
13081 @table @samp
13082 @item all
13084 Enable all language-specific dumps.
13086 @item class
13087 Dump class hierarchy information.  Virtual table information is emitted
13088 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13090 @item raw
13091 Dump the raw internal tree data.  This option is applicable to C++ only.
13093 @end table
13095 @item -fdump-passes
13096 @opindex fdump-passes
13097 Print on @file{stderr} the list of optimization passes that are turned
13098 on and off by the current command-line options.
13100 @item -fdump-statistics-@var{option}
13101 @opindex fdump-statistics
13102 Enable and control dumping of pass statistics in a separate file.  The
13103 file name is generated by appending a suffix ending in
13104 @samp{.statistics} to the source file name, and the file is created in
13105 the same directory as the output file.  If the @samp{-@var{option}}
13106 form is used, @samp{-stats} causes counters to be summed over the
13107 whole compilation unit while @samp{-details} dumps every event as
13108 the passes generate them.  The default with no option is to sum
13109 counters for each function compiled.
13111 @item -fdump-tree-all
13112 @itemx -fdump-tree-@var{switch}
13113 @itemx -fdump-tree-@var{switch}-@var{options}
13114 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13115 @opindex fdump-tree-all
13116 @opindex fdump-tree
13117 Control the dumping at various stages of processing the intermediate
13118 language tree to a file.  The file name is generated by appending a
13119 switch-specific suffix to the source file name, and the file is
13120 created in the same directory as the output file. In case of
13121 @option{=@var{filename}} option, the dump is output on the given file
13122 instead of the auto named dump files.  If the @samp{-@var{options}}
13123 form is used, @var{options} is a list of @samp{-} separated options
13124 which control the details of the dump.  Not all options are applicable
13125 to all dumps; those that are not meaningful are ignored.  The
13126 following options are available
13128 @table @samp
13129 @item address
13130 Print the address of each node.  Usually this is not meaningful as it
13131 changes according to the environment and source file.  Its primary use
13132 is for tying up a dump file with a debug environment.
13133 @item asmname
13134 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13135 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13136 use working backward from mangled names in the assembly file.
13137 @item slim
13138 When dumping front-end intermediate representations, inhibit dumping
13139 of members of a scope or body of a function merely because that scope
13140 has been reached.  Only dump such items when they are directly reachable
13141 by some other path.
13143 When dumping pretty-printed trees, this option inhibits dumping the
13144 bodies of control structures.
13146 When dumping RTL, print the RTL in slim (condensed) form instead of
13147 the default LISP-like representation.
13148 @item raw
13149 Print a raw representation of the tree.  By default, trees are
13150 pretty-printed into a C-like representation.
13151 @item details
13152 Enable more detailed dumps (not honored by every dump option). Also
13153 include information from the optimization passes.
13154 @item stats
13155 Enable dumping various statistics about the pass (not honored by every dump
13156 option).
13157 @item blocks
13158 Enable showing basic block boundaries (disabled in raw dumps).
13159 @item graph
13160 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13161 dump a representation of the control flow graph suitable for viewing with
13162 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13163 the file is pretty-printed as a subgraph, so that GraphViz can render them
13164 all in a single plot.
13166 This option currently only works for RTL dumps, and the RTL is always
13167 dumped in slim form.
13168 @item vops
13169 Enable showing virtual operands for every statement.
13170 @item lineno
13171 Enable showing line numbers for statements.
13172 @item uid
13173 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13174 @item verbose
13175 Enable showing the tree dump for each statement.
13176 @item eh
13177 Enable showing the EH region number holding each statement.
13178 @item scev
13179 Enable showing scalar evolution analysis details.
13180 @item optimized
13181 Enable showing optimization information (only available in certain
13182 passes).
13183 @item missed
13184 Enable showing missed optimization information (only available in certain
13185 passes).
13186 @item note
13187 Enable other detailed optimization information (only available in
13188 certain passes).
13189 @item =@var{filename}
13190 Instead of an auto named dump file, output into the given file
13191 name. The file names @file{stdout} and @file{stderr} are treated
13192 specially and are considered already open standard streams. For
13193 example,
13195 @smallexample
13196 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13197      -fdump-tree-pre=/dev/stderr file.c
13198 @end smallexample
13200 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13201 output on to @file{stderr}. If two conflicting dump filenames are
13202 given for the same pass, then the latter option overrides the earlier
13203 one.
13205 @item all
13206 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13207 and @option{lineno}.
13209 @item optall
13210 Turn on all optimization options, i.e., @option{optimized},
13211 @option{missed}, and @option{note}.
13212 @end table
13214 To determine what tree dumps are available or find the dump for a pass
13215 of interest follow the steps below.
13217 @enumerate
13218 @item
13219 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13220 look for a code that corresponds to the pass you are interested in.
13221 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13222 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13223 The number at the end distinguishes distinct invocations of the same pass.
13224 @item
13225 To enable the creation of the dump file, append the pass code to
13226 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13227 to enable the dump from the Early Value Range Propagation pass, invoke
13228 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13229 specify the name of the dump file.  If you don't specify one, GCC
13230 creates as described below.
13231 @item
13232 Find the pass dump in a file whose name is composed of three components
13233 separated by a period: the name of the source file GCC was invoked to
13234 compile, a numeric suffix indicating the pass number followed by the
13235 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13236 and finally the pass code.  For example, the Early VRP pass dump might
13237 be in a file named @file{myfile.c.038t.evrp} in the current working
13238 directory.  Note that the numeric codes are not stable and may change
13239 from one version of GCC to another.
13240 @end enumerate
13242 @item -fopt-info
13243 @itemx -fopt-info-@var{options}
13244 @itemx -fopt-info-@var{options}=@var{filename}
13245 @opindex fopt-info
13246 Controls optimization dumps from various optimization passes. If the
13247 @samp{-@var{options}} form is used, @var{options} is a list of
13248 @samp{-} separated option keywords to select the dump details and
13249 optimizations.  
13251 The @var{options} can be divided into two groups: options describing the
13252 verbosity of the dump, and options describing which optimizations
13253 should be included. The options from both the groups can be freely
13254 mixed as they are non-overlapping. However, in case of any conflicts,
13255 the later options override the earlier options on the command
13256 line. 
13258 The following options control the dump verbosity:
13260 @table @samp
13261 @item optimized
13262 Print information when an optimization is successfully applied. It is
13263 up to a pass to decide which information is relevant. For example, the
13264 vectorizer passes print the source location of loops which are
13265 successfully vectorized.
13266 @item missed
13267 Print information about missed optimizations. Individual passes
13268 control which information to include in the output. 
13269 @item note
13270 Print verbose information about optimizations, such as certain
13271 transformations, more detailed messages about decisions etc.
13272 @item all
13273 Print detailed optimization information. This includes
13274 @samp{optimized}, @samp{missed}, and @samp{note}.
13275 @end table
13277 One or more of the following option keywords can be used to describe a
13278 group of optimizations:
13280 @table @samp
13281 @item ipa
13282 Enable dumps from all interprocedural optimizations.
13283 @item loop
13284 Enable dumps from all loop optimizations.
13285 @item inline
13286 Enable dumps from all inlining optimizations.
13287 @item omp
13288 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13289 @item vec
13290 Enable dumps from all vectorization optimizations.
13291 @item optall
13292 Enable dumps from all optimizations. This is a superset of
13293 the optimization groups listed above.
13294 @end table
13296 If @var{options} is
13297 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13298 info about successful optimizations from all the passes.  
13300 If the @var{filename} is provided, then the dumps from all the
13301 applicable optimizations are concatenated into the @var{filename}.
13302 Otherwise the dump is output onto @file{stderr}. Though multiple
13303 @option{-fopt-info} options are accepted, only one of them can include
13304 a @var{filename}. If other filenames are provided then all but the
13305 first such option are ignored.
13307 Note that the output @var{filename} is overwritten
13308 in case of multiple translation units. If a combined output from
13309 multiple translation units is desired, @file{stderr} should be used
13310 instead.
13312 In the following example, the optimization info is output to
13313 @file{stderr}:
13315 @smallexample
13316 gcc -O3 -fopt-info
13317 @end smallexample
13319 This example:
13320 @smallexample
13321 gcc -O3 -fopt-info-missed=missed.all
13322 @end smallexample
13324 @noindent
13325 outputs missed optimization report from all the passes into
13326 @file{missed.all}, and this one:
13328 @smallexample
13329 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13330 @end smallexample
13332 @noindent
13333 prints information about missed optimization opportunities from
13334 vectorization passes on @file{stderr}.  
13335 Note that @option{-fopt-info-vec-missed} is equivalent to 
13336 @option{-fopt-info-missed-vec}.  The order of the optimization group
13337 names and message types listed after @option{-fopt-info} does not matter.
13339 As another example,
13340 @smallexample
13341 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13342 @end smallexample
13344 @noindent
13345 outputs information about missed optimizations as well as
13346 optimized locations from all the inlining passes into
13347 @file{inline.txt}.
13349 Finally, consider:
13351 @smallexample
13352 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13353 @end smallexample
13355 @noindent
13356 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13357 in conflict since only one output file is allowed. In this case, only
13358 the first option takes effect and the subsequent options are
13359 ignored. Thus only @file{vec.miss} is produced which contains
13360 dumps from the vectorizer about missed opportunities.
13362 @item -fsched-verbose=@var{n}
13363 @opindex fsched-verbose
13364 On targets that use instruction scheduling, this option controls the
13365 amount of debugging output the scheduler prints to the dump files.
13367 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13368 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13369 For @var{n} greater than one, it also output basic block probabilities,
13370 detailed ready list information and unit/insn info.  For @var{n} greater
13371 than two, it includes RTL at abort point, control-flow and regions info.
13372 And for @var{n} over four, @option{-fsched-verbose} also includes
13373 dependence info.
13377 @item -fenable-@var{kind}-@var{pass}
13378 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13379 @opindex fdisable-
13380 @opindex fenable-
13382 This is a set of options that are used to explicitly disable/enable
13383 optimization passes.  These options are intended for use for debugging GCC.
13384 Compiler users should use regular options for enabling/disabling
13385 passes instead.
13387 @table @gcctabopt
13389 @item -fdisable-ipa-@var{pass}
13390 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13391 statically invoked in the compiler multiple times, the pass name should be
13392 appended with a sequential number starting from 1.
13394 @item -fdisable-rtl-@var{pass}
13395 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13396 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13397 statically invoked in the compiler multiple times, the pass name should be
13398 appended with a sequential number starting from 1.  @var{range-list} is a 
13399 comma-separated list of function ranges or assembler names.  Each range is a number
13400 pair separated by a colon.  The range is inclusive in both ends.  If the range
13401 is trivial, the number pair can be simplified as a single number.  If the
13402 function's call graph node's @var{uid} falls within one of the specified ranges,
13403 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13404 function header of a dump file, and the pass names can be dumped by using
13405 option @option{-fdump-passes}.
13407 @item -fdisable-tree-@var{pass}
13408 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13409 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13410 option arguments.
13412 @item -fenable-ipa-@var{pass}
13413 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13414 statically invoked in the compiler multiple times, the pass name should be
13415 appended with a sequential number starting from 1.
13417 @item -fenable-rtl-@var{pass}
13418 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13419 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13420 description and examples.
13422 @item -fenable-tree-@var{pass}
13423 @itemx -fenable-tree-@var{pass}=@var{range-list}
13424 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13425 of option arguments.
13427 @end table
13429 Here are some examples showing uses of these options.
13431 @smallexample
13433 # disable ccp1 for all functions
13434    -fdisable-tree-ccp1
13435 # disable complete unroll for function whose cgraph node uid is 1
13436    -fenable-tree-cunroll=1
13437 # disable gcse2 for functions at the following ranges [1,1],
13438 # [300,400], and [400,1000]
13439 # disable gcse2 for functions foo and foo2
13440    -fdisable-rtl-gcse2=foo,foo2
13441 # disable early inlining
13442    -fdisable-tree-einline
13443 # disable ipa inlining
13444    -fdisable-ipa-inline
13445 # enable tree full unroll
13446    -fenable-tree-unroll
13448 @end smallexample
13450 @item -fchecking
13451 @itemx -fchecking=@var{n}
13452 @opindex fchecking
13453 @opindex fno-checking
13454 Enable internal consistency checking.  The default depends on
13455 the compiler configuration.  @option{-fchecking=2} enables further
13456 internal consistency checking that might affect code generation.
13458 @item -frandom-seed=@var{string}
13459 @opindex frandom-seed
13460 This option provides a seed that GCC uses in place of
13461 random numbers in generating certain symbol names
13462 that have to be different in every compiled file.  It is also used to
13463 place unique stamps in coverage data files and the object files that
13464 produce them.  You can use the @option{-frandom-seed} option to produce
13465 reproducibly identical object files.
13467 The @var{string} can either be a number (decimal, octal or hex) or an
13468 arbitrary string (in which case it's converted to a number by
13469 computing CRC32).
13471 The @var{string} should be different for every file you compile.
13473 @item -save-temps
13474 @itemx -save-temps=cwd
13475 @opindex save-temps
13476 Store the usual ``temporary'' intermediate files permanently; place them
13477 in the current directory and name them based on the source file.  Thus,
13478 compiling @file{foo.c} with @option{-c -save-temps} produces files
13479 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13480 preprocessed @file{foo.i} output file even though the compiler now
13481 normally uses an integrated preprocessor.
13483 When used in combination with the @option{-x} command-line option,
13484 @option{-save-temps} is sensible enough to avoid over writing an
13485 input source file with the same extension as an intermediate file.
13486 The corresponding intermediate file may be obtained by renaming the
13487 source file before using @option{-save-temps}.
13489 If you invoke GCC in parallel, compiling several different source
13490 files that share a common base name in different subdirectories or the
13491 same source file compiled for multiple output destinations, it is
13492 likely that the different parallel compilers will interfere with each
13493 other, and overwrite the temporary files.  For instance:
13495 @smallexample
13496 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13497 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13498 @end smallexample
13500 may result in @file{foo.i} and @file{foo.o} being written to
13501 simultaneously by both compilers.
13503 @item -save-temps=obj
13504 @opindex save-temps=obj
13505 Store the usual ``temporary'' intermediate files permanently.  If the
13506 @option{-o} option is used, the temporary files are based on the
13507 object file.  If the @option{-o} option is not used, the
13508 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13510 For example:
13512 @smallexample
13513 gcc -save-temps=obj -c foo.c
13514 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13515 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13516 @end smallexample
13518 @noindent
13519 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13520 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13521 @file{dir2/yfoobar.o}.
13523 @item -time@r{[}=@var{file}@r{]}
13524 @opindex time
13525 Report the CPU time taken by each subprocess in the compilation
13526 sequence.  For C source files, this is the compiler proper and assembler
13527 (plus the linker if linking is done).
13529 Without the specification of an output file, the output looks like this:
13531 @smallexample
13532 # cc1 0.12 0.01
13533 # as 0.00 0.01
13534 @end smallexample
13536 The first number on each line is the ``user time'', that is time spent
13537 executing the program itself.  The second number is ``system time'',
13538 time spent executing operating system routines on behalf of the program.
13539 Both numbers are in seconds.
13541 With the specification of an output file, the output is appended to the
13542 named file, and it looks like this:
13544 @smallexample
13545 0.12 0.01 cc1 @var{options}
13546 0.00 0.01 as @var{options}
13547 @end smallexample
13549 The ``user time'' and the ``system time'' are moved before the program
13550 name, and the options passed to the program are displayed, so that one
13551 can later tell what file was being compiled, and with which options.
13553 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13554 @opindex fdump-final-insns
13555 Dump the final internal representation (RTL) to @var{file}.  If the
13556 optional argument is omitted (or if @var{file} is @code{.}), the name
13557 of the dump file is determined by appending @code{.gkd} to the
13558 compilation output file name.
13560 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13561 @opindex fcompare-debug
13562 @opindex fno-compare-debug
13563 If no error occurs during compilation, run the compiler a second time,
13564 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13565 passed to the second compilation.  Dump the final internal
13566 representation in both compilations, and print an error if they differ.
13568 If the equal sign is omitted, the default @option{-gtoggle} is used.
13570 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13571 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13572 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13573 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13574 is used.
13576 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13577 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13578 of the final representation and the second compilation, preventing even
13579 @env{GCC_COMPARE_DEBUG} from taking effect.
13581 To verify full coverage during @option{-fcompare-debug} testing, set
13582 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13583 which GCC rejects as an invalid option in any actual compilation
13584 (rather than preprocessing, assembly or linking).  To get just a
13585 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13586 not overridden} will do.
13588 @item -fcompare-debug-second
13589 @opindex fcompare-debug-second
13590 This option is implicitly passed to the compiler for the second
13591 compilation requested by @option{-fcompare-debug}, along with options to
13592 silence warnings, and omitting other options that would cause
13593 side-effect compiler outputs to files or to the standard output.  Dump
13594 files and preserved temporary files are renamed so as to contain the
13595 @code{.gk} additional extension during the second compilation, to avoid
13596 overwriting those generated by the first.
13598 When this option is passed to the compiler driver, it causes the
13599 @emph{first} compilation to be skipped, which makes it useful for little
13600 other than debugging the compiler proper.
13602 @item -gtoggle
13603 @opindex gtoggle
13604 Turn off generation of debug info, if leaving out this option
13605 generates it, or turn it on at level 2 otherwise.  The position of this
13606 argument in the command line does not matter; it takes effect after all
13607 other options are processed, and it does so only once, no matter how
13608 many times it is given.  This is mainly intended to be used with
13609 @option{-fcompare-debug}.
13611 @item -fvar-tracking-assignments-toggle
13612 @opindex fvar-tracking-assignments-toggle
13613 @opindex fno-var-tracking-assignments-toggle
13614 Toggle @option{-fvar-tracking-assignments}, in the same way that
13615 @option{-gtoggle} toggles @option{-g}.
13617 @item -Q
13618 @opindex Q
13619 Makes the compiler print out each function name as it is compiled, and
13620 print some statistics about each pass when it finishes.
13622 @item -ftime-report
13623 @opindex ftime-report
13624 Makes the compiler print some statistics about the time consumed by each
13625 pass when it finishes.
13627 @item -ftime-report-details
13628 @opindex ftime-report-details
13629 Record the time consumed by infrastructure parts separately for each pass.
13631 @item -fira-verbose=@var{n}
13632 @opindex fira-verbose
13633 Control the verbosity of the dump file for the integrated register allocator.
13634 The default value is 5.  If the value @var{n} is greater or equal to 10,
13635 the dump output is sent to stderr using the same format as @var{n} minus 10.
13637 @item -flto-report
13638 @opindex flto-report
13639 Prints a report with internal details on the workings of the link-time
13640 optimizer.  The contents of this report vary from version to version.
13641 It is meant to be useful to GCC developers when processing object
13642 files in LTO mode (via @option{-flto}).
13644 Disabled by default.
13646 @item -flto-report-wpa
13647 @opindex flto-report-wpa
13648 Like @option{-flto-report}, but only print for the WPA phase of Link
13649 Time Optimization.
13651 @item -fmem-report
13652 @opindex fmem-report
13653 Makes the compiler print some statistics about permanent memory
13654 allocation when it finishes.
13656 @item -fmem-report-wpa
13657 @opindex fmem-report-wpa
13658 Makes the compiler print some statistics about permanent memory
13659 allocation for the WPA phase only.
13661 @item -fpre-ipa-mem-report
13662 @opindex fpre-ipa-mem-report
13663 @item -fpost-ipa-mem-report
13664 @opindex fpost-ipa-mem-report
13665 Makes the compiler print some statistics about permanent memory
13666 allocation before or after interprocedural optimization.
13668 @item -fprofile-report
13669 @opindex fprofile-report
13670 Makes the compiler print some statistics about consistency of the
13671 (estimated) profile and effect of individual passes.
13673 @item -fstack-usage
13674 @opindex fstack-usage
13675 Makes the compiler output stack usage information for the program, on a
13676 per-function basis.  The filename for the dump is made by appending
13677 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13678 the output file, if explicitly specified and it is not an executable,
13679 otherwise it is the basename of the source file.  An entry is made up
13680 of three fields:
13682 @itemize
13683 @item
13684 The name of the function.
13685 @item
13686 A number of bytes.
13687 @item
13688 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13689 @end itemize
13691 The qualifier @code{static} means that the function manipulates the stack
13692 statically: a fixed number of bytes are allocated for the frame on function
13693 entry and released on function exit; no stack adjustments are otherwise made
13694 in the function.  The second field is this fixed number of bytes.
13696 The qualifier @code{dynamic} means that the function manipulates the stack
13697 dynamically: in addition to the static allocation described above, stack
13698 adjustments are made in the body of the function, for example to push/pop
13699 arguments around function calls.  If the qualifier @code{bounded} is also
13700 present, the amount of these adjustments is bounded at compile time and
13701 the second field is an upper bound of the total amount of stack used by
13702 the function.  If it is not present, the amount of these adjustments is
13703 not bounded at compile time and the second field only represents the
13704 bounded part.
13706 @item -fstats
13707 @opindex fstats
13708 Emit statistics about front-end processing at the end of the compilation.
13709 This option is supported only by the C++ front end, and
13710 the information is generally only useful to the G++ development team.
13712 @item -fdbg-cnt-list
13713 @opindex fdbg-cnt-list
13714 Print the name and the counter upper bound for all debug counters.
13717 @item -fdbg-cnt=@var{counter-value-list}
13718 @opindex fdbg-cnt
13719 Set the internal debug counter upper bound.  @var{counter-value-list}
13720 is a comma-separated list of @var{name}:@var{value} pairs
13721 which sets the upper bound of each debug counter @var{name} to @var{value}.
13722 All debug counters have the initial upper bound of @code{UINT_MAX};
13723 thus @code{dbg_cnt} returns true always unless the upper bound
13724 is set by this option.
13725 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13726 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13728 @item -print-file-name=@var{library}
13729 @opindex print-file-name
13730 Print the full absolute name of the library file @var{library} that
13731 would be used when linking---and don't do anything else.  With this
13732 option, GCC does not compile or link anything; it just prints the
13733 file name.
13735 @item -print-multi-directory
13736 @opindex print-multi-directory
13737 Print the directory name corresponding to the multilib selected by any
13738 other switches present in the command line.  This directory is supposed
13739 to exist in @env{GCC_EXEC_PREFIX}.
13741 @item -print-multi-lib
13742 @opindex print-multi-lib
13743 Print the mapping from multilib directory names to compiler switches
13744 that enable them.  The directory name is separated from the switches by
13745 @samp{;}, and each switch starts with an @samp{@@} instead of the
13746 @samp{-}, without spaces between multiple switches.  This is supposed to
13747 ease shell processing.
13749 @item -print-multi-os-directory
13750 @opindex print-multi-os-directory
13751 Print the path to OS libraries for the selected
13752 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13753 present in the @file{lib} subdirectory and no multilibs are used, this is
13754 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13755 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13756 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13757 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13759 @item -print-multiarch
13760 @opindex print-multiarch
13761 Print the path to OS libraries for the selected multiarch,
13762 relative to some @file{lib} subdirectory.
13764 @item -print-prog-name=@var{program}
13765 @opindex print-prog-name
13766 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13768 @item -print-libgcc-file-name
13769 @opindex print-libgcc-file-name
13770 Same as @option{-print-file-name=libgcc.a}.
13772 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13773 but you do want to link with @file{libgcc.a}.  You can do:
13775 @smallexample
13776 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13777 @end smallexample
13779 @item -print-search-dirs
13780 @opindex print-search-dirs
13781 Print the name of the configured installation directory and a list of
13782 program and library directories @command{gcc} searches---and don't do anything else.
13784 This is useful when @command{gcc} prints the error message
13785 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13786 To resolve this you either need to put @file{cpp0} and the other compiler
13787 components where @command{gcc} expects to find them, or you can set the environment
13788 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13789 Don't forget the trailing @samp{/}.
13790 @xref{Environment Variables}.
13792 @item -print-sysroot
13793 @opindex print-sysroot
13794 Print the target sysroot directory that is used during
13795 compilation.  This is the target sysroot specified either at configure
13796 time or using the @option{--sysroot} option, possibly with an extra
13797 suffix that depends on compilation options.  If no target sysroot is
13798 specified, the option prints nothing.
13800 @item -print-sysroot-headers-suffix
13801 @opindex print-sysroot-headers-suffix
13802 Print the suffix added to the target sysroot when searching for
13803 headers, or give an error if the compiler is not configured with such
13804 a suffix---and don't do anything else.
13806 @item -dumpmachine
13807 @opindex dumpmachine
13808 Print the compiler's target machine (for example,
13809 @samp{i686-pc-linux-gnu})---and don't do anything else.
13811 @item -dumpversion
13812 @opindex dumpversion
13813 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13814 anything else.  This is the compiler version used in filesystem paths,
13815 specs, can be depending on how the compiler has been configured just
13816 a single number (major version), two numbers separated by dot (major and
13817 minor version) or three numbers separated by dots (major, minor and patchlevel
13818 version).
13820 @item -dumpfullversion
13821 @opindex dumpfullversion
13822 Print the full compiler version, always 3 numbers separated by dots,
13823 major, minor and patchlevel version.
13825 @item -dumpspecs
13826 @opindex dumpspecs
13827 Print the compiler's built-in specs---and don't do anything else.  (This
13828 is used when GCC itself is being built.)  @xref{Spec Files}.
13829 @end table
13831 @node Submodel Options
13832 @section Machine-Dependent Options
13833 @cindex submodel options
13834 @cindex specifying hardware config
13835 @cindex hardware models and configurations, specifying
13836 @cindex target-dependent options
13837 @cindex machine-dependent options
13839 Each target machine supported by GCC can have its own options---for
13840 example, to allow you to compile for a particular processor variant or
13841 ABI, or to control optimizations specific to that machine.  By
13842 convention, the names of machine-specific options start with
13843 @samp{-m}.
13845 Some configurations of the compiler also support additional target-specific
13846 options, usually for compatibility with other compilers on the same
13847 platform.
13849 @c This list is ordered alphanumerically by subsection name.
13850 @c It should be the same order and spelling as these options are listed
13851 @c in Machine Dependent Options
13853 @menu
13854 * AArch64 Options::
13855 * Adapteva Epiphany Options::
13856 * ARC Options::
13857 * ARM Options::
13858 * AVR Options::
13859 * Blackfin Options::
13860 * C6X Options::
13861 * CRIS Options::
13862 * CR16 Options::
13863 * Darwin Options::
13864 * DEC Alpha Options::
13865 * FR30 Options::
13866 * FT32 Options::
13867 * FRV Options::
13868 * GNU/Linux Options::
13869 * H8/300 Options::
13870 * HPPA Options::
13871 * IA-64 Options::
13872 * LM32 Options::
13873 * M32C Options::
13874 * M32R/D Options::
13875 * M680x0 Options::
13876 * MCore Options::
13877 * MeP Options::
13878 * MicroBlaze Options::
13879 * MIPS Options::
13880 * MMIX Options::
13881 * MN10300 Options::
13882 * Moxie Options::
13883 * MSP430 Options::
13884 * NDS32 Options::
13885 * Nios II Options::
13886 * Nvidia PTX Options::
13887 * PDP-11 Options::
13888 * picoChip Options::
13889 * PowerPC Options::
13890 * RISC-V Options::
13891 * RL78 Options::
13892 * RS/6000 and PowerPC Options::
13893 * RX Options::
13894 * S/390 and zSeries Options::
13895 * Score Options::
13896 * SH Options::
13897 * Solaris 2 Options::
13898 * SPARC Options::
13899 * SPU Options::
13900 * System V Options::
13901 * TILE-Gx Options::
13902 * TILEPro Options::
13903 * V850 Options::
13904 * VAX Options::
13905 * Visium Options::
13906 * VMS Options::
13907 * VxWorks Options::
13908 * x86 Options::
13909 * x86 Windows Options::
13910 * Xstormy16 Options::
13911 * Xtensa Options::
13912 * zSeries Options::
13913 @end menu
13915 @node AArch64 Options
13916 @subsection AArch64 Options
13917 @cindex AArch64 Options
13919 These options are defined for AArch64 implementations:
13921 @table @gcctabopt
13923 @item -mabi=@var{name}
13924 @opindex mabi
13925 Generate code for the specified data model.  Permissible values
13926 are @samp{ilp32} for SysV-like data model where int, long int and pointers
13927 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
13928 but long int and pointers are 64 bits.
13930 The default depends on the specific target configuration.  Note that
13931 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
13932 entire program with the same ABI, and link with a compatible set of libraries.
13934 @item -mbig-endian
13935 @opindex mbig-endian
13936 Generate big-endian code.  This is the default when GCC is configured for an
13937 @samp{aarch64_be-*-*} target.
13939 @item -mgeneral-regs-only
13940 @opindex mgeneral-regs-only
13941 Generate code which uses only the general-purpose registers.  This will prevent
13942 the compiler from using floating-point and Advanced SIMD registers but will not
13943 impose any restrictions on the assembler.
13945 @item -mlittle-endian
13946 @opindex mlittle-endian
13947 Generate little-endian code.  This is the default when GCC is configured for an
13948 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
13950 @item -mcmodel=tiny
13951 @opindex mcmodel=tiny
13952 Generate code for the tiny code model.  The program and its statically defined
13953 symbols must be within 1MB of each other.  Programs can be statically or
13954 dynamically linked.
13956 @item -mcmodel=small
13957 @opindex mcmodel=small
13958 Generate code for the small code model.  The program and its statically defined
13959 symbols must be within 4GB of each other.  Programs can be statically or
13960 dynamically linked.  This is the default code model.
13962 @item -mcmodel=large
13963 @opindex mcmodel=large
13964 Generate code for the large code model.  This makes no assumptions about
13965 addresses and sizes of sections.  Programs can be statically linked only.
13967 @item -mstrict-align
13968 @opindex mstrict-align
13969 Avoid generating memory accesses that may not be aligned on a natural object
13970 boundary as described in the architecture specification.
13972 @item -momit-leaf-frame-pointer
13973 @itemx -mno-omit-leaf-frame-pointer
13974 @opindex momit-leaf-frame-pointer
13975 @opindex mno-omit-leaf-frame-pointer
13976 Omit or keep the frame pointer in leaf functions.  The former behavior is the
13977 default.
13979 @item -mtls-dialect=desc
13980 @opindex mtls-dialect=desc
13981 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
13982 of TLS variables.  This is the default.
13984 @item -mtls-dialect=traditional
13985 @opindex mtls-dialect=traditional
13986 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
13987 of TLS variables.
13989 @item -mtls-size=@var{size}
13990 @opindex mtls-size
13991 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
13992 This option requires binutils 2.26 or newer.
13994 @item -mfix-cortex-a53-835769
13995 @itemx -mno-fix-cortex-a53-835769
13996 @opindex mfix-cortex-a53-835769
13997 @opindex mno-fix-cortex-a53-835769
13998 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
13999 This involves inserting a NOP instruction between memory instructions and
14000 64-bit integer multiply-accumulate instructions.
14002 @item -mfix-cortex-a53-843419
14003 @itemx -mno-fix-cortex-a53-843419
14004 @opindex mfix-cortex-a53-843419
14005 @opindex mno-fix-cortex-a53-843419
14006 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14007 This erratum workaround is made at link time and this will only pass the
14008 corresponding flag to the linker.
14010 @item -mlow-precision-recip-sqrt
14011 @item -mno-low-precision-recip-sqrt
14012 @opindex mlow-precision-recip-sqrt
14013 @opindex mno-low-precision-recip-sqrt
14014 Enable or disable the reciprocal square root approximation.
14015 This option only has an effect if @option{-ffast-math} or
14016 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14017 precision of reciprocal square root results to about 16 bits for
14018 single precision and to 32 bits for double precision.
14020 @item -mlow-precision-sqrt
14021 @item -mno-low-precision-sqrt
14022 @opindex -mlow-precision-sqrt
14023 @opindex -mno-low-precision-sqrt
14024 Enable or disable the square root approximation.
14025 This option only has an effect if @option{-ffast-math} or
14026 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14027 precision of square root results to about 16 bits for
14028 single precision and to 32 bits for double precision.
14029 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14031 @item -mlow-precision-div
14032 @item -mno-low-precision-div
14033 @opindex -mlow-precision-div
14034 @opindex -mno-low-precision-div
14035 Enable or disable the division approximation.
14036 This option only has an effect if @option{-ffast-math} or
14037 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14038 precision of division results to about 16 bits for
14039 single precision and to 32 bits for double precision.
14041 @item -march=@var{name}
14042 @opindex march
14043 Specify the name of the target architecture and, optionally, one or
14044 more feature modifiers.  This option has the form
14045 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14047 The permissible values for @var{arch} are @samp{armv8-a},
14048 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14050 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14051 support for the ARMv8.3-A architecture extensions.
14053 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14054 support for the ARMv8.2-A architecture extensions.
14056 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14057 support for the ARMv8.1-A architecture extension.  In particular, it
14058 enables the @samp{+crc} and @samp{+lse} features.
14060 The value @samp{native} is available on native AArch64 GNU/Linux and
14061 causes the compiler to pick the architecture of the host system.  This
14062 option has no effect if the compiler is unable to recognize the
14063 architecture of the host system,
14065 The permissible values for @var{feature} are listed in the sub-section
14066 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14067 Feature Modifiers}.  Where conflicting feature modifiers are
14068 specified, the right-most feature is used.
14070 GCC uses @var{name} to determine what kind of instructions it can emit
14071 when generating assembly code.  If @option{-march} is specified
14072 without either of @option{-mtune} or @option{-mcpu} also being
14073 specified, the code is tuned to perform well across a range of target
14074 processors implementing the target architecture.
14076 @item -mtune=@var{name}
14077 @opindex mtune
14078 Specify the name of the target processor for which GCC should tune the
14079 performance of the code.  Permissible values for this option are:
14080 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14081 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14082 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14083 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14084 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14085 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14086 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14087 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14088 @samp{native}.
14090 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14091 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14092 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14093 big.LITTLE system.
14095 Additionally on native AArch64 GNU/Linux systems the value
14096 @samp{native} tunes performance to the host system.  This option has no effect
14097 if the compiler is unable to recognize the processor of the host system.
14099 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14100 are specified, the code is tuned to perform well across a range
14101 of target processors.
14103 This option cannot be suffixed by feature modifiers.
14105 @item -mcpu=@var{name}
14106 @opindex mcpu
14107 Specify the name of the target processor, optionally suffixed by one
14108 or more feature modifiers.  This option has the form
14109 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14110 the permissible values for @var{cpu} are the same as those available
14111 for @option{-mtune}.  The permissible values for @var{feature} are
14112 documented in the sub-section on
14113 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14114 Feature Modifiers}.  Where conflicting feature modifiers are
14115 specified, the right-most feature is used.
14117 GCC uses @var{name} to determine what kind of instructions it can emit when
14118 generating assembly code (as if by @option{-march}) and to determine
14119 the target processor for which to tune for performance (as if
14120 by @option{-mtune}).  Where this option is used in conjunction
14121 with @option{-march} or @option{-mtune}, those options take precedence
14122 over the appropriate part of this option.
14124 @item -moverride=@var{string}
14125 @opindex moverride
14126 Override tuning decisions made by the back-end in response to a
14127 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14128 for @var{string} in this option are not guaranteed to be consistent
14129 across releases.
14131 This option is only intended to be useful when developing GCC.
14133 @item -mpc-relative-literal-loads
14134 @opindex mpc-relative-literal-loads
14135 Enable PC-relative literal loads.  With this option literal pools are
14136 accessed using a single instruction and emitted after each function.  This
14137 limits the maximum size of functions to 1MB.  This is enabled by default for
14138 @option{-mcmodel=tiny}.
14140 @item -msign-return-address=@var{scope}
14141 @opindex msign-return-address
14142 Select the function scope on which return address signing will be applied.
14143 Permissible values are @samp{none}, which disables return address signing,
14144 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14145 functions, and @samp{all}, which enables pointer signing for all functions.  The
14146 default value is @samp{none}.
14148 @end table
14150 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14151 @anchor{aarch64-feature-modifiers}
14152 @cindex @option{-march} feature modifiers
14153 @cindex @option{-mcpu} feature modifiers
14154 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14155 the following and their inverses @option{no@var{feature}}:
14157 @table @samp
14158 @item crc
14159 Enable CRC extension.  This is on by default for
14160 @option{-march=armv8.1-a}.
14161 @item crypto
14162 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14163 instructions.
14164 @item fp
14165 Enable floating-point instructions.  This is on by default for all possible
14166 values for options @option{-march} and @option{-mcpu}.
14167 @item simd
14168 Enable Advanced SIMD instructions.  This also enables floating-point
14169 instructions.  This is on by default for all possible values for options
14170 @option{-march} and @option{-mcpu}.
14171 @item lse
14172 Enable Large System Extension instructions.  This is on by default for
14173 @option{-march=armv8.1-a}.
14174 @item fp16
14175 Enable FP16 extension.  This also enables floating-point instructions.
14177 @end table
14179 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14180 Conversely, @option{nofp} implies @option{nosimd}, which implies
14181 @option{nocrypto}.
14183 @node Adapteva Epiphany Options
14184 @subsection Adapteva Epiphany Options
14186 These @samp{-m} options are defined for Adapteva Epiphany:
14188 @table @gcctabopt
14189 @item -mhalf-reg-file
14190 @opindex mhalf-reg-file
14191 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14192 That allows code to run on hardware variants that lack these registers.
14194 @item -mprefer-short-insn-regs
14195 @opindex mprefer-short-insn-regs
14196 Preferentially allocate registers that allow short instruction generation.
14197 This can result in increased instruction count, so this may either reduce or
14198 increase overall code size.
14200 @item -mbranch-cost=@var{num}
14201 @opindex mbranch-cost
14202 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14203 This cost is only a heuristic and is not guaranteed to produce
14204 consistent results across releases.
14206 @item -mcmove
14207 @opindex mcmove
14208 Enable the generation of conditional moves.
14210 @item -mnops=@var{num}
14211 @opindex mnops
14212 Emit @var{num} NOPs before every other generated instruction.
14214 @item -mno-soft-cmpsf
14215 @opindex mno-soft-cmpsf
14216 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14217 and test the flags.  This is faster than a software comparison, but can
14218 get incorrect results in the presence of NaNs, or when two different small
14219 numbers are compared such that their difference is calculated as zero.
14220 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14221 software comparisons.
14223 @item -mstack-offset=@var{num}
14224 @opindex mstack-offset
14225 Set the offset between the top of the stack and the stack pointer.
14226 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14227 can be used by leaf functions without stack allocation.
14228 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14229 Note also that this option changes the ABI; compiling a program with a
14230 different stack offset than the libraries have been compiled with
14231 generally does not work.
14232 This option can be useful if you want to evaluate if a different stack
14233 offset would give you better code, but to actually use a different stack
14234 offset to build working programs, it is recommended to configure the
14235 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14237 @item -mno-round-nearest
14238 @opindex mno-round-nearest
14239 Make the scheduler assume that the rounding mode has been set to
14240 truncating.  The default is @option{-mround-nearest}.
14242 @item -mlong-calls
14243 @opindex mlong-calls
14244 If not otherwise specified by an attribute, assume all calls might be beyond
14245 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14246 function address into a register before performing a (otherwise direct) call.
14247 This is the default.
14249 @item -mshort-calls
14250 @opindex short-calls
14251 If not otherwise specified by an attribute, assume all direct calls are
14252 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14253 for direct calls.  The default is @option{-mlong-calls}.
14255 @item -msmall16
14256 @opindex msmall16
14257 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14258 apply to function addresses for which @option{-mlong-calls} semantics
14259 are in effect.
14261 @item -mfp-mode=@var{mode}
14262 @opindex mfp-mode
14263 Set the prevailing mode of the floating-point unit.
14264 This determines the floating-point mode that is provided and expected
14265 at function call and return time.  Making this mode match the mode you
14266 predominantly need at function start can make your programs smaller and
14267 faster by avoiding unnecessary mode switches.
14269 @var{mode} can be set to one the following values:
14271 @table @samp
14272 @item caller
14273 Any mode at function entry is valid, and retained or restored when
14274 the function returns, and when it calls other functions.
14275 This mode is useful for compiling libraries or other compilation units
14276 you might want to incorporate into different programs with different
14277 prevailing FPU modes, and the convenience of being able to use a single
14278 object file outweighs the size and speed overhead for any extra
14279 mode switching that might be needed, compared with what would be needed
14280 with a more specific choice of prevailing FPU mode.
14282 @item truncate
14283 This is the mode used for floating-point calculations with
14284 truncating (i.e.@: round towards zero) rounding mode.  That includes
14285 conversion from floating point to integer.
14287 @item round-nearest
14288 This is the mode used for floating-point calculations with
14289 round-to-nearest-or-even rounding mode.
14291 @item int
14292 This is the mode used to perform integer calculations in the FPU, e.g.@:
14293 integer multiply, or integer multiply-and-accumulate.
14294 @end table
14296 The default is @option{-mfp-mode=caller}
14298 @item -mnosplit-lohi
14299 @itemx -mno-postinc
14300 @itemx -mno-postmodify
14301 @opindex mnosplit-lohi
14302 @opindex mno-postinc
14303 @opindex mno-postmodify
14304 Code generation tweaks that disable, respectively, splitting of 32-bit
14305 loads, generation of post-increment addresses, and generation of
14306 post-modify addresses.  The defaults are @option{msplit-lohi},
14307 @option{-mpost-inc}, and @option{-mpost-modify}.
14309 @item -mnovect-double
14310 @opindex mno-vect-double
14311 Change the preferred SIMD mode to SImode.  The default is
14312 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14314 @item -max-vect-align=@var{num}
14315 @opindex max-vect-align
14316 The maximum alignment for SIMD vector mode types.
14317 @var{num} may be 4 or 8.  The default is 8.
14318 Note that this is an ABI change, even though many library function
14319 interfaces are unaffected if they don't use SIMD vector modes
14320 in places that affect size and/or alignment of relevant types.
14322 @item -msplit-vecmove-early
14323 @opindex msplit-vecmove-early
14324 Split vector moves into single word moves before reload.  In theory this
14325 can give better register allocation, but so far the reverse seems to be
14326 generally the case.
14328 @item -m1reg-@var{reg}
14329 @opindex m1reg-
14330 Specify a register to hold the constant @minus{}1, which makes loading small negative
14331 constants and certain bitmasks faster.
14332 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14333 which specify use of that register as a fixed register,
14334 and @samp{none}, which means that no register is used for this
14335 purpose.  The default is @option{-m1reg-none}.
14337 @end table
14339 @node ARC Options
14340 @subsection ARC Options
14341 @cindex ARC options
14343 The following options control the architecture variant for which code
14344 is being compiled:
14346 @c architecture variants
14347 @table @gcctabopt
14349 @item -mbarrel-shifter
14350 @opindex mbarrel-shifter
14351 Generate instructions supported by barrel shifter.  This is the default
14352 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14354 @item -mcpu=@var{cpu}
14355 @opindex mcpu
14356 Set architecture type, register usage, and instruction scheduling
14357 parameters for @var{cpu}.  There are also shortcut alias options
14358 available for backward compatibility and convenience.  Supported
14359 values for @var{cpu} are
14361 @table @samp
14362 @opindex mA6
14363 @opindex mARC600
14364 @item arc600
14365 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14367 @item arc601
14368 @opindex mARC601
14369 Compile for ARC601.  Alias: @option{-mARC601}.
14371 @item arc700
14372 @opindex mA7
14373 @opindex mARC700
14374 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14375 This is the default when configured with @option{--with-cpu=arc700}@.
14377 @item arcem
14378 Compile for ARC EM.
14380 @item archs
14381 Compile for ARC HS.
14383 @item em
14384 Compile for ARC EM CPU with no hardware extensions.
14386 @item em4
14387 Compile for ARC EM4 CPU.
14389 @item em4_dmips
14390 Compile for ARC EM4 DMIPS CPU.
14392 @item em4_fpus
14393 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14394 extension.
14396 @item em4_fpuda
14397 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14398 double assist instructions.
14400 @item hs
14401 Compile for ARC HS CPU with no hardware extensions except the atomic
14402 instructions.
14404 @item hs34
14405 Compile for ARC HS34 CPU.
14407 @item hs38
14408 Compile for ARC HS38 CPU.
14410 @item hs38_linux
14411 Compile for ARC HS38 CPU with all hardware extensions on.
14413 @item arc600_norm
14414 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14416 @item arc600_mul32x16
14417 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14418 instructions enabled.
14420 @item arc600_mul64
14421 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14422 instructions enabled.
14424 @item arc601_norm
14425 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14427 @item arc601_mul32x16
14428 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14429 instructions enabled.
14431 @item arc601_mul64
14432 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14433 instructions enabled.
14435 @item nps400
14436 Compile for ARC 700 on NPS400 chip.
14438 @end table
14440 @item -mdpfp
14441 @opindex mdpfp
14442 @itemx -mdpfp-compact
14443 @opindex mdpfp-compact
14444 Generate double-precision FPX instructions, tuned for the compact
14445 implementation.
14447 @item -mdpfp-fast
14448 @opindex mdpfp-fast
14449 Generate double-precision FPX instructions, tuned for the fast
14450 implementation.
14452 @item -mno-dpfp-lrsr
14453 @opindex mno-dpfp-lrsr
14454 Disable @code{lr} and @code{sr} instructions from using FPX extension
14455 aux registers.
14457 @item -mea
14458 @opindex mea
14459 Generate extended arithmetic instructions.  Currently only
14460 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14461 supported.  This is always enabled for @option{-mcpu=ARC700}.
14463 @item -mno-mpy
14464 @opindex mno-mpy
14465 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14466 deprecated.
14468 @item -mmul32x16
14469 @opindex mmul32x16
14470 Generate 32x16-bit multiply and multiply-accumulate instructions.
14472 @item -mmul64
14473 @opindex mmul64
14474 Generate @code{mul64} and @code{mulu64} instructions.  
14475 Only valid for @option{-mcpu=ARC600}.
14477 @item -mnorm
14478 @opindex mnorm
14479 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14480 is in effect.
14482 @item -mspfp
14483 @opindex mspfp
14484 @itemx -mspfp-compact
14485 @opindex mspfp-compact
14486 Generate single-precision FPX instructions, tuned for the compact
14487 implementation.
14489 @item -mspfp-fast
14490 @opindex mspfp-fast
14491 Generate single-precision FPX instructions, tuned for the fast
14492 implementation.
14494 @item -msimd
14495 @opindex msimd
14496 Enable generation of ARC SIMD instructions via target-specific
14497 builtins.  Only valid for @option{-mcpu=ARC700}.
14499 @item -msoft-float
14500 @opindex msoft-float
14501 This option ignored; it is provided for compatibility purposes only.
14502 Software floating-point code is emitted by default, and this default
14503 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14504 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14505 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14507 @item -mswap
14508 @opindex mswap
14509 Generate @code{swap} instructions.
14511 @item -matomic
14512 @opindex matomic
14513 This enables use of the locked load/store conditional extension to implement
14514 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14515 EM cores.
14517 @item -mdiv-rem
14518 @opindex mdiv-rem
14519 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14521 @item -mcode-density
14522 @opindex mcode-density
14523 Enable code density instructions for ARC EM.  
14524 This option is on by default for ARC HS.
14526 @item -mll64
14527 @opindex mll64
14528 Enable double load/store operations for ARC HS cores.
14530 @item -mtp-regno=@var{regno}
14531 @opindex mtp-regno
14532 Specify thread pointer register number.
14534 @item -mmpy-option=@var{multo}
14535 @opindex mmpy-option
14536 Compile ARCv2 code with a multiplier design option.  You can specify 
14537 the option using either a string or numeric value for @var{multo}.  
14538 @samp{wlh1} is the default value.  The recognized values are:
14540 @table @samp
14541 @item 0
14542 @itemx none
14543 No multiplier available.
14545 @item 1
14546 @itemx w
14547 16x16 multiplier, fully pipelined.
14548 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14550 @item 2
14551 @itemx wlh1
14552 32x32 multiplier, fully
14553 pipelined (1 stage).  The following instructions are additionally
14554 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14556 @item 3
14557 @itemx wlh2
14558 32x32 multiplier, fully pipelined
14559 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14560 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14562 @item 4
14563 @itemx wlh3
14564 Two 16x16 multipliers, blocking,
14565 sequential.  The following instructions are additionally enabled: @code{mpy},
14566 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14568 @item 5
14569 @itemx wlh4
14570 One 16x16 multiplier, blocking,
14571 sequential.  The following instructions are additionally enabled: @code{mpy},
14572 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14574 @item 6
14575 @itemx wlh5
14576 One 32x4 multiplier, blocking,
14577 sequential.  The following instructions are additionally enabled: @code{mpy},
14578 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14580 @item 7
14581 @itemx plus_dmpy
14582 ARC HS SIMD support.
14584 @item 8
14585 @itemx plus_macd
14586 ARC HS SIMD support.
14588 @item 9
14589 @itemx plus_qmacw
14590 ARC HS SIMD support.
14592 @end table
14594 This option is only available for ARCv2 cores@.
14596 @item -mfpu=@var{fpu}
14597 @opindex mfpu
14598 Enables support for specific floating-point hardware extensions for ARCv2
14599 cores.  Supported values for @var{fpu} are:
14601 @table @samp
14603 @item fpus
14604 Enables support for single-precision floating-point hardware
14605 extensions@.
14607 @item fpud
14608 Enables support for double-precision floating-point hardware
14609 extensions.  The single-precision floating-point extension is also
14610 enabled.  Not available for ARC EM@.
14612 @item fpuda
14613 Enables support for double-precision floating-point hardware
14614 extensions using double-precision assist instructions.  The single-precision
14615 floating-point extension is also enabled.  This option is
14616 only available for ARC EM@.
14618 @item fpuda_div
14619 Enables support for double-precision floating-point hardware
14620 extensions using double-precision assist instructions.
14621 The single-precision floating-point, square-root, and divide 
14622 extensions are also enabled.  This option is
14623 only available for ARC EM@.
14625 @item fpuda_fma
14626 Enables support for double-precision floating-point hardware
14627 extensions using double-precision assist instructions.
14628 The single-precision floating-point and fused multiply and add 
14629 hardware extensions are also enabled.  This option is
14630 only available for ARC EM@.
14632 @item fpuda_all
14633 Enables support for double-precision floating-point hardware
14634 extensions using double-precision assist instructions.
14635 All single-precision floating-point hardware extensions are also
14636 enabled.  This option is only available for ARC EM@.
14638 @item fpus_div
14639 Enables support for single-precision floating-point, square-root and divide 
14640 hardware extensions@.
14642 @item fpud_div
14643 Enables support for double-precision floating-point, square-root and divide 
14644 hardware extensions.  This option
14645 includes option @samp{fpus_div}. Not available for ARC EM@.
14647 @item fpus_fma
14648 Enables support for single-precision floating-point and 
14649 fused multiply and add hardware extensions@.
14651 @item fpud_fma
14652 Enables support for double-precision floating-point and 
14653 fused multiply and add hardware extensions.  This option
14654 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14656 @item fpus_all
14657 Enables support for all single-precision floating-point hardware
14658 extensions@.
14660 @item fpud_all
14661 Enables support for all single- and double-precision floating-point
14662 hardware extensions.  Not available for ARC EM@.
14664 @end table
14666 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14667 @opindex mirq-ctrl-saved
14668 Specifies general-purposes registers that the processor automatically
14669 saves/restores on interrupt entry and exit.  @var{register-range} is
14670 specified as two registers separated by a dash.  The register range
14671 always starts with @code{r0}, the upper limit is @code{fp} register.
14672 @var{blink} and @var{lp_count} are optional.  This option is only
14673 valid for ARC EM and ARC HS cores.
14675 @item -mrgf-banked-regs=@var{number}
14676 @opindex mrgf-banked-regs
14677 Specifies the number of registers replicated in second register bank
14678 on entry to fast interrupt.  Fast interrupts are interrupts with the
14679 highest priority level P0.  These interrupts save only PC and STATUS32
14680 registers to avoid memory transactions during interrupt entry and exit
14681 sequences.  Use this option when you are using fast interrupts in an
14682 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14684 @end table
14686 The following options are passed through to the assembler, and also
14687 define preprocessor macro symbols.
14689 @c Flags used by the assembler, but for which we define preprocessor
14690 @c macro symbols as well.
14691 @table @gcctabopt
14692 @item -mdsp-packa
14693 @opindex mdsp-packa
14694 Passed down to the assembler to enable the DSP Pack A extensions.
14695 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14696 deprecated.
14698 @item -mdvbf
14699 @opindex mdvbf
14700 Passed down to the assembler to enable the dual Viterbi butterfly
14701 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14702 option is deprecated.
14704 @c ARC700 4.10 extension instruction
14705 @item -mlock
14706 @opindex mlock
14707 Passed down to the assembler to enable the locked load/store
14708 conditional extension.  Also sets the preprocessor symbol
14709 @code{__Xlock}.
14711 @item -mmac-d16
14712 @opindex mmac-d16
14713 Passed down to the assembler.  Also sets the preprocessor symbol
14714 @code{__Xxmac_d16}.  This option is deprecated.
14716 @item -mmac-24
14717 @opindex mmac-24
14718 Passed down to the assembler.  Also sets the preprocessor symbol
14719 @code{__Xxmac_24}.  This option is deprecated.
14721 @c ARC700 4.10 extension instruction
14722 @item -mrtsc
14723 @opindex mrtsc
14724 Passed down to the assembler to enable the 64-bit time-stamp counter
14725 extension instruction.  Also sets the preprocessor symbol
14726 @code{__Xrtsc}.  This option is deprecated.
14728 @c ARC700 4.10 extension instruction
14729 @item -mswape
14730 @opindex mswape
14731 Passed down to the assembler to enable the swap byte ordering
14732 extension instruction.  Also sets the preprocessor symbol
14733 @code{__Xswape}.
14735 @item -mtelephony
14736 @opindex mtelephony
14737 Passed down to the assembler to enable dual- and single-operand
14738 instructions for telephony.  Also sets the preprocessor symbol
14739 @code{__Xtelephony}.  This option is deprecated.
14741 @item -mxy
14742 @opindex mxy
14743 Passed down to the assembler to enable the XY memory extension.  Also
14744 sets the preprocessor symbol @code{__Xxy}.
14746 @end table
14748 The following options control how the assembly code is annotated:
14750 @c Assembly annotation options
14751 @table @gcctabopt
14752 @item -misize
14753 @opindex misize
14754 Annotate assembler instructions with estimated addresses.
14756 @item -mannotate-align
14757 @opindex mannotate-align
14758 Explain what alignment considerations lead to the decision to make an
14759 instruction short or long.
14761 @end table
14763 The following options are passed through to the linker:
14765 @c options passed through to the linker
14766 @table @gcctabopt
14767 @item -marclinux
14768 @opindex marclinux
14769 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14770 This option is enabled by default in tool chains built for
14771 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14772 when profiling is not requested.
14774 @item -marclinux_prof
14775 @opindex marclinux_prof
14776 Passed through to the linker, to specify use of the
14777 @code{arclinux_prof} emulation.  This option is enabled by default in
14778 tool chains built for @w{@code{arc-linux-uclibc}} and
14779 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14781 @end table
14783 The following options control the semantics of generated code:
14785 @c semantically relevant code generation options
14786 @table @gcctabopt
14787 @item -mlong-calls
14788 @opindex mlong-calls
14789 Generate calls as register indirect calls, thus providing access
14790 to the full 32-bit address range.
14792 @item -mmedium-calls
14793 @opindex mmedium-calls
14794 Don't use less than 25-bit addressing range for calls, which is the
14795 offset available for an unconditional branch-and-link
14796 instruction.  Conditional execution of function calls is suppressed, to
14797 allow use of the 25-bit range, rather than the 21-bit range with
14798 conditional branch-and-link.  This is the default for tool chains built
14799 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
14801 @item -mno-sdata
14802 @opindex mno-sdata
14803 Do not generate sdata references.  This is the default for tool chains
14804 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
14805 targets.
14807 @item -mvolatile-cache
14808 @opindex mvolatile-cache
14809 Use ordinarily cached memory accesses for volatile references.  This is the
14810 default.
14812 @item -mno-volatile-cache
14813 @opindex mno-volatile-cache
14814 Enable cache bypass for volatile references.
14816 @end table
14818 The following options fine tune code generation:
14819 @c code generation tuning options
14820 @table @gcctabopt
14821 @item -malign-call
14822 @opindex malign-call
14823 Do alignment optimizations for call instructions.
14825 @item -mauto-modify-reg
14826 @opindex mauto-modify-reg
14827 Enable the use of pre/post modify with register displacement.
14829 @item -mbbit-peephole
14830 @opindex mbbit-peephole
14831 Enable bbit peephole2.
14833 @item -mno-brcc
14834 @opindex mno-brcc
14835 This option disables a target-specific pass in @file{arc_reorg} to
14836 generate compare-and-branch (@code{br@var{cc}}) instructions.  
14837 It has no effect on
14838 generation of these instructions driven by the combiner pass.
14840 @item -mcase-vector-pcrel
14841 @opindex mcase-vector-pcrel
14842 Use PC-relative switch case tables to enable case table shortening.
14843 This is the default for @option{-Os}.
14845 @item -mcompact-casesi
14846 @opindex mcompact-casesi
14847 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
14848 and only available for ARCv1 cores.
14850 @item -mno-cond-exec
14851 @opindex mno-cond-exec
14852 Disable the ARCompact-specific pass to generate conditional 
14853 execution instructions.
14855 Due to delay slot scheduling and interactions between operand numbers,
14856 literal sizes, instruction lengths, and the support for conditional execution,
14857 the target-independent pass to generate conditional execution is often lacking,
14858 so the ARC port has kept a special pass around that tries to find more
14859 conditional execution generation opportunities after register allocation,
14860 branch shortening, and delay slot scheduling have been done.  This pass
14861 generally, but not always, improves performance and code size, at the cost of
14862 extra compilation time, which is why there is an option to switch it off.
14863 If you have a problem with call instructions exceeding their allowable
14864 offset range because they are conditionalized, you should consider using
14865 @option{-mmedium-calls} instead.
14867 @item -mearly-cbranchsi
14868 @opindex mearly-cbranchsi
14869 Enable pre-reload use of the @code{cbranchsi} pattern.
14871 @item -mexpand-adddi
14872 @opindex mexpand-adddi
14873 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
14874 @code{add.f}, @code{adc} etc.
14876 @item -mindexed-loads
14877 @opindex mindexed-loads
14878 Enable the use of indexed loads.  This can be problematic because some
14879 optimizers then assume that indexed stores exist, which is not
14880 the case.
14882 @opindex mlra
14883 Enable Local Register Allocation.  This is still experimental for ARC,
14884 so by default the compiler uses standard reload
14885 (i.e. @option{-mno-lra}).
14887 @item -mlra-priority-none
14888 @opindex mlra-priority-none
14889 Don't indicate any priority for target registers.
14891 @item -mlra-priority-compact
14892 @opindex mlra-priority-compact
14893 Indicate target register priority for r0..r3 / r12..r15.
14895 @item -mlra-priority-noncompact
14896 @opindex mlra-priority-noncompact
14897 Reduce target register priority for r0..r3 / r12..r15.
14899 @item -mno-millicode
14900 @opindex mno-millicode
14901 When optimizing for size (using @option{-Os}), prologues and epilogues
14902 that have to save or restore a large number of registers are often
14903 shortened by using call to a special function in libgcc; this is
14904 referred to as a @emph{millicode} call.  As these calls can pose
14905 performance issues, and/or cause linking issues when linking in a
14906 nonstandard way, this option is provided to turn off millicode call
14907 generation.
14909 @item -mmixed-code
14910 @opindex mmixed-code
14911 Tweak register allocation to help 16-bit instruction generation.
14912 This generally has the effect of decreasing the average instruction size
14913 while increasing the instruction count.
14915 @item -mq-class
14916 @opindex mq-class
14917 Enable @samp{q} instruction alternatives.
14918 This is the default for @option{-Os}.
14920 @item -mRcq
14921 @opindex mRcq
14922 Enable @samp{Rcq} constraint handling.  
14923 Most short code generation depends on this.
14924 This is the default.
14926 @item -mRcw
14927 @opindex mRcw
14928 Enable @samp{Rcw} constraint handling.  
14929 Most ccfsm condexec mostly depends on this.
14930 This is the default.
14932 @item -msize-level=@var{level}
14933 @opindex msize-level
14934 Fine-tune size optimization with regards to instruction lengths and alignment.
14935 The recognized values for @var{level} are:
14936 @table @samp
14937 @item 0
14938 No size optimization.  This level is deprecated and treated like @samp{1}.
14940 @item 1
14941 Short instructions are used opportunistically.
14943 @item 2
14944 In addition, alignment of loops and of code after barriers are dropped.
14946 @item 3
14947 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
14949 @end table
14951 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
14952 the behavior when this is not set is equivalent to level @samp{1}.
14954 @item -mtune=@var{cpu}
14955 @opindex mtune
14956 Set instruction scheduling parameters for @var{cpu}, overriding any implied
14957 by @option{-mcpu=}.
14959 Supported values for @var{cpu} are
14961 @table @samp
14962 @item ARC600
14963 Tune for ARC600 CPU.
14965 @item ARC601
14966 Tune for ARC601 CPU.
14968 @item ARC700
14969 Tune for ARC700 CPU with standard multiplier block.
14971 @item ARC700-xmac
14972 Tune for ARC700 CPU with XMAC block.
14974 @item ARC725D
14975 Tune for ARC725D CPU.
14977 @item ARC750D
14978 Tune for ARC750D CPU.
14980 @end table
14982 @item -mmultcost=@var{num}
14983 @opindex mmultcost
14984 Cost to assume for a multiply instruction, with @samp{4} being equal to a
14985 normal instruction.
14987 @item -munalign-prob-threshold=@var{probability}
14988 @opindex munalign-prob-threshold
14989 Set probability threshold for unaligning branches.
14990 When tuning for @samp{ARC700} and optimizing for speed, branches without
14991 filled delay slot are preferably emitted unaligned and long, unless
14992 profiling indicates that the probability for the branch to be taken
14993 is below @var{probability}.  @xref{Cross-profiling}.
14994 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
14996 @end table
14998 The following options are maintained for backward compatibility, but
14999 are now deprecated and will be removed in a future release:
15001 @c Deprecated options
15002 @table @gcctabopt
15004 @item -margonaut
15005 @opindex margonaut
15006 Obsolete FPX.
15008 @item -mbig-endian
15009 @opindex mbig-endian
15010 @itemx -EB
15011 @opindex EB
15012 Compile code for big-endian targets.  Use of these options is now
15013 deprecated.  Big-endian code is supported by configuring GCC to build
15014 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15015 for which big endian is the default.
15017 @item -mlittle-endian
15018 @opindex mlittle-endian
15019 @itemx -EL
15020 @opindex EL
15021 Compile code for little-endian targets.  Use of these options is now
15022 deprecated.  Little-endian code is supported by configuring GCC to build 
15023 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15024 for which little endian is the default.
15026 @item -mbarrel_shifter
15027 @opindex mbarrel_shifter
15028 Replaced by @option{-mbarrel-shifter}.
15030 @item -mdpfp_compact
15031 @opindex mdpfp_compact
15032 Replaced by @option{-mdpfp-compact}.
15034 @item -mdpfp_fast
15035 @opindex mdpfp_fast
15036 Replaced by @option{-mdpfp-fast}.
15038 @item -mdsp_packa
15039 @opindex mdsp_packa
15040 Replaced by @option{-mdsp-packa}.
15042 @item -mEA
15043 @opindex mEA
15044 Replaced by @option{-mea}.
15046 @item -mmac_24
15047 @opindex mmac_24
15048 Replaced by @option{-mmac-24}.
15050 @item -mmac_d16
15051 @opindex mmac_d16
15052 Replaced by @option{-mmac-d16}.
15054 @item -mspfp_compact
15055 @opindex mspfp_compact
15056 Replaced by @option{-mspfp-compact}.
15058 @item -mspfp_fast
15059 @opindex mspfp_fast
15060 Replaced by @option{-mspfp-fast}.
15062 @item -mtune=@var{cpu}
15063 @opindex mtune
15064 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15065 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15066 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15068 @item -multcost=@var{num}
15069 @opindex multcost
15070 Replaced by @option{-mmultcost}.
15072 @end table
15074 @node ARM Options
15075 @subsection ARM Options
15076 @cindex ARM options
15078 These @samp{-m} options are defined for the ARM port:
15080 @table @gcctabopt
15081 @item -mabi=@var{name}
15082 @opindex mabi
15083 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15084 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15086 @item -mapcs-frame
15087 @opindex mapcs-frame
15088 Generate a stack frame that is compliant with the ARM Procedure Call
15089 Standard for all functions, even if this is not strictly necessary for
15090 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15091 with this option causes the stack frames not to be generated for
15092 leaf functions.  The default is @option{-mno-apcs-frame}.
15093 This option is deprecated.
15095 @item -mapcs
15096 @opindex mapcs
15097 This is a synonym for @option{-mapcs-frame} and is deprecated.
15099 @ignore
15100 @c not currently implemented
15101 @item -mapcs-stack-check
15102 @opindex mapcs-stack-check
15103 Generate code to check the amount of stack space available upon entry to
15104 every function (that actually uses some stack space).  If there is
15105 insufficient space available then either the function
15106 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15107 called, depending upon the amount of stack space required.  The runtime
15108 system is required to provide these functions.  The default is
15109 @option{-mno-apcs-stack-check}, since this produces smaller code.
15111 @c not currently implemented
15112 @item -mapcs-reentrant
15113 @opindex mapcs-reentrant
15114 Generate reentrant, position-independent code.  The default is
15115 @option{-mno-apcs-reentrant}.
15116 @end ignore
15118 @item -mthumb-interwork
15119 @opindex mthumb-interwork
15120 Generate code that supports calling between the ARM and Thumb
15121 instruction sets.  Without this option, on pre-v5 architectures, the
15122 two instruction sets cannot be reliably used inside one program.  The
15123 default is @option{-mno-thumb-interwork}, since slightly larger code
15124 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15125 configurations this option is meaningless.
15127 @item -mno-sched-prolog
15128 @opindex mno-sched-prolog
15129 Prevent the reordering of instructions in the function prologue, or the
15130 merging of those instruction with the instructions in the function's
15131 body.  This means that all functions start with a recognizable set
15132 of instructions (or in fact one of a choice from a small set of
15133 different function prologues), and this information can be used to
15134 locate the start of functions inside an executable piece of code.  The
15135 default is @option{-msched-prolog}.
15137 @item -mfloat-abi=@var{name}
15138 @opindex mfloat-abi
15139 Specifies which floating-point ABI to use.  Permissible values
15140 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15142 Specifying @samp{soft} causes GCC to generate output containing
15143 library calls for floating-point operations.
15144 @samp{softfp} allows the generation of code using hardware floating-point
15145 instructions, but still uses the soft-float calling conventions.
15146 @samp{hard} allows generation of floating-point instructions
15147 and uses FPU-specific calling conventions.
15149 The default depends on the specific target configuration.  Note that
15150 the hard-float and soft-float ABIs are not link-compatible; you must
15151 compile your entire program with the same ABI, and link with a
15152 compatible set of libraries.
15154 @item -mlittle-endian
15155 @opindex mlittle-endian
15156 Generate code for a processor running in little-endian mode.  This is
15157 the default for all standard configurations.
15159 @item -mbig-endian
15160 @opindex mbig-endian
15161 Generate code for a processor running in big-endian mode; the default is
15162 to compile code for a little-endian processor.
15164 @item -march=@var{name@r{[}+extension@dots{}@r{]}}
15165 @opindex march
15166 This specifies the name of the target ARM architecture.  GCC uses this
15167 name to determine what kind of instructions it can emit when generating
15168 assembly code.  This option can be used in conjunction with or instead
15169 of the @option{-mcpu=} option.
15171 Permissible names are:
15172 @samp{armv4t},
15173 @samp{armv5t}, @samp{armv5te},
15174 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15175 @samp{armv6z}, @samp{armv6zk},
15176 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15177 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15178 @samp{armv7-r},
15179 @samp{armv6-m}, @samp{armv6s-m},
15180 @samp{armv7-m}, @samp{armv7e-m},
15181 @samp{armv8-m.base}, @samp{armv8-m.main},
15182 @samp{iwmmxt} and @samp{iwmmxt2}.
15184 Additionally, the following architectures, which lack support for the
15185 Thumb exection state, are recognized but support is deprecated:
15186 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15187 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15189 Many of the architectures support extensions.  These can be added by
15190 appending @samp{+@var{extension}} to the architecture name.  Extension
15191 options are processed in order and capabilities accumulate.  An extension
15192 will also enable any necessary base extensions
15193 upon which it depends.  For example, the @samp{+crypto} extension
15194 will always enable the @samp{+simd} extension.  The exception to the
15195 additive construction is for extensions that are prefixed with
15196 @samp{+no@dots{}}: these extensions disable the specified option and
15197 any other extensions that may depend on the presence of that
15198 extension.
15200 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15201 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15202 entirely disabled by the @samp{+nofp} option that follows it.
15204 Most extension names are generically named, but have an effect that is
15205 dependent upon the architecture to which it is applied.  For example,
15206 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15207 @samp{armv8-a} architectures, but will enable the original ARMv7
15208 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15209 variant for @samp{armv8-a}.
15211 The table below lists the supported extensions for each architecture.
15212 Architectures not mentioned do not support any extensions.
15214 @table @samp
15215 @item  armv5e
15216 @itemx armv5te
15217 @itemx armv6
15218 @itemx armv6j
15219 @itemx armv6k
15220 @itemx armv6kz
15221 @itemx armv6t2
15222 @itemx armv6z
15223 @itemx armv6zk
15224 @table @samp
15225 @item +fp
15226 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15227 used as an alias for this extension.
15229 @item +nofp
15230 Disable the floating-point instructions.
15231 @end table
15233 @item armv7
15234 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15235 @table @samp
15236 @item +fp
15237 The VFPv3 floating-point instructions, with 16 double-precision
15238 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15239 for this extension.  Note that floating-point is not supported by the
15240 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15241 ARMv7-R architectures.
15243 @item +nofp
15244 Disable the floating-point instructions.
15245 @end table
15247 @item armv7-a
15248 @table @samp
15249 @item +fp
15250 The VFPv3 floating-point instructions, with 16 double-precision
15251 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15252 for this extension.
15254 @item +simd
15255 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15256 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15257 for this extension.
15259 @item +vfpv3
15260 The VFPv3 floating-point instructions, with 32 double-precision
15261 registers.
15263 @item +vfpv3-d16-fp16
15264 The VFPv3 floating-point instructions, with 16 double-precision
15265 registers and the half-precision floating-point conversion operations.
15267 @item +vfpv3-fp16
15268 The VFPv3 floating-point instructions, with 32 double-precision
15269 registers and the half-precision floating-point conversion operations.
15271 @item +vfpv4-d16
15272 The VFPv4 floating-point instructions, with 16 double-precision
15273 registers.
15275 @item +vfpv4
15276 The VFPv4 floating-point instructions, with 32 double-precision
15277 registers.
15279 @item +neon-fp16
15280 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15281 the half-precision floating-point conversion operations.
15283 @item +neon-vfpv4
15284 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15286 @item +nosimd
15287 Disable the Advanced SIMD instructions (does not disable floating point).
15289 @item +nofp
15290 Disable the floating-point and Advanced SIMD instructions.
15291 @end table
15293 @item armv7ve
15294 The extended version of the ARMv7-A architecture with support for
15295 virtualization.
15296 @table @samp
15297 @item +fp
15298 The VFPv4 floating-point instructions, with 16 double-precision registers.
15299 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15301 @item +simd
15302 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15303 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15305 @item +vfpv3-d16
15306 The VFPv3 floating-point instructions, with 16 double-precision
15307 registers.
15309 @item +vfpv3
15310 The VFPv3 floating-point instructions, with 32 double-precision
15311 registers.
15313 @item +vfpv3-d16-fp16
15314 The VFPv3 floating-point instructions, with 16 double-precision
15315 registers and the half-precision floating-point conversion operations.
15317 @item +vfpv3-fp16
15318 The VFPv3 floating-point instructions, with 32 double-precision
15319 registers and the half-precision floating-point conversion operations.
15321 @item +vfpv4-d16
15322 The VFPv4 floating-point instructions, with 16 double-precision
15323 registers.
15325 @item +vfpv4
15326 The VFPv4 floating-point instructions, with 32 double-precision
15327 registers.
15329 @item +neon
15330 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15331 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15333 @item +neon-fp16
15334 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15335 the half-precision floating-point conversion operations.
15337 @item +nosimd
15338 Disable the Advanced SIMD instructions (does not disable floating point).
15340 @item +nofp
15341 Disable the floating-point and Advanced SIMD instructions.
15342 @end table
15344 @item armv8-a
15345 @table @samp
15346 @item +crc
15347 The Cyclic Redundancy Check (CRC) instructions.
15348 @item +simd
15349 The ARMv8 Advanced SIMD and floating-point instructions.
15350 @item +crypto
15351 The cryptographic instructions.
15352 @item +nocrypto
15353 Disable the cryptographic isntructions.
15354 @item +nofp
15355 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15356 @end table
15358 @item armv8.1-a
15359 @table @samp
15360 @item +simd
15361 The ARMv8.1 Advanced SIMD and floating-point instructions.
15363 @item +crypto
15364 The cryptographic instructions.  This also enables the Advanced SIMD and
15365 floating-point instructions.
15367 @item +nocrypto
15368 Disable the cryptographic isntructions.
15370 @item +nofp
15371 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15372 @end table
15374 @item armv8.2-a
15375 @table @samp
15376 @item +fp16
15377 The half-precision floating-point data processing instructions.
15378 This also enables the Advanced SIMD and floating-point instructions.
15380 @item +simd
15381 The ARMv8.1 Advanced SIMD and floating-point instructions.
15383 @item +crypto
15384 The cryptographic instructions.  This also enables the Advanced SIMD and
15385 floating-point instructions.
15387 @item +nocrypto
15388 Disable the cryptographic extension.
15390 @item +nofp
15391 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15392 @end table
15394 @item armv7-r
15395 @table @samp
15396 @item +fp.sp
15397 The single-precision VFPv3 floating-point instructions.  The extension
15398 @samp{+vfpv3xd} can be used as an alias for this extension.
15400 @item +fp
15401 The VFPv3 floating-point instructions with 16 double-precision registers.
15402 The extension +vfpv3-d16 can be used as an alias for this extension.
15404 @item +nofp
15405 Disable the floating-point extension.
15407 @item +idiv
15408 The ARM-state integer division instructions.
15410 @item +noidiv
15411 Disable the ARM-state integer division extension.
15412 @end table
15414 @item armv7e-m
15415 @table @samp
15416 @item +fp
15417 The single-precision VFPv4 floating-point instructions.
15419 @item +fpv5
15420 The single-precision FPv5 floating-point instructions.
15422 @item +fp.dp
15423 The single- and double-precision FPv5 floating-point instructions.
15425 @item +nofp
15426 Disable the floating-point extensions.
15427 @end table
15429 @item  armv8-m.main
15430 @table @samp
15431 @item +dsp
15432 The DSP instructions.
15434 @item +nodsp
15435 Disable the DSP extension.
15437 @item +fp
15438 The single-precision floating-point instructions.
15440 @item +fp.dp
15441 The single- and double-precision floating-point instructions.
15443 @item +nofp
15444 Disable the floating-point extension.
15446 @end table
15448 @end table
15450 @option{-march=native} causes the compiler to auto-detect the architecture
15451 of the build computer.  At present, this feature is only supported on
15452 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15453 is unsuccessful the option has no effect.
15455 @item -mtune=@var{name}
15456 @opindex mtune
15457 This option specifies the name of the target ARM processor for
15458 which GCC should tune the performance of the code.
15459 For some ARM implementations better performance can be obtained by using
15460 this option.
15461 Permissible names are: @samp{arm2}, @samp{arm250},
15462 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15463 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15464 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15465 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15466 @samp{arm720},
15467 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15468 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15469 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15470 @samp{strongarm1110},
15471 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15472 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15473 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15474 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15475 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15476 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15477 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15478 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15479 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15480 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a57},
15481 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-r4},
15482 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15483 @samp{cortex-m33},
15484 @samp{cortex-m23},
15485 @samp{cortex-m7},
15486 @samp{cortex-m4},
15487 @samp{cortex-m3},
15488 @samp{cortex-m1},
15489 @samp{cortex-m0},
15490 @samp{cortex-m0plus},
15491 @samp{cortex-m1.small-multiply},
15492 @samp{cortex-m0.small-multiply},
15493 @samp{cortex-m0plus.small-multiply},
15494 @samp{exynos-m1},
15495 @samp{marvell-pj4},
15496 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15497 @samp{fa526}, @samp{fa626},
15498 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15499 @samp{xgene1}.
15501 Additionally, this option can specify that GCC should tune the performance
15502 of the code for a big.LITTLE system.  Permissible names are:
15503 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15504 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15505 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}.
15507 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15508 performance for a blend of processors within architecture @var{arch}.
15509 The aim is to generate code that run well on the current most popular
15510 processors, balancing between optimizations that benefit some CPUs in the
15511 range, and avoiding performance pitfalls of other CPUs.  The effects of
15512 this option may change in future GCC versions as CPU models come and go.
15514 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15515 the extension options do not affect the tuning of the generated code.
15517 @option{-mtune=native} causes the compiler to auto-detect the CPU
15518 of the build computer.  At present, this feature is only supported on
15519 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15520 unsuccessful the option has no effect.
15522 @item -mcpu=@var{name@r{[}+extension@dots{}@r{]}}
15523 @opindex mcpu
15524 This specifies the name of the target ARM processor.  GCC uses this name
15525 to derive the name of the target ARM architecture (as if specified
15526 by @option{-march}) and the ARM processor type for which to tune for
15527 performance (as if specified by @option{-mtune}).  Where this option
15528 is used in conjunction with @option{-march} or @option{-mtune},
15529 those options take precedence over the appropriate part of this option.
15531 Many of the supported CPUs implement optional architectural
15532 extensions.  Where this is so the architectural extensions are
15533 normally enabled by default.  If implementations that lack the
15534 extension exist, then the extension syntax can be used to disable
15535 those extensions that have been omitted.  For floating-point and
15536 Advanced SIMD (Neon) instructions, the settings of the options
15537 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15538 floating-point and Advanced SIMD instructions will only be used if
15539 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15540 @option{-mfpu} other than @samp{auto} will override the available
15541 floating-point and SIMD extension instructions.
15543 For example, @samp{cortex-a9} can be found in three major
15544 configurations: integer only, with just a floating-point unit or with
15545 floating-point and Advanced SIMD.  The default is to enable all the
15546 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15547 be used to disable just the SIMD or both the SIMD and floating-point
15548 instructions respectively.
15550 Permissible names for this option are the same as those for
15551 @option{-mtune}.
15553 The following extension options are common to the listed CPUs:
15555 @table @samp
15556 @item  +nofp
15557 Disables the floating-point instructions on @samp{arm9e},
15558 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15559 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15560 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15561 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15562 Disables the floating-point and SIMD instructions on
15563 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15564 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15565 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15566 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35}
15567 and @samp{cortex-a53}.
15569 @item +nofp.dp
15570 Disables the double-precision component of the floating-point instructions
15571 on @samp{cortex-r5} and @samp{cortex-m7}.
15573 @item +nosimd
15574 Disables the SIMD (but not floating-point) instructions on
15575 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15576 and @samp{cortex-a9}.
15577 @end table
15579 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15580 VFPv3 with 16 double-precision registers.  It supports the following
15581 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15582 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15583 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15584 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15585 @option{-march=armv7-a}.
15587 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15588 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15589 See @option{-mtune} for more information.
15591 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15592 of the build computer.  At present, this feature is only supported on
15593 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15594 is unsuccessful the option has no effect.
15596 @item -mfpu=@var{name}
15597 @opindex mfpu
15598 This specifies what floating-point hardware (or hardware emulation) is
15599 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15600 @samp{vfpv3},
15601 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15602 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15603 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15604 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15605 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15606 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15607 is an alias for @samp{vfpv2}.
15609 The setting @samp{auto} is the default and is special.  It causes the
15610 compiler to select the floating-point and Advanced SIMD instructions
15611 based on the settings of @option{-mcpu} and @option{-march}.
15613 If the selected floating-point hardware includes the NEON extension
15614 (e.g. @option{-mfpu=neon}), note that floating-point
15615 operations are not generated by GCC's auto-vectorization pass unless
15616 @option{-funsafe-math-optimizations} is also specified.  This is
15617 because NEON hardware does not fully implement the IEEE 754 standard for
15618 floating-point arithmetic (in particular denormal values are treated as
15619 zero), so the use of NEON instructions may lead to a loss of precision.
15621 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}).
15623 @item -mfp16-format=@var{name}
15624 @opindex mfp16-format
15625 Specify the format of the @code{__fp16} half-precision floating-point type.
15626 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15627 the default is @samp{none}, in which case the @code{__fp16} type is not
15628 defined.  @xref{Half-Precision}, for more information.
15630 @item -mstructure-size-boundary=@var{n}
15631 @opindex mstructure-size-boundary
15632 The sizes of all structures and unions are rounded up to a multiple
15633 of the number of bits set by this option.  Permissible values are 8, 32
15634 and 64.  The default value varies for different toolchains.  For the COFF
15635 targeted toolchain the default value is 8.  A value of 64 is only allowed
15636 if the underlying ABI supports it.
15638 Specifying a larger number can produce faster, more efficient code, but
15639 can also increase the size of the program.  Different values are potentially
15640 incompatible.  Code compiled with one value cannot necessarily expect to
15641 work with code or libraries compiled with another value, if they exchange
15642 information using structures or unions.
15644 @item -mabort-on-noreturn
15645 @opindex mabort-on-noreturn
15646 Generate a call to the function @code{abort} at the end of a
15647 @code{noreturn} function.  It is executed if the function tries to
15648 return.
15650 @item -mlong-calls
15651 @itemx -mno-long-calls
15652 @opindex mlong-calls
15653 @opindex mno-long-calls
15654 Tells the compiler to perform function calls by first loading the
15655 address of the function into a register and then performing a subroutine
15656 call on this register.  This switch is needed if the target function
15657 lies outside of the 64-megabyte addressing range of the offset-based
15658 version of subroutine call instruction.
15660 Even if this switch is enabled, not all function calls are turned
15661 into long calls.  The heuristic is that static functions, functions
15662 that have the @code{short_call} attribute, functions that are inside
15663 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15664 definitions have already been compiled within the current compilation
15665 unit are not turned into long calls.  The exceptions to this rule are
15666 that weak function definitions, functions with the @code{long_call}
15667 attribute or the @code{section} attribute, and functions that are within
15668 the scope of a @code{#pragma long_calls} directive are always
15669 turned into long calls.
15671 This feature is not enabled by default.  Specifying
15672 @option{-mno-long-calls} restores the default behavior, as does
15673 placing the function calls within the scope of a @code{#pragma
15674 long_calls_off} directive.  Note these switches have no effect on how
15675 the compiler generates code to handle function calls via function
15676 pointers.
15678 @item -msingle-pic-base
15679 @opindex msingle-pic-base
15680 Treat the register used for PIC addressing as read-only, rather than
15681 loading it in the prologue for each function.  The runtime system is
15682 responsible for initializing this register with an appropriate value
15683 before execution begins.
15685 @item -mpic-register=@var{reg}
15686 @opindex mpic-register
15687 Specify the register to be used for PIC addressing.
15688 For standard PIC base case, the default is any suitable register
15689 determined by compiler.  For single PIC base case, the default is
15690 @samp{R9} if target is EABI based or stack-checking is enabled,
15691 otherwise the default is @samp{R10}.
15693 @item -mpic-data-is-text-relative
15694 @opindex mpic-data-is-text-relative
15695 Assume that the displacement between the text and data segments is fixed
15696 at static link time.  This permits using PC-relative addressing
15697 operations to access data known to be in the data segment.  For
15698 non-VxWorks RTP targets, this option is enabled by default.  When
15699 disabled on such targets, it will enable @option{-msingle-pic-base} by
15700 default.
15702 @item -mpoke-function-name
15703 @opindex mpoke-function-name
15704 Write the name of each function into the text section, directly
15705 preceding the function prologue.  The generated code is similar to this:
15707 @smallexample
15708      t0
15709          .ascii "arm_poke_function_name", 0
15710          .align
15711      t1
15712          .word 0xff000000 + (t1 - t0)
15713      arm_poke_function_name
15714          mov     ip, sp
15715          stmfd   sp!, @{fp, ip, lr, pc@}
15716          sub     fp, ip, #4
15717 @end smallexample
15719 When performing a stack backtrace, code can inspect the value of
15720 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15721 location @code{pc - 12} and the top 8 bits are set, then we know that
15722 there is a function name embedded immediately preceding this location
15723 and has length @code{((pc[-3]) & 0xff000000)}.
15725 @item -mthumb
15726 @itemx -marm
15727 @opindex marm
15728 @opindex mthumb
15730 Select between generating code that executes in ARM and Thumb
15731 states.  The default for most configurations is to generate code
15732 that executes in ARM state, but the default can be changed by
15733 configuring GCC with the @option{--with-mode=}@var{state}
15734 configure option.
15736 You can also override the ARM and Thumb mode for each function
15737 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15738 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15740 @item -mtpcs-frame
15741 @opindex mtpcs-frame
15742 Generate a stack frame that is compliant with the Thumb Procedure Call
15743 Standard for all non-leaf functions.  (A leaf function is one that does
15744 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15746 @item -mtpcs-leaf-frame
15747 @opindex mtpcs-leaf-frame
15748 Generate a stack frame that is compliant with the Thumb Procedure Call
15749 Standard for all leaf functions.  (A leaf function is one that does
15750 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15752 @item -mcallee-super-interworking
15753 @opindex mcallee-super-interworking
15754 Gives all externally visible functions in the file being compiled an ARM
15755 instruction set header which switches to Thumb mode before executing the
15756 rest of the function.  This allows these functions to be called from
15757 non-interworking code.  This option is not valid in AAPCS configurations
15758 because interworking is enabled by default.
15760 @item -mcaller-super-interworking
15761 @opindex mcaller-super-interworking
15762 Allows calls via function pointers (including virtual functions) to
15763 execute correctly regardless of whether the target code has been
15764 compiled for interworking or not.  There is a small overhead in the cost
15765 of executing a function pointer if this option is enabled.  This option
15766 is not valid in AAPCS configurations because interworking is enabled
15767 by default.
15769 @item -mtp=@var{name}
15770 @opindex mtp
15771 Specify the access model for the thread local storage pointer.  The valid
15772 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
15773 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
15774 (supported in the arm6k architecture), and @samp{auto}, which uses the
15775 best available method for the selected processor.  The default setting is
15776 @samp{auto}.
15778 @item -mtls-dialect=@var{dialect}
15779 @opindex mtls-dialect
15780 Specify the dialect to use for accessing thread local storage.  Two
15781 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
15782 @samp{gnu} dialect selects the original GNU scheme for supporting
15783 local and global dynamic TLS models.  The @samp{gnu2} dialect
15784 selects the GNU descriptor scheme, which provides better performance
15785 for shared libraries.  The GNU descriptor scheme is compatible with
15786 the original scheme, but does require new assembler, linker and
15787 library support.  Initial and local exec TLS models are unaffected by
15788 this option and always use the original scheme.
15790 @item -mword-relocations
15791 @opindex mword-relocations
15792 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
15793 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
15794 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
15795 is specified.
15797 @item -mfix-cortex-m3-ldrd
15798 @opindex mfix-cortex-m3-ldrd
15799 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
15800 with overlapping destination and base registers are used.  This option avoids
15801 generating these instructions.  This option is enabled by default when
15802 @option{-mcpu=cortex-m3} is specified.
15804 @item -munaligned-access
15805 @itemx -mno-unaligned-access
15806 @opindex munaligned-access
15807 @opindex mno-unaligned-access
15808 Enables (or disables) reading and writing of 16- and 32- bit values
15809 from addresses that are not 16- or 32- bit aligned.  By default
15810 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
15811 ARMv8-M Baseline architectures, and enabled for all other
15812 architectures.  If unaligned access is not enabled then words in packed
15813 data structures are accessed a byte at a time.
15815 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
15816 generated object file to either true or false, depending upon the
15817 setting of this option.  If unaligned access is enabled then the
15818 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
15819 defined.
15821 @item -mneon-for-64bits
15822 @opindex mneon-for-64bits
15823 Enables using Neon to handle scalar 64-bits operations. This is
15824 disabled by default since the cost of moving data from core registers
15825 to Neon is high.
15827 @item -mslow-flash-data
15828 @opindex mslow-flash-data
15829 Assume loading data from flash is slower than fetching instruction.
15830 Therefore literal load is minimized for better performance.
15831 This option is only supported when compiling for ARMv7 M-profile and
15832 off by default.
15834 @item -masm-syntax-unified
15835 @opindex masm-syntax-unified
15836 Assume inline assembler is using unified asm syntax.  The default is
15837 currently off which implies divided syntax.  This option has no impact
15838 on Thumb2. However, this may change in future releases of GCC.
15839 Divided syntax should be considered deprecated.
15841 @item -mrestrict-it
15842 @opindex mrestrict-it
15843 Restricts generation of IT blocks to conform to the rules of ARMv8.
15844 IT blocks can only contain a single 16-bit instruction from a select
15845 set of instructions. This option is on by default for ARMv8 Thumb mode.
15847 @item -mprint-tune-info
15848 @opindex mprint-tune-info
15849 Print CPU tuning information as comment in assembler file.  This is
15850 an option used only for regression testing of the compiler and not
15851 intended for ordinary use in compiling code.  This option is disabled
15852 by default.
15854 @item -mpure-code
15855 @opindex mpure-code
15856 Do not allow constant data to be placed in code sections.
15857 Additionally, when compiling for ELF object format give all text sections the
15858 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
15859 is only available when generating non-pic code for M-profile targets with the
15860 MOVT instruction.
15862 @item -mcmse
15863 @opindex mcmse
15864 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
15865 Development Tools Engineering Specification", which can be found on
15866 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
15867 @end table
15869 @node AVR Options
15870 @subsection AVR Options
15871 @cindex AVR Options
15873 These options are defined for AVR implementations:
15875 @table @gcctabopt
15876 @item -mmcu=@var{mcu}
15877 @opindex mmcu
15878 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
15880 The default for this option is@tie{}@samp{avr2}.
15882 GCC supports the following AVR devices and ISAs:
15884 @include avr-mmcu.texi
15886 @item -mabsdata
15887 @opindex mabsdata
15889 Assume that all data in static storage can be accessed by LDS / STS
15890 instructions.  This option has only an effect on reduced Tiny devices like
15891 ATtiny40.  See also the @code{absdata}
15892 @ref{AVR Variable Attributes,variable attribute}.
15894 @item -maccumulate-args
15895 @opindex maccumulate-args
15896 Accumulate outgoing function arguments and acquire/release the needed
15897 stack space for outgoing function arguments once in function
15898 prologue/epilogue.  Without this option, outgoing arguments are pushed
15899 before calling a function and popped afterwards.
15901 Popping the arguments after the function call can be expensive on
15902 AVR so that accumulating the stack space might lead to smaller
15903 executables because arguments need not be removed from the
15904 stack after such a function call.
15906 This option can lead to reduced code size for functions that perform
15907 several calls to functions that get their arguments on the stack like
15908 calls to printf-like functions.
15910 @item -mbranch-cost=@var{cost}
15911 @opindex mbranch-cost
15912 Set the branch costs for conditional branch instructions to
15913 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
15914 integers. The default branch cost is 0.
15916 @item -mcall-prologues
15917 @opindex mcall-prologues
15918 Functions prologues/epilogues are expanded as calls to appropriate
15919 subroutines.  Code size is smaller.
15921 @item -mint8
15922 @opindex mint8
15923 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
15924 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
15925 and @code{long long} is 4 bytes.  Please note that this option does not
15926 conform to the C standards, but it results in smaller code
15927 size.
15929 @item -mn-flash=@var{num}
15930 @opindex mn-flash
15931 Assume that the flash memory has a size of 
15932 @var{num} times 64@tie{}KiB.
15934 @item -mno-interrupts
15935 @opindex mno-interrupts
15936 Generated code is not compatible with hardware interrupts.
15937 Code size is smaller.
15939 @item -mrelax
15940 @opindex mrelax
15941 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
15942 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
15943 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
15944 the assembler's command line and the @option{--relax} option to the
15945 linker's command line.
15947 Jump relaxing is performed by the linker because jump offsets are not
15948 known before code is located. Therefore, the assembler code generated by the
15949 compiler is the same, but the instructions in the executable may
15950 differ from instructions in the assembler code.
15952 Relaxing must be turned on if linker stubs are needed, see the
15953 section on @code{EIND} and linker stubs below.
15955 @item -mrmw
15956 @opindex mrmw
15957 Assume that the device supports the Read-Modify-Write
15958 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
15960 @item -mshort-calls
15961 @opindex mshort-calls
15963 Assume that @code{RJMP} and @code{RCALL} can target the whole
15964 program memory.
15966 This option is used internally for multilib selection.  It is
15967 not an optimization option, and you don't need to set it by hand.
15969 @item -msp8
15970 @opindex msp8
15971 Treat the stack pointer register as an 8-bit register,
15972 i.e.@: assume the high byte of the stack pointer is zero.
15973 In general, you don't need to set this option by hand.
15975 This option is used internally by the compiler to select and
15976 build multilibs for architectures @code{avr2} and @code{avr25}.
15977 These architectures mix devices with and without @code{SPH}.
15978 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
15979 the compiler driver adds or removes this option from the compiler
15980 proper's command line, because the compiler then knows if the device
15981 or architecture has an 8-bit stack pointer and thus no @code{SPH}
15982 register or not.
15984 @item -mstrict-X
15985 @opindex mstrict-X
15986 Use address register @code{X} in a way proposed by the hardware.  This means
15987 that @code{X} is only used in indirect, post-increment or
15988 pre-decrement addressing.
15990 Without this option, the @code{X} register may be used in the same way
15991 as @code{Y} or @code{Z} which then is emulated by additional
15992 instructions.  
15993 For example, loading a value with @code{X+const} addressing with a
15994 small non-negative @code{const < 64} to a register @var{Rn} is
15995 performed as
15997 @example
15998 adiw r26, const   ; X += const
15999 ld   @var{Rn}, X        ; @var{Rn} = *X
16000 sbiw r26, const   ; X -= const
16001 @end example
16003 @item -mtiny-stack
16004 @opindex mtiny-stack
16005 Only change the lower 8@tie{}bits of the stack pointer.
16007 @item -mfract-convert-truncate
16008 @opindex mfract-convert-truncate
16009 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16011 @item -nodevicelib
16012 @opindex nodevicelib
16013 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16015 @item -Waddr-space-convert
16016 @opindex Waddr-space-convert
16017 Warn about conversions between address spaces in the case where the
16018 resulting address space is not contained in the incoming address space.
16020 @item -Wmisspelled-isr
16021 @opindex Wmisspelled-isr
16022 Warn if the ISR is misspelled, i.e. without __vector prefix.
16023 Enabled by default.
16024 @end table
16026 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16027 @cindex @code{EIND}
16028 Pointers in the implementation are 16@tie{}bits wide.
16029 The address of a function or label is represented as word address so
16030 that indirect jumps and calls can target any code address in the
16031 range of 64@tie{}Ki words.
16033 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16034 bytes of program memory space, there is a special function register called
16035 @code{EIND} that serves as most significant part of the target address
16036 when @code{EICALL} or @code{EIJMP} instructions are used.
16038 Indirect jumps and calls on these devices are handled as follows by
16039 the compiler and are subject to some limitations:
16041 @itemize @bullet
16043 @item
16044 The compiler never sets @code{EIND}.
16046 @item
16047 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16048 instructions or might read @code{EIND} directly in order to emulate an
16049 indirect call/jump by means of a @code{RET} instruction.
16051 @item
16052 The compiler assumes that @code{EIND} never changes during the startup
16053 code or during the application. In particular, @code{EIND} is not
16054 saved/restored in function or interrupt service routine
16055 prologue/epilogue.
16057 @item
16058 For indirect calls to functions and computed goto, the linker
16059 generates @emph{stubs}. Stubs are jump pads sometimes also called
16060 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16061 The stub contains a direct jump to the desired address.
16063 @item
16064 Linker relaxation must be turned on so that the linker generates
16065 the stubs correctly in all situations. See the compiler option
16066 @option{-mrelax} and the linker option @option{--relax}.
16067 There are corner cases where the linker is supposed to generate stubs
16068 but aborts without relaxation and without a helpful error message.
16070 @item
16071 The default linker script is arranged for code with @code{EIND = 0}.
16072 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16073 linker script has to be used in order to place the sections whose
16074 name start with @code{.trampolines} into the segment where @code{EIND}
16075 points to.
16077 @item
16078 The startup code from libgcc never sets @code{EIND}.
16079 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16080 For the impact of AVR-LibC on @code{EIND}, see the
16081 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16083 @item
16084 It is legitimate for user-specific startup code to set up @code{EIND}
16085 early, for example by means of initialization code located in
16086 section @code{.init3}. Such code runs prior to general startup code
16087 that initializes RAM and calls constructors, but after the bit
16088 of startup code from AVR-LibC that sets @code{EIND} to the segment
16089 where the vector table is located.
16090 @example
16091 #include <avr/io.h>
16093 static void
16094 __attribute__((section(".init3"),naked,used,no_instrument_function))
16095 init3_set_eind (void)
16097   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16098                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16100 @end example
16102 @noindent
16103 The @code{__trampolines_start} symbol is defined in the linker script.
16105 @item
16106 Stubs are generated automatically by the linker if
16107 the following two conditions are met:
16108 @itemize @minus
16110 @item The address of a label is taken by means of the @code{gs} modifier
16111 (short for @emph{generate stubs}) like so:
16112 @example
16113 LDI r24, lo8(gs(@var{func}))
16114 LDI r25, hi8(gs(@var{func}))
16115 @end example
16116 @item The final location of that label is in a code segment
16117 @emph{outside} the segment where the stubs are located.
16118 @end itemize
16120 @item
16121 The compiler emits such @code{gs} modifiers for code labels in the
16122 following situations:
16123 @itemize @minus
16124 @item Taking address of a function or code label.
16125 @item Computed goto.
16126 @item If prologue-save function is used, see @option{-mcall-prologues}
16127 command-line option.
16128 @item Switch/case dispatch tables. If you do not want such dispatch
16129 tables you can specify the @option{-fno-jump-tables} command-line option.
16130 @item C and C++ constructors/destructors called during startup/shutdown.
16131 @item If the tools hit a @code{gs()} modifier explained above.
16132 @end itemize
16134 @item
16135 Jumping to non-symbolic addresses like so is @emph{not} supported:
16137 @example
16138 int main (void)
16140     /* Call function at word address 0x2 */
16141     return ((int(*)(void)) 0x2)();
16143 @end example
16145 Instead, a stub has to be set up, i.e.@: the function has to be called
16146 through a symbol (@code{func_4} in the example):
16148 @example
16149 int main (void)
16151     extern int func_4 (void);
16153     /* Call function at byte address 0x4 */
16154     return func_4();
16156 @end example
16158 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16159 Alternatively, @code{func_4} can be defined in the linker script.
16160 @end itemize
16162 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16163 @cindex @code{RAMPD}
16164 @cindex @code{RAMPX}
16165 @cindex @code{RAMPY}
16166 @cindex @code{RAMPZ}
16167 Some AVR devices support memories larger than the 64@tie{}KiB range
16168 that can be accessed with 16-bit pointers.  To access memory locations
16169 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16170 register is used as high part of the address:
16171 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16172 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16173 register, respectively, to get a wide address. Similarly,
16174 @code{RAMPD} is used together with direct addressing.
16176 @itemize
16177 @item
16178 The startup code initializes the @code{RAMP} special function
16179 registers with zero.
16181 @item
16182 If a @ref{AVR Named Address Spaces,named address space} other than
16183 generic or @code{__flash} is used, then @code{RAMPZ} is set
16184 as needed before the operation.
16186 @item
16187 If the device supports RAM larger than 64@tie{}KiB and the compiler
16188 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16189 is reset to zero after the operation.
16191 @item
16192 If the device comes with a specific @code{RAMP} register, the ISR
16193 prologue/epilogue saves/restores that SFR and initializes it with
16194 zero in case the ISR code might (implicitly) use it.
16196 @item
16197 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16198 If you use inline assembler to read from locations outside the
16199 16-bit address range and change one of the @code{RAMP} registers,
16200 you must reset it to zero after the access.
16202 @end itemize
16204 @subsubsection AVR Built-in Macros
16206 GCC defines several built-in macros so that the user code can test
16207 for the presence or absence of features.  Almost any of the following
16208 built-in macros are deduced from device capabilities and thus
16209 triggered by the @option{-mmcu=} command-line option.
16211 For even more AVR-specific built-in macros see
16212 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16214 @table @code
16216 @item __AVR_ARCH__
16217 Build-in macro that resolves to a decimal number that identifies the
16218 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16219 Possible values are:
16221 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16222 @code{4}, @code{5}, @code{51}, @code{6}
16224 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16225 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16227 respectively and
16229 @code{100},
16230 @code{102}, @code{103}, @code{104},
16231 @code{105}, @code{106}, @code{107}
16233 for @var{mcu}=@code{avrtiny},
16234 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16235 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16236 If @var{mcu} specifies a device, this built-in macro is set
16237 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16238 defined to @code{4}.
16240 @item __AVR_@var{Device}__
16241 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16242 the device's name. For example, @option{-mmcu=atmega8} defines the
16243 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16244 @code{__AVR_ATtiny261A__}, etc.
16246 The built-in macros' names follow
16247 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16248 the device name as from the AVR user manual. The difference between
16249 @var{Device} in the built-in macro and @var{device} in
16250 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16252 If @var{device} is not a device but only a core architecture like
16253 @samp{avr51}, this macro is not defined.
16255 @item __AVR_DEVICE_NAME__
16256 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16257 the device's name. For example, with @option{-mmcu=atmega8} the macro
16258 is defined to @code{atmega8}.
16260 If @var{device} is not a device but only a core architecture like
16261 @samp{avr51}, this macro is not defined.
16263 @item __AVR_XMEGA__
16264 The device / architecture belongs to the XMEGA family of devices.
16266 @item __AVR_HAVE_ELPM__
16267 The device has the @code{ELPM} instruction.
16269 @item __AVR_HAVE_ELPMX__
16270 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16271 R@var{n},Z+} instructions.
16273 @item __AVR_HAVE_MOVW__
16274 The device has the @code{MOVW} instruction to perform 16-bit
16275 register-register moves.
16277 @item __AVR_HAVE_LPMX__
16278 The device has the @code{LPM R@var{n},Z} and
16279 @code{LPM R@var{n},Z+} instructions.
16281 @item __AVR_HAVE_MUL__
16282 The device has a hardware multiplier. 
16284 @item __AVR_HAVE_JMP_CALL__
16285 The device has the @code{JMP} and @code{CALL} instructions.
16286 This is the case for devices with more than 8@tie{}KiB of program
16287 memory.
16289 @item __AVR_HAVE_EIJMP_EICALL__
16290 @itemx __AVR_3_BYTE_PC__
16291 The device has the @code{EIJMP} and @code{EICALL} instructions.
16292 This is the case for devices with more than 128@tie{}KiB of program memory.
16293 This also means that the program counter
16294 (PC) is 3@tie{}bytes wide.
16296 @item __AVR_2_BYTE_PC__
16297 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16298 with up to 128@tie{}KiB of program memory.
16300 @item __AVR_HAVE_8BIT_SP__
16301 @itemx __AVR_HAVE_16BIT_SP__
16302 The stack pointer (SP) register is treated as 8-bit respectively
16303 16-bit register by the compiler.
16304 The definition of these macros is affected by @option{-mtiny-stack}.
16306 @item __AVR_HAVE_SPH__
16307 @itemx __AVR_SP8__
16308 The device has the SPH (high part of stack pointer) special function
16309 register or has an 8-bit stack pointer, respectively.
16310 The definition of these macros is affected by @option{-mmcu=} and
16311 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16312 by @option{-msp8}.
16314 @item __AVR_HAVE_RAMPD__
16315 @itemx __AVR_HAVE_RAMPX__
16316 @itemx __AVR_HAVE_RAMPY__
16317 @itemx __AVR_HAVE_RAMPZ__
16318 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16319 @code{RAMPZ} special function register, respectively.
16321 @item __NO_INTERRUPTS__
16322 This macro reflects the @option{-mno-interrupts} command-line option.
16324 @item __AVR_ERRATA_SKIP__
16325 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16326 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16327 instructions because of a hardware erratum.  Skip instructions are
16328 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16329 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16330 set.
16332 @item __AVR_ISA_RMW__
16333 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16335 @item __AVR_SFR_OFFSET__=@var{offset}
16336 Instructions that can address I/O special function registers directly
16337 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16338 address as if addressed by an instruction to access RAM like @code{LD}
16339 or @code{STS}. This offset depends on the device architecture and has
16340 to be subtracted from the RAM address in order to get the
16341 respective I/O@tie{}address.
16343 @item __AVR_SHORT_CALLS__
16344 The @option{-mshort-calls} command line option is set.
16346 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16347 Some devices support reading from flash memory by means of @code{LD*}
16348 instructions.  The flash memory is seen in the data address space
16349 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16350 is not defined, this feature is not available.  If defined,
16351 the address space is linear and there is no need to put
16352 @code{.rodata} into RAM.  This is handled by the default linker
16353 description file, and is currently available for
16354 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16355 there is no need to use address spaces like @code{__flash} or
16356 features like attribute @code{progmem} and @code{pgm_read_*}.
16358 @item __WITH_AVRLIBC__
16359 The compiler is configured to be used together with AVR-Libc.
16360 See the @option{--with-avrlibc} configure option.
16362 @end table
16364 @node Blackfin Options
16365 @subsection Blackfin Options
16366 @cindex Blackfin Options
16368 @table @gcctabopt
16369 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16370 @opindex mcpu=
16371 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16372 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16373 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16374 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16375 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16376 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16377 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16378 @samp{bf561}, @samp{bf592}.
16380 The optional @var{sirevision} specifies the silicon revision of the target
16381 Blackfin processor.  Any workarounds available for the targeted silicon revision
16382 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16383 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16384 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16385 hexadecimal digits representing the major and minor numbers in the silicon
16386 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16387 is not defined.  If @var{sirevision} is @samp{any}, the
16388 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16389 If this optional @var{sirevision} is not used, GCC assumes the latest known
16390 silicon revision of the targeted Blackfin processor.
16392 GCC defines a preprocessor macro for the specified @var{cpu}.
16393 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16394 provided by libgloss to be linked in if @option{-msim} is not given.
16396 Without this option, @samp{bf532} is used as the processor by default.
16398 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16399 only the preprocessor macro is defined.
16401 @item -msim
16402 @opindex msim
16403 Specifies that the program will be run on the simulator.  This causes
16404 the simulator BSP provided by libgloss to be linked in.  This option
16405 has effect only for @samp{bfin-elf} toolchain.
16406 Certain other options, such as @option{-mid-shared-library} and
16407 @option{-mfdpic}, imply @option{-msim}.
16409 @item -momit-leaf-frame-pointer
16410 @opindex momit-leaf-frame-pointer
16411 Don't keep the frame pointer in a register for leaf functions.  This
16412 avoids the instructions to save, set up and restore frame pointers and
16413 makes an extra register available in leaf functions.  The option
16414 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16415 which might make debugging harder.
16417 @item -mspecld-anomaly
16418 @opindex mspecld-anomaly
16419 When enabled, the compiler ensures that the generated code does not
16420 contain speculative loads after jump instructions. If this option is used,
16421 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16423 @item -mno-specld-anomaly
16424 @opindex mno-specld-anomaly
16425 Don't generate extra code to prevent speculative loads from occurring.
16427 @item -mcsync-anomaly
16428 @opindex mcsync-anomaly
16429 When enabled, the compiler ensures that the generated code does not
16430 contain CSYNC or SSYNC instructions too soon after conditional branches.
16431 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16433 @item -mno-csync-anomaly
16434 @opindex mno-csync-anomaly
16435 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16436 occurring too soon after a conditional branch.
16438 @item -mlow-64k
16439 @opindex mlow-64k
16440 When enabled, the compiler is free to take advantage of the knowledge that
16441 the entire program fits into the low 64k of memory.
16443 @item -mno-low-64k
16444 @opindex mno-low-64k
16445 Assume that the program is arbitrarily large.  This is the default.
16447 @item -mstack-check-l1
16448 @opindex mstack-check-l1
16449 Do stack checking using information placed into L1 scratchpad memory by the
16450 uClinux kernel.
16452 @item -mid-shared-library
16453 @opindex mid-shared-library
16454 Generate code that supports shared libraries via the library ID method.
16455 This allows for execute in place and shared libraries in an environment
16456 without virtual memory management.  This option implies @option{-fPIC}.
16457 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16459 @item -mno-id-shared-library
16460 @opindex mno-id-shared-library
16461 Generate code that doesn't assume ID-based shared libraries are being used.
16462 This is the default.
16464 @item -mleaf-id-shared-library
16465 @opindex mleaf-id-shared-library
16466 Generate code that supports shared libraries via the library ID method,
16467 but assumes that this library or executable won't link against any other
16468 ID shared libraries.  That allows the compiler to use faster code for jumps
16469 and calls.
16471 @item -mno-leaf-id-shared-library
16472 @opindex mno-leaf-id-shared-library
16473 Do not assume that the code being compiled won't link against any ID shared
16474 libraries.  Slower code is generated for jump and call insns.
16476 @item -mshared-library-id=n
16477 @opindex mshared-library-id
16478 Specifies the identification number of the ID-based shared library being
16479 compiled.  Specifying a value of 0 generates more compact code; specifying
16480 other values forces the allocation of that number to the current
16481 library but is no more space- or time-efficient than omitting this option.
16483 @item -msep-data
16484 @opindex msep-data
16485 Generate code that allows the data segment to be located in a different
16486 area of memory from the text segment.  This allows for execute in place in
16487 an environment without virtual memory management by eliminating relocations
16488 against the text section.
16490 @item -mno-sep-data
16491 @opindex mno-sep-data
16492 Generate code that assumes that the data segment follows the text segment.
16493 This is the default.
16495 @item -mlong-calls
16496 @itemx -mno-long-calls
16497 @opindex mlong-calls
16498 @opindex mno-long-calls
16499 Tells the compiler to perform function calls by first loading the
16500 address of the function into a register and then performing a subroutine
16501 call on this register.  This switch is needed if the target function
16502 lies outside of the 24-bit addressing range of the offset-based
16503 version of subroutine call instruction.
16505 This feature is not enabled by default.  Specifying
16506 @option{-mno-long-calls} restores the default behavior.  Note these
16507 switches have no effect on how the compiler generates code to handle
16508 function calls via function pointers.
16510 @item -mfast-fp
16511 @opindex mfast-fp
16512 Link with the fast floating-point library. This library relaxes some of
16513 the IEEE floating-point standard's rules for checking inputs against
16514 Not-a-Number (NAN), in the interest of performance.
16516 @item -minline-plt
16517 @opindex minline-plt
16518 Enable inlining of PLT entries in function calls to functions that are
16519 not known to bind locally.  It has no effect without @option{-mfdpic}.
16521 @item -mmulticore
16522 @opindex mmulticore
16523 Build a standalone application for multicore Blackfin processors. 
16524 This option causes proper start files and link scripts supporting 
16525 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16526 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16528 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16529 selects the one-application-per-core programming model.  Without
16530 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16531 programming model is used. In this model, the main function of Core B
16532 should be named as @code{coreb_main}.
16534 If this option is not used, the single-core application programming
16535 model is used.
16537 @item -mcorea
16538 @opindex mcorea
16539 Build a standalone application for Core A of BF561 when using
16540 the one-application-per-core programming model. Proper start files
16541 and link scripts are used to support Core A, and the macro
16542 @code{__BFIN_COREA} is defined.
16543 This option can only be used in conjunction with @option{-mmulticore}.
16545 @item -mcoreb
16546 @opindex mcoreb
16547 Build a standalone application for Core B of BF561 when using
16548 the one-application-per-core programming model. Proper start files
16549 and link scripts are used to support Core B, and the macro
16550 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16551 should be used instead of @code{main}. 
16552 This option can only be used in conjunction with @option{-mmulticore}.
16554 @item -msdram
16555 @opindex msdram
16556 Build a standalone application for SDRAM. Proper start files and
16557 link scripts are used to put the application into SDRAM, and the macro
16558 @code{__BFIN_SDRAM} is defined.
16559 The loader should initialize SDRAM before loading the application.
16561 @item -micplb
16562 @opindex micplb
16563 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16564 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16565 are enabled; for standalone applications the default is off.
16566 @end table
16568 @node C6X Options
16569 @subsection C6X Options
16570 @cindex C6X Options
16572 @table @gcctabopt
16573 @item -march=@var{name}
16574 @opindex march
16575 This specifies the name of the target architecture.  GCC uses this
16576 name to determine what kind of instructions it can emit when generating
16577 assembly code.  Permissible names are: @samp{c62x},
16578 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16580 @item -mbig-endian
16581 @opindex mbig-endian
16582 Generate code for a big-endian target.
16584 @item -mlittle-endian
16585 @opindex mlittle-endian
16586 Generate code for a little-endian target.  This is the default.
16588 @item -msim
16589 @opindex msim
16590 Choose startup files and linker script suitable for the simulator.
16592 @item -msdata=default
16593 @opindex msdata=default
16594 Put small global and static data in the @code{.neardata} section,
16595 which is pointed to by register @code{B14}.  Put small uninitialized
16596 global and static data in the @code{.bss} section, which is adjacent
16597 to the @code{.neardata} section.  Put small read-only data into the
16598 @code{.rodata} section.  The corresponding sections used for large
16599 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16601 @item -msdata=all
16602 @opindex msdata=all
16603 Put all data, not just small objects, into the sections reserved for
16604 small data, and use addressing relative to the @code{B14} register to
16605 access them.
16607 @item -msdata=none
16608 @opindex msdata=none
16609 Make no use of the sections reserved for small data, and use absolute
16610 addresses to access all data.  Put all initialized global and static
16611 data in the @code{.fardata} section, and all uninitialized data in the
16612 @code{.far} section.  Put all constant data into the @code{.const}
16613 section.
16614 @end table
16616 @node CRIS Options
16617 @subsection CRIS Options
16618 @cindex CRIS Options
16620 These options are defined specifically for the CRIS ports.
16622 @table @gcctabopt
16623 @item -march=@var{architecture-type}
16624 @itemx -mcpu=@var{architecture-type}
16625 @opindex march
16626 @opindex mcpu
16627 Generate code for the specified architecture.  The choices for
16628 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16629 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16630 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16631 @samp{v10}.
16633 @item -mtune=@var{architecture-type}
16634 @opindex mtune
16635 Tune to @var{architecture-type} everything applicable about the generated
16636 code, except for the ABI and the set of available instructions.  The
16637 choices for @var{architecture-type} are the same as for
16638 @option{-march=@var{architecture-type}}.
16640 @item -mmax-stack-frame=@var{n}
16641 @opindex mmax-stack-frame
16642 Warn when the stack frame of a function exceeds @var{n} bytes.
16644 @item -metrax4
16645 @itemx -metrax100
16646 @opindex metrax4
16647 @opindex metrax100
16648 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16649 @option{-march=v3} and @option{-march=v8} respectively.
16651 @item -mmul-bug-workaround
16652 @itemx -mno-mul-bug-workaround
16653 @opindex mmul-bug-workaround
16654 @opindex mno-mul-bug-workaround
16655 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16656 models where it applies.  This option is active by default.
16658 @item -mpdebug
16659 @opindex mpdebug
16660 Enable CRIS-specific verbose debug-related information in the assembly
16661 code.  This option also has the effect of turning off the @samp{#NO_APP}
16662 formatted-code indicator to the assembler at the beginning of the
16663 assembly file.
16665 @item -mcc-init
16666 @opindex mcc-init
16667 Do not use condition-code results from previous instruction; always emit
16668 compare and test instructions before use of condition codes.
16670 @item -mno-side-effects
16671 @opindex mno-side-effects
16672 Do not emit instructions with side effects in addressing modes other than
16673 post-increment.
16675 @item -mstack-align
16676 @itemx -mno-stack-align
16677 @itemx -mdata-align
16678 @itemx -mno-data-align
16679 @itemx -mconst-align
16680 @itemx -mno-const-align
16681 @opindex mstack-align
16682 @opindex mno-stack-align
16683 @opindex mdata-align
16684 @opindex mno-data-align
16685 @opindex mconst-align
16686 @opindex mno-const-align
16687 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16688 stack frame, individual data and constants to be aligned for the maximum
16689 single data access size for the chosen CPU model.  The default is to
16690 arrange for 32-bit alignment.  ABI details such as structure layout are
16691 not affected by these options.
16693 @item -m32-bit
16694 @itemx -m16-bit
16695 @itemx -m8-bit
16696 @opindex m32-bit
16697 @opindex m16-bit
16698 @opindex m8-bit
16699 Similar to the stack- data- and const-align options above, these options
16700 arrange for stack frame, writable data and constants to all be 32-bit,
16701 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16703 @item -mno-prologue-epilogue
16704 @itemx -mprologue-epilogue
16705 @opindex mno-prologue-epilogue
16706 @opindex mprologue-epilogue
16707 With @option{-mno-prologue-epilogue}, the normal function prologue and
16708 epilogue which set up the stack frame are omitted and no return
16709 instructions or return sequences are generated in the code.  Use this
16710 option only together with visual inspection of the compiled code: no
16711 warnings or errors are generated when call-saved registers must be saved,
16712 or storage for local variables needs to be allocated.
16714 @item -mno-gotplt
16715 @itemx -mgotplt
16716 @opindex mno-gotplt
16717 @opindex mgotplt
16718 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16719 instruction sequences that load addresses for functions from the PLT part
16720 of the GOT rather than (traditional on other architectures) calls to the
16721 PLT@.  The default is @option{-mgotplt}.
16723 @item -melf
16724 @opindex melf
16725 Legacy no-op option only recognized with the cris-axis-elf and
16726 cris-axis-linux-gnu targets.
16728 @item -mlinux
16729 @opindex mlinux
16730 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16732 @item -sim
16733 @opindex sim
16734 This option, recognized for the cris-axis-elf, arranges
16735 to link with input-output functions from a simulator library.  Code,
16736 initialized data and zero-initialized data are allocated consecutively.
16738 @item -sim2
16739 @opindex sim2
16740 Like @option{-sim}, but pass linker options to locate initialized data at
16741 0x40000000 and zero-initialized data at 0x80000000.
16742 @end table
16744 @node CR16 Options
16745 @subsection CR16 Options
16746 @cindex CR16 Options
16748 These options are defined specifically for the CR16 ports.
16750 @table @gcctabopt
16752 @item -mmac
16753 @opindex mmac
16754 Enable the use of multiply-accumulate instructions. Disabled by default.
16756 @item -mcr16cplus
16757 @itemx -mcr16c
16758 @opindex mcr16cplus
16759 @opindex mcr16c
16760 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
16761 is default.
16763 @item -msim
16764 @opindex msim
16765 Links the library libsim.a which is in compatible with simulator. Applicable
16766 to ELF compiler only.
16768 @item -mint32
16769 @opindex mint32
16770 Choose integer type as 32-bit wide.
16772 @item -mbit-ops
16773 @opindex mbit-ops
16774 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
16776 @item -mdata-model=@var{model}
16777 @opindex mdata-model
16778 Choose a data model. The choices for @var{model} are @samp{near},
16779 @samp{far} or @samp{medium}. @samp{medium} is default.
16780 However, @samp{far} is not valid with @option{-mcr16c}, as the
16781 CR16C architecture does not support the far data model.
16782 @end table
16784 @node Darwin Options
16785 @subsection Darwin Options
16786 @cindex Darwin options
16788 These options are defined for all architectures running the Darwin operating
16789 system.
16791 FSF GCC on Darwin does not create ``fat'' object files; it creates
16792 an object file for the single architecture that GCC was built to
16793 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
16794 @option{-arch} options are used; it does so by running the compiler or
16795 linker multiple times and joining the results together with
16796 @file{lipo}.
16798 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
16799 @samp{i686}) is determined by the flags that specify the ISA
16800 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
16801 @option{-force_cpusubtype_ALL} option can be used to override this.
16803 The Darwin tools vary in their behavior when presented with an ISA
16804 mismatch.  The assembler, @file{as}, only permits instructions to
16805 be used that are valid for the subtype of the file it is generating,
16806 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
16807 The linker for shared libraries, @file{/usr/bin/libtool}, fails
16808 and prints an error if asked to create a shared library with a less
16809 restrictive subtype than its input files (for instance, trying to put
16810 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
16811 for executables, @command{ld}, quietly gives the executable the most
16812 restrictive subtype of any of its input files.
16814 @table @gcctabopt
16815 @item -F@var{dir}
16816 @opindex F
16817 Add the framework directory @var{dir} to the head of the list of
16818 directories to be searched for header files.  These directories are
16819 interleaved with those specified by @option{-I} options and are
16820 scanned in a left-to-right order.
16822 A framework directory is a directory with frameworks in it.  A
16823 framework is a directory with a @file{Headers} and/or
16824 @file{PrivateHeaders} directory contained directly in it that ends
16825 in @file{.framework}.  The name of a framework is the name of this
16826 directory excluding the @file{.framework}.  Headers associated with
16827 the framework are found in one of those two directories, with
16828 @file{Headers} being searched first.  A subframework is a framework
16829 directory that is in a framework's @file{Frameworks} directory.
16830 Includes of subframework headers can only appear in a header of a
16831 framework that contains the subframework, or in a sibling subframework
16832 header.  Two subframeworks are siblings if they occur in the same
16833 framework.  A subframework should not have the same name as a
16834 framework; a warning is issued if this is violated.  Currently a
16835 subframework cannot have subframeworks; in the future, the mechanism
16836 may be extended to support this.  The standard frameworks can be found
16837 in @file{/System/Library/Frameworks} and
16838 @file{/Library/Frameworks}.  An example include looks like
16839 @code{#include <Framework/header.h>}, where @file{Framework} denotes
16840 the name of the framework and @file{header.h} is found in the
16841 @file{PrivateHeaders} or @file{Headers} directory.
16843 @item -iframework@var{dir}
16844 @opindex iframework
16845 Like @option{-F} except the directory is a treated as a system
16846 directory.  The main difference between this @option{-iframework} and
16847 @option{-F} is that with @option{-iframework} the compiler does not
16848 warn about constructs contained within header files found via
16849 @var{dir}.  This option is valid only for the C family of languages.
16851 @item -gused
16852 @opindex gused
16853 Emit debugging information for symbols that are used.  For stabs
16854 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
16855 This is by default ON@.
16857 @item -gfull
16858 @opindex gfull
16859 Emit debugging information for all symbols and types.
16861 @item -mmacosx-version-min=@var{version}
16862 The earliest version of MacOS X that this executable will run on
16863 is @var{version}.  Typical values of @var{version} include @code{10.1},
16864 @code{10.2}, and @code{10.3.9}.
16866 If the compiler was built to use the system's headers by default,
16867 then the default for this option is the system version on which the
16868 compiler is running, otherwise the default is to make choices that
16869 are compatible with as many systems and code bases as possible.
16871 @item -mkernel
16872 @opindex mkernel
16873 Enable kernel development mode.  The @option{-mkernel} option sets
16874 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
16875 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
16876 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
16877 applicable.  This mode also sets @option{-mno-altivec},
16878 @option{-msoft-float}, @option{-fno-builtin} and
16879 @option{-mlong-branch} for PowerPC targets.
16881 @item -mone-byte-bool
16882 @opindex mone-byte-bool
16883 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
16884 By default @code{sizeof(bool)} is @code{4} when compiling for
16885 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
16886 option has no effect on x86.
16888 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
16889 to generate code that is not binary compatible with code generated
16890 without that switch.  Using this switch may require recompiling all
16891 other modules in a program, including system libraries.  Use this
16892 switch to conform to a non-default data model.
16894 @item -mfix-and-continue
16895 @itemx -ffix-and-continue
16896 @itemx -findirect-data
16897 @opindex mfix-and-continue
16898 @opindex ffix-and-continue
16899 @opindex findirect-data
16900 Generate code suitable for fast turnaround development, such as to
16901 allow GDB to dynamically load @file{.o} files into already-running
16902 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
16903 are provided for backwards compatibility.
16905 @item -all_load
16906 @opindex all_load
16907 Loads all members of static archive libraries.
16908 See man ld(1) for more information.
16910 @item -arch_errors_fatal
16911 @opindex arch_errors_fatal
16912 Cause the errors having to do with files that have the wrong architecture
16913 to be fatal.
16915 @item -bind_at_load
16916 @opindex bind_at_load
16917 Causes the output file to be marked such that the dynamic linker will
16918 bind all undefined references when the file is loaded or launched.
16920 @item -bundle
16921 @opindex bundle
16922 Produce a Mach-o bundle format file.
16923 See man ld(1) for more information.
16925 @item -bundle_loader @var{executable}
16926 @opindex bundle_loader
16927 This option specifies the @var{executable} that will load the build
16928 output file being linked.  See man ld(1) for more information.
16930 @item -dynamiclib
16931 @opindex dynamiclib
16932 When passed this option, GCC produces a dynamic library instead of
16933 an executable when linking, using the Darwin @file{libtool} command.
16935 @item -force_cpusubtype_ALL
16936 @opindex force_cpusubtype_ALL
16937 This causes GCC's output file to have the @samp{ALL} subtype, instead of
16938 one controlled by the @option{-mcpu} or @option{-march} option.
16940 @item -allowable_client  @var{client_name}
16941 @itemx -client_name
16942 @itemx -compatibility_version
16943 @itemx -current_version
16944 @itemx -dead_strip
16945 @itemx -dependency-file
16946 @itemx -dylib_file
16947 @itemx -dylinker_install_name
16948 @itemx -dynamic
16949 @itemx -exported_symbols_list
16950 @itemx -filelist
16951 @need 800
16952 @itemx -flat_namespace
16953 @itemx -force_flat_namespace
16954 @itemx -headerpad_max_install_names
16955 @itemx -image_base
16956 @itemx -init
16957 @itemx -install_name
16958 @itemx -keep_private_externs
16959 @itemx -multi_module
16960 @itemx -multiply_defined
16961 @itemx -multiply_defined_unused
16962 @need 800
16963 @itemx -noall_load
16964 @itemx -no_dead_strip_inits_and_terms
16965 @itemx -nofixprebinding
16966 @itemx -nomultidefs
16967 @itemx -noprebind
16968 @itemx -noseglinkedit
16969 @itemx -pagezero_size
16970 @itemx -prebind
16971 @itemx -prebind_all_twolevel_modules
16972 @itemx -private_bundle
16973 @need 800
16974 @itemx -read_only_relocs
16975 @itemx -sectalign
16976 @itemx -sectobjectsymbols
16977 @itemx -whyload
16978 @itemx -seg1addr
16979 @itemx -sectcreate
16980 @itemx -sectobjectsymbols
16981 @itemx -sectorder
16982 @itemx -segaddr
16983 @itemx -segs_read_only_addr
16984 @need 800
16985 @itemx -segs_read_write_addr
16986 @itemx -seg_addr_table
16987 @itemx -seg_addr_table_filename
16988 @itemx -seglinkedit
16989 @itemx -segprot
16990 @itemx -segs_read_only_addr
16991 @itemx -segs_read_write_addr
16992 @itemx -single_module
16993 @itemx -static
16994 @itemx -sub_library
16995 @need 800
16996 @itemx -sub_umbrella
16997 @itemx -twolevel_namespace
16998 @itemx -umbrella
16999 @itemx -undefined
17000 @itemx -unexported_symbols_list
17001 @itemx -weak_reference_mismatches
17002 @itemx -whatsloaded
17003 @opindex allowable_client
17004 @opindex client_name
17005 @opindex compatibility_version
17006 @opindex current_version
17007 @opindex dead_strip
17008 @opindex dependency-file
17009 @opindex dylib_file
17010 @opindex dylinker_install_name
17011 @opindex dynamic
17012 @opindex exported_symbols_list
17013 @opindex filelist
17014 @opindex flat_namespace
17015 @opindex force_flat_namespace
17016 @opindex headerpad_max_install_names
17017 @opindex image_base
17018 @opindex init
17019 @opindex install_name
17020 @opindex keep_private_externs
17021 @opindex multi_module
17022 @opindex multiply_defined
17023 @opindex multiply_defined_unused
17024 @opindex noall_load
17025 @opindex no_dead_strip_inits_and_terms
17026 @opindex nofixprebinding
17027 @opindex nomultidefs
17028 @opindex noprebind
17029 @opindex noseglinkedit
17030 @opindex pagezero_size
17031 @opindex prebind
17032 @opindex prebind_all_twolevel_modules
17033 @opindex private_bundle
17034 @opindex read_only_relocs
17035 @opindex sectalign
17036 @opindex sectobjectsymbols
17037 @opindex whyload
17038 @opindex seg1addr
17039 @opindex sectcreate
17040 @opindex sectobjectsymbols
17041 @opindex sectorder
17042 @opindex segaddr
17043 @opindex segs_read_only_addr
17044 @opindex segs_read_write_addr
17045 @opindex seg_addr_table
17046 @opindex seg_addr_table_filename
17047 @opindex seglinkedit
17048 @opindex segprot
17049 @opindex segs_read_only_addr
17050 @opindex segs_read_write_addr
17051 @opindex single_module
17052 @opindex static
17053 @opindex sub_library
17054 @opindex sub_umbrella
17055 @opindex twolevel_namespace
17056 @opindex umbrella
17057 @opindex undefined
17058 @opindex unexported_symbols_list
17059 @opindex weak_reference_mismatches
17060 @opindex whatsloaded
17061 These options are passed to the Darwin linker.  The Darwin linker man page
17062 describes them in detail.
17063 @end table
17065 @node DEC Alpha Options
17066 @subsection DEC Alpha Options
17068 These @samp{-m} options are defined for the DEC Alpha implementations:
17070 @table @gcctabopt
17071 @item -mno-soft-float
17072 @itemx -msoft-float
17073 @opindex mno-soft-float
17074 @opindex msoft-float
17075 Use (do not use) the hardware floating-point instructions for
17076 floating-point operations.  When @option{-msoft-float} is specified,
17077 functions in @file{libgcc.a} are used to perform floating-point
17078 operations.  Unless they are replaced by routines that emulate the
17079 floating-point operations, or compiled in such a way as to call such
17080 emulations routines, these routines issue floating-point
17081 operations.   If you are compiling for an Alpha without floating-point
17082 operations, you must ensure that the library is built so as not to call
17083 them.
17085 Note that Alpha implementations without floating-point operations are
17086 required to have floating-point registers.
17088 @item -mfp-reg
17089 @itemx -mno-fp-regs
17090 @opindex mfp-reg
17091 @opindex mno-fp-regs
17092 Generate code that uses (does not use) the floating-point register set.
17093 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17094 register set is not used, floating-point operands are passed in integer
17095 registers as if they were integers and floating-point results are passed
17096 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17097 so any function with a floating-point argument or return value called by code
17098 compiled with @option{-mno-fp-regs} must also be compiled with that
17099 option.
17101 A typical use of this option is building a kernel that does not use,
17102 and hence need not save and restore, any floating-point registers.
17104 @item -mieee
17105 @opindex mieee
17106 The Alpha architecture implements floating-point hardware optimized for
17107 maximum performance.  It is mostly compliant with the IEEE floating-point
17108 standard.  However, for full compliance, software assistance is
17109 required.  This option generates code fully IEEE-compliant code
17110 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17111 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17112 defined during compilation.  The resulting code is less efficient but is
17113 able to correctly support denormalized numbers and exceptional IEEE
17114 values such as not-a-number and plus/minus infinity.  Other Alpha
17115 compilers call this option @option{-ieee_with_no_inexact}.
17117 @item -mieee-with-inexact
17118 @opindex mieee-with-inexact
17119 This is like @option{-mieee} except the generated code also maintains
17120 the IEEE @var{inexact-flag}.  Turning on this option causes the
17121 generated code to implement fully-compliant IEEE math.  In addition to
17122 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17123 macro.  On some Alpha implementations the resulting code may execute
17124 significantly slower than the code generated by default.  Since there is
17125 very little code that depends on the @var{inexact-flag}, you should
17126 normally not specify this option.  Other Alpha compilers call this
17127 option @option{-ieee_with_inexact}.
17129 @item -mfp-trap-mode=@var{trap-mode}
17130 @opindex mfp-trap-mode
17131 This option controls what floating-point related traps are enabled.
17132 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17133 The trap mode can be set to one of four values:
17135 @table @samp
17136 @item n
17137 This is the default (normal) setting.  The only traps that are enabled
17138 are the ones that cannot be disabled in software (e.g., division by zero
17139 trap).
17141 @item u
17142 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17143 as well.
17145 @item su
17146 Like @samp{u}, but the instructions are marked to be safe for software
17147 completion (see Alpha architecture manual for details).
17149 @item sui
17150 Like @samp{su}, but inexact traps are enabled as well.
17151 @end table
17153 @item -mfp-rounding-mode=@var{rounding-mode}
17154 @opindex mfp-rounding-mode
17155 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17156 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17159 @table @samp
17160 @item n
17161 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17162 the nearest machine number or towards the even machine number in case
17163 of a tie.
17165 @item m
17166 Round towards minus infinity.
17168 @item c
17169 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17171 @item d
17172 Dynamic rounding mode.  A field in the floating-point control register
17173 (@var{fpcr}, see Alpha architecture reference manual) controls the
17174 rounding mode in effect.  The C library initializes this register for
17175 rounding towards plus infinity.  Thus, unless your program modifies the
17176 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17177 @end table
17179 @item -mtrap-precision=@var{trap-precision}
17180 @opindex mtrap-precision
17181 In the Alpha architecture, floating-point traps are imprecise.  This
17182 means without software assistance it is impossible to recover from a
17183 floating trap and program execution normally needs to be terminated.
17184 GCC can generate code that can assist operating system trap handlers
17185 in determining the exact location that caused a floating-point trap.
17186 Depending on the requirements of an application, different levels of
17187 precisions can be selected:
17189 @table @samp
17190 @item p
17191 Program precision.  This option is the default and means a trap handler
17192 can only identify which program caused a floating-point exception.
17194 @item f
17195 Function precision.  The trap handler can determine the function that
17196 caused a floating-point exception.
17198 @item i
17199 Instruction precision.  The trap handler can determine the exact
17200 instruction that caused a floating-point exception.
17201 @end table
17203 Other Alpha compilers provide the equivalent options called
17204 @option{-scope_safe} and @option{-resumption_safe}.
17206 @item -mieee-conformant
17207 @opindex mieee-conformant
17208 This option marks the generated code as IEEE conformant.  You must not
17209 use this option unless you also specify @option{-mtrap-precision=i} and either
17210 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17211 is to emit the line @samp{.eflag 48} in the function prologue of the
17212 generated assembly file.
17214 @item -mbuild-constants
17215 @opindex mbuild-constants
17216 Normally GCC examines a 32- or 64-bit integer constant to
17217 see if it can construct it from smaller constants in two or three
17218 instructions.  If it cannot, it outputs the constant as a literal and
17219 generates code to load it from the data segment at run time.
17221 Use this option to require GCC to construct @emph{all} integer constants
17222 using code, even if it takes more instructions (the maximum is six).
17224 You typically use this option to build a shared library dynamic
17225 loader.  Itself a shared library, it must relocate itself in memory
17226 before it can find the variables and constants in its own data segment.
17228 @item -mbwx
17229 @itemx -mno-bwx
17230 @itemx -mcix
17231 @itemx -mno-cix
17232 @itemx -mfix
17233 @itemx -mno-fix
17234 @itemx -mmax
17235 @itemx -mno-max
17236 @opindex mbwx
17237 @opindex mno-bwx
17238 @opindex mcix
17239 @opindex mno-cix
17240 @opindex mfix
17241 @opindex mno-fix
17242 @opindex mmax
17243 @opindex mno-max
17244 Indicate whether GCC should generate code to use the optional BWX,
17245 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17246 sets supported by the CPU type specified via @option{-mcpu=} option or that
17247 of the CPU on which GCC was built if none is specified.
17249 @item -mfloat-vax
17250 @itemx -mfloat-ieee
17251 @opindex mfloat-vax
17252 @opindex mfloat-ieee
17253 Generate code that uses (does not use) VAX F and G floating-point
17254 arithmetic instead of IEEE single and double precision.
17256 @item -mexplicit-relocs
17257 @itemx -mno-explicit-relocs
17258 @opindex mexplicit-relocs
17259 @opindex mno-explicit-relocs
17260 Older Alpha assemblers provided no way to generate symbol relocations
17261 except via assembler macros.  Use of these macros does not allow
17262 optimal instruction scheduling.  GNU binutils as of version 2.12
17263 supports a new syntax that allows the compiler to explicitly mark
17264 which relocations should apply to which instructions.  This option
17265 is mostly useful for debugging, as GCC detects the capabilities of
17266 the assembler when it is built and sets the default accordingly.
17268 @item -msmall-data
17269 @itemx -mlarge-data
17270 @opindex msmall-data
17271 @opindex mlarge-data
17272 When @option{-mexplicit-relocs} is in effect, static data is
17273 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17274 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17275 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17276 16-bit relocations off of the @code{$gp} register.  This limits the
17277 size of the small data area to 64KB, but allows the variables to be
17278 directly accessed via a single instruction.
17280 The default is @option{-mlarge-data}.  With this option the data area
17281 is limited to just below 2GB@.  Programs that require more than 2GB of
17282 data must use @code{malloc} or @code{mmap} to allocate the data in the
17283 heap instead of in the program's data segment.
17285 When generating code for shared libraries, @option{-fpic} implies
17286 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17288 @item -msmall-text
17289 @itemx -mlarge-text
17290 @opindex msmall-text
17291 @opindex mlarge-text
17292 When @option{-msmall-text} is used, the compiler assumes that the
17293 code of the entire program (or shared library) fits in 4MB, and is
17294 thus reachable with a branch instruction.  When @option{-msmall-data}
17295 is used, the compiler can assume that all local symbols share the
17296 same @code{$gp} value, and thus reduce the number of instructions
17297 required for a function call from 4 to 1.
17299 The default is @option{-mlarge-text}.
17301 @item -mcpu=@var{cpu_type}
17302 @opindex mcpu
17303 Set the instruction set and instruction scheduling parameters for
17304 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17305 style name or the corresponding chip number.  GCC supports scheduling
17306 parameters for the EV4, EV5 and EV6 family of processors and
17307 chooses the default values for the instruction set from the processor
17308 you specify.  If you do not specify a processor type, GCC defaults
17309 to the processor on which the compiler was built.
17311 Supported values for @var{cpu_type} are
17313 @table @samp
17314 @item ev4
17315 @itemx ev45
17316 @itemx 21064
17317 Schedules as an EV4 and has no instruction set extensions.
17319 @item ev5
17320 @itemx 21164
17321 Schedules as an EV5 and has no instruction set extensions.
17323 @item ev56
17324 @itemx 21164a
17325 Schedules as an EV5 and supports the BWX extension.
17327 @item pca56
17328 @itemx 21164pc
17329 @itemx 21164PC
17330 Schedules as an EV5 and supports the BWX and MAX extensions.
17332 @item ev6
17333 @itemx 21264
17334 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17336 @item ev67
17337 @itemx 21264a
17338 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17339 @end table
17341 Native toolchains also support the value @samp{native},
17342 which selects the best architecture option for the host processor.
17343 @option{-mcpu=native} has no effect if GCC does not recognize
17344 the processor.
17346 @item -mtune=@var{cpu_type}
17347 @opindex mtune
17348 Set only the instruction scheduling parameters for machine type
17349 @var{cpu_type}.  The instruction set is not changed.
17351 Native toolchains also support the value @samp{native},
17352 which selects the best architecture option for the host processor.
17353 @option{-mtune=native} has no effect if GCC does not recognize
17354 the processor.
17356 @item -mmemory-latency=@var{time}
17357 @opindex mmemory-latency
17358 Sets the latency the scheduler should assume for typical memory
17359 references as seen by the application.  This number is highly
17360 dependent on the memory access patterns used by the application
17361 and the size of the external cache on the machine.
17363 Valid options for @var{time} are
17365 @table @samp
17366 @item @var{number}
17367 A decimal number representing clock cycles.
17369 @item L1
17370 @itemx L2
17371 @itemx L3
17372 @itemx main
17373 The compiler contains estimates of the number of clock cycles for
17374 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17375 (also called Dcache, Scache, and Bcache), as well as to main memory.
17376 Note that L3 is only valid for EV5.
17378 @end table
17379 @end table
17381 @node FR30 Options
17382 @subsection FR30 Options
17383 @cindex FR30 Options
17385 These options are defined specifically for the FR30 port.
17387 @table @gcctabopt
17389 @item -msmall-model
17390 @opindex msmall-model
17391 Use the small address space model.  This can produce smaller code, but
17392 it does assume that all symbolic values and addresses fit into a
17393 20-bit range.
17395 @item -mno-lsim
17396 @opindex mno-lsim
17397 Assume that runtime support has been provided and so there is no need
17398 to include the simulator library (@file{libsim.a}) on the linker
17399 command line.
17401 @end table
17403 @node FT32 Options
17404 @subsection FT32 Options
17405 @cindex FT32 Options
17407 These options are defined specifically for the FT32 port.
17409 @table @gcctabopt
17411 @item -msim
17412 @opindex msim
17413 Specifies that the program will be run on the simulator.  This causes
17414 an alternate runtime startup and library to be linked.
17415 You must not use this option when generating programs that will run on
17416 real hardware; you must provide your own runtime library for whatever
17417 I/O functions are needed.
17419 @item -mlra
17420 @opindex mlra
17421 Enable Local Register Allocation.  This is still experimental for FT32,
17422 so by default the compiler uses standard reload.
17424 @item -mnodiv
17425 @opindex mnodiv
17426 Do not use div and mod instructions.
17428 @end table
17430 @node FRV Options
17431 @subsection FRV Options
17432 @cindex FRV Options
17434 @table @gcctabopt
17435 @item -mgpr-32
17436 @opindex mgpr-32
17438 Only use the first 32 general-purpose registers.
17440 @item -mgpr-64
17441 @opindex mgpr-64
17443 Use all 64 general-purpose registers.
17445 @item -mfpr-32
17446 @opindex mfpr-32
17448 Use only the first 32 floating-point registers.
17450 @item -mfpr-64
17451 @opindex mfpr-64
17453 Use all 64 floating-point registers.
17455 @item -mhard-float
17456 @opindex mhard-float
17458 Use hardware instructions for floating-point operations.
17460 @item -msoft-float
17461 @opindex msoft-float
17463 Use library routines for floating-point operations.
17465 @item -malloc-cc
17466 @opindex malloc-cc
17468 Dynamically allocate condition code registers.
17470 @item -mfixed-cc
17471 @opindex mfixed-cc
17473 Do not try to dynamically allocate condition code registers, only
17474 use @code{icc0} and @code{fcc0}.
17476 @item -mdword
17477 @opindex mdword
17479 Change ABI to use double word insns.
17481 @item -mno-dword
17482 @opindex mno-dword
17484 Do not use double word instructions.
17486 @item -mdouble
17487 @opindex mdouble
17489 Use floating-point double instructions.
17491 @item -mno-double
17492 @opindex mno-double
17494 Do not use floating-point double instructions.
17496 @item -mmedia
17497 @opindex mmedia
17499 Use media instructions.
17501 @item -mno-media
17502 @opindex mno-media
17504 Do not use media instructions.
17506 @item -mmuladd
17507 @opindex mmuladd
17509 Use multiply and add/subtract instructions.
17511 @item -mno-muladd
17512 @opindex mno-muladd
17514 Do not use multiply and add/subtract instructions.
17516 @item -mfdpic
17517 @opindex mfdpic
17519 Select the FDPIC ABI, which uses function descriptors to represent
17520 pointers to functions.  Without any PIC/PIE-related options, it
17521 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17522 assumes GOT entries and small data are within a 12-bit range from the
17523 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17524 are computed with 32 bits.
17525 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17527 @item -minline-plt
17528 @opindex minline-plt
17530 Enable inlining of PLT entries in function calls to functions that are
17531 not known to bind locally.  It has no effect without @option{-mfdpic}.
17532 It's enabled by default if optimizing for speed and compiling for
17533 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17534 optimization option such as @option{-O3} or above is present in the
17535 command line.
17537 @item -mTLS
17538 @opindex mTLS
17540 Assume a large TLS segment when generating thread-local code.
17542 @item -mtls
17543 @opindex mtls
17545 Do not assume a large TLS segment when generating thread-local code.
17547 @item -mgprel-ro
17548 @opindex mgprel-ro
17550 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17551 that is known to be in read-only sections.  It's enabled by default,
17552 except for @option{-fpic} or @option{-fpie}: even though it may help
17553 make the global offset table smaller, it trades 1 instruction for 4.
17554 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17555 one of which may be shared by multiple symbols, and it avoids the need
17556 for a GOT entry for the referenced symbol, so it's more likely to be a
17557 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17559 @item -multilib-library-pic
17560 @opindex multilib-library-pic
17562 Link with the (library, not FD) pic libraries.  It's implied by
17563 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17564 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17565 it explicitly.
17567 @item -mlinked-fp
17568 @opindex mlinked-fp
17570 Follow the EABI requirement of always creating a frame pointer whenever
17571 a stack frame is allocated.  This option is enabled by default and can
17572 be disabled with @option{-mno-linked-fp}.
17574 @item -mlong-calls
17575 @opindex mlong-calls
17577 Use indirect addressing to call functions outside the current
17578 compilation unit.  This allows the functions to be placed anywhere
17579 within the 32-bit address space.
17581 @item -malign-labels
17582 @opindex malign-labels
17584 Try to align labels to an 8-byte boundary by inserting NOPs into the
17585 previous packet.  This option only has an effect when VLIW packing
17586 is enabled.  It doesn't create new packets; it merely adds NOPs to
17587 existing ones.
17589 @item -mlibrary-pic
17590 @opindex mlibrary-pic
17592 Generate position-independent EABI code.
17594 @item -macc-4
17595 @opindex macc-4
17597 Use only the first four media accumulator registers.
17599 @item -macc-8
17600 @opindex macc-8
17602 Use all eight media accumulator registers.
17604 @item -mpack
17605 @opindex mpack
17607 Pack VLIW instructions.
17609 @item -mno-pack
17610 @opindex mno-pack
17612 Do not pack VLIW instructions.
17614 @item -mno-eflags
17615 @opindex mno-eflags
17617 Do not mark ABI switches in e_flags.
17619 @item -mcond-move
17620 @opindex mcond-move
17622 Enable the use of conditional-move instructions (default).
17624 This switch is mainly for debugging the compiler and will likely be removed
17625 in a future version.
17627 @item -mno-cond-move
17628 @opindex mno-cond-move
17630 Disable the use of conditional-move instructions.
17632 This switch is mainly for debugging the compiler and will likely be removed
17633 in a future version.
17635 @item -mscc
17636 @opindex mscc
17638 Enable the use of conditional set instructions (default).
17640 This switch is mainly for debugging the compiler and will likely be removed
17641 in a future version.
17643 @item -mno-scc
17644 @opindex mno-scc
17646 Disable the use of conditional set instructions.
17648 This switch is mainly for debugging the compiler and will likely be removed
17649 in a future version.
17651 @item -mcond-exec
17652 @opindex mcond-exec
17654 Enable the use of conditional execution (default).
17656 This switch is mainly for debugging the compiler and will likely be removed
17657 in a future version.
17659 @item -mno-cond-exec
17660 @opindex mno-cond-exec
17662 Disable the use of conditional execution.
17664 This switch is mainly for debugging the compiler and will likely be removed
17665 in a future version.
17667 @item -mvliw-branch
17668 @opindex mvliw-branch
17670 Run a pass to pack branches into VLIW instructions (default).
17672 This switch is mainly for debugging the compiler and will likely be removed
17673 in a future version.
17675 @item -mno-vliw-branch
17676 @opindex mno-vliw-branch
17678 Do not run a pass to pack branches into VLIW instructions.
17680 This switch is mainly for debugging the compiler and will likely be removed
17681 in a future version.
17683 @item -mmulti-cond-exec
17684 @opindex mmulti-cond-exec
17686 Enable optimization of @code{&&} and @code{||} in conditional execution
17687 (default).
17689 This switch is mainly for debugging the compiler and will likely be removed
17690 in a future version.
17692 @item -mno-multi-cond-exec
17693 @opindex mno-multi-cond-exec
17695 Disable optimization of @code{&&} and @code{||} in conditional execution.
17697 This switch is mainly for debugging the compiler and will likely be removed
17698 in a future version.
17700 @item -mnested-cond-exec
17701 @opindex mnested-cond-exec
17703 Enable nested conditional execution optimizations (default).
17705 This switch is mainly for debugging the compiler and will likely be removed
17706 in a future version.
17708 @item -mno-nested-cond-exec
17709 @opindex mno-nested-cond-exec
17711 Disable nested conditional execution optimizations.
17713 This switch is mainly for debugging the compiler and will likely be removed
17714 in a future version.
17716 @item -moptimize-membar
17717 @opindex moptimize-membar
17719 This switch removes redundant @code{membar} instructions from the
17720 compiler-generated code.  It is enabled by default.
17722 @item -mno-optimize-membar
17723 @opindex mno-optimize-membar
17725 This switch disables the automatic removal of redundant @code{membar}
17726 instructions from the generated code.
17728 @item -mtomcat-stats
17729 @opindex mtomcat-stats
17731 Cause gas to print out tomcat statistics.
17733 @item -mcpu=@var{cpu}
17734 @opindex mcpu
17736 Select the processor type for which to generate code.  Possible values are
17737 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17738 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17740 @end table
17742 @node GNU/Linux Options
17743 @subsection GNU/Linux Options
17745 These @samp{-m} options are defined for GNU/Linux targets:
17747 @table @gcctabopt
17748 @item -mglibc
17749 @opindex mglibc
17750 Use the GNU C library.  This is the default except
17751 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
17752 @samp{*-*-linux-*android*} targets.
17754 @item -muclibc
17755 @opindex muclibc
17756 Use uClibc C library.  This is the default on
17757 @samp{*-*-linux-*uclibc*} targets.
17759 @item -mmusl
17760 @opindex mmusl
17761 Use the musl C library.  This is the default on
17762 @samp{*-*-linux-*musl*} targets.
17764 @item -mbionic
17765 @opindex mbionic
17766 Use Bionic C library.  This is the default on
17767 @samp{*-*-linux-*android*} targets.
17769 @item -mandroid
17770 @opindex mandroid
17771 Compile code compatible with Android platform.  This is the default on
17772 @samp{*-*-linux-*android*} targets.
17774 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
17775 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
17776 this option makes the GCC driver pass Android-specific options to the linker.
17777 Finally, this option causes the preprocessor macro @code{__ANDROID__}
17778 to be defined.
17780 @item -tno-android-cc
17781 @opindex tno-android-cc
17782 Disable compilation effects of @option{-mandroid}, i.e., do not enable
17783 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
17784 @option{-fno-rtti} by default.
17786 @item -tno-android-ld
17787 @opindex tno-android-ld
17788 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
17789 linking options to the linker.
17791 @end table
17793 @node H8/300 Options
17794 @subsection H8/300 Options
17796 These @samp{-m} options are defined for the H8/300 implementations:
17798 @table @gcctabopt
17799 @item -mrelax
17800 @opindex mrelax
17801 Shorten some address references at link time, when possible; uses the
17802 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
17803 ld, Using ld}, for a fuller description.
17805 @item -mh
17806 @opindex mh
17807 Generate code for the H8/300H@.
17809 @item -ms
17810 @opindex ms
17811 Generate code for the H8S@.
17813 @item -mn
17814 @opindex mn
17815 Generate code for the H8S and H8/300H in the normal mode.  This switch
17816 must be used either with @option{-mh} or @option{-ms}.
17818 @item -ms2600
17819 @opindex ms2600
17820 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
17822 @item -mexr
17823 @opindex mexr
17824 Extended registers are stored on stack before execution of function
17825 with monitor attribute. Default option is @option{-mexr}.
17826 This option is valid only for H8S targets.
17828 @item -mno-exr
17829 @opindex mno-exr
17830 Extended registers are not stored on stack before execution of function 
17831 with monitor attribute. Default option is @option{-mno-exr}. 
17832 This option is valid only for H8S targets.
17834 @item -mint32
17835 @opindex mint32
17836 Make @code{int} data 32 bits by default.
17838 @item -malign-300
17839 @opindex malign-300
17840 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
17841 The default for the H8/300H and H8S is to align longs and floats on
17842 4-byte boundaries.
17843 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
17844 This option has no effect on the H8/300.
17845 @end table
17847 @node HPPA Options
17848 @subsection HPPA Options
17849 @cindex HPPA Options
17851 These @samp{-m} options are defined for the HPPA family of computers:
17853 @table @gcctabopt
17854 @item -march=@var{architecture-type}
17855 @opindex march
17856 Generate code for the specified architecture.  The choices for
17857 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
17858 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
17859 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
17860 architecture option for your machine.  Code compiled for lower numbered
17861 architectures runs on higher numbered architectures, but not the
17862 other way around.
17864 @item -mpa-risc-1-0
17865 @itemx -mpa-risc-1-1
17866 @itemx -mpa-risc-2-0
17867 @opindex mpa-risc-1-0
17868 @opindex mpa-risc-1-1
17869 @opindex mpa-risc-2-0
17870 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
17872 @item -mcaller-copies
17873 @opindex mcaller-copies
17874 The caller copies function arguments passed by hidden reference.  This
17875 option should be used with care as it is not compatible with the default
17876 32-bit runtime.  However, only aggregates larger than eight bytes are
17877 passed by hidden reference and the option provides better compatibility
17878 with OpenMP.
17880 @item -mjump-in-delay
17881 @opindex mjump-in-delay
17882 This option is ignored and provided for compatibility purposes only.
17884 @item -mdisable-fpregs
17885 @opindex mdisable-fpregs
17886 Prevent floating-point registers from being used in any manner.  This is
17887 necessary for compiling kernels that perform lazy context switching of
17888 floating-point registers.  If you use this option and attempt to perform
17889 floating-point operations, the compiler aborts.
17891 @item -mdisable-indexing
17892 @opindex mdisable-indexing
17893 Prevent the compiler from using indexing address modes.  This avoids some
17894 rather obscure problems when compiling MIG generated code under MACH@.
17896 @item -mno-space-regs
17897 @opindex mno-space-regs
17898 Generate code that assumes the target has no space registers.  This allows
17899 GCC to generate faster indirect calls and use unscaled index address modes.
17901 Such code is suitable for level 0 PA systems and kernels.
17903 @item -mfast-indirect-calls
17904 @opindex mfast-indirect-calls
17905 Generate code that assumes calls never cross space boundaries.  This
17906 allows GCC to emit code that performs faster indirect calls.
17908 This option does not work in the presence of shared libraries or nested
17909 functions.
17911 @item -mfixed-range=@var{register-range}
17912 @opindex mfixed-range
17913 Generate code treating the given register range as fixed registers.
17914 A fixed register is one that the register allocator cannot use.  This is
17915 useful when compiling kernel code.  A register range is specified as
17916 two registers separated by a dash.  Multiple register ranges can be
17917 specified separated by a comma.
17919 @item -mlong-load-store
17920 @opindex mlong-load-store
17921 Generate 3-instruction load and store sequences as sometimes required by
17922 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
17923 the HP compilers.
17925 @item -mportable-runtime
17926 @opindex mportable-runtime
17927 Use the portable calling conventions proposed by HP for ELF systems.
17929 @item -mgas
17930 @opindex mgas
17931 Enable the use of assembler directives only GAS understands.
17933 @item -mschedule=@var{cpu-type}
17934 @opindex mschedule
17935 Schedule code according to the constraints for the machine type
17936 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
17937 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
17938 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
17939 proper scheduling option for your machine.  The default scheduling is
17940 @samp{8000}.
17942 @item -mlinker-opt
17943 @opindex mlinker-opt
17944 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
17945 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
17946 linkers in which they give bogus error messages when linking some programs.
17948 @item -msoft-float
17949 @opindex msoft-float
17950 Generate output containing library calls for floating point.
17951 @strong{Warning:} the requisite libraries are not available for all HPPA
17952 targets.  Normally the facilities of the machine's usual C compiler are
17953 used, but this cannot be done directly in cross-compilation.  You must make
17954 your own arrangements to provide suitable library functions for
17955 cross-compilation.
17957 @option{-msoft-float} changes the calling convention in the output file;
17958 therefore, it is only useful if you compile @emph{all} of a program with
17959 this option.  In particular, you need to compile @file{libgcc.a}, the
17960 library that comes with GCC, with @option{-msoft-float} in order for
17961 this to work.
17963 @item -msio
17964 @opindex msio
17965 Generate the predefine, @code{_SIO}, for server IO@.  The default is
17966 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
17967 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
17968 options are available under HP-UX and HI-UX@.
17970 @item -mgnu-ld
17971 @opindex mgnu-ld
17972 Use options specific to GNU @command{ld}.
17973 This passes @option{-shared} to @command{ld} when
17974 building a shared library.  It is the default when GCC is configured,
17975 explicitly or implicitly, with the GNU linker.  This option does not
17976 affect which @command{ld} is called; it only changes what parameters
17977 are passed to that @command{ld}.
17978 The @command{ld} that is called is determined by the
17979 @option{--with-ld} configure option, GCC's program search path, and
17980 finally by the user's @env{PATH}.  The linker used by GCC can be printed
17981 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
17982 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17984 @item -mhp-ld
17985 @opindex mhp-ld
17986 Use options specific to HP @command{ld}.
17987 This passes @option{-b} to @command{ld} when building
17988 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
17989 links.  It is the default when GCC is configured, explicitly or
17990 implicitly, with the HP linker.  This option does not affect
17991 which @command{ld} is called; it only changes what parameters are passed to that
17992 @command{ld}.
17993 The @command{ld} that is called is determined by the @option{--with-ld}
17994 configure option, GCC's program search path, and finally by the user's
17995 @env{PATH}.  The linker used by GCC can be printed using @samp{which
17996 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
17997 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
17999 @item -mlong-calls
18000 @opindex mno-long-calls
18001 Generate code that uses long call sequences.  This ensures that a call
18002 is always able to reach linker generated stubs.  The default is to generate
18003 long calls only when the distance from the call site to the beginning
18004 of the function or translation unit, as the case may be, exceeds a
18005 predefined limit set by the branch type being used.  The limits for
18006 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18007 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18008 240,000 bytes.
18010 Distances are measured from the beginning of functions when using the
18011 @option{-ffunction-sections} option, or when using the @option{-mgas}
18012 and @option{-mno-portable-runtime} options together under HP-UX with
18013 the SOM linker.
18015 It is normally not desirable to use this option as it degrades
18016 performance.  However, it may be useful in large applications,
18017 particularly when partial linking is used to build the application.
18019 The types of long calls used depends on the capabilities of the
18020 assembler and linker, and the type of code being generated.  The
18021 impact on systems that support long absolute calls, and long pic
18022 symbol-difference or pc-relative calls should be relatively small.
18023 However, an indirect call is used on 32-bit ELF systems in pic code
18024 and it is quite long.
18026 @item -munix=@var{unix-std}
18027 @opindex march
18028 Generate compiler predefines and select a startfile for the specified
18029 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18030 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18031 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18032 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18033 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18034 and later.
18036 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18037 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18038 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18039 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18040 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18041 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18043 It is @emph{important} to note that this option changes the interfaces
18044 for various library routines.  It also affects the operational behavior
18045 of the C library.  Thus, @emph{extreme} care is needed in using this
18046 option.
18048 Library code that is intended to operate with more than one UNIX
18049 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18050 as appropriate.  Most GNU software doesn't provide this capability.
18052 @item -nolibdld
18053 @opindex nolibdld
18054 Suppress the generation of link options to search libdld.sl when the
18055 @option{-static} option is specified on HP-UX 10 and later.
18057 @item -static
18058 @opindex static
18059 The HP-UX implementation of setlocale in libc has a dependency on
18060 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18061 when the @option{-static} option is specified, special link options
18062 are needed to resolve this dependency.
18064 On HP-UX 10 and later, the GCC driver adds the necessary options to
18065 link with libdld.sl when the @option{-static} option is specified.
18066 This causes the resulting binary to be dynamic.  On the 64-bit port,
18067 the linkers generate dynamic binaries by default in any case.  The
18068 @option{-nolibdld} option can be used to prevent the GCC driver from
18069 adding these link options.
18071 @item -threads
18072 @opindex threads
18073 Add support for multithreading with the @dfn{dce thread} library
18074 under HP-UX@.  This option sets flags for both the preprocessor and
18075 linker.
18076 @end table
18078 @node IA-64 Options
18079 @subsection IA-64 Options
18080 @cindex IA-64 Options
18082 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18084 @table @gcctabopt
18085 @item -mbig-endian
18086 @opindex mbig-endian
18087 Generate code for a big-endian target.  This is the default for HP-UX@.
18089 @item -mlittle-endian
18090 @opindex mlittle-endian
18091 Generate code for a little-endian target.  This is the default for AIX5
18092 and GNU/Linux.
18094 @item -mgnu-as
18095 @itemx -mno-gnu-as
18096 @opindex mgnu-as
18097 @opindex mno-gnu-as
18098 Generate (or don't) code for the GNU assembler.  This is the default.
18099 @c Also, this is the default if the configure option @option{--with-gnu-as}
18100 @c is used.
18102 @item -mgnu-ld
18103 @itemx -mno-gnu-ld
18104 @opindex mgnu-ld
18105 @opindex mno-gnu-ld
18106 Generate (or don't) code for the GNU linker.  This is the default.
18107 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18108 @c is used.
18110 @item -mno-pic
18111 @opindex mno-pic
18112 Generate code that does not use a global pointer register.  The result
18113 is not position independent code, and violates the IA-64 ABI@.
18115 @item -mvolatile-asm-stop
18116 @itemx -mno-volatile-asm-stop
18117 @opindex mvolatile-asm-stop
18118 @opindex mno-volatile-asm-stop
18119 Generate (or don't) a stop bit immediately before and after volatile asm
18120 statements.
18122 @item -mregister-names
18123 @itemx -mno-register-names
18124 @opindex mregister-names
18125 @opindex mno-register-names
18126 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18127 the stacked registers.  This may make assembler output more readable.
18129 @item -mno-sdata
18130 @itemx -msdata
18131 @opindex mno-sdata
18132 @opindex msdata
18133 Disable (or enable) optimizations that use the small data section.  This may
18134 be useful for working around optimizer bugs.
18136 @item -mconstant-gp
18137 @opindex mconstant-gp
18138 Generate code that uses a single constant global pointer value.  This is
18139 useful when compiling kernel code.
18141 @item -mauto-pic
18142 @opindex mauto-pic
18143 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18144 This is useful when compiling firmware code.
18146 @item -minline-float-divide-min-latency
18147 @opindex minline-float-divide-min-latency
18148 Generate code for inline divides of floating-point values
18149 using the minimum latency algorithm.
18151 @item -minline-float-divide-max-throughput
18152 @opindex minline-float-divide-max-throughput
18153 Generate code for inline divides of floating-point values
18154 using the maximum throughput algorithm.
18156 @item -mno-inline-float-divide
18157 @opindex mno-inline-float-divide
18158 Do not generate inline code for divides of floating-point values.
18160 @item -minline-int-divide-min-latency
18161 @opindex minline-int-divide-min-latency
18162 Generate code for inline divides of integer values
18163 using the minimum latency algorithm.
18165 @item -minline-int-divide-max-throughput
18166 @opindex minline-int-divide-max-throughput
18167 Generate code for inline divides of integer values
18168 using the maximum throughput algorithm.
18170 @item -mno-inline-int-divide
18171 @opindex mno-inline-int-divide
18172 Do not generate inline code for divides of integer values.
18174 @item -minline-sqrt-min-latency
18175 @opindex minline-sqrt-min-latency
18176 Generate code for inline square roots
18177 using the minimum latency algorithm.
18179 @item -minline-sqrt-max-throughput
18180 @opindex minline-sqrt-max-throughput
18181 Generate code for inline square roots
18182 using the maximum throughput algorithm.
18184 @item -mno-inline-sqrt
18185 @opindex mno-inline-sqrt
18186 Do not generate inline code for @code{sqrt}.
18188 @item -mfused-madd
18189 @itemx -mno-fused-madd
18190 @opindex mfused-madd
18191 @opindex mno-fused-madd
18192 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18193 instructions.  The default is to use these instructions.
18195 @item -mno-dwarf2-asm
18196 @itemx -mdwarf2-asm
18197 @opindex mno-dwarf2-asm
18198 @opindex mdwarf2-asm
18199 Don't (or do) generate assembler code for the DWARF line number debugging
18200 info.  This may be useful when not using the GNU assembler.
18202 @item -mearly-stop-bits
18203 @itemx -mno-early-stop-bits
18204 @opindex mearly-stop-bits
18205 @opindex mno-early-stop-bits
18206 Allow stop bits to be placed earlier than immediately preceding the
18207 instruction that triggered the stop bit.  This can improve instruction
18208 scheduling, but does not always do so.
18210 @item -mfixed-range=@var{register-range}
18211 @opindex mfixed-range
18212 Generate code treating the given register range as fixed registers.
18213 A fixed register is one that the register allocator cannot use.  This is
18214 useful when compiling kernel code.  A register range is specified as
18215 two registers separated by a dash.  Multiple register ranges can be
18216 specified separated by a comma.
18218 @item -mtls-size=@var{tls-size}
18219 @opindex mtls-size
18220 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18223 @item -mtune=@var{cpu-type}
18224 @opindex mtune
18225 Tune the instruction scheduling for a particular CPU, Valid values are
18226 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18227 and @samp{mckinley}.
18229 @item -milp32
18230 @itemx -mlp64
18231 @opindex milp32
18232 @opindex mlp64
18233 Generate code for a 32-bit or 64-bit environment.
18234 The 32-bit environment sets int, long and pointer to 32 bits.
18235 The 64-bit environment sets int to 32 bits and long and pointer
18236 to 64 bits.  These are HP-UX specific flags.
18238 @item -mno-sched-br-data-spec
18239 @itemx -msched-br-data-spec
18240 @opindex mno-sched-br-data-spec
18241 @opindex msched-br-data-spec
18242 (Dis/En)able data speculative scheduling before reload.
18243 This results in generation of @code{ld.a} instructions and
18244 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18245 The default setting is disabled.
18247 @item -msched-ar-data-spec
18248 @itemx -mno-sched-ar-data-spec
18249 @opindex msched-ar-data-spec
18250 @opindex mno-sched-ar-data-spec
18251 (En/Dis)able data speculative scheduling after reload.
18252 This results in generation of @code{ld.a} instructions and
18253 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18254 The default setting is enabled.
18256 @item -mno-sched-control-spec
18257 @itemx -msched-control-spec
18258 @opindex mno-sched-control-spec
18259 @opindex msched-control-spec
18260 (Dis/En)able control speculative scheduling.  This feature is
18261 available only during region scheduling (i.e.@: before reload).
18262 This results in generation of the @code{ld.s} instructions and
18263 the corresponding check instructions @code{chk.s}.
18264 The default setting is disabled.
18266 @item -msched-br-in-data-spec
18267 @itemx -mno-sched-br-in-data-spec
18268 @opindex msched-br-in-data-spec
18269 @opindex mno-sched-br-in-data-spec
18270 (En/Dis)able speculative scheduling of the instructions that
18271 are dependent on the data speculative loads before reload.
18272 This is effective only with @option{-msched-br-data-spec} enabled.
18273 The default setting is enabled.
18275 @item -msched-ar-in-data-spec
18276 @itemx -mno-sched-ar-in-data-spec
18277 @opindex msched-ar-in-data-spec
18278 @opindex mno-sched-ar-in-data-spec
18279 (En/Dis)able speculative scheduling of the instructions that
18280 are dependent on the data speculative loads after reload.
18281 This is effective only with @option{-msched-ar-data-spec} enabled.
18282 The default setting is enabled.
18284 @item -msched-in-control-spec
18285 @itemx -mno-sched-in-control-spec
18286 @opindex msched-in-control-spec
18287 @opindex mno-sched-in-control-spec
18288 (En/Dis)able speculative scheduling of the instructions that
18289 are dependent on the control speculative loads.
18290 This is effective only with @option{-msched-control-spec} enabled.
18291 The default setting is enabled.
18293 @item -mno-sched-prefer-non-data-spec-insns
18294 @itemx -msched-prefer-non-data-spec-insns
18295 @opindex mno-sched-prefer-non-data-spec-insns
18296 @opindex msched-prefer-non-data-spec-insns
18297 If enabled, data-speculative instructions are chosen for schedule
18298 only if there are no other choices at the moment.  This makes
18299 the use of the data speculation much more conservative.
18300 The default setting is disabled.
18302 @item -mno-sched-prefer-non-control-spec-insns
18303 @itemx -msched-prefer-non-control-spec-insns
18304 @opindex mno-sched-prefer-non-control-spec-insns
18305 @opindex msched-prefer-non-control-spec-insns
18306 If enabled, control-speculative instructions are chosen for schedule
18307 only if there are no other choices at the moment.  This makes
18308 the use of the control speculation much more conservative.
18309 The default setting is disabled.
18311 @item -mno-sched-count-spec-in-critical-path
18312 @itemx -msched-count-spec-in-critical-path
18313 @opindex mno-sched-count-spec-in-critical-path
18314 @opindex msched-count-spec-in-critical-path
18315 If enabled, speculative dependencies are considered during
18316 computation of the instructions priorities.  This makes the use of the
18317 speculation a bit more conservative.
18318 The default setting is disabled.
18320 @item -msched-spec-ldc
18321 @opindex msched-spec-ldc
18322 Use a simple data speculation check.  This option is on by default.
18324 @item -msched-control-spec-ldc
18325 @opindex msched-spec-ldc
18326 Use a simple check for control speculation.  This option is on by default.
18328 @item -msched-stop-bits-after-every-cycle
18329 @opindex msched-stop-bits-after-every-cycle
18330 Place a stop bit after every cycle when scheduling.  This option is on
18331 by default.
18333 @item -msched-fp-mem-deps-zero-cost
18334 @opindex msched-fp-mem-deps-zero-cost
18335 Assume that floating-point stores and loads are not likely to cause a conflict
18336 when placed into the same instruction group.  This option is disabled by
18337 default.
18339 @item -msel-sched-dont-check-control-spec
18340 @opindex msel-sched-dont-check-control-spec
18341 Generate checks for control speculation in selective scheduling.
18342 This flag is disabled by default.
18344 @item -msched-max-memory-insns=@var{max-insns}
18345 @opindex msched-max-memory-insns
18346 Limit on the number of memory insns per instruction group, giving lower
18347 priority to subsequent memory insns attempting to schedule in the same
18348 instruction group. Frequently useful to prevent cache bank conflicts.
18349 The default value is 1.
18351 @item -msched-max-memory-insns-hard-limit
18352 @opindex msched-max-memory-insns-hard-limit
18353 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18354 disallowing more than that number in an instruction group.
18355 Otherwise, the limit is ``soft'', meaning that non-memory operations
18356 are preferred when the limit is reached, but memory operations may still
18357 be scheduled.
18359 @end table
18361 @node LM32 Options
18362 @subsection LM32 Options
18363 @cindex LM32 options
18365 These @option{-m} options are defined for the LatticeMico32 architecture:
18367 @table @gcctabopt
18368 @item -mbarrel-shift-enabled
18369 @opindex mbarrel-shift-enabled
18370 Enable barrel-shift instructions.
18372 @item -mdivide-enabled
18373 @opindex mdivide-enabled
18374 Enable divide and modulus instructions.
18376 @item -mmultiply-enabled
18377 @opindex multiply-enabled
18378 Enable multiply instructions.
18380 @item -msign-extend-enabled
18381 @opindex msign-extend-enabled
18382 Enable sign extend instructions.
18384 @item -muser-enabled
18385 @opindex muser-enabled
18386 Enable user-defined instructions.
18388 @end table
18390 @node M32C Options
18391 @subsection M32C Options
18392 @cindex M32C options
18394 @table @gcctabopt
18395 @item -mcpu=@var{name}
18396 @opindex mcpu=
18397 Select the CPU for which code is generated.  @var{name} may be one of
18398 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18399 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18400 the M32C/80 series.
18402 @item -msim
18403 @opindex msim
18404 Specifies that the program will be run on the simulator.  This causes
18405 an alternate runtime library to be linked in which supports, for
18406 example, file I/O@.  You must not use this option when generating
18407 programs that will run on real hardware; you must provide your own
18408 runtime library for whatever I/O functions are needed.
18410 @item -memregs=@var{number}
18411 @opindex memregs=
18412 Specifies the number of memory-based pseudo-registers GCC uses
18413 during code generation.  These pseudo-registers are used like real
18414 registers, so there is a tradeoff between GCC's ability to fit the
18415 code into available registers, and the performance penalty of using
18416 memory instead of registers.  Note that all modules in a program must
18417 be compiled with the same value for this option.  Because of that, you
18418 must not use this option with GCC's default runtime libraries.
18420 @end table
18422 @node M32R/D Options
18423 @subsection M32R/D Options
18424 @cindex M32R/D options
18426 These @option{-m} options are defined for Renesas M32R/D architectures:
18428 @table @gcctabopt
18429 @item -m32r2
18430 @opindex m32r2
18431 Generate code for the M32R/2@.
18433 @item -m32rx
18434 @opindex m32rx
18435 Generate code for the M32R/X@.
18437 @item -m32r
18438 @opindex m32r
18439 Generate code for the M32R@.  This is the default.
18441 @item -mmodel=small
18442 @opindex mmodel=small
18443 Assume all objects live in the lower 16MB of memory (so that their addresses
18444 can be loaded with the @code{ld24} instruction), and assume all subroutines
18445 are reachable with the @code{bl} instruction.
18446 This is the default.
18448 The addressability of a particular object can be set with the
18449 @code{model} attribute.
18451 @item -mmodel=medium
18452 @opindex mmodel=medium
18453 Assume objects may be anywhere in the 32-bit address space (the compiler
18454 generates @code{seth/add3} instructions to load their addresses), and
18455 assume all subroutines are reachable with the @code{bl} instruction.
18457 @item -mmodel=large
18458 @opindex mmodel=large
18459 Assume objects may be anywhere in the 32-bit address space (the compiler
18460 generates @code{seth/add3} instructions to load their addresses), and
18461 assume subroutines may not be reachable with the @code{bl} instruction
18462 (the compiler generates the much slower @code{seth/add3/jl}
18463 instruction sequence).
18465 @item -msdata=none
18466 @opindex msdata=none
18467 Disable use of the small data area.  Variables are put into
18468 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18469 @code{section} attribute has been specified).
18470 This is the default.
18472 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18473 Objects may be explicitly put in the small data area with the
18474 @code{section} attribute using one of these sections.
18476 @item -msdata=sdata
18477 @opindex msdata=sdata
18478 Put small global and static data in the small data area, but do not
18479 generate special code to reference them.
18481 @item -msdata=use
18482 @opindex msdata=use
18483 Put small global and static data in the small data area, and generate
18484 special instructions to reference them.
18486 @item -G @var{num}
18487 @opindex G
18488 @cindex smaller data references
18489 Put global and static objects less than or equal to @var{num} bytes
18490 into the small data or BSS sections instead of the normal data or BSS
18491 sections.  The default value of @var{num} is 8.
18492 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18493 for this option to have any effect.
18495 All modules should be compiled with the same @option{-G @var{num}} value.
18496 Compiling with different values of @var{num} may or may not work; if it
18497 doesn't the linker gives an error message---incorrect code is not
18498 generated.
18500 @item -mdebug
18501 @opindex mdebug
18502 Makes the M32R-specific code in the compiler display some statistics
18503 that might help in debugging programs.
18505 @item -malign-loops
18506 @opindex malign-loops
18507 Align all loops to a 32-byte boundary.
18509 @item -mno-align-loops
18510 @opindex mno-align-loops
18511 Do not enforce a 32-byte alignment for loops.  This is the default.
18513 @item -missue-rate=@var{number}
18514 @opindex missue-rate=@var{number}
18515 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18516 or 2.
18518 @item -mbranch-cost=@var{number}
18519 @opindex mbranch-cost=@var{number}
18520 @var{number} can only be 1 or 2.  If it is 1 then branches are
18521 preferred over conditional code, if it is 2, then the opposite applies.
18523 @item -mflush-trap=@var{number}
18524 @opindex mflush-trap=@var{number}
18525 Specifies the trap number to use to flush the cache.  The default is
18526 12.  Valid numbers are between 0 and 15 inclusive.
18528 @item -mno-flush-trap
18529 @opindex mno-flush-trap
18530 Specifies that the cache cannot be flushed by using a trap.
18532 @item -mflush-func=@var{name}
18533 @opindex mflush-func=@var{name}
18534 Specifies the name of the operating system function to call to flush
18535 the cache.  The default is @samp{_flush_cache}, but a function call
18536 is only used if a trap is not available.
18538 @item -mno-flush-func
18539 @opindex mno-flush-func
18540 Indicates that there is no OS function for flushing the cache.
18542 @end table
18544 @node M680x0 Options
18545 @subsection M680x0 Options
18546 @cindex M680x0 options
18548 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18549 The default settings depend on which architecture was selected when
18550 the compiler was configured; the defaults for the most common choices
18551 are given below.
18553 @table @gcctabopt
18554 @item -march=@var{arch}
18555 @opindex march
18556 Generate code for a specific M680x0 or ColdFire instruction set
18557 architecture.  Permissible values of @var{arch} for M680x0
18558 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18559 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18560 architectures are selected according to Freescale's ISA classification
18561 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18562 @samp{isab} and @samp{isac}.
18564 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18565 code for a ColdFire target.  The @var{arch} in this macro is one of the
18566 @option{-march} arguments given above.
18568 When used together, @option{-march} and @option{-mtune} select code
18569 that runs on a family of similar processors but that is optimized
18570 for a particular microarchitecture.
18572 @item -mcpu=@var{cpu}
18573 @opindex mcpu
18574 Generate code for a specific M680x0 or ColdFire processor.
18575 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18576 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18577 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18578 below, which also classifies the CPUs into families:
18580 @multitable @columnfractions 0.20 0.80
18581 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18582 @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}
18583 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18584 @item @samp{5206e} @tab @samp{5206e}
18585 @item @samp{5208} @tab @samp{5207} @samp{5208}
18586 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18587 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18588 @item @samp{5216} @tab @samp{5214} @samp{5216}
18589 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18590 @item @samp{5225} @tab @samp{5224} @samp{5225}
18591 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18592 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18593 @item @samp{5249} @tab @samp{5249}
18594 @item @samp{5250} @tab @samp{5250}
18595 @item @samp{5271} @tab @samp{5270} @samp{5271}
18596 @item @samp{5272} @tab @samp{5272}
18597 @item @samp{5275} @tab @samp{5274} @samp{5275}
18598 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18599 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18600 @item @samp{5307} @tab @samp{5307}
18601 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18602 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18603 @item @samp{5407} @tab @samp{5407}
18604 @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}
18605 @end multitable
18607 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18608 @var{arch} is compatible with @var{cpu}.  Other combinations of
18609 @option{-mcpu} and @option{-march} are rejected.
18611 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18612 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18613 where the value of @var{family} is given by the table above.
18615 @item -mtune=@var{tune}
18616 @opindex mtune
18617 Tune the code for a particular microarchitecture within the
18618 constraints set by @option{-march} and @option{-mcpu}.
18619 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18620 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18621 and @samp{cpu32}.  The ColdFire microarchitectures
18622 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18624 You can also use @option{-mtune=68020-40} for code that needs
18625 to run relatively well on 68020, 68030 and 68040 targets.
18626 @option{-mtune=68020-60} is similar but includes 68060 targets
18627 as well.  These two options select the same tuning decisions as
18628 @option{-m68020-40} and @option{-m68020-60} respectively.
18630 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18631 when tuning for 680x0 architecture @var{arch}.  It also defines
18632 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18633 option is used.  If GCC is tuning for a range of architectures,
18634 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18635 it defines the macros for every architecture in the range.
18637 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18638 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18639 of the arguments given above.
18641 @item -m68000
18642 @itemx -mc68000
18643 @opindex m68000
18644 @opindex mc68000
18645 Generate output for a 68000.  This is the default
18646 when the compiler is configured for 68000-based systems.
18647 It is equivalent to @option{-march=68000}.
18649 Use this option for microcontrollers with a 68000 or EC000 core,
18650 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18652 @item -m68010
18653 @opindex m68010
18654 Generate output for a 68010.  This is the default
18655 when the compiler is configured for 68010-based systems.
18656 It is equivalent to @option{-march=68010}.
18658 @item -m68020
18659 @itemx -mc68020
18660 @opindex m68020
18661 @opindex mc68020
18662 Generate output for a 68020.  This is the default
18663 when the compiler is configured for 68020-based systems.
18664 It is equivalent to @option{-march=68020}.
18666 @item -m68030
18667 @opindex m68030
18668 Generate output for a 68030.  This is the default when the compiler is
18669 configured for 68030-based systems.  It is equivalent to
18670 @option{-march=68030}.
18672 @item -m68040
18673 @opindex m68040
18674 Generate output for a 68040.  This is the default when the compiler is
18675 configured for 68040-based systems.  It is equivalent to
18676 @option{-march=68040}.
18678 This option inhibits the use of 68881/68882 instructions that have to be
18679 emulated by software on the 68040.  Use this option if your 68040 does not
18680 have code to emulate those instructions.
18682 @item -m68060
18683 @opindex m68060
18684 Generate output for a 68060.  This is the default when the compiler is
18685 configured for 68060-based systems.  It is equivalent to
18686 @option{-march=68060}.
18688 This option inhibits the use of 68020 and 68881/68882 instructions that
18689 have to be emulated by software on the 68060.  Use this option if your 68060
18690 does not have code to emulate those instructions.
18692 @item -mcpu32
18693 @opindex mcpu32
18694 Generate output for a CPU32.  This is the default
18695 when the compiler is configured for CPU32-based systems.
18696 It is equivalent to @option{-march=cpu32}.
18698 Use this option for microcontrollers with a
18699 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18700 68336, 68340, 68341, 68349 and 68360.
18702 @item -m5200
18703 @opindex m5200
18704 Generate output for a 520X ColdFire CPU@.  This is the default
18705 when the compiler is configured for 520X-based systems.
18706 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18707 in favor of that option.
18709 Use this option for microcontroller with a 5200 core, including
18710 the MCF5202, MCF5203, MCF5204 and MCF5206.
18712 @item -m5206e
18713 @opindex m5206e
18714 Generate output for a 5206e ColdFire CPU@.  The option is now
18715 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18717 @item -m528x
18718 @opindex m528x
18719 Generate output for a member of the ColdFire 528X family.
18720 The option is now deprecated in favor of the equivalent
18721 @option{-mcpu=528x}.
18723 @item -m5307
18724 @opindex m5307
18725 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18726 in favor of the equivalent @option{-mcpu=5307}.
18728 @item -m5407
18729 @opindex m5407
18730 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18731 in favor of the equivalent @option{-mcpu=5407}.
18733 @item -mcfv4e
18734 @opindex mcfv4e
18735 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18736 This includes use of hardware floating-point instructions.
18737 The option is equivalent to @option{-mcpu=547x}, and is now
18738 deprecated in favor of that option.
18740 @item -m68020-40
18741 @opindex m68020-40
18742 Generate output for a 68040, without using any of the new instructions.
18743 This results in code that can run relatively efficiently on either a
18744 68020/68881 or a 68030 or a 68040.  The generated code does use the
18745 68881 instructions that are emulated on the 68040.
18747 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
18749 @item -m68020-60
18750 @opindex m68020-60
18751 Generate output for a 68060, without using any of the new instructions.
18752 This results in code that can run relatively efficiently on either a
18753 68020/68881 or a 68030 or a 68040.  The generated code does use the
18754 68881 instructions that are emulated on the 68060.
18756 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
18758 @item -mhard-float
18759 @itemx -m68881
18760 @opindex mhard-float
18761 @opindex m68881
18762 Generate floating-point instructions.  This is the default for 68020
18763 and above, and for ColdFire devices that have an FPU@.  It defines the
18764 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
18765 on ColdFire targets.
18767 @item -msoft-float
18768 @opindex msoft-float
18769 Do not generate floating-point instructions; use library calls instead.
18770 This is the default for 68000, 68010, and 68832 targets.  It is also
18771 the default for ColdFire devices that have no FPU.
18773 @item -mdiv
18774 @itemx -mno-div
18775 @opindex mdiv
18776 @opindex mno-div
18777 Generate (do not generate) ColdFire hardware divide and remainder
18778 instructions.  If @option{-march} is used without @option{-mcpu},
18779 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
18780 architectures.  Otherwise, the default is taken from the target CPU
18781 (either the default CPU, or the one specified by @option{-mcpu}).  For
18782 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
18783 @option{-mcpu=5206e}.
18785 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
18787 @item -mshort
18788 @opindex mshort
18789 Consider type @code{int} to be 16 bits wide, like @code{short int}.
18790 Additionally, parameters passed on the stack are also aligned to a
18791 16-bit boundary even on targets whose API mandates promotion to 32-bit.
18793 @item -mno-short
18794 @opindex mno-short
18795 Do not consider type @code{int} to be 16 bits wide.  This is the default.
18797 @item -mnobitfield
18798 @itemx -mno-bitfield
18799 @opindex mnobitfield
18800 @opindex mno-bitfield
18801 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
18802 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
18804 @item -mbitfield
18805 @opindex mbitfield
18806 Do use the bit-field instructions.  The @option{-m68020} option implies
18807 @option{-mbitfield}.  This is the default if you use a configuration
18808 designed for a 68020.
18810 @item -mrtd
18811 @opindex mrtd
18812 Use a different function-calling convention, in which functions
18813 that take a fixed number of arguments return with the @code{rtd}
18814 instruction, which pops their arguments while returning.  This
18815 saves one instruction in the caller since there is no need to pop
18816 the arguments there.
18818 This calling convention is incompatible with the one normally
18819 used on Unix, so you cannot use it if you need to call libraries
18820 compiled with the Unix compiler.
18822 Also, you must provide function prototypes for all functions that
18823 take variable numbers of arguments (including @code{printf});
18824 otherwise incorrect code is generated for calls to those
18825 functions.
18827 In addition, seriously incorrect code results if you call a
18828 function with too many arguments.  (Normally, extra arguments are
18829 harmlessly ignored.)
18831 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
18832 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
18834 @item -mno-rtd
18835 @opindex mno-rtd
18836 Do not use the calling conventions selected by @option{-mrtd}.
18837 This is the default.
18839 @item -malign-int
18840 @itemx -mno-align-int
18841 @opindex malign-int
18842 @opindex mno-align-int
18843 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
18844 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
18845 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
18846 Aligning variables on 32-bit boundaries produces code that runs somewhat
18847 faster on processors with 32-bit busses at the expense of more memory.
18849 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
18850 aligns structures containing the above types differently than
18851 most published application binary interface specifications for the m68k.
18853 @item -mpcrel
18854 @opindex mpcrel
18855 Use the pc-relative addressing mode of the 68000 directly, instead of
18856 using a global offset table.  At present, this option implies @option{-fpic},
18857 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
18858 not presently supported with @option{-mpcrel}, though this could be supported for
18859 68020 and higher processors.
18861 @item -mno-strict-align
18862 @itemx -mstrict-align
18863 @opindex mno-strict-align
18864 @opindex mstrict-align
18865 Do not (do) assume that unaligned memory references are handled by
18866 the system.
18868 @item -msep-data
18869 Generate code that allows the data segment to be located in a different
18870 area of memory from the text segment.  This allows for execute-in-place in
18871 an environment without virtual memory management.  This option implies
18872 @option{-fPIC}.
18874 @item -mno-sep-data
18875 Generate code that assumes that the data segment follows the text segment.
18876 This is the default.
18878 @item -mid-shared-library
18879 Generate code that supports shared libraries via the library ID method.
18880 This allows for execute-in-place and shared libraries in an environment
18881 without virtual memory management.  This option implies @option{-fPIC}.
18883 @item -mno-id-shared-library
18884 Generate code that doesn't assume ID-based shared libraries are being used.
18885 This is the default.
18887 @item -mshared-library-id=n
18888 Specifies the identification number of the ID-based shared library being
18889 compiled.  Specifying a value of 0 generates more compact code; specifying
18890 other values forces the allocation of that number to the current
18891 library, but is no more space- or time-efficient than omitting this option.
18893 @item -mxgot
18894 @itemx -mno-xgot
18895 @opindex mxgot
18896 @opindex mno-xgot
18897 When generating position-independent code for ColdFire, generate code
18898 that works if the GOT has more than 8192 entries.  This code is
18899 larger and slower than code generated without this option.  On M680x0
18900 processors, this option is not needed; @option{-fPIC} suffices.
18902 GCC normally uses a single instruction to load values from the GOT@.
18903 While this is relatively efficient, it only works if the GOT
18904 is smaller than about 64k.  Anything larger causes the linker
18905 to report an error such as:
18907 @cindex relocation truncated to fit (ColdFire)
18908 @smallexample
18909 relocation truncated to fit: R_68K_GOT16O foobar
18910 @end smallexample
18912 If this happens, you should recompile your code with @option{-mxgot}.
18913 It should then work with very large GOTs.  However, code generated with
18914 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
18915 the value of a global symbol.
18917 Note that some linkers, including newer versions of the GNU linker,
18918 can create multiple GOTs and sort GOT entries.  If you have such a linker,
18919 you should only need to use @option{-mxgot} when compiling a single
18920 object file that accesses more than 8192 GOT entries.  Very few do.
18922 These options have no effect unless GCC is generating
18923 position-independent code.
18925 @item -mlong-jump-table-offsets
18926 @opindex mlong-jump-table-offsets
18927 Use 32-bit offsets in @code{switch} tables.  The default is to use
18928 16-bit offsets.
18930 @end table
18932 @node MCore Options
18933 @subsection MCore Options
18934 @cindex MCore options
18936 These are the @samp{-m} options defined for the Motorola M*Core
18937 processors.
18939 @table @gcctabopt
18941 @item -mhardlit
18942 @itemx -mno-hardlit
18943 @opindex mhardlit
18944 @opindex mno-hardlit
18945 Inline constants into the code stream if it can be done in two
18946 instructions or less.
18948 @item -mdiv
18949 @itemx -mno-div
18950 @opindex mdiv
18951 @opindex mno-div
18952 Use the divide instruction.  (Enabled by default).
18954 @item -mrelax-immediate
18955 @itemx -mno-relax-immediate
18956 @opindex mrelax-immediate
18957 @opindex mno-relax-immediate
18958 Allow arbitrary-sized immediates in bit operations.
18960 @item -mwide-bitfields
18961 @itemx -mno-wide-bitfields
18962 @opindex mwide-bitfields
18963 @opindex mno-wide-bitfields
18964 Always treat bit-fields as @code{int}-sized.
18966 @item -m4byte-functions
18967 @itemx -mno-4byte-functions
18968 @opindex m4byte-functions
18969 @opindex mno-4byte-functions
18970 Force all functions to be aligned to a 4-byte boundary.
18972 @item -mcallgraph-data
18973 @itemx -mno-callgraph-data
18974 @opindex mcallgraph-data
18975 @opindex mno-callgraph-data
18976 Emit callgraph information.
18978 @item -mslow-bytes
18979 @itemx -mno-slow-bytes
18980 @opindex mslow-bytes
18981 @opindex mno-slow-bytes
18982 Prefer word access when reading byte quantities.
18984 @item -mlittle-endian
18985 @itemx -mbig-endian
18986 @opindex mlittle-endian
18987 @opindex mbig-endian
18988 Generate code for a little-endian target.
18990 @item -m210
18991 @itemx -m340
18992 @opindex m210
18993 @opindex m340
18994 Generate code for the 210 processor.
18996 @item -mno-lsim
18997 @opindex mno-lsim
18998 Assume that runtime support has been provided and so omit the
18999 simulator library (@file{libsim.a)} from the linker command line.
19001 @item -mstack-increment=@var{size}
19002 @opindex mstack-increment
19003 Set the maximum amount for a single stack increment operation.  Large
19004 values can increase the speed of programs that contain functions
19005 that need a large amount of stack space, but they can also trigger a
19006 segmentation fault if the stack is extended too much.  The default
19007 value is 0x1000.
19009 @end table
19011 @node MeP Options
19012 @subsection MeP Options
19013 @cindex MeP options
19015 @table @gcctabopt
19017 @item -mabsdiff
19018 @opindex mabsdiff
19019 Enables the @code{abs} instruction, which is the absolute difference
19020 between two registers.
19022 @item -mall-opts
19023 @opindex mall-opts
19024 Enables all the optional instructions---average, multiply, divide, bit
19025 operations, leading zero, absolute difference, min/max, clip, and
19026 saturation.
19029 @item -maverage
19030 @opindex maverage
19031 Enables the @code{ave} instruction, which computes the average of two
19032 registers.
19034 @item -mbased=@var{n}
19035 @opindex mbased=
19036 Variables of size @var{n} bytes or smaller are placed in the
19037 @code{.based} section by default.  Based variables use the @code{$tp}
19038 register as a base register, and there is a 128-byte limit to the
19039 @code{.based} section.
19041 @item -mbitops
19042 @opindex mbitops
19043 Enables the bit operation instructions---bit test (@code{btstm}), set
19044 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19045 test-and-set (@code{tas}).
19047 @item -mc=@var{name}
19048 @opindex mc=
19049 Selects which section constant data is placed in.  @var{name} may
19050 be @samp{tiny}, @samp{near}, or @samp{far}.
19052 @item -mclip
19053 @opindex mclip
19054 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19055 useful unless you also provide @option{-mminmax}.
19057 @item -mconfig=@var{name}
19058 @opindex mconfig=
19059 Selects one of the built-in core configurations.  Each MeP chip has
19060 one or more modules in it; each module has a core CPU and a variety of
19061 coprocessors, optional instructions, and peripherals.  The
19062 @code{MeP-Integrator} tool, not part of GCC, provides these
19063 configurations through this option; using this option is the same as
19064 using all the corresponding command-line options.  The default
19065 configuration is @samp{default}.
19067 @item -mcop
19068 @opindex mcop
19069 Enables the coprocessor instructions.  By default, this is a 32-bit
19070 coprocessor.  Note that the coprocessor is normally enabled via the
19071 @option{-mconfig=} option.
19073 @item -mcop32
19074 @opindex mcop32
19075 Enables the 32-bit coprocessor's instructions.
19077 @item -mcop64
19078 @opindex mcop64
19079 Enables the 64-bit coprocessor's instructions.
19081 @item -mivc2
19082 @opindex mivc2
19083 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19085 @item -mdc
19086 @opindex mdc
19087 Causes constant variables to be placed in the @code{.near} section.
19089 @item -mdiv
19090 @opindex mdiv
19091 Enables the @code{div} and @code{divu} instructions.
19093 @item -meb
19094 @opindex meb
19095 Generate big-endian code.
19097 @item -mel
19098 @opindex mel
19099 Generate little-endian code.
19101 @item -mio-volatile
19102 @opindex mio-volatile
19103 Tells the compiler that any variable marked with the @code{io}
19104 attribute is to be considered volatile.
19106 @item -ml
19107 @opindex ml
19108 Causes variables to be assigned to the @code{.far} section by default.
19110 @item -mleadz
19111 @opindex mleadz
19112 Enables the @code{leadz} (leading zero) instruction.
19114 @item -mm
19115 @opindex mm
19116 Causes variables to be assigned to the @code{.near} section by default.
19118 @item -mminmax
19119 @opindex mminmax
19120 Enables the @code{min} and @code{max} instructions.
19122 @item -mmult
19123 @opindex mmult
19124 Enables the multiplication and multiply-accumulate instructions.
19126 @item -mno-opts
19127 @opindex mno-opts
19128 Disables all the optional instructions enabled by @option{-mall-opts}.
19130 @item -mrepeat
19131 @opindex mrepeat
19132 Enables the @code{repeat} and @code{erepeat} instructions, used for
19133 low-overhead looping.
19135 @item -ms
19136 @opindex ms
19137 Causes all variables to default to the @code{.tiny} section.  Note
19138 that there is a 65536-byte limit to this section.  Accesses to these
19139 variables use the @code{%gp} base register.
19141 @item -msatur
19142 @opindex msatur
19143 Enables the saturation instructions.  Note that the compiler does not
19144 currently generate these itself, but this option is included for
19145 compatibility with other tools, like @code{as}.
19147 @item -msdram
19148 @opindex msdram
19149 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19151 @item -msim
19152 @opindex msim
19153 Link the simulator run-time libraries.
19155 @item -msimnovec
19156 @opindex msimnovec
19157 Link the simulator runtime libraries, excluding built-in support
19158 for reset and exception vectors and tables.
19160 @item -mtf
19161 @opindex mtf
19162 Causes all functions to default to the @code{.far} section.  Without
19163 this option, functions default to the @code{.near} section.
19165 @item -mtiny=@var{n}
19166 @opindex mtiny=
19167 Variables that are @var{n} bytes or smaller are allocated to the
19168 @code{.tiny} section.  These variables use the @code{$gp} base
19169 register.  The default for this option is 4, but note that there's a
19170 65536-byte limit to the @code{.tiny} section.
19172 @end table
19174 @node MicroBlaze Options
19175 @subsection MicroBlaze Options
19176 @cindex MicroBlaze Options
19178 @table @gcctabopt
19180 @item -msoft-float
19181 @opindex msoft-float
19182 Use software emulation for floating point (default).
19184 @item -mhard-float
19185 @opindex mhard-float
19186 Use hardware floating-point instructions.
19188 @item -mmemcpy
19189 @opindex mmemcpy
19190 Do not optimize block moves, use @code{memcpy}.
19192 @item -mno-clearbss
19193 @opindex mno-clearbss
19194 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19196 @item -mcpu=@var{cpu-type}
19197 @opindex mcpu=
19198 Use features of, and schedule code for, the given CPU.
19199 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19200 where @var{X} is a major version, @var{YY} is the minor version, and
19201 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19202 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19204 @item -mxl-soft-mul
19205 @opindex mxl-soft-mul
19206 Use software multiply emulation (default).
19208 @item -mxl-soft-div
19209 @opindex mxl-soft-div
19210 Use software emulation for divides (default).
19212 @item -mxl-barrel-shift
19213 @opindex mxl-barrel-shift
19214 Use the hardware barrel shifter.
19216 @item -mxl-pattern-compare
19217 @opindex mxl-pattern-compare
19218 Use pattern compare instructions.
19220 @item -msmall-divides
19221 @opindex msmall-divides
19222 Use table lookup optimization for small signed integer divisions.
19224 @item -mxl-stack-check
19225 @opindex mxl-stack-check
19226 This option is deprecated.  Use @option{-fstack-check} instead.
19228 @item -mxl-gp-opt
19229 @opindex mxl-gp-opt
19230 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19232 @item -mxl-multiply-high
19233 @opindex mxl-multiply-high
19234 Use multiply high instructions for high part of 32x32 multiply.
19236 @item -mxl-float-convert
19237 @opindex mxl-float-convert
19238 Use hardware floating-point conversion instructions.
19240 @item -mxl-float-sqrt
19241 @opindex mxl-float-sqrt
19242 Use hardware floating-point square root instruction.
19244 @item -mbig-endian
19245 @opindex mbig-endian
19246 Generate code for a big-endian target.
19248 @item -mlittle-endian
19249 @opindex mlittle-endian
19250 Generate code for a little-endian target.
19252 @item -mxl-reorder
19253 @opindex mxl-reorder
19254 Use reorder instructions (swap and byte reversed load/store).
19256 @item -mxl-mode-@var{app-model}
19257 Select application model @var{app-model}.  Valid models are
19258 @table @samp
19259 @item executable
19260 normal executable (default), uses startup code @file{crt0.o}.
19262 @item xmdstub
19263 for use with Xilinx Microprocessor Debugger (XMD) based
19264 software intrusive debug agent called xmdstub. This uses startup file
19265 @file{crt1.o} and sets the start address of the program to 0x800.
19267 @item bootstrap
19268 for applications that are loaded using a bootloader.
19269 This model uses startup file @file{crt2.o} which does not contain a processor
19270 reset vector handler. This is suitable for transferring control on a
19271 processor reset to the bootloader rather than the application.
19273 @item novectors
19274 for applications that do not require any of the
19275 MicroBlaze vectors. This option may be useful for applications running
19276 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19277 @end table
19279 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19280 @option{-mxl-mode-@var{app-model}}.
19282 @end table
19284 @node MIPS Options
19285 @subsection MIPS Options
19286 @cindex MIPS options
19288 @table @gcctabopt
19290 @item -EB
19291 @opindex EB
19292 Generate big-endian code.
19294 @item -EL
19295 @opindex EL
19296 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19297 configurations.
19299 @item -march=@var{arch}
19300 @opindex march
19301 Generate code that runs on @var{arch}, which can be the name of a
19302 generic MIPS ISA, or the name of a particular processor.
19303 The ISA names are:
19304 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19305 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19306 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19307 @samp{mips64r5} and @samp{mips64r6}.
19308 The processor names are:
19309 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19310 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19311 @samp{5kc}, @samp{5kf},
19312 @samp{20kc},
19313 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19314 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19315 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19316 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19317 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19318 @samp{i6400},
19319 @samp{interaptiv},
19320 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19321 @samp{m4k},
19322 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19323 @samp{m5100}, @samp{m5101},
19324 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19325 @samp{orion},
19326 @samp{p5600},
19327 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19328 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19329 @samp{rm7000}, @samp{rm9000},
19330 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19331 @samp{sb1},
19332 @samp{sr71000},
19333 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19334 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19335 @samp{xlr} and @samp{xlp}.
19336 The special value @samp{from-abi} selects the
19337 most compatible architecture for the selected ABI (that is,
19338 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19340 The native Linux/GNU toolchain also supports the value @samp{native},
19341 which selects the best architecture option for the host processor.
19342 @option{-march=native} has no effect if GCC does not recognize
19343 the processor.
19345 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19346 (for example, @option{-march=r2k}).  Prefixes are optional, and
19347 @samp{vr} may be written @samp{r}.
19349 Names of the form @samp{@var{n}f2_1} refer to processors with
19350 FPUs clocked at half the rate of the core, names of the form
19351 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19352 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19353 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19354 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19355 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19356 accepted as synonyms for @samp{@var{n}f1_1}.
19358 GCC defines two macros based on the value of this option.  The first
19359 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19360 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19361 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19362 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19363 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19365 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19366 above.  In other words, it has the full prefix and does not
19367 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19368 the macro names the resolved architecture (either @code{"mips1"} or
19369 @code{"mips3"}).  It names the default architecture when no
19370 @option{-march} option is given.
19372 @item -mtune=@var{arch}
19373 @opindex mtune
19374 Optimize for @var{arch}.  Among other things, this option controls
19375 the way instructions are scheduled, and the perceived cost of arithmetic
19376 operations.  The list of @var{arch} values is the same as for
19377 @option{-march}.
19379 When this option is not used, GCC optimizes for the processor
19380 specified by @option{-march}.  By using @option{-march} and
19381 @option{-mtune} together, it is possible to generate code that
19382 runs on a family of processors, but optimize the code for one
19383 particular member of that family.
19385 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19386 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19387 @option{-march} ones described above.
19389 @item -mips1
19390 @opindex mips1
19391 Equivalent to @option{-march=mips1}.
19393 @item -mips2
19394 @opindex mips2
19395 Equivalent to @option{-march=mips2}.
19397 @item -mips3
19398 @opindex mips3
19399 Equivalent to @option{-march=mips3}.
19401 @item -mips4
19402 @opindex mips4
19403 Equivalent to @option{-march=mips4}.
19405 @item -mips32
19406 @opindex mips32
19407 Equivalent to @option{-march=mips32}.
19409 @item -mips32r3
19410 @opindex mips32r3
19411 Equivalent to @option{-march=mips32r3}.
19413 @item -mips32r5
19414 @opindex mips32r5
19415 Equivalent to @option{-march=mips32r5}.
19417 @item -mips32r6
19418 @opindex mips32r6
19419 Equivalent to @option{-march=mips32r6}.
19421 @item -mips64
19422 @opindex mips64
19423 Equivalent to @option{-march=mips64}.
19425 @item -mips64r2
19426 @opindex mips64r2
19427 Equivalent to @option{-march=mips64r2}.
19429 @item -mips64r3
19430 @opindex mips64r3
19431 Equivalent to @option{-march=mips64r3}.
19433 @item -mips64r5
19434 @opindex mips64r5
19435 Equivalent to @option{-march=mips64r5}.
19437 @item -mips64r6
19438 @opindex mips64r6
19439 Equivalent to @option{-march=mips64r6}.
19441 @item -mips16
19442 @itemx -mno-mips16
19443 @opindex mips16
19444 @opindex mno-mips16
19445 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19446 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19448 MIPS16 code generation can also be controlled on a per-function basis
19449 by means of @code{mips16} and @code{nomips16} attributes.
19450 @xref{Function Attributes}, for more information.
19452 @item -mflip-mips16
19453 @opindex mflip-mips16
19454 Generate MIPS16 code on alternating functions.  This option is provided
19455 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19456 not intended for ordinary use in compiling user code.
19458 @item -minterlink-compressed
19459 @item -mno-interlink-compressed
19460 @opindex minterlink-compressed
19461 @opindex mno-interlink-compressed
19462 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19463 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19465 For example, code using the standard ISA encoding cannot jump directly
19466 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19467 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19468 knows that the target of the jump is not compressed.
19470 @item -minterlink-mips16
19471 @itemx -mno-interlink-mips16
19472 @opindex minterlink-mips16
19473 @opindex mno-interlink-mips16
19474 Aliases of @option{-minterlink-compressed} and
19475 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19476 and are retained for backwards compatibility.
19478 @item -mabi=32
19479 @itemx -mabi=o64
19480 @itemx -mabi=n32
19481 @itemx -mabi=64
19482 @itemx -mabi=eabi
19483 @opindex mabi=32
19484 @opindex mabi=o64
19485 @opindex mabi=n32
19486 @opindex mabi=64
19487 @opindex mabi=eabi
19488 Generate code for the given ABI@.
19490 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19491 generates 64-bit code when you select a 64-bit architecture, but you
19492 can use @option{-mgp32} to get 32-bit code instead.
19494 For information about the O64 ABI, see
19495 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19497 GCC supports a variant of the o32 ABI in which floating-point registers
19498 are 64 rather than 32 bits wide.  You can select this combination with
19499 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19500 and @code{mfhc1} instructions and is therefore only supported for
19501 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19503 The register assignments for arguments and return values remain the
19504 same, but each scalar value is passed in a single 64-bit register
19505 rather than a pair of 32-bit registers.  For example, scalar
19506 floating-point values are returned in @samp{$f0} only, not a
19507 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19508 remains the same in that the even-numbered double-precision registers
19509 are saved.
19511 Two additional variants of the o32 ABI are supported to enable
19512 a transition from 32-bit to 64-bit registers.  These are FPXX
19513 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19514 The FPXX extension mandates that all code must execute correctly
19515 when run using 32-bit or 64-bit registers.  The code can be interlinked
19516 with either FP32 or FP64, but not both.
19517 The FP64A extension is similar to the FP64 extension but forbids the
19518 use of odd-numbered single-precision registers.  This can be used
19519 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19520 processors and allows both FP32 and FP64A code to interlink and
19521 run in the same process without changing FPU modes.
19523 @item -mabicalls
19524 @itemx -mno-abicalls
19525 @opindex mabicalls
19526 @opindex mno-abicalls
19527 Generate (do not generate) code that is suitable for SVR4-style
19528 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19529 systems.
19531 @item -mshared
19532 @itemx -mno-shared
19533 Generate (do not generate) code that is fully position-independent,
19534 and that can therefore be linked into shared libraries.  This option
19535 only affects @option{-mabicalls}.
19537 All @option{-mabicalls} code has traditionally been position-independent,
19538 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19539 as an extension, the GNU toolchain allows executables to use absolute
19540 accesses for locally-binding symbols.  It can also use shorter GP
19541 initialization sequences and generate direct calls to locally-defined
19542 functions.  This mode is selected by @option{-mno-shared}.
19544 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19545 objects that can only be linked by the GNU linker.  However, the option
19546 does not affect the ABI of the final executable; it only affects the ABI
19547 of relocatable objects.  Using @option{-mno-shared} generally makes
19548 executables both smaller and quicker.
19550 @option{-mshared} is the default.
19552 @item -mplt
19553 @itemx -mno-plt
19554 @opindex mplt
19555 @opindex mno-plt
19556 Assume (do not assume) that the static and dynamic linkers
19557 support PLTs and copy relocations.  This option only affects
19558 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19559 has no effect without @option{-msym32}.
19561 You can make @option{-mplt} the default by configuring
19562 GCC with @option{--with-mips-plt}.  The default is
19563 @option{-mno-plt} otherwise.
19565 @item -mxgot
19566 @itemx -mno-xgot
19567 @opindex mxgot
19568 @opindex mno-xgot
19569 Lift (do not lift) the usual restrictions on the size of the global
19570 offset table.
19572 GCC normally uses a single instruction to load values from the GOT@.
19573 While this is relatively efficient, it only works if the GOT
19574 is smaller than about 64k.  Anything larger causes the linker
19575 to report an error such as:
19577 @cindex relocation truncated to fit (MIPS)
19578 @smallexample
19579 relocation truncated to fit: R_MIPS_GOT16 foobar
19580 @end smallexample
19582 If this happens, you should recompile your code with @option{-mxgot}.
19583 This works with very large GOTs, although the code is also
19584 less efficient, since it takes three instructions to fetch the
19585 value of a global symbol.
19587 Note that some linkers can create multiple GOTs.  If you have such a
19588 linker, you should only need to use @option{-mxgot} when a single object
19589 file accesses more than 64k's worth of GOT entries.  Very few do.
19591 These options have no effect unless GCC is generating position
19592 independent code.
19594 @item -mgp32
19595 @opindex mgp32
19596 Assume that general-purpose registers are 32 bits wide.
19598 @item -mgp64
19599 @opindex mgp64
19600 Assume that general-purpose registers are 64 bits wide.
19602 @item -mfp32
19603 @opindex mfp32
19604 Assume that floating-point registers are 32 bits wide.
19606 @item -mfp64
19607 @opindex mfp64
19608 Assume that floating-point registers are 64 bits wide.
19610 @item -mfpxx
19611 @opindex mfpxx
19612 Do not assume the width of floating-point registers.
19614 @item -mhard-float
19615 @opindex mhard-float
19616 Use floating-point coprocessor instructions.
19618 @item -msoft-float
19619 @opindex msoft-float
19620 Do not use floating-point coprocessor instructions.  Implement
19621 floating-point calculations using library calls instead.
19623 @item -mno-float
19624 @opindex mno-float
19625 Equivalent to @option{-msoft-float}, but additionally asserts that the
19626 program being compiled does not perform any floating-point operations.
19627 This option is presently supported only by some bare-metal MIPS
19628 configurations, where it may select a special set of libraries
19629 that lack all floating-point support (including, for example, the
19630 floating-point @code{printf} formats).  
19631 If code compiled with @option{-mno-float} accidentally contains
19632 floating-point operations, it is likely to suffer a link-time
19633 or run-time failure.
19635 @item -msingle-float
19636 @opindex msingle-float
19637 Assume that the floating-point coprocessor only supports single-precision
19638 operations.
19640 @item -mdouble-float
19641 @opindex mdouble-float
19642 Assume that the floating-point coprocessor supports double-precision
19643 operations.  This is the default.
19645 @item -modd-spreg
19646 @itemx -mno-odd-spreg
19647 @opindex modd-spreg
19648 @opindex mno-odd-spreg
19649 Enable the use of odd-numbered single-precision floating-point registers
19650 for the o32 ABI.  This is the default for processors that are known to
19651 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19652 is set by default.
19654 @item -mabs=2008
19655 @itemx -mabs=legacy
19656 @opindex mabs=2008
19657 @opindex mabs=legacy
19658 These options control the treatment of the special not-a-number (NaN)
19659 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19660 @code{neg.@i{fmt}} machine instructions.
19662 By default or when @option{-mabs=legacy} is used the legacy
19663 treatment is selected.  In this case these instructions are considered
19664 arithmetic and avoided where correct operation is required and the
19665 input operand might be a NaN.  A longer sequence of instructions that
19666 manipulate the sign bit of floating-point datum manually is used
19667 instead unless the @option{-ffinite-math-only} option has also been
19668 specified.
19670 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19671 this case these instructions are considered non-arithmetic and therefore
19672 operating correctly in all cases, including in particular where the
19673 input operand is a NaN.  These instructions are therefore always used
19674 for the respective operations.
19676 @item -mnan=2008
19677 @itemx -mnan=legacy
19678 @opindex mnan=2008
19679 @opindex mnan=legacy
19680 These options control the encoding of the special not-a-number (NaN)
19681 IEEE 754 floating-point data.
19683 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19684 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19685 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19686 by the first bit of their trailing significand field being 1.
19688 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19689 this case qNaNs are denoted by the first bit of their trailing
19690 significand field being 1, whereas sNaNs are denoted by the first bit of
19691 their trailing significand field being 0.
19693 The default is @option{-mnan=legacy} unless GCC has been configured with
19694 @option{--with-nan=2008}.
19696 @item -mllsc
19697 @itemx -mno-llsc
19698 @opindex mllsc
19699 @opindex mno-llsc
19700 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19701 implement atomic memory built-in functions.  When neither option is
19702 specified, GCC uses the instructions if the target architecture
19703 supports them.
19705 @option{-mllsc} is useful if the runtime environment can emulate the
19706 instructions and @option{-mno-llsc} can be useful when compiling for
19707 nonstandard ISAs.  You can make either option the default by
19708 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19709 respectively.  @option{--with-llsc} is the default for some
19710 configurations; see the installation documentation for details.
19712 @item -mdsp
19713 @itemx -mno-dsp
19714 @opindex mdsp
19715 @opindex mno-dsp
19716 Use (do not use) revision 1 of the MIPS DSP ASE@.
19717 @xref{MIPS DSP Built-in Functions}.  This option defines the
19718 preprocessor macro @code{__mips_dsp}.  It also defines
19719 @code{__mips_dsp_rev} to 1.
19721 @item -mdspr2
19722 @itemx -mno-dspr2
19723 @opindex mdspr2
19724 @opindex mno-dspr2
19725 Use (do not use) revision 2 of the MIPS DSP ASE@.
19726 @xref{MIPS DSP Built-in Functions}.  This option defines the
19727 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19728 It also defines @code{__mips_dsp_rev} to 2.
19730 @item -msmartmips
19731 @itemx -mno-smartmips
19732 @opindex msmartmips
19733 @opindex mno-smartmips
19734 Use (do not use) the MIPS SmartMIPS ASE.
19736 @item -mpaired-single
19737 @itemx -mno-paired-single
19738 @opindex mpaired-single
19739 @opindex mno-paired-single
19740 Use (do not use) paired-single floating-point instructions.
19741 @xref{MIPS Paired-Single Support}.  This option requires
19742 hardware floating-point support to be enabled.
19744 @item -mdmx
19745 @itemx -mno-mdmx
19746 @opindex mdmx
19747 @opindex mno-mdmx
19748 Use (do not use) MIPS Digital Media Extension instructions.
19749 This option can only be used when generating 64-bit code and requires
19750 hardware floating-point support to be enabled.
19752 @item -mips3d
19753 @itemx -mno-mips3d
19754 @opindex mips3d
19755 @opindex mno-mips3d
19756 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
19757 The option @option{-mips3d} implies @option{-mpaired-single}.
19759 @item -mmicromips
19760 @itemx -mno-micromips
19761 @opindex mmicromips
19762 @opindex mno-mmicromips
19763 Generate (do not generate) microMIPS code.
19765 MicroMIPS code generation can also be controlled on a per-function basis
19766 by means of @code{micromips} and @code{nomicromips} attributes.
19767 @xref{Function Attributes}, for more information.
19769 @item -mmt
19770 @itemx -mno-mt
19771 @opindex mmt
19772 @opindex mno-mt
19773 Use (do not use) MT Multithreading instructions.
19775 @item -mmcu
19776 @itemx -mno-mcu
19777 @opindex mmcu
19778 @opindex mno-mcu
19779 Use (do not use) the MIPS MCU ASE instructions.
19781 @item -meva
19782 @itemx -mno-eva
19783 @opindex meva
19784 @opindex mno-eva
19785 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
19787 @item -mvirt
19788 @itemx -mno-virt
19789 @opindex mvirt
19790 @opindex mno-virt
19791 Use (do not use) the MIPS Virtualization (VZ) instructions.
19793 @item -mxpa
19794 @itemx -mno-xpa
19795 @opindex mxpa
19796 @opindex mno-xpa
19797 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
19799 @item -mlong64
19800 @opindex mlong64
19801 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
19802 an explanation of the default and the way that the pointer size is
19803 determined.
19805 @item -mlong32
19806 @opindex mlong32
19807 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
19809 The default size of @code{int}s, @code{long}s and pointers depends on
19810 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
19811 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
19812 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
19813 or the same size as integer registers, whichever is smaller.
19815 @item -msym32
19816 @itemx -mno-sym32
19817 @opindex msym32
19818 @opindex mno-sym32
19819 Assume (do not assume) that all symbols have 32-bit values, regardless
19820 of the selected ABI@.  This option is useful in combination with
19821 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
19822 to generate shorter and faster references to symbolic addresses.
19824 @item -G @var{num}
19825 @opindex G
19826 Put definitions of externally-visible data in a small data section
19827 if that data is no bigger than @var{num} bytes.  GCC can then generate
19828 more efficient accesses to the data; see @option{-mgpopt} for details.
19830 The default @option{-G} option depends on the configuration.
19832 @item -mlocal-sdata
19833 @itemx -mno-local-sdata
19834 @opindex mlocal-sdata
19835 @opindex mno-local-sdata
19836 Extend (do not extend) the @option{-G} behavior to local data too,
19837 such as to static variables in C@.  @option{-mlocal-sdata} is the
19838 default for all configurations.
19840 If the linker complains that an application is using too much small data,
19841 you might want to try rebuilding the less performance-critical parts with
19842 @option{-mno-local-sdata}.  You might also want to build large
19843 libraries with @option{-mno-local-sdata}, so that the libraries leave
19844 more room for the main program.
19846 @item -mextern-sdata
19847 @itemx -mno-extern-sdata
19848 @opindex mextern-sdata
19849 @opindex mno-extern-sdata
19850 Assume (do not assume) that externally-defined data is in
19851 a small data section if the size of that data is within the @option{-G} limit.
19852 @option{-mextern-sdata} is the default for all configurations.
19854 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
19855 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
19856 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
19857 is placed in a small data section.  If @var{Var} is defined by another
19858 module, you must either compile that module with a high-enough
19859 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
19860 definition.  If @var{Var} is common, you must link the application
19861 with a high-enough @option{-G} setting.
19863 The easiest way of satisfying these restrictions is to compile
19864 and link every module with the same @option{-G} option.  However,
19865 you may wish to build a library that supports several different
19866 small data limits.  You can do this by compiling the library with
19867 the highest supported @option{-G} setting and additionally using
19868 @option{-mno-extern-sdata} to stop the library from making assumptions
19869 about externally-defined data.
19871 @item -mgpopt
19872 @itemx -mno-gpopt
19873 @opindex mgpopt
19874 @opindex mno-gpopt
19875 Use (do not use) GP-relative accesses for symbols that are known to be
19876 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
19877 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
19878 configurations.
19880 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
19881 might not hold the value of @code{_gp}.  For example, if the code is
19882 part of a library that might be used in a boot monitor, programs that
19883 call boot monitor routines pass an unknown value in @code{$gp}.
19884 (In such situations, the boot monitor itself is usually compiled
19885 with @option{-G0}.)
19887 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
19888 @option{-mno-extern-sdata}.
19890 @item -membedded-data
19891 @itemx -mno-embedded-data
19892 @opindex membedded-data
19893 @opindex mno-embedded-data
19894 Allocate variables to the read-only data section first if possible, then
19895 next in the small data section if possible, otherwise in data.  This gives
19896 slightly slower code than the default, but reduces the amount of RAM required
19897 when executing, and thus may be preferred for some embedded systems.
19899 @item -muninit-const-in-rodata
19900 @itemx -mno-uninit-const-in-rodata
19901 @opindex muninit-const-in-rodata
19902 @opindex mno-uninit-const-in-rodata
19903 Put uninitialized @code{const} variables in the read-only data section.
19904 This option is only meaningful in conjunction with @option{-membedded-data}.
19906 @item -mcode-readable=@var{setting}
19907 @opindex mcode-readable
19908 Specify whether GCC may generate code that reads from executable sections.
19909 There are three possible settings:
19911 @table @gcctabopt
19912 @item -mcode-readable=yes
19913 Instructions may freely access executable sections.  This is the
19914 default setting.
19916 @item -mcode-readable=pcrel
19917 MIPS16 PC-relative load instructions can access executable sections,
19918 but other instructions must not do so.  This option is useful on 4KSc
19919 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
19920 It is also useful on processors that can be configured to have a dual
19921 instruction/data SRAM interface and that, like the M4K, automatically
19922 redirect PC-relative loads to the instruction RAM.
19924 @item -mcode-readable=no
19925 Instructions must not access executable sections.  This option can be
19926 useful on targets that are configured to have a dual instruction/data
19927 SRAM interface but that (unlike the M4K) do not automatically redirect
19928 PC-relative loads to the instruction RAM.
19929 @end table
19931 @item -msplit-addresses
19932 @itemx -mno-split-addresses
19933 @opindex msplit-addresses
19934 @opindex mno-split-addresses
19935 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
19936 relocation operators.  This option has been superseded by
19937 @option{-mexplicit-relocs} but is retained for backwards compatibility.
19939 @item -mexplicit-relocs
19940 @itemx -mno-explicit-relocs
19941 @opindex mexplicit-relocs
19942 @opindex mno-explicit-relocs
19943 Use (do not use) assembler relocation operators when dealing with symbolic
19944 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
19945 is to use assembler macros instead.
19947 @option{-mexplicit-relocs} is the default if GCC was configured
19948 to use an assembler that supports relocation operators.
19950 @item -mcheck-zero-division
19951 @itemx -mno-check-zero-division
19952 @opindex mcheck-zero-division
19953 @opindex mno-check-zero-division
19954 Trap (do not trap) on integer division by zero.
19956 The default is @option{-mcheck-zero-division}.
19958 @item -mdivide-traps
19959 @itemx -mdivide-breaks
19960 @opindex mdivide-traps
19961 @opindex mdivide-breaks
19962 MIPS systems check for division by zero by generating either a
19963 conditional trap or a break instruction.  Using traps results in
19964 smaller code, but is only supported on MIPS II and later.  Also, some
19965 versions of the Linux kernel have a bug that prevents trap from
19966 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
19967 allow conditional traps on architectures that support them and
19968 @option{-mdivide-breaks} to force the use of breaks.
19970 The default is usually @option{-mdivide-traps}, but this can be
19971 overridden at configure time using @option{--with-divide=breaks}.
19972 Divide-by-zero checks can be completely disabled using
19973 @option{-mno-check-zero-division}.
19975 @item -mload-store-pairs
19976 @itemx -mno-load-store-pairs
19977 @opindex mload-store-pairs
19978 @opindex mno-load-store-pairs
19979 Enable (disable) an optimization that pairs consecutive load or store
19980 instructions to enable load/store bonding.  This option is enabled by
19981 default but only takes effect when the selected architecture is known
19982 to support bonding.
19984 @item -mmemcpy
19985 @itemx -mno-memcpy
19986 @opindex mmemcpy
19987 @opindex mno-memcpy
19988 Force (do not force) the use of @code{memcpy} for non-trivial block
19989 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
19990 most constant-sized copies.
19992 @item -mlong-calls
19993 @itemx -mno-long-calls
19994 @opindex mlong-calls
19995 @opindex mno-long-calls
19996 Disable (do not disable) use of the @code{jal} instruction.  Calling
19997 functions using @code{jal} is more efficient but requires the caller
19998 and callee to be in the same 256 megabyte segment.
20000 This option has no effect on abicalls code.  The default is
20001 @option{-mno-long-calls}.
20003 @item -mmad
20004 @itemx -mno-mad
20005 @opindex mmad
20006 @opindex mno-mad
20007 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20008 instructions, as provided by the R4650 ISA@.
20010 @item -mimadd
20011 @itemx -mno-imadd
20012 @opindex mimadd
20013 @opindex mno-imadd
20014 Enable (disable) use of the @code{madd} and @code{msub} integer
20015 instructions.  The default is @option{-mimadd} on architectures
20016 that support @code{madd} and @code{msub} except for the 74k 
20017 architecture where it was found to generate slower code.
20019 @item -mfused-madd
20020 @itemx -mno-fused-madd
20021 @opindex mfused-madd
20022 @opindex mno-fused-madd
20023 Enable (disable) use of the floating-point multiply-accumulate
20024 instructions, when they are available.  The default is
20025 @option{-mfused-madd}.
20027 On the R8000 CPU when multiply-accumulate instructions are used,
20028 the intermediate product is calculated to infinite precision
20029 and is not subject to the FCSR Flush to Zero bit.  This may be
20030 undesirable in some circumstances.  On other processors the result
20031 is numerically identical to the equivalent computation using
20032 separate multiply, add, subtract and negate instructions.
20034 @item -nocpp
20035 @opindex nocpp
20036 Tell the MIPS assembler to not run its preprocessor over user
20037 assembler files (with a @samp{.s} suffix) when assembling them.
20039 @item -mfix-24k
20040 @item -mno-fix-24k
20041 @opindex mfix-24k
20042 @opindex mno-fix-24k
20043 Work around the 24K E48 (lost data on stores during refill) errata.
20044 The workarounds are implemented by the assembler rather than by GCC@.
20046 @item -mfix-r4000
20047 @itemx -mno-fix-r4000
20048 @opindex mfix-r4000
20049 @opindex mno-fix-r4000
20050 Work around certain R4000 CPU errata:
20051 @itemize @minus
20052 @item
20053 A double-word or a variable shift may give an incorrect result if executed
20054 immediately after starting an integer division.
20055 @item
20056 A double-word or a variable shift may give an incorrect result if executed
20057 while an integer multiplication is in progress.
20058 @item
20059 An integer division may give an incorrect result if started in a delay slot
20060 of a taken branch or a jump.
20061 @end itemize
20063 @item -mfix-r4400
20064 @itemx -mno-fix-r4400
20065 @opindex mfix-r4400
20066 @opindex mno-fix-r4400
20067 Work around certain R4400 CPU errata:
20068 @itemize @minus
20069 @item
20070 A double-word or a variable shift may give an incorrect result if executed
20071 immediately after starting an integer division.
20072 @end itemize
20074 @item -mfix-r10000
20075 @itemx -mno-fix-r10000
20076 @opindex mfix-r10000
20077 @opindex mno-fix-r10000
20078 Work around certain R10000 errata:
20079 @itemize @minus
20080 @item
20081 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20082 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20083 @end itemize
20085 This option can only be used if the target architecture supports
20086 branch-likely instructions.  @option{-mfix-r10000} is the default when
20087 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20088 otherwise.
20090 @item -mfix-rm7000
20091 @itemx -mno-fix-rm7000
20092 @opindex mfix-rm7000
20093 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20094 workarounds are implemented by the assembler rather than by GCC@.
20096 @item -mfix-vr4120
20097 @itemx -mno-fix-vr4120
20098 @opindex mfix-vr4120
20099 Work around certain VR4120 errata:
20100 @itemize @minus
20101 @item
20102 @code{dmultu} does not always produce the correct result.
20103 @item
20104 @code{div} and @code{ddiv} do not always produce the correct result if one
20105 of the operands is negative.
20106 @end itemize
20107 The workarounds for the division errata rely on special functions in
20108 @file{libgcc.a}.  At present, these functions are only provided by
20109 the @code{mips64vr*-elf} configurations.
20111 Other VR4120 errata require a NOP to be inserted between certain pairs of
20112 instructions.  These errata are handled by the assembler, not by GCC itself.
20114 @item -mfix-vr4130
20115 @opindex mfix-vr4130
20116 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20117 workarounds are implemented by the assembler rather than by GCC,
20118 although GCC avoids using @code{mflo} and @code{mfhi} if the
20119 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20120 instructions are available instead.
20122 @item -mfix-sb1
20123 @itemx -mno-fix-sb1
20124 @opindex mfix-sb1
20125 Work around certain SB-1 CPU core errata.
20126 (This flag currently works around the SB-1 revision 2
20127 ``F1'' and ``F2'' floating-point errata.)
20129 @item -mr10k-cache-barrier=@var{setting}
20130 @opindex mr10k-cache-barrier
20131 Specify whether GCC should insert cache barriers to avoid the
20132 side-effects of speculation on R10K processors.
20134 In common with many processors, the R10K tries to predict the outcome
20135 of a conditional branch and speculatively executes instructions from
20136 the ``taken'' branch.  It later aborts these instructions if the
20137 predicted outcome is wrong.  However, on the R10K, even aborted
20138 instructions can have side effects.
20140 This problem only affects kernel stores and, depending on the system,
20141 kernel loads.  As an example, a speculatively-executed store may load
20142 the target memory into cache and mark the cache line as dirty, even if
20143 the store itself is later aborted.  If a DMA operation writes to the
20144 same area of memory before the ``dirty'' line is flushed, the cached
20145 data overwrites the DMA-ed data.  See the R10K processor manual
20146 for a full description, including other potential problems.
20148 One workaround is to insert cache barrier instructions before every memory
20149 access that might be speculatively executed and that might have side
20150 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20151 controls GCC's implementation of this workaround.  It assumes that
20152 aborted accesses to any byte in the following regions does not have
20153 side effects:
20155 @enumerate
20156 @item
20157 the memory occupied by the current function's stack frame;
20159 @item
20160 the memory occupied by an incoming stack argument;
20162 @item
20163 the memory occupied by an object with a link-time-constant address.
20164 @end enumerate
20166 It is the kernel's responsibility to ensure that speculative
20167 accesses to these regions are indeed safe.
20169 If the input program contains a function declaration such as:
20171 @smallexample
20172 void foo (void);
20173 @end smallexample
20175 then the implementation of @code{foo} must allow @code{j foo} and
20176 @code{jal foo} to be executed speculatively.  GCC honors this
20177 restriction for functions it compiles itself.  It expects non-GCC
20178 functions (such as hand-written assembly code) to do the same.
20180 The option has three forms:
20182 @table @gcctabopt
20183 @item -mr10k-cache-barrier=load-store
20184 Insert a cache barrier before a load or store that might be
20185 speculatively executed and that might have side effects even
20186 if aborted.
20188 @item -mr10k-cache-barrier=store
20189 Insert a cache barrier before a store that might be speculatively
20190 executed and that might have side effects even if aborted.
20192 @item -mr10k-cache-barrier=none
20193 Disable the insertion of cache barriers.  This is the default setting.
20194 @end table
20196 @item -mflush-func=@var{func}
20197 @itemx -mno-flush-func
20198 @opindex mflush-func
20199 Specifies the function to call to flush the I and D caches, or to not
20200 call any such function.  If called, the function must take the same
20201 arguments as the common @code{_flush_func}, that is, the address of the
20202 memory range for which the cache is being flushed, the size of the
20203 memory range, and the number 3 (to flush both caches).  The default
20204 depends on the target GCC was configured for, but commonly is either
20205 @code{_flush_func} or @code{__cpu_flush}.
20207 @item mbranch-cost=@var{num}
20208 @opindex mbranch-cost
20209 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20210 This cost is only a heuristic and is not guaranteed to produce
20211 consistent results across releases.  A zero cost redundantly selects
20212 the default, which is based on the @option{-mtune} setting.
20214 @item -mbranch-likely
20215 @itemx -mno-branch-likely
20216 @opindex mbranch-likely
20217 @opindex mno-branch-likely
20218 Enable or disable use of Branch Likely instructions, regardless of the
20219 default for the selected architecture.  By default, Branch Likely
20220 instructions may be generated if they are supported by the selected
20221 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20222 and processors that implement those architectures; for those, Branch
20223 Likely instructions are not be generated by default because the MIPS32
20224 and MIPS64 architectures specifically deprecate their use.
20226 @item -mcompact-branches=never
20227 @itemx -mcompact-branches=optimal
20228 @itemx -mcompact-branches=always
20229 @opindex mcompact-branches=never
20230 @opindex mcompact-branches=optimal
20231 @opindex mcompact-branches=always
20232 These options control which form of branches will be generated.  The
20233 default is @option{-mcompact-branches=optimal}.
20235 The @option{-mcompact-branches=never} option ensures that compact branch
20236 instructions will never be generated.
20238 The @option{-mcompact-branches=always} option ensures that a compact
20239 branch instruction will be generated if available.  If a compact branch
20240 instruction is not available, a delay slot form of the branch will be
20241 used instead.
20243 This option is supported from MIPS Release 6 onwards.
20245 The @option{-mcompact-branches=optimal} option will cause a delay slot
20246 branch to be used if one is available in the current ISA and the delay
20247 slot is successfully filled.  If the delay slot is not filled, a compact
20248 branch will be chosen if one is available.
20250 @item -mfp-exceptions
20251 @itemx -mno-fp-exceptions
20252 @opindex mfp-exceptions
20253 Specifies whether FP exceptions are enabled.  This affects how
20254 FP instructions are scheduled for some processors.
20255 The default is that FP exceptions are
20256 enabled.
20258 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20259 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20260 FP pipe.
20262 @item -mvr4130-align
20263 @itemx -mno-vr4130-align
20264 @opindex mvr4130-align
20265 The VR4130 pipeline is two-way superscalar, but can only issue two
20266 instructions together if the first one is 8-byte aligned.  When this
20267 option is enabled, GCC aligns pairs of instructions that it
20268 thinks should execute in parallel.
20270 This option only has an effect when optimizing for the VR4130.
20271 It normally makes code faster, but at the expense of making it bigger.
20272 It is enabled by default at optimization level @option{-O3}.
20274 @item -msynci
20275 @itemx -mno-synci
20276 @opindex msynci
20277 Enable (disable) generation of @code{synci} instructions on
20278 architectures that support it.  The @code{synci} instructions (if
20279 enabled) are generated when @code{__builtin___clear_cache} is
20280 compiled.
20282 This option defaults to @option{-mno-synci}, but the default can be
20283 overridden by configuring GCC with @option{--with-synci}.
20285 When compiling code for single processor systems, it is generally safe
20286 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20287 does not invalidate the instruction caches on all cores and may lead
20288 to undefined behavior.
20290 @item -mrelax-pic-calls
20291 @itemx -mno-relax-pic-calls
20292 @opindex mrelax-pic-calls
20293 Try to turn PIC calls that are normally dispatched via register
20294 @code{$25} into direct calls.  This is only possible if the linker can
20295 resolve the destination at link time and if the destination is within
20296 range for a direct call.
20298 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20299 an assembler and a linker that support the @code{.reloc} assembly
20300 directive and @option{-mexplicit-relocs} is in effect.  With
20301 @option{-mno-explicit-relocs}, this optimization can be performed by the
20302 assembler and the linker alone without help from the compiler.
20304 @item -mmcount-ra-address
20305 @itemx -mno-mcount-ra-address
20306 @opindex mmcount-ra-address
20307 @opindex mno-mcount-ra-address
20308 Emit (do not emit) code that allows @code{_mcount} to modify the
20309 calling function's return address.  When enabled, this option extends
20310 the usual @code{_mcount} interface with a new @var{ra-address}
20311 parameter, which has type @code{intptr_t *} and is passed in register
20312 @code{$12}.  @code{_mcount} can then modify the return address by
20313 doing both of the following:
20314 @itemize
20315 @item
20316 Returning the new address in register @code{$31}.
20317 @item
20318 Storing the new address in @code{*@var{ra-address}},
20319 if @var{ra-address} is nonnull.
20320 @end itemize
20322 The default is @option{-mno-mcount-ra-address}.
20324 @item -mframe-header-opt
20325 @itemx -mno-frame-header-opt
20326 @opindex mframe-header-opt
20327 Enable (disable) frame header optimization in the o32 ABI.  When using the
20328 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20329 function to write out register arguments.  When enabled, this optimization
20330 will suppress the allocation of the frame header if it can be determined that
20331 it is unused.
20333 This optimization is off by default at all optimization levels.
20335 @item -mlxc1-sxc1
20336 @itemx -mno-lxc1-sxc1
20337 @opindex mlxc1-sxc1
20338 When applicable, enable (disable) the generation of @code{lwxc1},
20339 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20341 @item -mmadd4
20342 @itemx -mno-madd4
20343 @opindex mmadd4
20344 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20345 @code{madd.d} and related instructions.  Enabled by default.
20347 @end table
20349 @node MMIX Options
20350 @subsection MMIX Options
20351 @cindex MMIX Options
20353 These options are defined for the MMIX:
20355 @table @gcctabopt
20356 @item -mlibfuncs
20357 @itemx -mno-libfuncs
20358 @opindex mlibfuncs
20359 @opindex mno-libfuncs
20360 Specify that intrinsic library functions are being compiled, passing all
20361 values in registers, no matter the size.
20363 @item -mepsilon
20364 @itemx -mno-epsilon
20365 @opindex mepsilon
20366 @opindex mno-epsilon
20367 Generate floating-point comparison instructions that compare with respect
20368 to the @code{rE} epsilon register.
20370 @item -mabi=mmixware
20371 @itemx -mabi=gnu
20372 @opindex mabi=mmixware
20373 @opindex mabi=gnu
20374 Generate code that passes function parameters and return values that (in
20375 the called function) are seen as registers @code{$0} and up, as opposed to
20376 the GNU ABI which uses global registers @code{$231} and up.
20378 @item -mzero-extend
20379 @itemx -mno-zero-extend
20380 @opindex mzero-extend
20381 @opindex mno-zero-extend
20382 When reading data from memory in sizes shorter than 64 bits, use (do not
20383 use) zero-extending load instructions by default, rather than
20384 sign-extending ones.
20386 @item -mknuthdiv
20387 @itemx -mno-knuthdiv
20388 @opindex mknuthdiv
20389 @opindex mno-knuthdiv
20390 Make the result of a division yielding a remainder have the same sign as
20391 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20392 remainder follows the sign of the dividend.  Both methods are
20393 arithmetically valid, the latter being almost exclusively used.
20395 @item -mtoplevel-symbols
20396 @itemx -mno-toplevel-symbols
20397 @opindex mtoplevel-symbols
20398 @opindex mno-toplevel-symbols
20399 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20400 code can be used with the @code{PREFIX} assembly directive.
20402 @item -melf
20403 @opindex melf
20404 Generate an executable in the ELF format, rather than the default
20405 @samp{mmo} format used by the @command{mmix} simulator.
20407 @item -mbranch-predict
20408 @itemx -mno-branch-predict
20409 @opindex mbranch-predict
20410 @opindex mno-branch-predict
20411 Use (do not use) the probable-branch instructions, when static branch
20412 prediction indicates a probable branch.
20414 @item -mbase-addresses
20415 @itemx -mno-base-addresses
20416 @opindex mbase-addresses
20417 @opindex mno-base-addresses
20418 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20419 base address automatically generates a request (handled by the assembler
20420 and the linker) for a constant to be set up in a global register.  The
20421 register is used for one or more base address requests within the range 0
20422 to 255 from the value held in the register.  The generally leads to short
20423 and fast code, but the number of different data items that can be
20424 addressed is limited.  This means that a program that uses lots of static
20425 data may require @option{-mno-base-addresses}.
20427 @item -msingle-exit
20428 @itemx -mno-single-exit
20429 @opindex msingle-exit
20430 @opindex mno-single-exit
20431 Force (do not force) generated code to have a single exit point in each
20432 function.
20433 @end table
20435 @node MN10300 Options
20436 @subsection MN10300 Options
20437 @cindex MN10300 options
20439 These @option{-m} options are defined for Matsushita MN10300 architectures:
20441 @table @gcctabopt
20442 @item -mmult-bug
20443 @opindex mmult-bug
20444 Generate code to avoid bugs in the multiply instructions for the MN10300
20445 processors.  This is the default.
20447 @item -mno-mult-bug
20448 @opindex mno-mult-bug
20449 Do not generate code to avoid bugs in the multiply instructions for the
20450 MN10300 processors.
20452 @item -mam33
20453 @opindex mam33
20454 Generate code using features specific to the AM33 processor.
20456 @item -mno-am33
20457 @opindex mno-am33
20458 Do not generate code using features specific to the AM33 processor.  This
20459 is the default.
20461 @item -mam33-2
20462 @opindex mam33-2
20463 Generate code using features specific to the AM33/2.0 processor.
20465 @item -mam34
20466 @opindex mam34
20467 Generate code using features specific to the AM34 processor.
20469 @item -mtune=@var{cpu-type}
20470 @opindex mtune
20471 Use the timing characteristics of the indicated CPU type when
20472 scheduling instructions.  This does not change the targeted processor
20473 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20474 @samp{am33-2} or @samp{am34}.
20476 @item -mreturn-pointer-on-d0
20477 @opindex mreturn-pointer-on-d0
20478 When generating a function that returns a pointer, return the pointer
20479 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20480 only in @code{a0}, and attempts to call such functions without a prototype
20481 result in errors.  Note that this option is on by default; use
20482 @option{-mno-return-pointer-on-d0} to disable it.
20484 @item -mno-crt0
20485 @opindex mno-crt0
20486 Do not link in the C run-time initialization object file.
20488 @item -mrelax
20489 @opindex mrelax
20490 Indicate to the linker that it should perform a relaxation optimization pass
20491 to shorten branches, calls and absolute memory addresses.  This option only
20492 has an effect when used on the command line for the final link step.
20494 This option makes symbolic debugging impossible.
20496 @item -mliw
20497 @opindex mliw
20498 Allow the compiler to generate @emph{Long Instruction Word}
20499 instructions if the target is the @samp{AM33} or later.  This is the
20500 default.  This option defines the preprocessor macro @code{__LIW__}.
20502 @item -mnoliw
20503 @opindex mnoliw
20504 Do not allow the compiler to generate @emph{Long Instruction Word}
20505 instructions.  This option defines the preprocessor macro
20506 @code{__NO_LIW__}.
20508 @item -msetlb
20509 @opindex msetlb
20510 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20511 instructions if the target is the @samp{AM33} or later.  This is the
20512 default.  This option defines the preprocessor macro @code{__SETLB__}.
20514 @item -mnosetlb
20515 @opindex mnosetlb
20516 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20517 instructions.  This option defines the preprocessor macro
20518 @code{__NO_SETLB__}.
20520 @end table
20522 @node Moxie Options
20523 @subsection Moxie Options
20524 @cindex Moxie Options
20526 @table @gcctabopt
20528 @item -meb
20529 @opindex meb
20530 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20531 configurations.
20533 @item -mel
20534 @opindex mel
20535 Generate little-endian code.
20537 @item -mmul.x
20538 @opindex mmul.x
20539 Generate mul.x and umul.x instructions.  This is the default for
20540 @samp{moxiebox-*-*} configurations.
20542 @item -mno-crt0
20543 @opindex mno-crt0
20544 Do not link in the C run-time initialization object file.
20546 @end table
20548 @node MSP430 Options
20549 @subsection MSP430 Options
20550 @cindex MSP430 Options
20552 These options are defined for the MSP430:
20554 @table @gcctabopt
20556 @item -masm-hex
20557 @opindex masm-hex
20558 Force assembly output to always use hex constants.  Normally such
20559 constants are signed decimals, but this option is available for
20560 testsuite and/or aesthetic purposes.
20562 @item -mmcu=
20563 @opindex mmcu=
20564 Select the MCU to target.  This is used to create a C preprocessor
20565 symbol based upon the MCU name, converted to upper case and pre- and
20566 post-fixed with @samp{__}.  This in turn is used by the
20567 @file{msp430.h} header file to select an MCU-specific supplementary
20568 header file.
20570 The option also sets the ISA to use.  If the MCU name is one that is
20571 known to only support the 430 ISA then that is selected, otherwise the
20572 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20573 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20574 name selects the 430X ISA.
20576 In addition an MCU-specific linker script is added to the linker
20577 command line.  The script's name is the name of the MCU with
20578 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20579 command line defines the C preprocessor symbol @code{__XXX__} and
20580 cause the linker to search for a script called @file{xxx.ld}.
20582 This option is also passed on to the assembler.
20584 @item -mwarn-mcu
20585 @itemx -mno-warn-mcu
20586 @opindex mwarn-mcu
20587 @opindex mno-warn-mcu
20588 This option enables or disables warnings about conflicts between the
20589 MCU name specified by the @option{-mmcu} option and the ISA set by the
20590 @option{-mcpu} option and/or the hardware multiply support set by the
20591 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20592 MCU names.  This option is on by default.
20594 @item -mcpu=
20595 @opindex mcpu=
20596 Specifies the ISA to use.  Accepted values are @samp{msp430},
20597 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20598 @option{-mmcu=} option should be used to select the ISA.
20600 @item -msim
20601 @opindex msim
20602 Link to the simulator runtime libraries and linker script.  Overrides
20603 any scripts that would be selected by the @option{-mmcu=} option.
20605 @item -mlarge
20606 @opindex mlarge
20607 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20609 @item -msmall
20610 @opindex msmall
20611 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20613 @item -mrelax
20614 @opindex mrelax
20615 This option is passed to the assembler and linker, and allows the
20616 linker to perform certain optimizations that cannot be done until
20617 the final link.
20619 @item mhwmult=
20620 @opindex mhwmult=
20621 Describes the type of hardware multiply supported by the target.
20622 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20623 for the original 16-bit-only multiply supported by early MCUs.
20624 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20625 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20626 A value of @samp{auto} can also be given.  This tells GCC to deduce
20627 the hardware multiply support based upon the MCU name provided by the
20628 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20629 the MCU name is not recognized then no hardware multiply support is
20630 assumed.  @code{auto} is the default setting.
20632 Hardware multiplies are normally performed by calling a library
20633 routine.  This saves space in the generated code.  When compiling at
20634 @option{-O3} or higher however the hardware multiplier is invoked
20635 inline.  This makes for bigger, but faster code.
20637 The hardware multiply routines disable interrupts whilst running and
20638 restore the previous interrupt state when they finish.  This makes
20639 them safe to use inside interrupt handlers as well as in normal code.
20641 @item -minrt
20642 @opindex minrt
20643 Enable the use of a minimum runtime environment - no static
20644 initializers or constructors.  This is intended for memory-constrained
20645 devices.  The compiler includes special symbols in some objects
20646 that tell the linker and runtime which code fragments are required.
20648 @item -mcode-region=
20649 @itemx -mdata-region=
20650 @opindex mcode-region
20651 @opindex mdata-region
20652 These options tell the compiler where to place functions and data that
20653 do not have one of the @code{lower}, @code{upper}, @code{either} or
20654 @code{section} attributes.  Possible values are @code{lower},
20655 @code{upper}, @code{either} or @code{any}.  The first three behave
20656 like the corresponding attribute.  The fourth possible value -
20657 @code{any} - is the default.  It leaves placement entirely up to the
20658 linker script and how it assigns the standard sections
20659 (@code{.text}, @code{.data}, etc) to the memory regions.
20661 @item -msilicon-errata=
20662 @opindex msilicon-errata
20663 This option passes on a request to assembler to enable the fixes for
20664 the named silicon errata.
20666 @item -msilicon-errata-warn=
20667 @opindex msilicon-errata-warn
20668 This option passes on a request to the assembler to enable warning
20669 messages when a silicon errata might need to be applied.
20671 @end table
20673 @node NDS32 Options
20674 @subsection NDS32 Options
20675 @cindex NDS32 Options
20677 These options are defined for NDS32 implementations:
20679 @table @gcctabopt
20681 @item -mbig-endian
20682 @opindex mbig-endian
20683 Generate code in big-endian mode.
20685 @item -mlittle-endian
20686 @opindex mlittle-endian
20687 Generate code in little-endian mode.
20689 @item -mreduced-regs
20690 @opindex mreduced-regs
20691 Use reduced-set registers for register allocation.
20693 @item -mfull-regs
20694 @opindex mfull-regs
20695 Use full-set registers for register allocation.
20697 @item -mcmov
20698 @opindex mcmov
20699 Generate conditional move instructions.
20701 @item -mno-cmov
20702 @opindex mno-cmov
20703 Do not generate conditional move instructions.
20705 @item -mperf-ext
20706 @opindex mperf-ext
20707 Generate performance extension instructions.
20709 @item -mno-perf-ext
20710 @opindex mno-perf-ext
20711 Do not generate performance extension instructions.
20713 @item -mv3push
20714 @opindex mv3push
20715 Generate v3 push25/pop25 instructions.
20717 @item -mno-v3push
20718 @opindex mno-v3push
20719 Do not generate v3 push25/pop25 instructions.
20721 @item -m16-bit
20722 @opindex m16-bit
20723 Generate 16-bit instructions.
20725 @item -mno-16-bit
20726 @opindex mno-16-bit
20727 Do not generate 16-bit instructions.
20729 @item -misr-vector-size=@var{num}
20730 @opindex misr-vector-size
20731 Specify the size of each interrupt vector, which must be 4 or 16.
20733 @item -mcache-block-size=@var{num}
20734 @opindex mcache-block-size
20735 Specify the size of each cache block,
20736 which must be a power of 2 between 4 and 512.
20738 @item -march=@var{arch}
20739 @opindex march
20740 Specify the name of the target architecture.
20742 @item -mcmodel=@var{code-model}
20743 @opindex mcmodel
20744 Set the code model to one of
20745 @table @asis
20746 @item @samp{small}
20747 All the data and read-only data segments must be within 512KB addressing space.
20748 The text segment must be within 16MB addressing space.
20749 @item @samp{medium}
20750 The data segment must be within 512KB while the read-only data segment can be
20751 within 4GB addressing space.  The text segment should be still within 16MB
20752 addressing space.
20753 @item @samp{large}
20754 All the text and data segments can be within 4GB addressing space.
20755 @end table
20757 @item -mctor-dtor
20758 @opindex mctor-dtor
20759 Enable constructor/destructor feature.
20761 @item -mrelax
20762 @opindex mrelax
20763 Guide linker to relax instructions.
20765 @end table
20767 @node Nios II Options
20768 @subsection Nios II Options
20769 @cindex Nios II options
20770 @cindex Altera Nios II options
20772 These are the options defined for the Altera Nios II processor.
20774 @table @gcctabopt
20776 @item -G @var{num}
20777 @opindex G
20778 @cindex smaller data references
20779 Put global and static objects less than or equal to @var{num} bytes
20780 into the small data or BSS sections instead of the normal data or BSS
20781 sections.  The default value of @var{num} is 8.
20783 @item -mgpopt=@var{option}
20784 @item -mgpopt
20785 @itemx -mno-gpopt
20786 @opindex mgpopt
20787 @opindex mno-gpopt
20788 Generate (do not generate) GP-relative accesses.  The following 
20789 @var{option} names are recognized:
20791 @table @samp
20793 @item none
20794 Do not generate GP-relative accesses.
20796 @item local
20797 Generate GP-relative accesses for small data objects that are not 
20798 external, weak, or uninitialized common symbols.  
20799 Also use GP-relative addressing for objects that
20800 have been explicitly placed in a small data section via a @code{section}
20801 attribute.
20803 @item global
20804 As for @samp{local}, but also generate GP-relative accesses for
20805 small data objects that are external, weak, or common.  If you use this option,
20806 you must ensure that all parts of your program (including libraries) are
20807 compiled with the same @option{-G} setting.
20809 @item data
20810 Generate GP-relative accesses for all data objects in the program.  If you
20811 use this option, the entire data and BSS segments
20812 of your program must fit in 64K of memory and you must use an appropriate
20813 linker script to allocate them within the addressable range of the
20814 global pointer.
20816 @item all
20817 Generate GP-relative addresses for function pointers as well as data
20818 pointers.  If you use this option, the entire text, data, and BSS segments
20819 of your program must fit in 64K of memory and you must use an appropriate
20820 linker script to allocate them within the addressable range of the
20821 global pointer.
20823 @end table
20825 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
20826 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
20828 The default is @option{-mgpopt} except when @option{-fpic} or
20829 @option{-fPIC} is specified to generate position-independent code.
20830 Note that the Nios II ABI does not permit GP-relative accesses from
20831 shared libraries.
20833 You may need to specify @option{-mno-gpopt} explicitly when building
20834 programs that include large amounts of small data, including large
20835 GOT data sections.  In this case, the 16-bit offset for GP-relative
20836 addressing may not be large enough to allow access to the entire 
20837 small data section.
20839 @item -mel
20840 @itemx -meb
20841 @opindex mel
20842 @opindex meb
20843 Generate little-endian (default) or big-endian (experimental) code,
20844 respectively.
20846 @item -march=@var{arch}
20847 @opindex march
20848 This specifies the name of the target Nios II architecture.  GCC uses this
20849 name to determine what kind of instructions it can emit when generating
20850 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
20852 The preprocessor macro @code{__nios2_arch__} is available to programs,
20853 with value 1 or 2, indicating the targeted ISA level.
20855 @item -mbypass-cache
20856 @itemx -mno-bypass-cache
20857 @opindex mno-bypass-cache
20858 @opindex mbypass-cache
20859 Force all load and store instructions to always bypass cache by 
20860 using I/O variants of the instructions. The default is not to
20861 bypass the cache.
20863 @item -mno-cache-volatile 
20864 @itemx -mcache-volatile       
20865 @opindex mcache-volatile 
20866 @opindex mno-cache-volatile
20867 Volatile memory access bypass the cache using the I/O variants of 
20868 the load and store instructions. The default is not to bypass the cache.
20870 @item -mno-fast-sw-div
20871 @itemx -mfast-sw-div
20872 @opindex mno-fast-sw-div
20873 @opindex mfast-sw-div
20874 Do not use table-based fast divide for small numbers. The default 
20875 is to use the fast divide at @option{-O3} and above.
20877 @item -mno-hw-mul
20878 @itemx -mhw-mul
20879 @itemx -mno-hw-mulx
20880 @itemx -mhw-mulx
20881 @itemx -mno-hw-div
20882 @itemx -mhw-div
20883 @opindex mno-hw-mul
20884 @opindex mhw-mul
20885 @opindex mno-hw-mulx
20886 @opindex mhw-mulx
20887 @opindex mno-hw-div
20888 @opindex mhw-div
20889 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
20890 instructions by the compiler. The default is to emit @code{mul}
20891 and not emit @code{div} and @code{mulx}.
20893 @item -mbmx
20894 @itemx -mno-bmx
20895 @itemx -mcdx
20896 @itemx -mno-cdx
20897 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
20898 CDX (code density) instructions.  Enabling these instructions also
20899 requires @option{-march=r2}.  Since these instructions are optional
20900 extensions to the R2 architecture, the default is not to emit them.
20902 @item -mcustom-@var{insn}=@var{N}
20903 @itemx -mno-custom-@var{insn}
20904 @opindex mcustom-@var{insn}
20905 @opindex mno-custom-@var{insn}
20906 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
20907 custom instruction with encoding @var{N} when generating code that uses 
20908 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
20909 instruction 253 for single-precision floating-point add operations instead
20910 of the default behavior of using a library call.
20912 The following values of @var{insn} are supported.  Except as otherwise
20913 noted, floating-point operations are expected to be implemented with
20914 normal IEEE 754 semantics and correspond directly to the C operators or the
20915 equivalent GCC built-in functions (@pxref{Other Builtins}).
20917 Single-precision floating point:
20918 @table @asis
20920 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
20921 Binary arithmetic operations.
20923 @item @samp{fnegs}
20924 Unary negation.
20926 @item @samp{fabss}
20927 Unary absolute value.
20929 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
20930 Comparison operations.
20932 @item @samp{fmins}, @samp{fmaxs}
20933 Floating-point minimum and maximum.  These instructions are only
20934 generated if @option{-ffinite-math-only} is specified.
20936 @item @samp{fsqrts}
20937 Unary square root operation.
20939 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
20940 Floating-point trigonometric and exponential functions.  These instructions
20941 are only generated if @option{-funsafe-math-optimizations} is also specified.
20943 @end table
20945 Double-precision floating point:
20946 @table @asis
20948 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
20949 Binary arithmetic operations.
20951 @item @samp{fnegd}
20952 Unary negation.
20954 @item @samp{fabsd}
20955 Unary absolute value.
20957 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
20958 Comparison operations.
20960 @item @samp{fmind}, @samp{fmaxd}
20961 Double-precision minimum and maximum.  These instructions are only
20962 generated if @option{-ffinite-math-only} is specified.
20964 @item @samp{fsqrtd}
20965 Unary square root operation.
20967 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
20968 Double-precision trigonometric and exponential functions.  These instructions
20969 are only generated if @option{-funsafe-math-optimizations} is also specified.
20971 @end table
20973 Conversions:
20974 @table @asis
20975 @item @samp{fextsd}
20976 Conversion from single precision to double precision.
20978 @item @samp{ftruncds}
20979 Conversion from double precision to single precision.
20981 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
20982 Conversion from floating point to signed or unsigned integer types, with
20983 truncation towards zero.
20985 @item @samp{round}
20986 Conversion from single-precision floating point to signed integer,
20987 rounding to the nearest integer and ties away from zero.
20988 This corresponds to the @code{__builtin_lroundf} function when
20989 @option{-fno-math-errno} is used.
20991 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
20992 Conversion from signed or unsigned integer types to floating-point types.
20994 @end table
20996 In addition, all of the following transfer instructions for internal
20997 registers X and Y must be provided to use any of the double-precision
20998 floating-point instructions.  Custom instructions taking two
20999 double-precision source operands expect the first operand in the
21000 64-bit register X.  The other operand (or only operand of a unary
21001 operation) is given to the custom arithmetic instruction with the
21002 least significant half in source register @var{src1} and the most
21003 significant half in @var{src2}.  A custom instruction that returns a
21004 double-precision result returns the most significant 32 bits in the
21005 destination register and the other half in 32-bit register Y.  
21006 GCC automatically generates the necessary code sequences to write
21007 register X and/or read register Y when double-precision floating-point
21008 instructions are used.
21010 @table @asis
21012 @item @samp{fwrx}
21013 Write @var{src1} into the least significant half of X and @var{src2} into
21014 the most significant half of X.
21016 @item @samp{fwry}
21017 Write @var{src1} into Y.
21019 @item @samp{frdxhi}, @samp{frdxlo}
21020 Read the most or least (respectively) significant half of X and store it in
21021 @var{dest}.
21023 @item @samp{frdy}
21024 Read the value of Y and store it into @var{dest}.
21025 @end table
21027 Note that you can gain more local control over generation of Nios II custom
21028 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21029 and @code{target("no-custom-@var{insn}")} function attributes
21030 (@pxref{Function Attributes})
21031 or pragmas (@pxref{Function Specific Option Pragmas}).
21033 @item -mcustom-fpu-cfg=@var{name}
21034 @opindex mcustom-fpu-cfg
21036 This option enables a predefined, named set of custom instruction encodings
21037 (see @option{-mcustom-@var{insn}} above).  
21038 Currently, the following sets are defined:
21040 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21041 @gccoptlist{-mcustom-fmuls=252 @gol
21042 -mcustom-fadds=253 @gol
21043 -mcustom-fsubs=254 @gol
21044 -fsingle-precision-constant}
21046 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21047 @gccoptlist{-mcustom-fmuls=252 @gol
21048 -mcustom-fadds=253 @gol
21049 -mcustom-fsubs=254 @gol
21050 -mcustom-fdivs=255 @gol
21051 -fsingle-precision-constant}
21053 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21054 @gccoptlist{-mcustom-floatus=243 @gol
21055 -mcustom-fixsi=244 @gol
21056 -mcustom-floatis=245 @gol
21057 -mcustom-fcmpgts=246 @gol
21058 -mcustom-fcmples=249 @gol
21059 -mcustom-fcmpeqs=250 @gol
21060 -mcustom-fcmpnes=251 @gol
21061 -mcustom-fmuls=252 @gol
21062 -mcustom-fadds=253 @gol
21063 -mcustom-fsubs=254 @gol
21064 -mcustom-fdivs=255 @gol
21065 -fsingle-precision-constant}
21067 Custom instruction assignments given by individual
21068 @option{-mcustom-@var{insn}=} options override those given by
21069 @option{-mcustom-fpu-cfg=}, regardless of the
21070 order of the options on the command line.
21072 Note that you can gain more local control over selection of a FPU
21073 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21074 function attribute (@pxref{Function Attributes})
21075 or pragma (@pxref{Function Specific Option Pragmas}).
21077 @end table
21079 These additional @samp{-m} options are available for the Altera Nios II
21080 ELF (bare-metal) target:
21082 @table @gcctabopt
21084 @item -mhal
21085 @opindex mhal
21086 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21087 startup and termination code, and is typically used in conjunction with
21088 @option{-msys-crt0=} to specify the location of the alternate startup code
21089 provided by the HAL BSP.
21091 @item -msmallc
21092 @opindex msmallc
21093 Link with a limited version of the C library, @option{-lsmallc}, rather than
21094 Newlib.
21096 @item -msys-crt0=@var{startfile}
21097 @opindex msys-crt0
21098 @var{startfile} is the file name of the startfile (crt0) to use 
21099 when linking.  This option is only useful in conjunction with @option{-mhal}.
21101 @item -msys-lib=@var{systemlib}
21102 @opindex msys-lib
21103 @var{systemlib} is the library name of the library that provides
21104 low-level system calls required by the C library,
21105 e.g. @code{read} and @code{write}.
21106 This option is typically used to link with a library provided by a HAL BSP.
21108 @end table
21110 @node Nvidia PTX Options
21111 @subsection Nvidia PTX Options
21112 @cindex Nvidia PTX options
21113 @cindex nvptx options
21115 These options are defined for Nvidia PTX:
21117 @table @gcctabopt
21119 @item -m32
21120 @itemx -m64
21121 @opindex m32
21122 @opindex m64
21123 Generate code for 32-bit or 64-bit ABI.
21125 @item -mmainkernel
21126 @opindex mmainkernel
21127 Link in code for a __main kernel.  This is for stand-alone instead of
21128 offloading execution.
21130 @item -moptimize
21131 @opindex moptimize
21132 Apply partitioned execution optimizations.  This is the default when any
21133 level of optimization is selected.
21135 @item -msoft-stack
21136 @opindex msoft-stack
21137 Generate code that does not use @code{.local} memory
21138 directly for stack storage. Instead, a per-warp stack pointer is
21139 maintained explicitly. This enables variable-length stack allocation (with
21140 variable-length arrays or @code{alloca}), and when global memory is used for
21141 underlying storage, makes it possible to access automatic variables from other
21142 threads, or with atomic instructions. This code generation variant is used
21143 for OpenMP offloading, but the option is exposed on its own for the purpose
21144 of testing the compiler; to generate code suitable for linking into programs
21145 using OpenMP offloading, use option @option{-mgomp}.
21147 @item -muniform-simt
21148 @opindex muniform-simt
21149 Switch to code generation variant that allows to execute all threads in each
21150 warp, while maintaining memory state and side effects as if only one thread
21151 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21152 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21153 current lane index equals the master lane index), and the register being
21154 assigned is copied via a shuffle instruction from the master lane.  Outside of
21155 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21156 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21157 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21158 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21159 with current lane index to compute the master lane index.
21161 @item -mgomp
21162 @opindex mgomp
21163 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21164 @option{-muniform-simt} options, and selects corresponding multilib variant.
21166 @end table
21168 @node PDP-11 Options
21169 @subsection PDP-11 Options
21170 @cindex PDP-11 Options
21172 These options are defined for the PDP-11:
21174 @table @gcctabopt
21175 @item -mfpu
21176 @opindex mfpu
21177 Use hardware FPP floating point.  This is the default.  (FIS floating
21178 point on the PDP-11/40 is not supported.)
21180 @item -msoft-float
21181 @opindex msoft-float
21182 Do not use hardware floating point.
21184 @item -mac0
21185 @opindex mac0
21186 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21188 @item -mno-ac0
21189 @opindex mno-ac0
21190 Return floating-point results in memory.  This is the default.
21192 @item -m40
21193 @opindex m40
21194 Generate code for a PDP-11/40.
21196 @item -m45
21197 @opindex m45
21198 Generate code for a PDP-11/45.  This is the default.
21200 @item -m10
21201 @opindex m10
21202 Generate code for a PDP-11/10.
21204 @item -mbcopy-builtin
21205 @opindex mbcopy-builtin
21206 Use inline @code{movmemhi} patterns for copying memory.  This is the
21207 default.
21209 @item -mbcopy
21210 @opindex mbcopy
21211 Do not use inline @code{movmemhi} patterns for copying memory.
21213 @item -mint16
21214 @itemx -mno-int32
21215 @opindex mint16
21216 @opindex mno-int32
21217 Use 16-bit @code{int}.  This is the default.
21219 @item -mint32
21220 @itemx -mno-int16
21221 @opindex mint32
21222 @opindex mno-int16
21223 Use 32-bit @code{int}.
21225 @item -mfloat64
21226 @itemx -mno-float32
21227 @opindex mfloat64
21228 @opindex mno-float32
21229 Use 64-bit @code{float}.  This is the default.
21231 @item -mfloat32
21232 @itemx -mno-float64
21233 @opindex mfloat32
21234 @opindex mno-float64
21235 Use 32-bit @code{float}.
21237 @item -mabshi
21238 @opindex mabshi
21239 Use @code{abshi2} pattern.  This is the default.
21241 @item -mno-abshi
21242 @opindex mno-abshi
21243 Do not use @code{abshi2} pattern.
21245 @item -mbranch-expensive
21246 @opindex mbranch-expensive
21247 Pretend that branches are expensive.  This is for experimenting with
21248 code generation only.
21250 @item -mbranch-cheap
21251 @opindex mbranch-cheap
21252 Do not pretend that branches are expensive.  This is the default.
21254 @item -munix-asm
21255 @opindex munix-asm
21256 Use Unix assembler syntax.  This is the default when configured for
21257 @samp{pdp11-*-bsd}.
21259 @item -mdec-asm
21260 @opindex mdec-asm
21261 Use DEC assembler syntax.  This is the default when configured for any
21262 PDP-11 target other than @samp{pdp11-*-bsd}.
21263 @end table
21265 @node picoChip Options
21266 @subsection picoChip Options
21267 @cindex picoChip options
21269 These @samp{-m} options are defined for picoChip implementations:
21271 @table @gcctabopt
21273 @item -mae=@var{ae_type}
21274 @opindex mcpu
21275 Set the instruction set, register set, and instruction scheduling
21276 parameters for array element type @var{ae_type}.  Supported values
21277 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21279 @option{-mae=ANY} selects a completely generic AE type.  Code
21280 generated with this option runs on any of the other AE types.  The
21281 code is not as efficient as it would be if compiled for a specific
21282 AE type, and some types of operation (e.g., multiplication) do not
21283 work properly on all types of AE.
21285 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21286 for compiled code, and is the default.
21288 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21289 option may suffer from poor performance of byte (char) manipulation,
21290 since the DSP AE does not provide hardware support for byte load/stores.
21292 @item -msymbol-as-address
21293 Enable the compiler to directly use a symbol name as an address in a
21294 load/store instruction, without first loading it into a
21295 register.  Typically, the use of this option generates larger
21296 programs, which run faster than when the option isn't used.  However, the
21297 results vary from program to program, so it is left as a user option,
21298 rather than being permanently enabled.
21300 @item -mno-inefficient-warnings
21301 Disables warnings about the generation of inefficient code.  These
21302 warnings can be generated, for example, when compiling code that
21303 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21304 no hardware support for byte-level memory operations, so all byte
21305 load/stores must be synthesized from word load/store operations.  This is
21306 inefficient and a warning is generated to indicate
21307 that you should rewrite the code to avoid byte operations, or to target
21308 an AE type that has the necessary hardware support.  This option disables
21309 these warnings.
21311 @end table
21313 @node PowerPC Options
21314 @subsection PowerPC Options
21315 @cindex PowerPC options
21317 These are listed under @xref{RS/6000 and PowerPC Options}.
21319 @node RISC-V Options
21320 @subsection RISC-V Options
21321 @cindex RISC-V Options
21323 These command-line options are defined for RISC-V targets:
21325 @table @gcctabopt
21326 @item -mbranch-cost=@var{n}
21327 @opindex mbranch-cost
21328 Set the cost of branches to roughly @var{n} instructions.
21330 @item -mmemcpy
21331 @itemx -mno-memcpy
21332 @opindex mmemcpy
21333 Don't optimize block moves.
21335 @item -mplt
21336 @itemx -mno-plt
21337 @opindex plt
21338 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21340 @item -mabi=@var{ABI-string}
21341 @opindex mabi
21342 Specify integer and floating-point calling convention.  This defaults to the
21343 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21344 RV64G.
21346 @item -mfdiv
21347 @itemx -mno-fdiv
21348 @opindex mfdiv
21349 Use hardware floating-point divide and square root instructions.  This requires
21350 the F or D extensions for floating-point registers.
21352 @item -mdiv
21353 @itemx -mno-div
21354 @opindex mdiv
21355 Use hardware instructions for integer division.  This requires the M extension.
21357 @item -march=@var{ISA-string}
21358 @opindex march
21359 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21360 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21362 @item -mtune=@var{processor-string}
21363 @opindex mtune
21364 Optimize the output for the given processor, specified by microarchitecture
21365 name.
21367 @item -msmall-data-limit=@var{n}
21368 @opindex msmall-data-limit
21369 Put global and static data smaller than @var{n} bytes into a special section
21370 (on some targets).
21372 @item -msave-restore
21373 @itemx -mno-save-restore
21374 @opindex msave-restore
21375 Use smaller but slower prologue and epilogue code.
21377 @item -mstrict-align
21378 @itemx -mno-strict-align
21379 @opindex mstrict-align
21380 Do not generate unaligned memory accesses.
21382 @item -mcmodel=@var{code-model}
21383 @opindex mcmodel
21384 Specify the code model.
21386 @end table
21388 @node RL78 Options
21389 @subsection RL78 Options
21390 @cindex RL78 Options
21392 @table @gcctabopt
21394 @item -msim
21395 @opindex msim
21396 Links in additional target libraries to support operation within a
21397 simulator.
21399 @item -mmul=none
21400 @itemx -mmul=g10
21401 @itemx -mmul=g13
21402 @itemx -mmul=g14
21403 @itemx -mmul=rl78
21404 @opindex mmul
21405 Specifies the type of hardware multiplication and division support to
21406 be used.  The simplest is @code{none}, which uses software for both
21407 multiplication and division.  This is the default.  The @code{g13}
21408 value is for the hardware multiply/divide peripheral found on the
21409 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21410 the multiplication and division instructions supported by the RL78/G14
21411 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21412 the value @code{mg10} is an alias for @code{none}.
21414 In addition a C preprocessor macro is defined, based upon the setting
21415 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21416 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21418 @item -mcpu=g10
21419 @itemx -mcpu=g13
21420 @itemx -mcpu=g14
21421 @itemx -mcpu=rl78
21422 @opindex mcpu
21423 Specifies the RL78 core to target.  The default is the G14 core, also
21424 known as an S3 core or just RL78.  The G13 or S2 core does not have
21425 multiply or divide instructions, instead it uses a hardware peripheral
21426 for these operations.  The G10 or S1 core does not have register
21427 banks, so it uses a different calling convention.
21429 If this option is set it also selects the type of hardware multiply
21430 support to use, unless this is overridden by an explicit
21431 @option{-mmul=none} option on the command line.  Thus specifying
21432 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21433 peripheral and specifying @option{-mcpu=g10} disables the use of
21434 hardware multiplications altogether.
21436 Note, although the RL78/G14 core is the default target, specifying
21437 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21438 change the behavior of the toolchain since it also enables G14
21439 hardware multiply support.  If these options are not specified on the
21440 command line then software multiplication routines will be used even
21441 though the code targets the RL78 core.  This is for backwards
21442 compatibility with older toolchains which did not have hardware
21443 multiply and divide support.
21445 In addition a C preprocessor macro is defined, based upon the setting
21446 of this option.  Possible values are: @code{__RL78_G10__},
21447 @code{__RL78_G13__} or @code{__RL78_G14__}.
21449 @item -mg10
21450 @itemx -mg13
21451 @itemx -mg14
21452 @itemx -mrl78
21453 @opindex mg10
21454 @opindex mg13
21455 @opindex mg14
21456 @opindex mrl78
21457 These are aliases for the corresponding @option{-mcpu=} option.  They
21458 are provided for backwards compatibility.
21460 @item -mallregs
21461 @opindex mallregs
21462 Allow the compiler to use all of the available registers.  By default
21463 registers @code{r24..r31} are reserved for use in interrupt handlers.
21464 With this option enabled these registers can be used in ordinary
21465 functions as well.
21467 @item -m64bit-doubles
21468 @itemx -m32bit-doubles
21469 @opindex m64bit-doubles
21470 @opindex m32bit-doubles
21471 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21472 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21473 @option{-m32bit-doubles}.
21475 @item -msave-mduc-in-interrupts
21476 @item -mno-save-mduc-in-interrupts
21477 @opindex msave-mduc-in-interrupts
21478 @opindex mno-save-mduc-in-interrupts
21479 Specifies that interrupt handler functions should preserve the
21480 MDUC registers.  This is only necessary if normal code might use
21481 the MDUC registers, for example because it performs multiplication
21482 and division operations.  The default is to ignore the MDUC registers
21483 as this makes the interrupt handlers faster.  The target option -mg13
21484 needs to be passed for this to work as this feature is only available
21485 on the G13 target (S2 core).  The MDUC registers will only be saved
21486 if the interrupt handler performs a multiplication or division
21487 operation or it calls another function.
21489 @end table
21491 @node RS/6000 and PowerPC Options
21492 @subsection IBM RS/6000 and PowerPC Options
21493 @cindex RS/6000 and PowerPC Options
21494 @cindex IBM RS/6000 and PowerPC Options
21496 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21497 @table @gcctabopt
21498 @item -mpowerpc-gpopt
21499 @itemx -mno-powerpc-gpopt
21500 @itemx -mpowerpc-gfxopt
21501 @itemx -mno-powerpc-gfxopt
21502 @need 800
21503 @itemx -mpowerpc64
21504 @itemx -mno-powerpc64
21505 @itemx -mmfcrf
21506 @itemx -mno-mfcrf
21507 @itemx -mpopcntb
21508 @itemx -mno-popcntb
21509 @itemx -mpopcntd
21510 @itemx -mno-popcntd
21511 @itemx -mfprnd
21512 @itemx -mno-fprnd
21513 @need 800
21514 @itemx -mcmpb
21515 @itemx -mno-cmpb
21516 @itemx -mmfpgpr
21517 @itemx -mno-mfpgpr
21518 @itemx -mhard-dfp
21519 @itemx -mno-hard-dfp
21520 @opindex mpowerpc-gpopt
21521 @opindex mno-powerpc-gpopt
21522 @opindex mpowerpc-gfxopt
21523 @opindex mno-powerpc-gfxopt
21524 @opindex mpowerpc64
21525 @opindex mno-powerpc64
21526 @opindex mmfcrf
21527 @opindex mno-mfcrf
21528 @opindex mpopcntb
21529 @opindex mno-popcntb
21530 @opindex mpopcntd
21531 @opindex mno-popcntd
21532 @opindex mfprnd
21533 @opindex mno-fprnd
21534 @opindex mcmpb
21535 @opindex mno-cmpb
21536 @opindex mmfpgpr
21537 @opindex mno-mfpgpr
21538 @opindex mhard-dfp
21539 @opindex mno-hard-dfp
21540 You use these options to specify which instructions are available on the
21541 processor you are using.  The default value of these options is
21542 determined when configuring GCC@.  Specifying the
21543 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21544 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21545 rather than the options listed above.
21547 Specifying @option{-mpowerpc-gpopt} allows
21548 GCC to use the optional PowerPC architecture instructions in the
21549 General Purpose group, including floating-point square root.  Specifying
21550 @option{-mpowerpc-gfxopt} allows GCC to
21551 use the optional PowerPC architecture instructions in the Graphics
21552 group, including floating-point select.
21554 The @option{-mmfcrf} option allows GCC to generate the move from
21555 condition register field instruction implemented on the POWER4
21556 processor and other processors that support the PowerPC V2.01
21557 architecture.
21558 The @option{-mpopcntb} option allows GCC to generate the popcount and
21559 double-precision FP reciprocal estimate instruction implemented on the
21560 POWER5 processor and other processors that support the PowerPC V2.02
21561 architecture.
21562 The @option{-mpopcntd} option allows GCC to generate the popcount
21563 instruction implemented on the POWER7 processor and other processors
21564 that support the PowerPC V2.06 architecture.
21565 The @option{-mfprnd} option allows GCC to generate the FP round to
21566 integer instructions implemented on the POWER5+ processor and other
21567 processors that support the PowerPC V2.03 architecture.
21568 The @option{-mcmpb} option allows GCC to generate the compare bytes
21569 instruction implemented on the POWER6 processor and other processors
21570 that support the PowerPC V2.05 architecture.
21571 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21572 general-purpose register instructions implemented on the POWER6X
21573 processor and other processors that support the extended PowerPC V2.05
21574 architecture.
21575 The @option{-mhard-dfp} option allows GCC to generate the decimal
21576 floating-point instructions implemented on some POWER processors.
21578 The @option{-mpowerpc64} option allows GCC to generate the additional
21579 64-bit instructions that are found in the full PowerPC64 architecture
21580 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21581 @option{-mno-powerpc64}.
21583 @item -mcpu=@var{cpu_type}
21584 @opindex mcpu
21585 Set architecture type, register usage, and
21586 instruction scheduling parameters for machine type @var{cpu_type}.
21587 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21588 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21589 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21590 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21591 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21592 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21593 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21594 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21595 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21596 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21597 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21598 and @samp{rs64}.
21600 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21601 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21602 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21603 architecture machine types, with an appropriate, generic processor
21604 model assumed for scheduling purposes.
21606 The other options specify a specific processor.  Code generated under
21607 those options runs best on that processor, and may not run at all on
21608 others.
21610 The @option{-mcpu} options automatically enable or disable the
21611 following options:
21613 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21614 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21615 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21616 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21617 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21618 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21620 The particular options set for any particular CPU varies between
21621 compiler versions, depending on what setting seems to produce optimal
21622 code for that CPU; it doesn't necessarily reflect the actual hardware's
21623 capabilities.  If you wish to set an individual option to a particular
21624 value, you may specify it after the @option{-mcpu} option, like
21625 @option{-mcpu=970 -mno-altivec}.
21627 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21628 not enabled or disabled by the @option{-mcpu} option at present because
21629 AIX does not have full support for these options.  You may still
21630 enable or disable them individually if you're sure it'll work in your
21631 environment.
21633 @item -mtune=@var{cpu_type}
21634 @opindex mtune
21635 Set the instruction scheduling parameters for machine type
21636 @var{cpu_type}, but do not set the architecture type or register usage,
21637 as @option{-mcpu=@var{cpu_type}} does.  The same
21638 values for @var{cpu_type} are used for @option{-mtune} as for
21639 @option{-mcpu}.  If both are specified, the code generated uses the
21640 architecture and registers set by @option{-mcpu}, but the
21641 scheduling parameters set by @option{-mtune}.
21643 @item -mcmodel=small
21644 @opindex mcmodel=small
21645 Generate PowerPC64 code for the small model: The TOC is limited to
21646 64k.
21648 @item -mcmodel=medium
21649 @opindex mcmodel=medium
21650 Generate PowerPC64 code for the medium model: The TOC and other static
21651 data may be up to a total of 4G in size.  This is the default for 64-bit
21652 Linux.
21654 @item -mcmodel=large
21655 @opindex mcmodel=large
21656 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21657 in size.  Other data and code is only limited by the 64-bit address
21658 space.
21660 @item -maltivec
21661 @itemx -mno-altivec
21662 @opindex maltivec
21663 @opindex mno-altivec
21664 Generate code that uses (does not use) AltiVec instructions, and also
21665 enable the use of built-in functions that allow more direct access to
21666 the AltiVec instruction set.  You may also need to set
21667 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21668 enhancements.
21670 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21671 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21672 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21673 match array element order corresponding to the endianness of the
21674 target.  That is, element zero identifies the leftmost element in a
21675 vector register when targeting a big-endian platform, and identifies
21676 the rightmost element in a vector register when targeting a
21677 little-endian platform.
21679 @item -maltivec=be
21680 @opindex maltivec=be
21681 Generate AltiVec instructions using big-endian element order,
21682 regardless of whether the target is big- or little-endian.  This is
21683 the default when targeting a big-endian platform.
21685 The element order is used to interpret element numbers in AltiVec
21686 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21687 @code{vec_insert}.  By default, these match array element order
21688 corresponding to the endianness for the target.
21690 @item -maltivec=le
21691 @opindex maltivec=le
21692 Generate AltiVec instructions using little-endian element order,
21693 regardless of whether the target is big- or little-endian.  This is
21694 the default when targeting a little-endian platform.  This option is
21695 currently ignored when targeting a big-endian platform.
21697 The element order is used to interpret element numbers in AltiVec
21698 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21699 @code{vec_insert}.  By default, these match array element order
21700 corresponding to the endianness for the target.
21702 @item -mvrsave
21703 @itemx -mno-vrsave
21704 @opindex mvrsave
21705 @opindex mno-vrsave
21706 Generate VRSAVE instructions when generating AltiVec code.
21708 @item -msecure-plt
21709 @opindex msecure-plt
21710 Generate code that allows @command{ld} and @command{ld.so}
21711 to build executables and shared
21712 libraries with non-executable @code{.plt} and @code{.got} sections.
21713 This is a PowerPC
21714 32-bit SYSV ABI option.
21716 @item -mbss-plt
21717 @opindex mbss-plt
21718 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21719 fills in, and
21720 requires @code{.plt} and @code{.got}
21721 sections that are both writable and executable.
21722 This is a PowerPC 32-bit SYSV ABI option.
21724 @item -misel
21725 @itemx -mno-isel
21726 @opindex misel
21727 @opindex mno-isel
21728 This switch enables or disables the generation of ISEL instructions.
21730 @item -misel=@var{yes/no}
21731 This switch has been deprecated.  Use @option{-misel} and
21732 @option{-mno-isel} instead.
21734 @item -mlra
21735 @opindex mlra
21736 Enable Local Register Allocation. By default the port uses LRA.
21737 (i.e. @option{-mno-lra}).
21739 @item -mspe
21740 @itemx -mno-spe
21741 @opindex mspe
21742 @opindex mno-spe
21743 This switch enables or disables the generation of SPE simd
21744 instructions.
21746 @item -mpaired
21747 @itemx -mno-paired
21748 @opindex mpaired
21749 @opindex mno-paired
21750 This switch enables or disables the generation of PAIRED simd
21751 instructions.
21753 @item -mspe=@var{yes/no}
21754 This option has been deprecated.  Use @option{-mspe} and
21755 @option{-mno-spe} instead.
21757 @item -mvsx
21758 @itemx -mno-vsx
21759 @opindex mvsx
21760 @opindex mno-vsx
21761 Generate code that uses (does not use) vector/scalar (VSX)
21762 instructions, and also enable the use of built-in functions that allow
21763 more direct access to the VSX instruction set.
21765 @item -mcrypto
21766 @itemx -mno-crypto
21767 @opindex mcrypto
21768 @opindex mno-crypto
21769 Enable the use (disable) of the built-in functions that allow direct
21770 access to the cryptographic instructions that were added in version
21771 2.07 of the PowerPC ISA.
21773 @item -mdirect-move
21774 @itemx -mno-direct-move
21775 @opindex mdirect-move
21776 @opindex mno-direct-move
21777 Generate code that uses (does not use) the instructions to move data
21778 between the general purpose registers and the vector/scalar (VSX)
21779 registers that were added in version 2.07 of the PowerPC ISA.
21781 @item -mhtm
21782 @itemx -mno-htm
21783 @opindex mhtm
21784 @opindex mno-htm
21785 Enable (disable) the use of the built-in functions that allow direct
21786 access to the Hardware Transactional Memory (HTM) instructions that
21787 were added in version 2.07 of the PowerPC ISA.
21789 @item -mpower8-fusion
21790 @itemx -mno-power8-fusion
21791 @opindex mpower8-fusion
21792 @opindex mno-power8-fusion
21793 Generate code that keeps (does not keeps) some integer operations
21794 adjacent so that the instructions can be fused together on power8 and
21795 later processors.
21797 @item -mpower8-vector
21798 @itemx -mno-power8-vector
21799 @opindex mpower8-vector
21800 @opindex mno-power8-vector
21801 Generate code that uses (does not use) the vector and scalar
21802 instructions that were added in version 2.07 of the PowerPC ISA.  Also
21803 enable the use of built-in functions that allow more direct access to
21804 the vector instructions.
21806 @item -mquad-memory
21807 @itemx -mno-quad-memory
21808 @opindex mquad-memory
21809 @opindex mno-quad-memory
21810 Generate code that uses (does not use) the non-atomic quad word memory
21811 instructions.  The @option{-mquad-memory} option requires use of
21812 64-bit mode.
21814 @item -mquad-memory-atomic
21815 @itemx -mno-quad-memory-atomic
21816 @opindex mquad-memory-atomic
21817 @opindex mno-quad-memory-atomic
21818 Generate code that uses (does not use) the atomic quad word memory
21819 instructions.  The @option{-mquad-memory-atomic} option requires use of
21820 64-bit mode.
21822 @item -mupper-regs-di
21823 @itemx -mno-upper-regs-di
21824 @opindex mupper-regs-di
21825 @opindex mno-upper-regs-di
21826 Generate code that uses (does not use) the scalar instructions that
21827 target all 64 registers in the vector/scalar floating point register
21828 set that were added in version 2.06 of the PowerPC ISA when processing
21829 integers.  @option{-mupper-regs-di} is turned on by default if you use
21830 any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21831 @option{-mcpu=power9}, or @option{-mvsx} options.
21833 @item -mupper-regs-df
21834 @itemx -mno-upper-regs-df
21835 @opindex mupper-regs-df
21836 @opindex mno-upper-regs-df
21837 Generate code that uses (does not use) the scalar double precision
21838 instructions that target all 64 registers in the vector/scalar
21839 floating point register set that were added in version 2.06 of the
21840 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
21841 use any of the @option{-mcpu=power7}, @option{-mcpu=power8},
21842 @option{-mcpu=power9}, or @option{-mvsx} options.
21844 @item -mupper-regs-sf
21845 @itemx -mno-upper-regs-sf
21846 @opindex mupper-regs-sf
21847 @opindex mno-upper-regs-sf
21848 Generate code that uses (does not use) the scalar single precision
21849 instructions that target all 64 registers in the vector/scalar
21850 floating point register set that were added in version 2.07 of the
21851 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
21852 use either of the @option{-mcpu=power8}, @option{-mpower8-vector}, or
21853 @option{-mcpu=power9} options.
21855 @item -mupper-regs
21856 @itemx -mno-upper-regs
21857 @opindex mupper-regs
21858 @opindex mno-upper-regs
21859 Generate code that uses (does not use) the scalar
21860 instructions that target all 64 registers in the vector/scalar
21861 floating point register set, depending on the model of the machine.
21863 If the @option{-mno-upper-regs} option is used, it turns off both
21864 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
21866 @item -mfloat128
21867 @itemx -mno-float128
21868 @opindex mfloat128
21869 @opindex mno-float128
21870 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
21871 and use either software emulation for IEEE 128-bit floating point or
21872 hardware instructions.
21874 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
21875 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
21876 option.  The @option{-mfloat128} option only works on PowerPC 64-bit
21877 Linux systems.
21879 If you use the ISA 3.0 instruction set (@option{-mcpu=power9}), the
21880 @option{-mfloat128} option will also enable the generation of ISA 3.0
21881 IEEE 128-bit floating point instructions.  Otherwise, IEEE 128-bit
21882 floating point will be done with software emulation.
21884 @item -mfloat128-hardware
21885 @itemx -mno-float128-hardware
21886 @opindex mfloat128-hardware
21887 @opindex mno-float128-hardware
21888 Enable/disable using ISA 3.0 hardware instructions to support the
21889 @var{__float128} data type.
21891 If you use @option{-mfloat128-hardware}, it will enable the option
21892 @option{-mfloat128} as well.
21894 If you select ISA 3.0 instructions with @option{-mcpu=power9}, but do
21895 not use either @option{-mfloat128} or @option{-mfloat128-hardware},
21896 the IEEE 128-bit floating point support will not be enabled.
21898 @item -mfloat-gprs=@var{yes/single/double/no}
21899 @itemx -mfloat-gprs
21900 @opindex mfloat-gprs
21901 This switch enables or disables the generation of floating-point
21902 operations on the general-purpose registers for architectures that
21903 support it.
21905 The argument @samp{yes} or @samp{single} enables the use of
21906 single-precision floating-point operations.
21908 The argument @samp{double} enables the use of single and
21909 double-precision floating-point operations.
21911 The argument @samp{no} disables floating-point operations on the
21912 general-purpose registers.
21914 This option is currently only available on the MPC854x.
21916 @item -m32
21917 @itemx -m64
21918 @opindex m32
21919 @opindex m64
21920 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
21921 targets (including GNU/Linux).  The 32-bit environment sets int, long
21922 and pointer to 32 bits and generates code that runs on any PowerPC
21923 variant.  The 64-bit environment sets int to 32 bits and long and
21924 pointer to 64 bits, and generates code for PowerPC64, as for
21925 @option{-mpowerpc64}.
21927 @item -mfull-toc
21928 @itemx -mno-fp-in-toc
21929 @itemx -mno-sum-in-toc
21930 @itemx -mminimal-toc
21931 @opindex mfull-toc
21932 @opindex mno-fp-in-toc
21933 @opindex mno-sum-in-toc
21934 @opindex mminimal-toc
21935 Modify generation of the TOC (Table Of Contents), which is created for
21936 every executable file.  The @option{-mfull-toc} option is selected by
21937 default.  In that case, GCC allocates at least one TOC entry for
21938 each unique non-automatic variable reference in your program.  GCC
21939 also places floating-point constants in the TOC@.  However, only
21940 16,384 entries are available in the TOC@.
21942 If you receive a linker error message that saying you have overflowed
21943 the available TOC space, you can reduce the amount of TOC space used
21944 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
21945 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
21946 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
21947 generate code to calculate the sum of an address and a constant at
21948 run time instead of putting that sum into the TOC@.  You may specify one
21949 or both of these options.  Each causes GCC to produce very slightly
21950 slower and larger code at the expense of conserving TOC space.
21952 If you still run out of space in the TOC even when you specify both of
21953 these options, specify @option{-mminimal-toc} instead.  This option causes
21954 GCC to make only one TOC entry for every file.  When you specify this
21955 option, GCC produces code that is slower and larger but which
21956 uses extremely little TOC space.  You may wish to use this option
21957 only on files that contain less frequently-executed code.
21959 @item -maix64
21960 @itemx -maix32
21961 @opindex maix64
21962 @opindex maix32
21963 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
21964 @code{long} type, and the infrastructure needed to support them.
21965 Specifying @option{-maix64} implies @option{-mpowerpc64},
21966 while @option{-maix32} disables the 64-bit ABI and
21967 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
21969 @item -mxl-compat
21970 @itemx -mno-xl-compat
21971 @opindex mxl-compat
21972 @opindex mno-xl-compat
21973 Produce code that conforms more closely to IBM XL compiler semantics
21974 when using AIX-compatible ABI@.  Pass floating-point arguments to
21975 prototyped functions beyond the register save area (RSA) on the stack
21976 in addition to argument FPRs.  Do not assume that most significant
21977 double in 128-bit long double value is properly rounded when comparing
21978 values and converting to double.  Use XL symbol names for long double
21979 support routines.
21981 The AIX calling convention was extended but not initially documented to
21982 handle an obscure K&R C case of calling a function that takes the
21983 address of its arguments with fewer arguments than declared.  IBM XL
21984 compilers access floating-point arguments that do not fit in the
21985 RSA from the stack when a subroutine is compiled without
21986 optimization.  Because always storing floating-point arguments on the
21987 stack is inefficient and rarely needed, this option is not enabled by
21988 default and only is necessary when calling subroutines compiled by IBM
21989 XL compilers without optimization.
21991 @item -mpe
21992 @opindex mpe
21993 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
21994 application written to use message passing with special startup code to
21995 enable the application to run.  The system must have PE installed in the
21996 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
21997 must be overridden with the @option{-specs=} option to specify the
21998 appropriate directory location.  The Parallel Environment does not
21999 support threads, so the @option{-mpe} option and the @option{-pthread}
22000 option are incompatible.
22002 @item -malign-natural
22003 @itemx -malign-power
22004 @opindex malign-natural
22005 @opindex malign-power
22006 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22007 @option{-malign-natural} overrides the ABI-defined alignment of larger
22008 types, such as floating-point doubles, on their natural size-based boundary.
22009 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22010 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22012 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22013 is not supported.
22015 @item -msoft-float
22016 @itemx -mhard-float
22017 @opindex msoft-float
22018 @opindex mhard-float
22019 Generate code that does not use (uses) the floating-point register set.
22020 Software floating-point emulation is provided if you use the
22021 @option{-msoft-float} option, and pass the option to GCC when linking.
22023 @item -msingle-float
22024 @itemx -mdouble-float
22025 @opindex msingle-float
22026 @opindex mdouble-float
22027 Generate code for single- or double-precision floating-point operations.
22028 @option{-mdouble-float} implies @option{-msingle-float}.
22030 @item -msimple-fpu
22031 @opindex msimple-fpu
22032 Do not generate @code{sqrt} and @code{div} instructions for hardware
22033 floating-point unit.
22035 @item -mfpu=@var{name}
22036 @opindex mfpu
22037 Specify type of floating-point unit.  Valid values for @var{name} are
22038 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22039 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22040 @samp{sp_full} (equivalent to @option{-msingle-float}),
22041 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22043 @item -mxilinx-fpu
22044 @opindex mxilinx-fpu
22045 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22047 @item -mmultiple
22048 @itemx -mno-multiple
22049 @opindex mmultiple
22050 @opindex mno-multiple
22051 Generate code that uses (does not use) the load multiple word
22052 instructions and the store multiple word instructions.  These
22053 instructions are generated by default on POWER systems, and not
22054 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22055 PowerPC systems, since those instructions do not work when the
22056 processor is in little-endian mode.  The exceptions are PPC740 and
22057 PPC750 which permit these instructions in little-endian mode.
22059 @item -mstring
22060 @itemx -mno-string
22061 @opindex mstring
22062 @opindex mno-string
22063 Generate code that uses (does not use) the load string instructions
22064 and the store string word instructions to save multiple registers and
22065 do small block moves.  These instructions are generated by default on
22066 POWER systems, and not generated on PowerPC systems.  Do not use
22067 @option{-mstring} on little-endian PowerPC systems, since those
22068 instructions do not work when the processor is in little-endian mode.
22069 The exceptions are PPC740 and PPC750 which permit these instructions
22070 in little-endian mode.
22072 @item -mupdate
22073 @itemx -mno-update
22074 @opindex mupdate
22075 @opindex mno-update
22076 Generate code that uses (does not use) the load or store instructions
22077 that update the base register to the address of the calculated memory
22078 location.  These instructions are generated by default.  If you use
22079 @option{-mno-update}, there is a small window between the time that the
22080 stack pointer is updated and the address of the previous frame is
22081 stored, which means code that walks the stack frame across interrupts or
22082 signals may get corrupted data.
22084 @item -mavoid-indexed-addresses
22085 @itemx -mno-avoid-indexed-addresses
22086 @opindex mavoid-indexed-addresses
22087 @opindex mno-avoid-indexed-addresses
22088 Generate code that tries to avoid (not avoid) the use of indexed load
22089 or store instructions. These instructions can incur a performance
22090 penalty on Power6 processors in certain situations, such as when
22091 stepping through large arrays that cross a 16M boundary.  This option
22092 is enabled by default when targeting Power6 and disabled otherwise.
22094 @item -mfused-madd
22095 @itemx -mno-fused-madd
22096 @opindex mfused-madd
22097 @opindex mno-fused-madd
22098 Generate code that uses (does not use) the floating-point multiply and
22099 accumulate instructions.  These instructions are generated by default
22100 if hardware floating point is used.  The machine-dependent
22101 @option{-mfused-madd} option is now mapped to the machine-independent
22102 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22103 mapped to @option{-ffp-contract=off}.
22105 @item -mmulhw
22106 @itemx -mno-mulhw
22107 @opindex mmulhw
22108 @opindex mno-mulhw
22109 Generate code that uses (does not use) the half-word multiply and
22110 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22111 These instructions are generated by default when targeting those
22112 processors.
22114 @item -mdlmzb
22115 @itemx -mno-dlmzb
22116 @opindex mdlmzb
22117 @opindex mno-dlmzb
22118 Generate code that uses (does not use) the string-search @samp{dlmzb}
22119 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22120 generated by default when targeting those processors.
22122 @item -mno-bit-align
22123 @itemx -mbit-align
22124 @opindex mno-bit-align
22125 @opindex mbit-align
22126 On System V.4 and embedded PowerPC systems do not (do) force structures
22127 and unions that contain bit-fields to be aligned to the base type of the
22128 bit-field.
22130 For example, by default a structure containing nothing but 8
22131 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22132 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22133 the structure is aligned to a 1-byte boundary and is 1 byte in
22134 size.
22136 @item -mno-strict-align
22137 @itemx -mstrict-align
22138 @opindex mno-strict-align
22139 @opindex mstrict-align
22140 On System V.4 and embedded PowerPC systems do not (do) assume that
22141 unaligned memory references are handled by the system.
22143 @item -mrelocatable
22144 @itemx -mno-relocatable
22145 @opindex mrelocatable
22146 @opindex mno-relocatable
22147 Generate code that allows (does not allow) a static executable to be
22148 relocated to a different address at run time.  A simple embedded
22149 PowerPC system loader should relocate the entire contents of
22150 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22151 a table of 32-bit addresses generated by this option.  For this to
22152 work, all objects linked together must be compiled with
22153 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22154 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22156 @item -mrelocatable-lib
22157 @itemx -mno-relocatable-lib
22158 @opindex mrelocatable-lib
22159 @opindex mno-relocatable-lib
22160 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22161 @code{.fixup} section to allow static executables to be relocated at
22162 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22163 alignment of @option{-mrelocatable}.  Objects compiled with
22164 @option{-mrelocatable-lib} may be linked with objects compiled with
22165 any combination of the @option{-mrelocatable} options.
22167 @item -mno-toc
22168 @itemx -mtoc
22169 @opindex mno-toc
22170 @opindex mtoc
22171 On System V.4 and embedded PowerPC systems do not (do) assume that
22172 register 2 contains a pointer to a global area pointing to the addresses
22173 used in the program.
22175 @item -mlittle
22176 @itemx -mlittle-endian
22177 @opindex mlittle
22178 @opindex mlittle-endian
22179 On System V.4 and embedded PowerPC systems compile code for the
22180 processor in little-endian mode.  The @option{-mlittle-endian} option is
22181 the same as @option{-mlittle}.
22183 @item -mbig
22184 @itemx -mbig-endian
22185 @opindex mbig
22186 @opindex mbig-endian
22187 On System V.4 and embedded PowerPC systems compile code for the
22188 processor in big-endian mode.  The @option{-mbig-endian} option is
22189 the same as @option{-mbig}.
22191 @item -mdynamic-no-pic
22192 @opindex mdynamic-no-pic
22193 On Darwin and Mac OS X systems, compile code so that it is not
22194 relocatable, but that its external references are relocatable.  The
22195 resulting code is suitable for applications, but not shared
22196 libraries.
22198 @item -msingle-pic-base
22199 @opindex msingle-pic-base
22200 Treat the register used for PIC addressing as read-only, rather than
22201 loading it in the prologue for each function.  The runtime system is
22202 responsible for initializing this register with an appropriate value
22203 before execution begins.
22205 @item -mprioritize-restricted-insns=@var{priority}
22206 @opindex mprioritize-restricted-insns
22207 This option controls the priority that is assigned to
22208 dispatch-slot restricted instructions during the second scheduling
22209 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22210 or @samp{2} to assign no, highest, or second-highest (respectively) 
22211 priority to dispatch-slot restricted
22212 instructions.
22214 @item -msched-costly-dep=@var{dependence_type}
22215 @opindex msched-costly-dep
22216 This option controls which dependences are considered costly
22217 by the target during instruction scheduling.  The argument
22218 @var{dependence_type} takes one of the following values:
22220 @table @asis
22221 @item @samp{no}
22222 No dependence is costly.
22224 @item @samp{all}
22225 All dependences are costly.
22227 @item @samp{true_store_to_load}
22228 A true dependence from store to load is costly.
22230 @item @samp{store_to_load}
22231 Any dependence from store to load is costly.
22233 @item @var{number}
22234 Any dependence for which the latency is greater than or equal to 
22235 @var{number} is costly.
22236 @end table
22238 @item -minsert-sched-nops=@var{scheme}
22239 @opindex minsert-sched-nops
22240 This option controls which NOP insertion scheme is used during
22241 the second scheduling pass.  The argument @var{scheme} takes one of the
22242 following values:
22244 @table @asis
22245 @item @samp{no}
22246 Don't insert NOPs.
22248 @item @samp{pad}
22249 Pad with NOPs any dispatch group that has vacant issue slots,
22250 according to the scheduler's grouping.
22252 @item @samp{regroup_exact}
22253 Insert NOPs to force costly dependent insns into
22254 separate groups.  Insert exactly as many NOPs as needed to force an insn
22255 to a new group, according to the estimated processor grouping.
22257 @item @var{number}
22258 Insert NOPs to force costly dependent insns into
22259 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22260 @end table
22262 @item -mcall-sysv
22263 @opindex mcall-sysv
22264 On System V.4 and embedded PowerPC systems compile code using calling
22265 conventions that adhere to the March 1995 draft of the System V
22266 Application Binary Interface, PowerPC processor supplement.  This is the
22267 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22269 @item -mcall-sysv-eabi
22270 @itemx -mcall-eabi
22271 @opindex mcall-sysv-eabi
22272 @opindex mcall-eabi
22273 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22275 @item -mcall-sysv-noeabi
22276 @opindex mcall-sysv-noeabi
22277 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22279 @item -mcall-aixdesc
22280 @opindex m
22281 On System V.4 and embedded PowerPC systems compile code for the AIX
22282 operating system.
22284 @item -mcall-linux
22285 @opindex mcall-linux
22286 On System V.4 and embedded PowerPC systems compile code for the
22287 Linux-based GNU system.
22289 @item -mcall-freebsd
22290 @opindex mcall-freebsd
22291 On System V.4 and embedded PowerPC systems compile code for the
22292 FreeBSD operating system.
22294 @item -mcall-netbsd
22295 @opindex mcall-netbsd
22296 On System V.4 and embedded PowerPC systems compile code for the
22297 NetBSD operating system.
22299 @item -mcall-openbsd
22300 @opindex mcall-netbsd
22301 On System V.4 and embedded PowerPC systems compile code for the
22302 OpenBSD operating system.
22304 @item -maix-struct-return
22305 @opindex maix-struct-return
22306 Return all structures in memory (as specified by the AIX ABI)@.
22308 @item -msvr4-struct-return
22309 @opindex msvr4-struct-return
22310 Return structures smaller than 8 bytes in registers (as specified by the
22311 SVR4 ABI)@.
22313 @item -mabi=@var{abi-type}
22314 @opindex mabi
22315 Extend the current ABI with a particular extension, or remove such extension.
22316 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22317 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22318 @samp{elfv1}, @samp{elfv2}@.
22320 @item -mabi=spe
22321 @opindex mabi=spe
22322 Extend the current ABI with SPE ABI extensions.  This does not change
22323 the default ABI, instead it adds the SPE ABI extensions to the current
22324 ABI@.
22326 @item -mabi=no-spe
22327 @opindex mabi=no-spe
22328 Disable Book-E SPE ABI extensions for the current ABI@.
22330 @item -mabi=ibmlongdouble
22331 @opindex mabi=ibmlongdouble
22332 Change the current ABI to use IBM extended-precision long double.
22333 This is a PowerPC 32-bit SYSV ABI option.
22335 @item -mabi=ieeelongdouble
22336 @opindex mabi=ieeelongdouble
22337 Change the current ABI to use IEEE extended-precision long double.
22338 This is a PowerPC 32-bit Linux ABI option.
22340 @item -mabi=elfv1
22341 @opindex mabi=elfv1
22342 Change the current ABI to use the ELFv1 ABI.
22343 This is the default ABI for big-endian PowerPC 64-bit Linux.
22344 Overriding the default ABI requires special system support and is
22345 likely to fail in spectacular ways.
22347 @item -mabi=elfv2
22348 @opindex mabi=elfv2
22349 Change the current ABI to use the ELFv2 ABI.
22350 This is the default ABI for little-endian PowerPC 64-bit Linux.
22351 Overriding the default ABI requires special system support and is
22352 likely to fail in spectacular ways.
22354 @item -mgnu-attribute
22355 @itemx -mno-gnu-attribute
22356 @opindex mgnu-attribute
22357 @opindex mno-gnu-attribute
22358 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22359 .gnu.attributes section that specify ABI variations in function
22360 parameters or return values.
22362 @item -mprototype
22363 @itemx -mno-prototype
22364 @opindex mprototype
22365 @opindex mno-prototype
22366 On System V.4 and embedded PowerPC systems assume that all calls to
22367 variable argument functions are properly prototyped.  Otherwise, the
22368 compiler must insert an instruction before every non-prototyped call to
22369 set or clear bit 6 of the condition code register (@code{CR}) to
22370 indicate whether floating-point values are passed in the floating-point
22371 registers in case the function takes variable arguments.  With
22372 @option{-mprototype}, only calls to prototyped variable argument functions
22373 set or clear the bit.
22375 @item -msim
22376 @opindex msim
22377 On embedded PowerPC systems, assume that the startup module is called
22378 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22379 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22380 configurations.
22382 @item -mmvme
22383 @opindex mmvme
22384 On embedded PowerPC systems, assume that the startup module is called
22385 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22386 @file{libc.a}.
22388 @item -mads
22389 @opindex mads
22390 On embedded PowerPC systems, assume that the startup module is called
22391 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22392 @file{libc.a}.
22394 @item -myellowknife
22395 @opindex myellowknife
22396 On embedded PowerPC systems, assume that the startup module is called
22397 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22398 @file{libc.a}.
22400 @item -mvxworks
22401 @opindex mvxworks
22402 On System V.4 and embedded PowerPC systems, specify that you are
22403 compiling for a VxWorks system.
22405 @item -memb
22406 @opindex memb
22407 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22408 header to indicate that @samp{eabi} extended relocations are used.
22410 @item -meabi
22411 @itemx -mno-eabi
22412 @opindex meabi
22413 @opindex mno-eabi
22414 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22415 Embedded Applications Binary Interface (EABI), which is a set of
22416 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22417 means that the stack is aligned to an 8-byte boundary, a function
22418 @code{__eabi} is called from @code{main} to set up the EABI
22419 environment, and the @option{-msdata} option can use both @code{r2} and
22420 @code{r13} to point to two separate small data areas.  Selecting
22421 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22422 no EABI initialization function is called from @code{main}, and the
22423 @option{-msdata} option only uses @code{r13} to point to a single
22424 small data area.  The @option{-meabi} option is on by default if you
22425 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22427 @item -msdata=eabi
22428 @opindex msdata=eabi
22429 On System V.4 and embedded PowerPC systems, put small initialized
22430 @code{const} global and static data in the @code{.sdata2} section, which
22431 is pointed to by register @code{r2}.  Put small initialized
22432 non-@code{const} global and static data in the @code{.sdata} section,
22433 which is pointed to by register @code{r13}.  Put small uninitialized
22434 global and static data in the @code{.sbss} section, which is adjacent to
22435 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22436 incompatible with the @option{-mrelocatable} option.  The
22437 @option{-msdata=eabi} option also sets the @option{-memb} option.
22439 @item -msdata=sysv
22440 @opindex msdata=sysv
22441 On System V.4 and embedded PowerPC systems, put small global and static
22442 data in the @code{.sdata} section, which is pointed to by register
22443 @code{r13}.  Put small uninitialized global and static data in the
22444 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22445 The @option{-msdata=sysv} option is incompatible with the
22446 @option{-mrelocatable} option.
22448 @item -msdata=default
22449 @itemx -msdata
22450 @opindex msdata=default
22451 @opindex msdata
22452 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22453 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22454 same as @option{-msdata=sysv}.
22456 @item -msdata=data
22457 @opindex msdata=data
22458 On System V.4 and embedded PowerPC systems, put small global
22459 data in the @code{.sdata} section.  Put small uninitialized global
22460 data in the @code{.sbss} section.  Do not use register @code{r13}
22461 to address small data however.  This is the default behavior unless
22462 other @option{-msdata} options are used.
22464 @item -msdata=none
22465 @itemx -mno-sdata
22466 @opindex msdata=none
22467 @opindex mno-sdata
22468 On embedded PowerPC systems, put all initialized global and static data
22469 in the @code{.data} section, and all uninitialized data in the
22470 @code{.bss} section.
22472 @item -mblock-move-inline-limit=@var{num}
22473 @opindex mblock-move-inline-limit
22474 Inline all block moves (such as calls to @code{memcpy} or structure
22475 copies) less than or equal to @var{num} bytes.  The minimum value for
22476 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22477 targets.  The default value is target-specific.
22479 @item -G @var{num}
22480 @opindex G
22481 @cindex smaller data references (PowerPC)
22482 @cindex .sdata/.sdata2 references (PowerPC)
22483 On embedded PowerPC systems, put global and static items less than or
22484 equal to @var{num} bytes into the small data or BSS sections instead of
22485 the normal data or BSS section.  By default, @var{num} is 8.  The
22486 @option{-G @var{num}} switch is also passed to the linker.
22487 All modules should be compiled with the same @option{-G @var{num}} value.
22489 @item -mregnames
22490 @itemx -mno-regnames
22491 @opindex mregnames
22492 @opindex mno-regnames
22493 On System V.4 and embedded PowerPC systems do (do not) emit register
22494 names in the assembly language output using symbolic forms.
22496 @item -mlongcall
22497 @itemx -mno-longcall
22498 @opindex mlongcall
22499 @opindex mno-longcall
22500 By default assume that all calls are far away so that a longer and more
22501 expensive calling sequence is required.  This is required for calls
22502 farther than 32 megabytes (33,554,432 bytes) from the current location.
22503 A short call is generated if the compiler knows
22504 the call cannot be that far away.  This setting can be overridden by
22505 the @code{shortcall} function attribute, or by @code{#pragma
22506 longcall(0)}.
22508 Some linkers are capable of detecting out-of-range calls and generating
22509 glue code on the fly.  On these systems, long calls are unnecessary and
22510 generate slower code.  As of this writing, the AIX linker can do this,
22511 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22512 to the GNU linker for 32-bit PowerPC systems as well.
22514 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22515 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22516 addresses represent the callee and the branch island.  The
22517 Darwin/PPC linker prefers the first address and generates a @code{bl
22518 callee} if the PPC @code{bl} instruction reaches the callee directly;
22519 otherwise, the linker generates @code{bl L42} to call the branch
22520 island.  The branch island is appended to the body of the
22521 calling function; it computes the full 32-bit address of the callee
22522 and jumps to it.
22524 On Mach-O (Darwin) systems, this option directs the compiler emit to
22525 the glue for every direct call, and the Darwin linker decides whether
22526 to use or discard it.
22528 In the future, GCC may ignore all longcall specifications
22529 when the linker is known to generate glue.
22531 @item -mtls-markers
22532 @itemx -mno-tls-markers
22533 @opindex mtls-markers
22534 @opindex mno-tls-markers
22535 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22536 specifying the function argument.  The relocation allows the linker to
22537 reliably associate function call with argument setup instructions for
22538 TLS optimization, which in turn allows GCC to better schedule the
22539 sequence.
22541 @item -mrecip
22542 @itemx -mno-recip
22543 @opindex mrecip
22544 This option enables use of the reciprocal estimate and
22545 reciprocal square root estimate instructions with additional
22546 Newton-Raphson steps to increase precision instead of doing a divide or
22547 square root and divide for floating-point arguments.  You should use
22548 the @option{-ffast-math} option when using @option{-mrecip} (or at
22549 least @option{-funsafe-math-optimizations},
22550 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22551 @option{-fno-trapping-math}).  Note that while the throughput of the
22552 sequence is generally higher than the throughput of the non-reciprocal
22553 instruction, the precision of the sequence can be decreased by up to 2
22554 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22555 roots.
22557 @item -mrecip=@var{opt}
22558 @opindex mrecip=opt
22559 This option controls which reciprocal estimate instructions
22560 may be used.  @var{opt} is a comma-separated list of options, which may
22561 be preceded by a @code{!} to invert the option:
22563 @table @samp
22565 @item all
22566 Enable all estimate instructions.
22568 @item default 
22569 Enable the default instructions, equivalent to @option{-mrecip}.
22571 @item none 
22572 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22574 @item div 
22575 Enable the reciprocal approximation instructions for both 
22576 single and double precision.
22578 @item divf 
22579 Enable the single-precision reciprocal approximation instructions.
22581 @item divd 
22582 Enable the double-precision reciprocal approximation instructions.
22584 @item rsqrt 
22585 Enable the reciprocal square root approximation instructions for both
22586 single and double precision.
22588 @item rsqrtf 
22589 Enable the single-precision reciprocal square root approximation instructions.
22591 @item rsqrtd 
22592 Enable the double-precision reciprocal square root approximation instructions.
22594 @end table
22596 So, for example, @option{-mrecip=all,!rsqrtd} enables
22597 all of the reciprocal estimate instructions, except for the
22598 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22599 which handle the double-precision reciprocal square root calculations.
22601 @item -mrecip-precision
22602 @itemx -mno-recip-precision
22603 @opindex mrecip-precision
22604 Assume (do not assume) that the reciprocal estimate instructions
22605 provide higher-precision estimates than is mandated by the PowerPC
22606 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22607 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22608 The double-precision square root estimate instructions are not generated by
22609 default on low-precision machines, since they do not provide an
22610 estimate that converges after three steps.
22612 @item -mveclibabi=@var{type}
22613 @opindex mveclibabi
22614 Specifies the ABI type to use for vectorizing intrinsics using an
22615 external library.  The only type supported at present is @samp{mass},
22616 which specifies to use IBM's Mathematical Acceleration Subsystem
22617 (MASS) libraries for vectorizing intrinsics using external libraries.
22618 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22619 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22620 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22621 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22622 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22623 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22624 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22625 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22626 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22627 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22628 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22629 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22630 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22631 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22632 for power7.  Both @option{-ftree-vectorize} and
22633 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22634 libraries must be specified at link time.
22636 @item -mfriz
22637 @itemx -mno-friz
22638 @opindex mfriz
22639 Generate (do not generate) the @code{friz} instruction when the
22640 @option{-funsafe-math-optimizations} option is used to optimize
22641 rounding of floating-point values to 64-bit integer and back to floating
22642 point.  The @code{friz} instruction does not return the same value if
22643 the floating-point number is too large to fit in an integer.
22645 @item -mpointers-to-nested-functions
22646 @itemx -mno-pointers-to-nested-functions
22647 @opindex mpointers-to-nested-functions
22648 Generate (do not generate) code to load up the static chain register
22649 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22650 systems where a function pointer points to a 3-word descriptor giving
22651 the function address, TOC value to be loaded in register @code{r2}, and
22652 static chain value to be loaded in register @code{r11}.  The
22653 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22654 call through pointers to nested functions or pointers
22655 to functions compiled in other languages that use the static chain if
22656 you use @option{-mno-pointers-to-nested-functions}.
22658 @item -msave-toc-indirect
22659 @itemx -mno-save-toc-indirect
22660 @opindex msave-toc-indirect
22661 Generate (do not generate) code to save the TOC value in the reserved
22662 stack location in the function prologue if the function calls through
22663 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22664 saved in the prologue, it is saved just before the call through the
22665 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22667 @item -mcompat-align-parm
22668 @itemx -mno-compat-align-parm
22669 @opindex mcompat-align-parm
22670 Generate (do not generate) code to pass structure parameters with a
22671 maximum alignment of 64 bits, for compatibility with older versions
22672 of GCC.
22674 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22675 structure parameter on a 128-bit boundary when that structure contained
22676 a member requiring 128-bit alignment.  This is corrected in more
22677 recent versions of GCC.  This option may be used to generate code
22678 that is compatible with functions compiled with older versions of
22679 GCC.
22681 The @option{-mno-compat-align-parm} option is the default.
22683 @item -mstack-protector-guard=@var{guard}
22684 @itemx -mstack-protector-guard-reg=@var{reg}
22685 @itemx -mstack-protector-guard-offset=@var{offset}
22686 @opindex mstack-protector-guard
22687 @opindex mstack-protector-guard-reg
22688 @opindex mstack-protector-guard-offset
22689 Generate stack protection code using canary at @var{guard}.  Supported
22690 locations are @samp{global} for global canary or @samp{tls} for per-thread
22691 canary in the TLS block (the default with GNU libc version 2.4 or later).
22693 With the latter choice the options
22694 @option{-mstack-protector-guard-reg=@var{reg}} and
22695 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22696 which register to use as base register for reading the canary, and from what
22697 offset from that base register. The default for those is as specified in the
22698 relevant ABI.
22699 @end table
22701 @node RX Options
22702 @subsection RX Options
22703 @cindex RX Options
22705 These command-line options are defined for RX targets:
22707 @table @gcctabopt
22708 @item -m64bit-doubles
22709 @itemx -m32bit-doubles
22710 @opindex m64bit-doubles
22711 @opindex m32bit-doubles
22712 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22713 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22714 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22715 works on 32-bit values, which is why the default is
22716 @option{-m32bit-doubles}.
22718 @item -fpu
22719 @itemx -nofpu
22720 @opindex fpu
22721 @opindex nofpu
22722 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22723 floating-point hardware.  The default is enabled for the RX600
22724 series and disabled for the RX200 series.
22726 Floating-point instructions are only generated for 32-bit floating-point 
22727 values, however, so the FPU hardware is not used for doubles if the
22728 @option{-m64bit-doubles} option is used.
22730 @emph{Note} If the @option{-fpu} option is enabled then
22731 @option{-funsafe-math-optimizations} is also enabled automatically.
22732 This is because the RX FPU instructions are themselves unsafe.
22734 @item -mcpu=@var{name}
22735 @opindex mcpu
22736 Selects the type of RX CPU to be targeted.  Currently three types are
22737 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22738 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22740 The only difference between @samp{RX600} and @samp{RX610} is that the
22741 @samp{RX610} does not support the @code{MVTIPL} instruction.
22743 The @samp{RX200} series does not have a hardware floating-point unit
22744 and so @option{-nofpu} is enabled by default when this type is
22745 selected.
22747 @item -mbig-endian-data
22748 @itemx -mlittle-endian-data
22749 @opindex mbig-endian-data
22750 @opindex mlittle-endian-data
22751 Store data (but not code) in the big-endian format.  The default is
22752 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22753 format.
22755 @item -msmall-data-limit=@var{N}
22756 @opindex msmall-data-limit
22757 Specifies the maximum size in bytes of global and static variables
22758 which can be placed into the small data area.  Using the small data
22759 area can lead to smaller and faster code, but the size of area is
22760 limited and it is up to the programmer to ensure that the area does
22761 not overflow.  Also when the small data area is used one of the RX's
22762 registers (usually @code{r13}) is reserved for use pointing to this
22763 area, so it is no longer available for use by the compiler.  This
22764 could result in slower and/or larger code if variables are pushed onto
22765 the stack instead of being held in this register.
22767 Note, common variables (variables that have not been initialized) and
22768 constants are not placed into the small data area as they are assigned
22769 to other sections in the output executable.
22771 The default value is zero, which disables this feature.  Note, this
22772 feature is not enabled by default with higher optimization levels
22773 (@option{-O2} etc) because of the potentially detrimental effects of
22774 reserving a register.  It is up to the programmer to experiment and
22775 discover whether this feature is of benefit to their program.  See the
22776 description of the @option{-mpid} option for a description of how the
22777 actual register to hold the small data area pointer is chosen.
22779 @item -msim
22780 @itemx -mno-sim
22781 @opindex msim
22782 @opindex mno-sim
22783 Use the simulator runtime.  The default is to use the libgloss
22784 board-specific runtime.
22786 @item -mas100-syntax
22787 @itemx -mno-as100-syntax
22788 @opindex mas100-syntax
22789 @opindex mno-as100-syntax
22790 When generating assembler output use a syntax that is compatible with
22791 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
22792 assembler, but it has some restrictions so it is not generated by default.
22794 @item -mmax-constant-size=@var{N}
22795 @opindex mmax-constant-size
22796 Specifies the maximum size, in bytes, of a constant that can be used as
22797 an operand in a RX instruction.  Although the RX instruction set does
22798 allow constants of up to 4 bytes in length to be used in instructions,
22799 a longer value equates to a longer instruction.  Thus in some
22800 circumstances it can be beneficial to restrict the size of constants
22801 that are used in instructions.  Constants that are too big are instead
22802 placed into a constant pool and referenced via register indirection.
22804 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
22805 or 4 means that constants of any size are allowed.
22807 @item -mrelax
22808 @opindex mrelax
22809 Enable linker relaxation.  Linker relaxation is a process whereby the
22810 linker attempts to reduce the size of a program by finding shorter
22811 versions of various instructions.  Disabled by default.
22813 @item -mint-register=@var{N}
22814 @opindex mint-register
22815 Specify the number of registers to reserve for fast interrupt handler
22816 functions.  The value @var{N} can be between 0 and 4.  A value of 1
22817 means that register @code{r13} is reserved for the exclusive use
22818 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
22819 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
22820 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
22821 A value of 0, the default, does not reserve any registers.
22823 @item -msave-acc-in-interrupts
22824 @opindex msave-acc-in-interrupts
22825 Specifies that interrupt handler functions should preserve the
22826 accumulator register.  This is only necessary if normal code might use
22827 the accumulator register, for example because it performs 64-bit
22828 multiplications.  The default is to ignore the accumulator as this
22829 makes the interrupt handlers faster.
22831 @item -mpid
22832 @itemx -mno-pid
22833 @opindex mpid
22834 @opindex mno-pid
22835 Enables the generation of position independent data.  When enabled any
22836 access to constant data is done via an offset from a base address
22837 held in a register.  This allows the location of constant data to be
22838 determined at run time without requiring the executable to be
22839 relocated, which is a benefit to embedded applications with tight
22840 memory constraints.  Data that can be modified is not affected by this
22841 option.
22843 Note, using this feature reserves a register, usually @code{r13}, for
22844 the constant data base address.  This can result in slower and/or
22845 larger code, especially in complicated functions.
22847 The actual register chosen to hold the constant data base address
22848 depends upon whether the @option{-msmall-data-limit} and/or the
22849 @option{-mint-register} command-line options are enabled.  Starting
22850 with register @code{r13} and proceeding downwards, registers are
22851 allocated first to satisfy the requirements of @option{-mint-register},
22852 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
22853 is possible for the small data area register to be @code{r8} if both
22854 @option{-mint-register=4} and @option{-mpid} are specified on the
22855 command line.
22857 By default this feature is not enabled.  The default can be restored
22858 via the @option{-mno-pid} command-line option.
22860 @item -mno-warn-multiple-fast-interrupts
22861 @itemx -mwarn-multiple-fast-interrupts
22862 @opindex mno-warn-multiple-fast-interrupts
22863 @opindex mwarn-multiple-fast-interrupts
22864 Prevents GCC from issuing a warning message if it finds more than one
22865 fast interrupt handler when it is compiling a file.  The default is to
22866 issue a warning for each extra fast interrupt handler found, as the RX
22867 only supports one such interrupt.
22869 @item -mallow-string-insns
22870 @itemx -mno-allow-string-insns
22871 @opindex mallow-string-insns
22872 @opindex mno-allow-string-insns
22873 Enables or disables the use of the string manipulation instructions
22874 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
22875 @code{SWHILE} and also the @code{RMPA} instruction.  These
22876 instructions may prefetch data, which is not safe to do if accessing
22877 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
22878 for more information).
22880 The default is to allow these instructions, but it is not possible for
22881 GCC to reliably detect all circumstances where a string instruction
22882 might be used to access an I/O register, so their use cannot be
22883 disabled automatically.  Instead it is reliant upon the programmer to
22884 use the @option{-mno-allow-string-insns} option if their program
22885 accesses I/O space.
22887 When the instructions are enabled GCC defines the C preprocessor
22888 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
22889 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
22891 @item -mjsr
22892 @itemx -mno-jsr
22893 @opindex mjsr
22894 @opindex mno-jsr
22895 Use only (or not only) @code{JSR} instructions to access functions.
22896 This option can be used when code size exceeds the range of @code{BSR}
22897 instructions.  Note that @option{-mno-jsr} does not mean to not use
22898 @code{JSR} but instead means that any type of branch may be used.
22899 @end table
22901 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
22902 has special significance to the RX port when used with the
22903 @code{interrupt} function attribute.  This attribute indicates a
22904 function intended to process fast interrupts.  GCC ensures
22905 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
22906 and/or @code{r13} and only provided that the normal use of the
22907 corresponding registers have been restricted via the
22908 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
22909 options.
22911 @node S/390 and zSeries Options
22912 @subsection S/390 and zSeries Options
22913 @cindex S/390 and zSeries Options
22915 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
22917 @table @gcctabopt
22918 @item -mhard-float
22919 @itemx -msoft-float
22920 @opindex mhard-float
22921 @opindex msoft-float
22922 Use (do not use) the hardware floating-point instructions and registers
22923 for floating-point operations.  When @option{-msoft-float} is specified,
22924 functions in @file{libgcc.a} are used to perform floating-point
22925 operations.  When @option{-mhard-float} is specified, the compiler
22926 generates IEEE floating-point instructions.  This is the default.
22928 @item -mhard-dfp
22929 @itemx -mno-hard-dfp
22930 @opindex mhard-dfp
22931 @opindex mno-hard-dfp
22932 Use (do not use) the hardware decimal-floating-point instructions for
22933 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
22934 specified, functions in @file{libgcc.a} are used to perform
22935 decimal-floating-point operations.  When @option{-mhard-dfp} is
22936 specified, the compiler generates decimal-floating-point hardware
22937 instructions.  This is the default for @option{-march=z9-ec} or higher.
22939 @item -mlong-double-64
22940 @itemx -mlong-double-128
22941 @opindex mlong-double-64
22942 @opindex mlong-double-128
22943 These switches control the size of @code{long double} type. A size
22944 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22945 type. This is the default.
22947 @item -mbackchain
22948 @itemx -mno-backchain
22949 @opindex mbackchain
22950 @opindex mno-backchain
22951 Store (do not store) the address of the caller's frame as backchain pointer
22952 into the callee's stack frame.
22953 A backchain may be needed to allow debugging using tools that do not understand
22954 DWARF call frame information.
22955 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
22956 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
22957 the backchain is placed into the topmost word of the 96/160 byte register
22958 save area.
22960 In general, code compiled with @option{-mbackchain} is call-compatible with
22961 code compiled with @option{-mmo-backchain}; however, use of the backchain
22962 for debugging purposes usually requires that the whole binary is built with
22963 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
22964 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22965 to build a linux kernel use @option{-msoft-float}.
22967 The default is to not maintain the backchain.
22969 @item -mpacked-stack
22970 @itemx -mno-packed-stack
22971 @opindex mpacked-stack
22972 @opindex mno-packed-stack
22973 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
22974 specified, the compiler uses the all fields of the 96/160 byte register save
22975 area only for their default purpose; unused fields still take up stack space.
22976 When @option{-mpacked-stack} is specified, register save slots are densely
22977 packed at the top of the register save area; unused space is reused for other
22978 purposes, allowing for more efficient use of the available stack space.
22979 However, when @option{-mbackchain} is also in effect, the topmost word of
22980 the save area is always used to store the backchain, and the return address
22981 register is always saved two words below the backchain.
22983 As long as the stack frame backchain is not used, code generated with
22984 @option{-mpacked-stack} is call-compatible with code generated with
22985 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
22986 S/390 or zSeries generated code that uses the stack frame backchain at run
22987 time, not just for debugging purposes.  Such code is not call-compatible
22988 with code compiled with @option{-mpacked-stack}.  Also, note that the
22989 combination of @option{-mbackchain},
22990 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
22991 to build a linux kernel use @option{-msoft-float}.
22993 The default is to not use the packed stack layout.
22995 @item -msmall-exec
22996 @itemx -mno-small-exec
22997 @opindex msmall-exec
22998 @opindex mno-small-exec
22999 Generate (or do not generate) code using the @code{bras} instruction
23000 to do subroutine calls.
23001 This only works reliably if the total executable size does not
23002 exceed 64k.  The default is to use the @code{basr} instruction instead,
23003 which does not have this limitation.
23005 @item -m64
23006 @itemx -m31
23007 @opindex m64
23008 @opindex m31
23009 When @option{-m31} is specified, generate code compliant to the
23010 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23011 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23012 particular to generate 64-bit instructions.  For the @samp{s390}
23013 targets, the default is @option{-m31}, while the @samp{s390x}
23014 targets default to @option{-m64}.
23016 @item -mzarch
23017 @itemx -mesa
23018 @opindex mzarch
23019 @opindex mesa
23020 When @option{-mzarch} is specified, generate code using the
23021 instructions available on z/Architecture.
23022 When @option{-mesa} is specified, generate code using the
23023 instructions available on ESA/390.  Note that @option{-mesa} is
23024 not possible with @option{-m64}.
23025 When generating code compliant to the GNU/Linux for S/390 ABI,
23026 the default is @option{-mesa}.  When generating code compliant
23027 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23029 @item -mhtm
23030 @itemx -mno-htm
23031 @opindex mhtm
23032 @opindex mno-htm
23033 The @option{-mhtm} option enables a set of builtins making use of
23034 instructions available with the transactional execution facility
23035 introduced with the IBM zEnterprise EC12 machine generation
23036 @ref{S/390 System z Built-in Functions}.
23037 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23039 @item -mvx
23040 @itemx -mno-vx
23041 @opindex mvx
23042 @opindex mno-vx
23043 When @option{-mvx} is specified, generate code using the instructions
23044 available with the vector extension facility introduced with the IBM
23045 z13 machine generation.
23046 This option changes the ABI for some vector type values with regard to
23047 alignment and calling conventions.  In case vector type values are
23048 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23049 command will be added to mark the resulting binary with the ABI used.
23050 @option{-mvx} is enabled by default when using @option{-march=z13}.
23052 @item -mzvector
23053 @itemx -mno-zvector
23054 @opindex mzvector
23055 @opindex mno-zvector
23056 The @option{-mzvector} option enables vector language extensions and
23057 builtins using instructions available with the vector extension
23058 facility introduced with the IBM z13 machine generation.
23059 This option adds support for @samp{vector} to be used as a keyword to
23060 define vector type variables and arguments.  @samp{vector} is only
23061 available when GNU extensions are enabled.  It will not be expanded
23062 when requesting strict standard compliance e.g. with @option{-std=c99}.
23063 In addition to the GCC low-level builtins @option{-mzvector} enables
23064 a set of builtins added for compatibility with AltiVec-style
23065 implementations like Power and Cell.  In order to make use of these
23066 builtins the header file @file{vecintrin.h} needs to be included.
23067 @option{-mzvector} is disabled by default.
23069 @item -mmvcle
23070 @itemx -mno-mvcle
23071 @opindex mmvcle
23072 @opindex mno-mvcle
23073 Generate (or do not generate) code using the @code{mvcle} instruction
23074 to perform block moves.  When @option{-mno-mvcle} is specified,
23075 use a @code{mvc} loop instead.  This is the default unless optimizing for
23076 size.
23078 @item -mdebug
23079 @itemx -mno-debug
23080 @opindex mdebug
23081 @opindex mno-debug
23082 Print (or do not print) additional debug information when compiling.
23083 The default is to not print debug information.
23085 @item -march=@var{cpu-type}
23086 @opindex march
23087 Generate code that runs on @var{cpu-type}, which is the name of a
23088 system representing a certain processor type.  Possible values for
23089 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23090 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23091 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23092 @samp{native}.
23094 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23095 @samp{g6} are deprecated and will be removed with future releases.
23097 Specifying @samp{native} as cpu type can be used to select the best
23098 architecture option for the host processor.
23099 @option{-march=native} has no effect if GCC does not recognize the
23100 processor.
23102 @item -mtune=@var{cpu-type}
23103 @opindex mtune
23104 Tune to @var{cpu-type} everything applicable about the generated code,
23105 except for the ABI and the set of available instructions.
23106 The list of @var{cpu-type} values is the same as for @option{-march}.
23107 The default is the value used for @option{-march}.
23109 @item -mtpf-trace
23110 @itemx -mno-tpf-trace
23111 @opindex mtpf-trace
23112 @opindex mno-tpf-trace
23113 Generate code that adds (does not add) in TPF OS specific branches to trace
23114 routines in the operating system.  This option is off by default, even
23115 when compiling for the TPF OS@.
23117 @item -mfused-madd
23118 @itemx -mno-fused-madd
23119 @opindex mfused-madd
23120 @opindex mno-fused-madd
23121 Generate code that uses (does not use) the floating-point multiply and
23122 accumulate instructions.  These instructions are generated by default if
23123 hardware floating point is used.
23125 @item -mwarn-framesize=@var{framesize}
23126 @opindex mwarn-framesize
23127 Emit a warning if the current function exceeds the given frame size.  Because
23128 this is a compile-time check it doesn't need to be a real problem when the program
23129 runs.  It is intended to identify functions that most probably cause
23130 a stack overflow.  It is useful to be used in an environment with limited stack
23131 size e.g.@: the linux kernel.
23133 @item -mwarn-dynamicstack
23134 @opindex mwarn-dynamicstack
23135 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23136 arrays.  This is generally a bad idea with a limited stack size.
23138 @item -mstack-guard=@var{stack-guard}
23139 @itemx -mstack-size=@var{stack-size}
23140 @opindex mstack-guard
23141 @opindex mstack-size
23142 If these options are provided the S/390 back end emits additional instructions in
23143 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23144 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23145 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23146 the frame size of the compiled function is chosen.
23147 These options are intended to be used to help debugging stack overflow problems.
23148 The additionally emitted code causes only little overhead and hence can also be
23149 used in production-like systems without greater performance degradation.  The given
23150 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23151 @var{stack-guard} without exceeding 64k.
23152 In order to be efficient the extra code makes the assumption that the stack starts
23153 at an address aligned to the value given by @var{stack-size}.
23154 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23156 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23157 @opindex mhotpatch
23158 If the hotpatch option is enabled, a ``hot-patching'' function
23159 prologue is generated for all functions in the compilation unit.
23160 The funtion label is prepended with the given number of two-byte
23161 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23162 the label, 2 * @var{post-halfwords} bytes are appended, using the
23163 largest NOP like instructions the architecture allows (maximum
23164 1000000).
23166 If both arguments are zero, hotpatching is disabled.
23168 This option can be overridden for individual functions with the
23169 @code{hotpatch} attribute.
23170 @end table
23172 @node Score Options
23173 @subsection Score Options
23174 @cindex Score Options
23176 These options are defined for Score implementations:
23178 @table @gcctabopt
23179 @item -meb
23180 @opindex meb
23181 Compile code for big-endian mode.  This is the default.
23183 @item -mel
23184 @opindex mel
23185 Compile code for little-endian mode.
23187 @item -mnhwloop
23188 @opindex mnhwloop
23189 Disable generation of @code{bcnz} instructions.
23191 @item -muls
23192 @opindex muls
23193 Enable generation of unaligned load and store instructions.
23195 @item -mmac
23196 @opindex mmac
23197 Enable the use of multiply-accumulate instructions. Disabled by default.
23199 @item -mscore5
23200 @opindex mscore5
23201 Specify the SCORE5 as the target architecture.
23203 @item -mscore5u
23204 @opindex mscore5u
23205 Specify the SCORE5U of the target architecture.
23207 @item -mscore7
23208 @opindex mscore7
23209 Specify the SCORE7 as the target architecture. This is the default.
23211 @item -mscore7d
23212 @opindex mscore7d
23213 Specify the SCORE7D as the target architecture.
23214 @end table
23216 @node SH Options
23217 @subsection SH Options
23219 These @samp{-m} options are defined for the SH implementations:
23221 @table @gcctabopt
23222 @item -m1
23223 @opindex m1
23224 Generate code for the SH1.
23226 @item -m2
23227 @opindex m2
23228 Generate code for the SH2.
23230 @item -m2e
23231 Generate code for the SH2e.
23233 @item -m2a-nofpu
23234 @opindex m2a-nofpu
23235 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23236 that the floating-point unit is not used.
23238 @item -m2a-single-only
23239 @opindex m2a-single-only
23240 Generate code for the SH2a-FPU, in such a way that no double-precision
23241 floating-point operations are used.
23243 @item -m2a-single
23244 @opindex m2a-single
23245 Generate code for the SH2a-FPU assuming the floating-point unit is in
23246 single-precision mode by default.
23248 @item -m2a
23249 @opindex m2a
23250 Generate code for the SH2a-FPU assuming the floating-point unit is in
23251 double-precision mode by default.
23253 @item -m3
23254 @opindex m3
23255 Generate code for the SH3.
23257 @item -m3e
23258 @opindex m3e
23259 Generate code for the SH3e.
23261 @item -m4-nofpu
23262 @opindex m4-nofpu
23263 Generate code for the SH4 without a floating-point unit.
23265 @item -m4-single-only
23266 @opindex m4-single-only
23267 Generate code for the SH4 with a floating-point unit that only
23268 supports single-precision arithmetic.
23270 @item -m4-single
23271 @opindex m4-single
23272 Generate code for the SH4 assuming the floating-point unit is in
23273 single-precision mode by default.
23275 @item -m4
23276 @opindex m4
23277 Generate code for the SH4.
23279 @item -m4-100
23280 @opindex m4-100
23281 Generate code for SH4-100.
23283 @item -m4-100-nofpu
23284 @opindex m4-100-nofpu
23285 Generate code for SH4-100 in such a way that the
23286 floating-point unit is not used.
23288 @item -m4-100-single
23289 @opindex m4-100-single
23290 Generate code for SH4-100 assuming the floating-point unit is in
23291 single-precision mode by default.
23293 @item -m4-100-single-only
23294 @opindex m4-100-single-only
23295 Generate code for SH4-100 in such a way that no double-precision
23296 floating-point operations are used.
23298 @item -m4-200
23299 @opindex m4-200
23300 Generate code for SH4-200.
23302 @item -m4-200-nofpu
23303 @opindex m4-200-nofpu
23304 Generate code for SH4-200 without in such a way that the
23305 floating-point unit is not used.
23307 @item -m4-200-single
23308 @opindex m4-200-single
23309 Generate code for SH4-200 assuming the floating-point unit is in
23310 single-precision mode by default.
23312 @item -m4-200-single-only
23313 @opindex m4-200-single-only
23314 Generate code for SH4-200 in such a way that no double-precision
23315 floating-point operations are used.
23317 @item -m4-300
23318 @opindex m4-300
23319 Generate code for SH4-300.
23321 @item -m4-300-nofpu
23322 @opindex m4-300-nofpu
23323 Generate code for SH4-300 without in such a way that the
23324 floating-point unit is not used.
23326 @item -m4-300-single
23327 @opindex m4-300-single
23328 Generate code for SH4-300 in such a way that no double-precision
23329 floating-point operations are used.
23331 @item -m4-300-single-only
23332 @opindex m4-300-single-only
23333 Generate code for SH4-300 in such a way that no double-precision
23334 floating-point operations are used.
23336 @item -m4-340
23337 @opindex m4-340
23338 Generate code for SH4-340 (no MMU, no FPU).
23340 @item -m4-500
23341 @opindex m4-500
23342 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23343 assembler.
23345 @item -m4a-nofpu
23346 @opindex m4a-nofpu
23347 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23348 floating-point unit is not used.
23350 @item -m4a-single-only
23351 @opindex m4a-single-only
23352 Generate code for the SH4a, in such a way that no double-precision
23353 floating-point operations are used.
23355 @item -m4a-single
23356 @opindex m4a-single
23357 Generate code for the SH4a assuming the floating-point unit is in
23358 single-precision mode by default.
23360 @item -m4a
23361 @opindex m4a
23362 Generate code for the SH4a.
23364 @item -m4al
23365 @opindex m4al
23366 Same as @option{-m4a-nofpu}, except that it implicitly passes
23367 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23368 instructions at the moment.
23370 @item -mb
23371 @opindex mb
23372 Compile code for the processor in big-endian mode.
23374 @item -ml
23375 @opindex ml
23376 Compile code for the processor in little-endian mode.
23378 @item -mdalign
23379 @opindex mdalign
23380 Align doubles at 64-bit boundaries.  Note that this changes the calling
23381 conventions, and thus some functions from the standard C library do
23382 not work unless you recompile it first with @option{-mdalign}.
23384 @item -mrelax
23385 @opindex mrelax
23386 Shorten some address references at link time, when possible; uses the
23387 linker option @option{-relax}.
23389 @item -mbigtable
23390 @opindex mbigtable
23391 Use 32-bit offsets in @code{switch} tables.  The default is to use
23392 16-bit offsets.
23394 @item -mbitops
23395 @opindex mbitops
23396 Enable the use of bit manipulation instructions on SH2A.
23398 @item -mfmovd
23399 @opindex mfmovd
23400 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23401 alignment constraints.
23403 @item -mrenesas
23404 @opindex mrenesas
23405 Comply with the calling conventions defined by Renesas.
23407 @item -mno-renesas
23408 @opindex mno-renesas
23409 Comply with the calling conventions defined for GCC before the Renesas
23410 conventions were available.  This option is the default for all
23411 targets of the SH toolchain.
23413 @item -mnomacsave
23414 @opindex mnomacsave
23415 Mark the @code{MAC} register as call-clobbered, even if
23416 @option{-mrenesas} is given.
23418 @item -mieee
23419 @itemx -mno-ieee
23420 @opindex mieee
23421 @opindex mno-ieee
23422 Control the IEEE compliance of floating-point comparisons, which affects the
23423 handling of cases where the result of a comparison is unordered.  By default
23424 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23425 enabled @option{-mno-ieee} is implicitly set, which results in faster
23426 floating-point greater-equal and less-equal comparisons.  The implicit settings
23427 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23429 @item -minline-ic_invalidate
23430 @opindex minline-ic_invalidate
23431 Inline code to invalidate instruction cache entries after setting up
23432 nested function trampolines.
23433 This option has no effect if @option{-musermode} is in effect and the selected
23434 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23435 instruction.
23436 If the selected code generation option does not allow the use of the @code{icbi}
23437 instruction, and @option{-musermode} is not in effect, the inlined code
23438 manipulates the instruction cache address array directly with an associative
23439 write.  This not only requires privileged mode at run time, but it also
23440 fails if the cache line had been mapped via the TLB and has become unmapped.
23442 @item -misize
23443 @opindex misize
23444 Dump instruction size and location in the assembly code.
23446 @item -mpadstruct
23447 @opindex mpadstruct
23448 This option is deprecated.  It pads structures to multiple of 4 bytes,
23449 which is incompatible with the SH ABI@.
23451 @item -matomic-model=@var{model}
23452 @opindex matomic-model=@var{model}
23453 Sets the model of atomic operations and additional parameters as a comma
23454 separated list.  For details on the atomic built-in functions see
23455 @ref{__atomic Builtins}.  The following models and parameters are supported:
23457 @table @samp
23459 @item none
23460 Disable compiler generated atomic sequences and emit library calls for atomic
23461 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23463 @item soft-gusa
23464 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23465 built-in functions.  The generated atomic sequences require additional support
23466 from the interrupt/exception handling code of the system and are only suitable
23467 for SH3* and SH4* single-core systems.  This option is enabled by default when
23468 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23469 this option also partially utilizes the hardware atomic instructions
23470 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23471 @samp{strict} is specified.  
23473 @item soft-tcb
23474 Generate software atomic sequences that use a variable in the thread control
23475 block.  This is a variation of the gUSA sequences which can also be used on
23476 SH1* and SH2* targets.  The generated atomic sequences require additional
23477 support from the interrupt/exception handling code of the system and are only
23478 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23479 parameter has to be specified as well.
23481 @item soft-imask
23482 Generate software atomic sequences that temporarily disable interrupts by
23483 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23484 in privileged mode and is only suitable for single-core systems.  Additional
23485 support from the interrupt/exception handling code of the system is not
23486 required.  This model is enabled by default when the target is
23487 @code{sh*-*-linux*} and SH1* or SH2*.
23489 @item hard-llcs
23490 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23491 instructions only.  This is only available on SH4A and is suitable for
23492 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23493 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23494 Code compiled with this option is also compatible with other software
23495 atomic model interrupt/exception handling systems if executed on an SH4A
23496 system.  Additional support from the interrupt/exception handling code of the
23497 system is not required for this model.
23499 @item gbr-offset=
23500 This parameter specifies the offset in bytes of the variable in the thread
23501 control block structure that should be used by the generated atomic sequences
23502 when the @samp{soft-tcb} model has been selected.  For other models this
23503 parameter is ignored.  The specified value must be an integer multiple of four
23504 and in the range 0-1020.
23506 @item strict
23507 This parameter prevents mixed usage of multiple atomic models, even if they
23508 are compatible, and makes the compiler generate atomic sequences of the
23509 specified model only.
23511 @end table
23513 @item -mtas
23514 @opindex mtas
23515 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23516 Notice that depending on the particular hardware and software configuration
23517 this can degrade overall performance due to the operand cache line flushes
23518 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23519 processors the @code{tas.b} instruction must be used with caution since it
23520 can result in data corruption for certain cache configurations.
23522 @item -mprefergot
23523 @opindex mprefergot
23524 When generating position-independent code, emit function calls using
23525 the Global Offset Table instead of the Procedure Linkage Table.
23527 @item -musermode
23528 @itemx -mno-usermode
23529 @opindex musermode
23530 @opindex mno-usermode
23531 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23532 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23533 inlined code would not work in user mode.  @option{-musermode} is the default
23534 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23535 @option{-musermode} has no effect, since there is no user mode.
23537 @item -multcost=@var{number}
23538 @opindex multcost=@var{number}
23539 Set the cost to assume for a multiply insn.
23541 @item -mdiv=@var{strategy}
23542 @opindex mdiv=@var{strategy}
23543 Set the division strategy to be used for integer division operations.
23544 @var{strategy} can be one of: 
23546 @table @samp
23548 @item call-div1
23549 Calls a library function that uses the single-step division instruction
23550 @code{div1} to perform the operation.  Division by zero calculates an
23551 unspecified result and does not trap.  This is the default except for SH4,
23552 SH2A and SHcompact.
23554 @item call-fp
23555 Calls a library function that performs the operation in double precision
23556 floating point.  Division by zero causes a floating-point exception.  This is
23557 the default for SHcompact with FPU.  Specifying this for targets that do not
23558 have a double precision FPU defaults to @code{call-div1}.
23560 @item call-table
23561 Calls a library function that uses a lookup table for small divisors and
23562 the @code{div1} instruction with case distinction for larger divisors.  Division
23563 by zero calculates an unspecified result and does not trap.  This is the default
23564 for SH4.  Specifying this for targets that do not have dynamic shift
23565 instructions defaults to @code{call-div1}.
23567 @end table
23569 When a division strategy has not been specified the default strategy is
23570 selected based on the current target.  For SH2A the default strategy is to
23571 use the @code{divs} and @code{divu} instructions instead of library function
23572 calls.
23574 @item -maccumulate-outgoing-args
23575 @opindex maccumulate-outgoing-args
23576 Reserve space once for outgoing arguments in the function prologue rather
23577 than around each call.  Generally beneficial for performance and size.  Also
23578 needed for unwinding to avoid changing the stack frame around conditional code.
23580 @item -mdivsi3_libfunc=@var{name}
23581 @opindex mdivsi3_libfunc=@var{name}
23582 Set the name of the library function used for 32-bit signed division to
23583 @var{name}.
23584 This only affects the name used in the @samp{call} division strategies, and
23585 the compiler still expects the same sets of input/output/clobbered registers as
23586 if this option were not present.
23588 @item -mfixed-range=@var{register-range}
23589 @opindex mfixed-range
23590 Generate code treating the given register range as fixed registers.
23591 A fixed register is one that the register allocator can not use.  This is
23592 useful when compiling kernel code.  A register range is specified as
23593 two registers separated by a dash.  Multiple register ranges can be
23594 specified separated by a comma.
23596 @item -mbranch-cost=@var{num}
23597 @opindex mbranch-cost=@var{num}
23598 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23599 make the compiler try to generate more branch-free code if possible.  
23600 If not specified the value is selected depending on the processor type that
23601 is being compiled for.
23603 @item -mzdcbranch
23604 @itemx -mno-zdcbranch
23605 @opindex mzdcbranch
23606 @opindex mno-zdcbranch
23607 Assume (do not assume) that zero displacement conditional branch instructions
23608 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23609 compiler prefers zero displacement branch code sequences.  This is
23610 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23611 disabled by specifying @option{-mno-zdcbranch}.
23613 @item -mcbranch-force-delay-slot
23614 @opindex mcbranch-force-delay-slot
23615 Force the usage of delay slots for conditional branches, which stuffs the delay
23616 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23617 this option is disabled.  It can be enabled to work around hardware bugs as
23618 found in the original SH7055.
23620 @item -mfused-madd
23621 @itemx -mno-fused-madd
23622 @opindex mfused-madd
23623 @opindex mno-fused-madd
23624 Generate code that uses (does not use) the floating-point multiply and
23625 accumulate instructions.  These instructions are generated by default
23626 if hardware floating point is used.  The machine-dependent
23627 @option{-mfused-madd} option is now mapped to the machine-independent
23628 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23629 mapped to @option{-ffp-contract=off}.
23631 @item -mfsca
23632 @itemx -mno-fsca
23633 @opindex mfsca
23634 @opindex mno-fsca
23635 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23636 and cosine approximations.  The option @option{-mfsca} must be used in
23637 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23638 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23639 approximations even if @option{-funsafe-math-optimizations} is in effect.
23641 @item -mfsrra
23642 @itemx -mno-fsrra
23643 @opindex mfsrra
23644 @opindex mno-fsrra
23645 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23646 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23647 in combination with @option{-funsafe-math-optimizations} and
23648 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23649 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23650 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23651 in effect.
23653 @item -mpretend-cmove
23654 @opindex mpretend-cmove
23655 Prefer zero-displacement conditional branches for conditional move instruction
23656 patterns.  This can result in faster code on the SH4 processor.
23658 @item -mfdpic
23659 @opindex fdpic
23660 Generate code using the FDPIC ABI.
23662 @end table
23664 @node Solaris 2 Options
23665 @subsection Solaris 2 Options
23666 @cindex Solaris 2 options
23668 These @samp{-m} options are supported on Solaris 2:
23670 @table @gcctabopt
23671 @item -mclear-hwcap
23672 @opindex mclear-hwcap
23673 @option{-mclear-hwcap} tells the compiler to remove the hardware
23674 capabilities generated by the Solaris assembler.  This is only necessary
23675 when object files use ISA extensions not supported by the current
23676 machine, but check at runtime whether or not to use them.
23678 @item -mimpure-text
23679 @opindex mimpure-text
23680 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23681 the compiler to not pass @option{-z text} to the linker when linking a
23682 shared object.  Using this option, you can link position-dependent
23683 code into a shared object.
23685 @option{-mimpure-text} suppresses the ``relocations remain against
23686 allocatable but non-writable sections'' linker error message.
23687 However, the necessary relocations trigger copy-on-write, and the
23688 shared object is not actually shared across processes.  Instead of
23689 using @option{-mimpure-text}, you should compile all source code with
23690 @option{-fpic} or @option{-fPIC}.
23692 @end table
23694 These switches are supported in addition to the above on Solaris 2:
23696 @table @gcctabopt
23697 @item -pthreads
23698 @opindex pthreads
23699 This is a synonym for @option{-pthread}.
23700 @end table
23702 @node SPARC Options
23703 @subsection SPARC Options
23704 @cindex SPARC options
23706 These @samp{-m} options are supported on the SPARC:
23708 @table @gcctabopt
23709 @item -mno-app-regs
23710 @itemx -mapp-regs
23711 @opindex mno-app-regs
23712 @opindex mapp-regs
23713 Specify @option{-mapp-regs} to generate output using the global registers
23714 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23715 global register 1, each global register 2 through 4 is then treated as an
23716 allocable register that is clobbered by function calls.  This is the default.
23718 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23719 specify @option{-mno-app-regs}.  You should compile libraries and system
23720 software with this option.
23722 @item -mflat
23723 @itemx -mno-flat
23724 @opindex mflat
23725 @opindex mno-flat
23726 With @option{-mflat}, the compiler does not generate save/restore instructions
23727 and uses a ``flat'' or single register window model.  This model is compatible
23728 with the regular register window model.  The local registers and the input
23729 registers (0--5) are still treated as ``call-saved'' registers and are
23730 saved on the stack as needed.
23732 With @option{-mno-flat} (the default), the compiler generates save/restore
23733 instructions (except for leaf functions).  This is the normal operating mode.
23735 @item -mfpu
23736 @itemx -mhard-float
23737 @opindex mfpu
23738 @opindex mhard-float
23739 Generate output containing floating-point instructions.  This is the
23740 default.
23742 @item -mno-fpu
23743 @itemx -msoft-float
23744 @opindex mno-fpu
23745 @opindex msoft-float
23746 Generate output containing library calls for floating point.
23747 @strong{Warning:} the requisite libraries are not available for all SPARC
23748 targets.  Normally the facilities of the machine's usual C compiler are
23749 used, but this cannot be done directly in cross-compilation.  You must make
23750 your own arrangements to provide suitable library functions for
23751 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23752 @samp{sparclite-*-*} do provide software floating-point support.
23754 @option{-msoft-float} changes the calling convention in the output file;
23755 therefore, it is only useful if you compile @emph{all} of a program with
23756 this option.  In particular, you need to compile @file{libgcc.a}, the
23757 library that comes with GCC, with @option{-msoft-float} in order for
23758 this to work.
23760 @item -mhard-quad-float
23761 @opindex mhard-quad-float
23762 Generate output containing quad-word (long double) floating-point
23763 instructions.
23765 @item -msoft-quad-float
23766 @opindex msoft-quad-float
23767 Generate output containing library calls for quad-word (long double)
23768 floating-point instructions.  The functions called are those specified
23769 in the SPARC ABI@.  This is the default.
23771 As of this writing, there are no SPARC implementations that have hardware
23772 support for the quad-word floating-point instructions.  They all invoke
23773 a trap handler for one of these instructions, and then the trap handler
23774 emulates the effect of the instruction.  Because of the trap handler overhead,
23775 this is much slower than calling the ABI library routines.  Thus the
23776 @option{-msoft-quad-float} option is the default.
23778 @item -mno-unaligned-doubles
23779 @itemx -munaligned-doubles
23780 @opindex mno-unaligned-doubles
23781 @opindex munaligned-doubles
23782 Assume that doubles have 8-byte alignment.  This is the default.
23784 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23785 alignment only if they are contained in another type, or if they have an
23786 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23787 Specifying this option avoids some rare compatibility problems with code
23788 generated by other compilers.  It is not the default because it results
23789 in a performance loss, especially for floating-point code.
23791 @item -muser-mode
23792 @itemx -mno-user-mode
23793 @opindex muser-mode
23794 @opindex mno-user-mode
23795 Do not generate code that can only run in supervisor mode.  This is relevant
23796 only for the @code{casa} instruction emitted for the LEON3 processor.  This
23797 is the default.
23799 @item -mfaster-structs
23800 @itemx -mno-faster-structs
23801 @opindex mfaster-structs
23802 @opindex mno-faster-structs
23803 With @option{-mfaster-structs}, the compiler assumes that structures
23804 should have 8-byte alignment.  This enables the use of pairs of
23805 @code{ldd} and @code{std} instructions for copies in structure
23806 assignment, in place of twice as many @code{ld} and @code{st} pairs.
23807 However, the use of this changed alignment directly violates the SPARC
23808 ABI@.  Thus, it's intended only for use on targets where the developer
23809 acknowledges that their resulting code is not directly in line with
23810 the rules of the ABI@.
23812 @item -mstd-struct-return
23813 @itemx -mno-std-struct-return
23814 @opindex mstd-struct-return
23815 @opindex mno-std-struct-return
23816 With @option{-mstd-struct-return}, the compiler generates checking code
23817 in functions returning structures or unions to detect size mismatches
23818 between the two sides of function calls, as per the 32-bit ABI@.
23820 The default is @option{-mno-std-struct-return}.  This option has no effect
23821 in 64-bit mode.
23823 @item -mlra
23824 @itemx -mno-lra
23825 @opindex mlra
23826 @opindex mno-lra
23827 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
23828 so @option{-mno-lra} needs to be passed to get old Reload.
23830 @item -mcpu=@var{cpu_type}
23831 @opindex mcpu
23832 Set the instruction set, register set, and instruction scheduling parameters
23833 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
23834 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
23835 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
23836 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
23837 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
23838 @samp{niagara3}, @samp{niagara4} and @samp{niagara7}.
23840 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
23841 which selects the best architecture option for the host processor.
23842 @option{-mcpu=native} has no effect if GCC does not recognize
23843 the processor.
23845 Default instruction scheduling parameters are used for values that select
23846 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
23847 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
23849 Here is a list of each supported architecture and their supported
23850 implementations.
23852 @table @asis
23853 @item v7
23854 cypress, leon3v7
23856 @item v8
23857 supersparc, hypersparc, leon, leon3
23859 @item sparclite
23860 f930, f934, sparclite86x
23862 @item sparclet
23863 tsc701
23865 @item v9
23866 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, niagara7
23867 @end table
23869 By default (unless configured otherwise), GCC generates code for the V7
23870 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
23871 additionally optimizes it for the Cypress CY7C602 chip, as used in the
23872 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
23873 SPARCStation 1, 2, IPX etc.
23875 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
23876 architecture.  The only difference from V7 code is that the compiler emits
23877 the integer multiply and integer divide instructions which exist in SPARC-V8
23878 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
23879 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
23880 2000 series.
23882 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
23883 the SPARC architecture.  This adds the integer multiply, integer divide step
23884 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
23885 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
23886 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
23887 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
23888 MB86934 chip, which is the more recent SPARClite with FPU@.
23890 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
23891 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
23892 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
23893 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
23894 optimizes it for the TEMIC SPARClet chip.
23896 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
23897 architecture.  This adds 64-bit integer and floating-point move instructions,
23898 3 additional floating-point condition code registers and conditional move
23899 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
23900 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
23901 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
23902 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
23903 @option{-mcpu=niagara}, the compiler additionally optimizes it for
23904 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
23905 additionally optimizes it for Sun UltraSPARC T2 chips. With
23906 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
23907 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
23908 additionally optimizes it for Sun UltraSPARC T4 chips.  With
23909 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
23910 Oracle SPARC M7 chips.
23912 @item -mtune=@var{cpu_type}
23913 @opindex mtune
23914 Set the instruction scheduling parameters for machine type
23915 @var{cpu_type}, but do not set the instruction set or register set that the
23916 option @option{-mcpu=@var{cpu_type}} does.
23918 The same values for @option{-mcpu=@var{cpu_type}} can be used for
23919 @option{-mtune=@var{cpu_type}}, but the only useful values are those
23920 that select a particular CPU implementation.  Those are
23921 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
23922 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
23923 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
23924 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
23925 @samp{niagara4} and @samp{niagara7}.  With native Solaris and
23926 GNU/Linux toolchains, @samp{native} can also be used.
23928 @item -mv8plus
23929 @itemx -mno-v8plus
23930 @opindex mv8plus
23931 @opindex mno-v8plus
23932 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
23933 difference from the V8 ABI is that the global and out registers are
23934 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
23935 mode for all SPARC-V9 processors.
23937 @item -mvis
23938 @itemx -mno-vis
23939 @opindex mvis
23940 @opindex mno-vis
23941 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
23942 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
23944 @item -mvis2
23945 @itemx -mno-vis2
23946 @opindex mvis2
23947 @opindex mno-vis2
23948 With @option{-mvis2}, GCC generates code that takes advantage of
23949 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
23950 default is @option{-mvis2} when targeting a cpu that supports such
23951 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
23952 also sets @option{-mvis}.
23954 @item -mvis3
23955 @itemx -mno-vis3
23956 @opindex mvis3
23957 @opindex mno-vis3
23958 With @option{-mvis3}, GCC generates code that takes advantage of
23959 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
23960 default is @option{-mvis3} when targeting a cpu that supports such
23961 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
23962 also sets @option{-mvis2} and @option{-mvis}.
23964 @item -mvis4
23965 @itemx -mno-vis4
23966 @opindex mvis4
23967 @opindex mno-vis4
23968 With @option{-mvis4}, GCC generates code that takes advantage of
23969 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
23970 default is @option{-mvis4} when targeting a cpu that supports such
23971 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
23972 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
23974 @item -mcbcond
23975 @itemx -mno-cbcond
23976 @opindex mcbcond
23977 @opindex mno-cbcond
23978 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
23979 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
23980 when targeting a CPU that supports such instructions, such as Niagara-4 and
23981 later.
23983 @item -mfmaf
23984 @itemx -mno-fmaf
23985 @opindex mfmaf
23986 @opindex mno-fmaf
23987 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
23988 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
23989 when targeting a CPU that supports such instructions, such as Niagara-3 and
23990 later.
23992 @item -mpopc
23993 @itemx -mno-popc
23994 @opindex mpopc
23995 @opindex mno-popc
23996 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
23997 Population Count instruction.  The default is @option{-mpopc}
23998 when targeting a CPU that supports such an instruction, such as Niagara-2 and
23999 later.
24001 @item -msubxc
24002 @itemx -mno-subxc
24003 @opindex msubxc
24004 @opindex mno-subxc
24005 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24006 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24007 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24008 later.
24010 @item -mfix-at697f
24011 @opindex mfix-at697f
24012 Enable the documented workaround for the single erratum of the Atmel AT697F
24013 processor (which corresponds to erratum #13 of the AT697E processor).
24015 @item -mfix-ut699
24016 @opindex mfix-ut699
24017 Enable the documented workarounds for the floating-point errata and the data
24018 cache nullify errata of the UT699 processor.
24019 @end table
24021 These @samp{-m} options are supported in addition to the above
24022 on SPARC-V9 processors in 64-bit environments:
24024 @table @gcctabopt
24025 @item -m32
24026 @itemx -m64
24027 @opindex m32
24028 @opindex m64
24029 Generate code for a 32-bit or 64-bit environment.
24030 The 32-bit environment sets int, long and pointer to 32 bits.
24031 The 64-bit environment sets int to 32 bits and long and pointer
24032 to 64 bits.
24034 @item -mcmodel=@var{which}
24035 @opindex mcmodel
24036 Set the code model to one of
24038 @table @samp
24039 @item medlow
24040 The Medium/Low code model: 64-bit addresses, programs
24041 must be linked in the low 32 bits of memory.  Programs can be statically
24042 or dynamically linked.
24044 @item medmid
24045 The Medium/Middle code model: 64-bit addresses, programs
24046 must be linked in the low 44 bits of memory, the text and data segments must
24047 be less than 2GB in size and the data segment must be located within 2GB of
24048 the text segment.
24050 @item medany
24051 The Medium/Anywhere code model: 64-bit addresses, programs
24052 may be linked anywhere in memory, the text and data segments must be less
24053 than 2GB in size and the data segment must be located within 2GB of the
24054 text segment.
24056 @item embmedany
24057 The Medium/Anywhere code model for embedded systems:
24058 64-bit addresses, the text and data segments must be less than 2GB in
24059 size, both starting anywhere in memory (determined at link time).  The
24060 global register %g4 points to the base of the data segment.  Programs
24061 are statically linked and PIC is not supported.
24062 @end table
24064 @item -mmemory-model=@var{mem-model}
24065 @opindex mmemory-model
24066 Set the memory model in force on the processor to one of
24068 @table @samp
24069 @item default
24070 The default memory model for the processor and operating system.
24072 @item rmo
24073 Relaxed Memory Order
24075 @item pso
24076 Partial Store Order
24078 @item tso
24079 Total Store Order
24081 @item sc
24082 Sequential Consistency
24083 @end table
24085 These memory models are formally defined in Appendix D of the SPARC-V9
24086 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24088 @item -mstack-bias
24089 @itemx -mno-stack-bias
24090 @opindex mstack-bias
24091 @opindex mno-stack-bias
24092 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24093 frame pointer if present, are offset by @minus{}2047 which must be added back
24094 when making stack frame references.  This is the default in 64-bit mode.
24095 Otherwise, assume no such offset is present.
24096 @end table
24098 @node SPU Options
24099 @subsection SPU Options
24100 @cindex SPU options
24102 These @samp{-m} options are supported on the SPU:
24104 @table @gcctabopt
24105 @item -mwarn-reloc
24106 @itemx -merror-reloc
24107 @opindex mwarn-reloc
24108 @opindex merror-reloc
24110 The loader for SPU does not handle dynamic relocations.  By default, GCC
24111 gives an error when it generates code that requires a dynamic
24112 relocation.  @option{-mno-error-reloc} disables the error,
24113 @option{-mwarn-reloc} generates a warning instead.
24115 @item -msafe-dma
24116 @itemx -munsafe-dma
24117 @opindex msafe-dma
24118 @opindex munsafe-dma
24120 Instructions that initiate or test completion of DMA must not be
24121 reordered with respect to loads and stores of the memory that is being
24122 accessed.
24123 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24124 memory accesses, but that can lead to inefficient code in places where the
24125 memory is known to not change.  Rather than mark the memory as volatile,
24126 you can use @option{-msafe-dma} to tell the compiler to treat
24127 the DMA instructions as potentially affecting all memory.  
24129 @item -mbranch-hints
24130 @opindex mbranch-hints
24132 By default, GCC generates a branch hint instruction to avoid
24133 pipeline stalls for always-taken or probably-taken branches.  A hint
24134 is not generated closer than 8 instructions away from its branch.
24135 There is little reason to disable them, except for debugging purposes,
24136 or to make an object a little bit smaller.
24138 @item -msmall-mem
24139 @itemx -mlarge-mem
24140 @opindex msmall-mem
24141 @opindex mlarge-mem
24143 By default, GCC generates code assuming that addresses are never larger
24144 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24145 a full 32-bit address.
24147 @item -mstdmain
24148 @opindex mstdmain
24150 By default, GCC links against startup code that assumes the SPU-style
24151 main function interface (which has an unconventional parameter list).
24152 With @option{-mstdmain}, GCC links your program against startup
24153 code that assumes a C99-style interface to @code{main}, including a
24154 local copy of @code{argv} strings.
24156 @item -mfixed-range=@var{register-range}
24157 @opindex mfixed-range
24158 Generate code treating the given register range as fixed registers.
24159 A fixed register is one that the register allocator cannot use.  This is
24160 useful when compiling kernel code.  A register range is specified as
24161 two registers separated by a dash.  Multiple register ranges can be
24162 specified separated by a comma.
24164 @item -mea32
24165 @itemx -mea64
24166 @opindex mea32
24167 @opindex mea64
24168 Compile code assuming that pointers to the PPU address space accessed
24169 via the @code{__ea} named address space qualifier are either 32 or 64
24170 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24171 all object code in an executable must be compiled with the same setting.
24173 @item -maddress-space-conversion
24174 @itemx -mno-address-space-conversion
24175 @opindex maddress-space-conversion
24176 @opindex mno-address-space-conversion
24177 Allow/disallow treating the @code{__ea} address space as superset
24178 of the generic address space.  This enables explicit type casts
24179 between @code{__ea} and generic pointer as well as implicit
24180 conversions of generic pointers to @code{__ea} pointers.  The
24181 default is to allow address space pointer conversions.
24183 @item -mcache-size=@var{cache-size}
24184 @opindex mcache-size
24185 This option controls the version of libgcc that the compiler links to an
24186 executable and selects a software-managed cache for accessing variables
24187 in the @code{__ea} address space with a particular cache size.  Possible
24188 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24189 and @samp{128}.  The default cache size is 64KB.
24191 @item -matomic-updates
24192 @itemx -mno-atomic-updates
24193 @opindex matomic-updates
24194 @opindex mno-atomic-updates
24195 This option controls the version of libgcc that the compiler links to an
24196 executable and selects whether atomic updates to the software-managed
24197 cache of PPU-side variables are used.  If you use atomic updates, changes
24198 to a PPU variable from SPU code using the @code{__ea} named address space
24199 qualifier do not interfere with changes to other PPU variables residing
24200 in the same cache line from PPU code.  If you do not use atomic updates,
24201 such interference may occur; however, writing back cache lines is
24202 more efficient.  The default behavior is to use atomic updates.
24204 @item -mdual-nops
24205 @itemx -mdual-nops=@var{n}
24206 @opindex mdual-nops
24207 By default, GCC inserts NOPs to increase dual issue when it expects
24208 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24209 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24210 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24212 @item -mhint-max-nops=@var{n}
24213 @opindex mhint-max-nops
24214 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24215 be at least 8 instructions away from the branch it is affecting.  GCC
24216 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24217 generate the branch hint.
24219 @item -mhint-max-distance=@var{n}
24220 @opindex mhint-max-distance
24221 The encoding of the branch hint instruction limits the hint to be within
24222 256 instructions of the branch it is affecting.  By default, GCC makes
24223 sure it is within 125.
24225 @item -msafe-hints
24226 @opindex msafe-hints
24227 Work around a hardware bug that causes the SPU to stall indefinitely.
24228 By default, GCC inserts the @code{hbrp} instruction to make sure
24229 this stall won't happen.
24231 @end table
24233 @node System V Options
24234 @subsection Options for System V
24236 These additional options are available on System V Release 4 for
24237 compatibility with other compilers on those systems:
24239 @table @gcctabopt
24240 @item -G
24241 @opindex G
24242 Create a shared object.
24243 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24245 @item -Qy
24246 @opindex Qy
24247 Identify the versions of each tool used by the compiler, in a
24248 @code{.ident} assembler directive in the output.
24250 @item -Qn
24251 @opindex Qn
24252 Refrain from adding @code{.ident} directives to the output file (this is
24253 the default).
24255 @item -YP,@var{dirs}
24256 @opindex YP
24257 Search the directories @var{dirs}, and no others, for libraries
24258 specified with @option{-l}.
24260 @item -Ym,@var{dir}
24261 @opindex Ym
24262 Look in the directory @var{dir} to find the M4 preprocessor.
24263 The assembler uses this option.
24264 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24265 @c the generic assembler that comes with Solaris takes just -Ym.
24266 @end table
24268 @node TILE-Gx Options
24269 @subsection TILE-Gx Options
24270 @cindex TILE-Gx options
24272 These @samp{-m} options are supported on the TILE-Gx:
24274 @table @gcctabopt
24275 @item -mcmodel=small
24276 @opindex mcmodel=small
24277 Generate code for the small model.  The distance for direct calls is
24278 limited to 500M in either direction.  PC-relative addresses are 32
24279 bits.  Absolute addresses support the full address range.
24281 @item -mcmodel=large
24282 @opindex mcmodel=large
24283 Generate code for the large model.  There is no limitation on call
24284 distance, pc-relative addresses, or absolute addresses.
24286 @item -mcpu=@var{name}
24287 @opindex mcpu
24288 Selects the type of CPU to be targeted.  Currently the only supported
24289 type is @samp{tilegx}.
24291 @item -m32
24292 @itemx -m64
24293 @opindex m32
24294 @opindex m64
24295 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24296 environment sets int, long, and pointer to 32 bits.  The 64-bit
24297 environment sets int to 32 bits and long and pointer to 64 bits.
24299 @item -mbig-endian
24300 @itemx -mlittle-endian
24301 @opindex mbig-endian
24302 @opindex mlittle-endian
24303 Generate code in big/little endian mode, respectively.
24304 @end table
24306 @node TILEPro Options
24307 @subsection TILEPro Options
24308 @cindex TILEPro options
24310 These @samp{-m} options are supported on the TILEPro:
24312 @table @gcctabopt
24313 @item -mcpu=@var{name}
24314 @opindex mcpu
24315 Selects the type of CPU to be targeted.  Currently the only supported
24316 type is @samp{tilepro}.
24318 @item -m32
24319 @opindex m32
24320 Generate code for a 32-bit environment, which sets int, long, and
24321 pointer to 32 bits.  This is the only supported behavior so the flag
24322 is essentially ignored.
24323 @end table
24325 @node V850 Options
24326 @subsection V850 Options
24327 @cindex V850 Options
24329 These @samp{-m} options are defined for V850 implementations:
24331 @table @gcctabopt
24332 @item -mlong-calls
24333 @itemx -mno-long-calls
24334 @opindex mlong-calls
24335 @opindex mno-long-calls
24336 Treat all calls as being far away (near).  If calls are assumed to be
24337 far away, the compiler always loads the function's address into a
24338 register, and calls indirect through the pointer.
24340 @item -mno-ep
24341 @itemx -mep
24342 @opindex mno-ep
24343 @opindex mep
24344 Do not optimize (do optimize) basic blocks that use the same index
24345 pointer 4 or more times to copy pointer into the @code{ep} register, and
24346 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24347 option is on by default if you optimize.
24349 @item -mno-prolog-function
24350 @itemx -mprolog-function
24351 @opindex mno-prolog-function
24352 @opindex mprolog-function
24353 Do not use (do use) external functions to save and restore registers
24354 at the prologue and epilogue of a function.  The external functions
24355 are slower, but use less code space if more than one function saves
24356 the same number of registers.  The @option{-mprolog-function} option
24357 is on by default if you optimize.
24359 @item -mspace
24360 @opindex mspace
24361 Try to make the code as small as possible.  At present, this just turns
24362 on the @option{-mep} and @option{-mprolog-function} options.
24364 @item -mtda=@var{n}
24365 @opindex mtda
24366 Put static or global variables whose size is @var{n} bytes or less into
24367 the tiny data area that register @code{ep} points to.  The tiny data
24368 area can hold up to 256 bytes in total (128 bytes for byte references).
24370 @item -msda=@var{n}
24371 @opindex msda
24372 Put static or global variables whose size is @var{n} bytes or less into
24373 the small data area that register @code{gp} points to.  The small data
24374 area can hold up to 64 kilobytes.
24376 @item -mzda=@var{n}
24377 @opindex mzda
24378 Put static or global variables whose size is @var{n} bytes or less into
24379 the first 32 kilobytes of memory.
24381 @item -mv850
24382 @opindex mv850
24383 Specify that the target processor is the V850.
24385 @item -mv850e3v5
24386 @opindex mv850e3v5
24387 Specify that the target processor is the V850E3V5.  The preprocessor
24388 constant @code{__v850e3v5__} is defined if this option is used.
24390 @item -mv850e2v4
24391 @opindex mv850e2v4
24392 Specify that the target processor is the V850E3V5.  This is an alias for
24393 the @option{-mv850e3v5} option.
24395 @item -mv850e2v3
24396 @opindex mv850e2v3
24397 Specify that the target processor is the V850E2V3.  The preprocessor
24398 constant @code{__v850e2v3__} is defined if this option is used.
24400 @item -mv850e2
24401 @opindex mv850e2
24402 Specify that the target processor is the V850E2.  The preprocessor
24403 constant @code{__v850e2__} is defined if this option is used.
24405 @item -mv850e1
24406 @opindex mv850e1
24407 Specify that the target processor is the V850E1.  The preprocessor
24408 constants @code{__v850e1__} and @code{__v850e__} are defined if
24409 this option is used.
24411 @item -mv850es
24412 @opindex mv850es
24413 Specify that the target processor is the V850ES.  This is an alias for
24414 the @option{-mv850e1} option.
24416 @item -mv850e
24417 @opindex mv850e
24418 Specify that the target processor is the V850E@.  The preprocessor
24419 constant @code{__v850e__} is defined if this option is used.
24421 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24422 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24423 are defined then a default target processor is chosen and the
24424 relevant @samp{__v850*__} preprocessor constant is defined.
24426 The preprocessor constants @code{__v850} and @code{__v851__} are always
24427 defined, regardless of which processor variant is the target.
24429 @item -mdisable-callt
24430 @itemx -mno-disable-callt
24431 @opindex mdisable-callt
24432 @opindex mno-disable-callt
24433 This option suppresses generation of the @code{CALLT} instruction for the
24434 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24435 architecture.
24437 This option is enabled by default when the RH850 ABI is
24438 in use (see @option{-mrh850-abi}), and disabled by default when the
24439 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24440 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24442 @item -mrelax
24443 @itemx -mno-relax
24444 @opindex mrelax
24445 @opindex mno-relax
24446 Pass on (or do not pass on) the @option{-mrelax} command-line option
24447 to the assembler.
24449 @item -mlong-jumps
24450 @itemx -mno-long-jumps
24451 @opindex mlong-jumps
24452 @opindex mno-long-jumps
24453 Disable (or re-enable) the generation of PC-relative jump instructions.
24455 @item -msoft-float
24456 @itemx -mhard-float
24457 @opindex msoft-float
24458 @opindex mhard-float
24459 Disable (or re-enable) the generation of hardware floating point
24460 instructions.  This option is only significant when the target
24461 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24462 instructions are being generated then the C preprocessor symbol
24463 @code{__FPU_OK__} is defined, otherwise the symbol
24464 @code{__NO_FPU__} is defined.
24466 @item -mloop
24467 @opindex mloop
24468 Enables the use of the e3v5 LOOP instruction.  The use of this
24469 instruction is not enabled by default when the e3v5 architecture is
24470 selected because its use is still experimental.
24472 @item -mrh850-abi
24473 @itemx -mghs
24474 @opindex mrh850-abi
24475 @opindex mghs
24476 Enables support for the RH850 version of the V850 ABI.  This is the
24477 default.  With this version of the ABI the following rules apply:
24479 @itemize
24480 @item
24481 Integer sized structures and unions are returned via a memory pointer
24482 rather than a register.
24484 @item
24485 Large structures and unions (more than 8 bytes in size) are passed by
24486 value.
24488 @item
24489 Functions are aligned to 16-bit boundaries.
24491 @item
24492 The @option{-m8byte-align} command-line option is supported.
24494 @item
24495 The @option{-mdisable-callt} command-line option is enabled by
24496 default.  The @option{-mno-disable-callt} command-line option is not
24497 supported.
24498 @end itemize
24500 When this version of the ABI is enabled the C preprocessor symbol
24501 @code{__V850_RH850_ABI__} is defined.
24503 @item -mgcc-abi
24504 @opindex mgcc-abi
24505 Enables support for the old GCC version of the V850 ABI.  With this
24506 version of the ABI the following rules apply:
24508 @itemize
24509 @item
24510 Integer sized structures and unions are returned in register @code{r10}.
24512 @item
24513 Large structures and unions (more than 8 bytes in size) are passed by
24514 reference.
24516 @item
24517 Functions are aligned to 32-bit boundaries, unless optimizing for
24518 size.
24520 @item
24521 The @option{-m8byte-align} command-line option is not supported.
24523 @item
24524 The @option{-mdisable-callt} command-line option is supported but not
24525 enabled by default.
24526 @end itemize
24528 When this version of the ABI is enabled the C preprocessor symbol
24529 @code{__V850_GCC_ABI__} is defined.
24531 @item -m8byte-align
24532 @itemx -mno-8byte-align
24533 @opindex m8byte-align
24534 @opindex mno-8byte-align
24535 Enables support for @code{double} and @code{long long} types to be
24536 aligned on 8-byte boundaries.  The default is to restrict the
24537 alignment of all objects to at most 4-bytes.  When
24538 @option{-m8byte-align} is in effect the C preprocessor symbol
24539 @code{__V850_8BYTE_ALIGN__} is defined.
24541 @item -mbig-switch
24542 @opindex mbig-switch
24543 Generate code suitable for big switch tables.  Use this option only if
24544 the assembler/linker complain about out of range branches within a switch
24545 table.
24547 @item -mapp-regs
24548 @opindex mapp-regs
24549 This option causes r2 and r5 to be used in the code generated by
24550 the compiler.  This setting is the default.
24552 @item -mno-app-regs
24553 @opindex mno-app-regs
24554 This option causes r2 and r5 to be treated as fixed registers.
24556 @end table
24558 @node VAX Options
24559 @subsection VAX Options
24560 @cindex VAX options
24562 These @samp{-m} options are defined for the VAX:
24564 @table @gcctabopt
24565 @item -munix
24566 @opindex munix
24567 Do not output certain jump instructions (@code{aobleq} and so on)
24568 that the Unix assembler for the VAX cannot handle across long
24569 ranges.
24571 @item -mgnu
24572 @opindex mgnu
24573 Do output those jump instructions, on the assumption that the
24574 GNU assembler is being used.
24576 @item -mg
24577 @opindex mg
24578 Output code for G-format floating-point numbers instead of D-format.
24579 @end table
24581 @node Visium Options
24582 @subsection Visium Options
24583 @cindex Visium options
24585 @table @gcctabopt
24587 @item -mdebug
24588 @opindex mdebug
24589 A program which performs file I/O and is destined to run on an MCM target
24590 should be linked with this option.  It causes the libraries libc.a and
24591 libdebug.a to be linked.  The program should be run on the target under
24592 the control of the GDB remote debugging stub.
24594 @item -msim
24595 @opindex msim
24596 A program which performs file I/O and is destined to run on the simulator
24597 should be linked with option.  This causes libraries libc.a and libsim.a to
24598 be linked.
24600 @item -mfpu
24601 @itemx -mhard-float
24602 @opindex mfpu
24603 @opindex mhard-float
24604 Generate code containing floating-point instructions.  This is the
24605 default.
24607 @item -mno-fpu
24608 @itemx -msoft-float
24609 @opindex mno-fpu
24610 @opindex msoft-float
24611 Generate code containing library calls for floating-point.
24613 @option{-msoft-float} changes the calling convention in the output file;
24614 therefore, it is only useful if you compile @emph{all} of a program with
24615 this option.  In particular, you need to compile @file{libgcc.a}, the
24616 library that comes with GCC, with @option{-msoft-float} in order for
24617 this to work.
24619 @item -mcpu=@var{cpu_type}
24620 @opindex mcpu
24621 Set the instruction set, register set, and instruction scheduling parameters
24622 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24623 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24625 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24627 By default (unless configured otherwise), GCC generates code for the GR5
24628 variant of the Visium architecture.  
24630 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24631 architecture.  The only difference from GR5 code is that the compiler will
24632 generate block move instructions.
24634 @item -mtune=@var{cpu_type}
24635 @opindex mtune
24636 Set the instruction scheduling parameters for machine type @var{cpu_type},
24637 but do not set the instruction set or register set that the option
24638 @option{-mcpu=@var{cpu_type}} would.
24640 @item -msv-mode
24641 @opindex msv-mode
24642 Generate code for the supervisor mode, where there are no restrictions on
24643 the access to general registers.  This is the default.
24645 @item -muser-mode
24646 @opindex muser-mode
24647 Generate code for the user mode, where the access to some general registers
24648 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24649 mode; on the GR6, only registers r29 to r31 are affected.
24650 @end table
24652 @node VMS Options
24653 @subsection VMS Options
24655 These @samp{-m} options are defined for the VMS implementations:
24657 @table @gcctabopt
24658 @item -mvms-return-codes
24659 @opindex mvms-return-codes
24660 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24661 condition (e.g.@ error) codes.
24663 @item -mdebug-main=@var{prefix}
24664 @opindex mdebug-main=@var{prefix}
24665 Flag the first routine whose name starts with @var{prefix} as the main
24666 routine for the debugger.
24668 @item -mmalloc64
24669 @opindex mmalloc64
24670 Default to 64-bit memory allocation routines.
24672 @item -mpointer-size=@var{size}
24673 @opindex mpointer-size=@var{size}
24674 Set the default size of pointers. Possible options for @var{size} are
24675 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24676 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24677 The later option disables @code{pragma pointer_size}.
24678 @end table
24680 @node VxWorks Options
24681 @subsection VxWorks Options
24682 @cindex VxWorks Options
24684 The options in this section are defined for all VxWorks targets.
24685 Options specific to the target hardware are listed with the other
24686 options for that target.
24688 @table @gcctabopt
24689 @item -mrtp
24690 @opindex mrtp
24691 GCC can generate code for both VxWorks kernels and real time processes
24692 (RTPs).  This option switches from the former to the latter.  It also
24693 defines the preprocessor macro @code{__RTP__}.
24695 @item -non-static
24696 @opindex non-static
24697 Link an RTP executable against shared libraries rather than static
24698 libraries.  The options @option{-static} and @option{-shared} can
24699 also be used for RTPs (@pxref{Link Options}); @option{-static}
24700 is the default.
24702 @item -Bstatic
24703 @itemx -Bdynamic
24704 @opindex Bstatic
24705 @opindex Bdynamic
24706 These options are passed down to the linker.  They are defined for
24707 compatibility with Diab.
24709 @item -Xbind-lazy
24710 @opindex Xbind-lazy
24711 Enable lazy binding of function calls.  This option is equivalent to
24712 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24714 @item -Xbind-now
24715 @opindex Xbind-now
24716 Disable lazy binding of function calls.  This option is the default and
24717 is defined for compatibility with Diab.
24718 @end table
24720 @node x86 Options
24721 @subsection x86 Options
24722 @cindex x86 Options
24724 These @samp{-m} options are defined for the x86 family of computers.
24726 @table @gcctabopt
24728 @item -march=@var{cpu-type}
24729 @opindex march
24730 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24731 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24732 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24733 to generate code that may not run at all on processors other than the one
24734 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24735 @option{-mtune=@var{cpu-type}}.
24737 The choices for @var{cpu-type} are:
24739 @table @samp
24740 @item native
24741 This selects the CPU to generate code for at compilation time by determining
24742 the processor type of the compiling machine.  Using @option{-march=native}
24743 enables all instruction subsets supported by the local machine (hence
24744 the result might not run on different machines).  Using @option{-mtune=native}
24745 produces code optimized for the local machine under the constraints
24746 of the selected instruction set.  
24748 @item i386
24749 Original Intel i386 CPU@.
24751 @item i486
24752 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24754 @item i586
24755 @itemx pentium
24756 Intel Pentium CPU with no MMX support.
24758 @item lakemont
24759 Intel Lakemont MCU, based on Intel Pentium CPU.
24761 @item pentium-mmx
24762 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
24764 @item pentiumpro
24765 Intel Pentium Pro CPU@.
24767 @item i686
24768 When used with @option{-march}, the Pentium Pro
24769 instruction set is used, so the code runs on all i686 family chips.
24770 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
24772 @item pentium2
24773 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
24774 support.
24776 @item pentium3
24777 @itemx pentium3m
24778 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
24779 set support.
24781 @item pentium-m
24782 Intel Pentium M; low-power version of Intel Pentium III CPU
24783 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
24785 @item pentium4
24786 @itemx pentium4m
24787 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
24789 @item prescott
24790 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
24791 set support.
24793 @item nocona
24794 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
24795 SSE2 and SSE3 instruction set support.
24797 @item core2
24798 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
24799 instruction set support.
24801 @item nehalem
24802 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24803 SSE4.1, SSE4.2 and POPCNT instruction set support.
24805 @item westmere
24806 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24807 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
24809 @item sandybridge
24810 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24811 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
24813 @item ivybridge
24814 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
24815 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
24816 instruction set support.
24818 @item haswell
24819 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24820 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24821 BMI, BMI2 and F16C instruction set support.
24823 @item broadwell
24824 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24825 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24826 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
24828 @item skylake
24829 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24830 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24831 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
24832 XSAVES instruction set support.
24834 @item bonnell
24835 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
24836 instruction set support.
24838 @item silvermont
24839 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
24840 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
24842 @item knl
24843 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24844 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24845 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
24846 AVX512CD instruction set support.
24848 @item skylake-avx512
24849 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
24850 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
24851 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
24852 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
24854 @item k6
24855 AMD K6 CPU with MMX instruction set support.
24857 @item k6-2
24858 @itemx k6-3
24859 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
24861 @item athlon
24862 @itemx athlon-tbird
24863 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
24864 support.
24866 @item athlon-4
24867 @itemx athlon-xp
24868 @itemx athlon-mp
24869 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
24870 instruction set support.
24872 @item k8
24873 @itemx opteron
24874 @itemx athlon64
24875 @itemx athlon-fx
24876 Processors based on the AMD K8 core with x86-64 instruction set support,
24877 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
24878 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
24879 instruction set extensions.)
24881 @item k8-sse3
24882 @itemx opteron-sse3
24883 @itemx athlon64-sse3
24884 Improved versions of AMD K8 cores with SSE3 instruction set support.
24886 @item amdfam10
24887 @itemx barcelona
24888 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
24889 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
24890 instruction set extensions.)
24892 @item bdver1
24893 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
24894 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
24895 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
24896 @item bdver2
24897 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24898 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
24899 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
24900 extensions.)
24901 @item bdver3
24902 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24903 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
24904 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
24905 64-bit instruction set extensions.
24906 @item bdver4
24907 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
24908 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
24909 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
24910 SSE4.2, ABM and 64-bit instruction set extensions.
24912 @item znver1
24913 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
24914 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
24915 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
24916 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
24917 instruction set extensions.
24919 @item btver1
24920 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
24921 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
24922 instruction set extensions.)
24924 @item btver2
24925 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
24926 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
24927 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
24929 @item winchip-c6
24930 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
24931 set support.
24933 @item winchip2
24934 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
24935 instruction set support.
24937 @item c3
24938 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
24939 (No scheduling is implemented for this chip.)
24941 @item c3-2
24942 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
24943 (No scheduling is implemented for this chip.)
24945 @item c7
24946 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24947 (No scheduling is implemented for this chip.)
24949 @item samuel-2
24950 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
24951 (No scheduling is implemented for this chip.)
24953 @item nehemiah
24954 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
24955 (No scheduling is implemented for this chip.)
24957 @item esther
24958 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
24959 (No scheduling is implemented for this chip.)
24961 @item eden-x2
24962 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
24963 (No scheduling is implemented for this chip.)
24965 @item eden-x4
24966 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
24967 AVX and AVX2 instruction set support.
24968 (No scheduling is implemented for this chip.)
24970 @item nano
24971 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24972 instruction set support.
24973 (No scheduling is implemented for this chip.)
24975 @item nano-1000
24976 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24977 instruction set support.
24978 (No scheduling is implemented for this chip.)
24980 @item nano-2000
24981 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
24982 instruction set support.
24983 (No scheduling is implemented for this chip.)
24985 @item nano-3000
24986 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24987 instruction set support.
24988 (No scheduling is implemented for this chip.)
24990 @item nano-x2
24991 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24992 instruction set support.
24993 (No scheduling is implemented for this chip.)
24995 @item nano-x4
24996 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
24997 instruction set support.
24998 (No scheduling is implemented for this chip.)
25000 @item geode
25001 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25002 @end table
25004 @item -mtune=@var{cpu-type}
25005 @opindex mtune
25006 Tune to @var{cpu-type} everything applicable about the generated code, except
25007 for the ABI and the set of available instructions.  
25008 While picking a specific @var{cpu-type} schedules things appropriately
25009 for that particular chip, the compiler does not generate any code that
25010 cannot run on the default machine type unless you use a
25011 @option{-march=@var{cpu-type}} option.
25012 For example, if GCC is configured for i686-pc-linux-gnu
25013 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25014 but still runs on i686 machines.
25016 The choices for @var{cpu-type} are the same as for @option{-march}.
25017 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25019 @table @samp
25020 @item generic
25021 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25022 If you know the CPU on which your code will run, then you should use
25023 the corresponding @option{-mtune} or @option{-march} option instead of
25024 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25025 of your application will have, then you should use this option.
25027 As new processors are deployed in the marketplace, the behavior of this
25028 option will change.  Therefore, if you upgrade to a newer version of
25029 GCC, code generation controlled by this option will change to reflect
25030 the processors
25031 that are most common at the time that version of GCC is released.
25033 There is no @option{-march=generic} option because @option{-march}
25034 indicates the instruction set the compiler can use, and there is no
25035 generic instruction set applicable to all processors.  In contrast,
25036 @option{-mtune} indicates the processor (or, in this case, collection of
25037 processors) for which the code is optimized.
25039 @item intel
25040 Produce code optimized for the most current Intel processors, which are
25041 Haswell and Silvermont for this version of GCC.  If you know the CPU
25042 on which your code will run, then you should use the corresponding
25043 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25044 But, if you want your application performs better on both Haswell and
25045 Silvermont, then you should use this option.
25047 As new Intel processors are deployed in the marketplace, the behavior of
25048 this option will change.  Therefore, if you upgrade to a newer version of
25049 GCC, code generation controlled by this option will change to reflect
25050 the most current Intel processors at the time that version of GCC is
25051 released.
25053 There is no @option{-march=intel} option because @option{-march} indicates
25054 the instruction set the compiler can use, and there is no common
25055 instruction set applicable to all processors.  In contrast,
25056 @option{-mtune} indicates the processor (or, in this case, collection of
25057 processors) for which the code is optimized.
25058 @end table
25060 @item -mcpu=@var{cpu-type}
25061 @opindex mcpu
25062 A deprecated synonym for @option{-mtune}.
25064 @item -mfpmath=@var{unit}
25065 @opindex mfpmath
25066 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25067 for @var{unit} are:
25069 @table @samp
25070 @item 387
25071 Use the standard 387 floating-point coprocessor present on the majority of chips and
25072 emulated otherwise.  Code compiled with this option runs almost everywhere.
25073 The temporary results are computed in 80-bit precision instead of the precision
25074 specified by the type, resulting in slightly different results compared to most
25075 of other chips.  See @option{-ffloat-store} for more detailed description.
25077 This is the default choice for non-Darwin x86-32 targets.
25079 @item sse
25080 Use scalar floating-point instructions present in the SSE instruction set.
25081 This instruction set is supported by Pentium III and newer chips,
25082 and in the AMD line
25083 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25084 instruction set supports only single-precision arithmetic, thus the double and
25085 extended-precision arithmetic are still done using 387.  A later version, present
25086 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25087 arithmetic too.
25089 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25090 or @option{-msse2} switches to enable SSE extensions and make this option
25091 effective.  For the x86-64 compiler, these extensions are enabled by default.
25093 The resulting code should be considerably faster in the majority of cases and avoid
25094 the numerical instability problems of 387 code, but may break some existing
25095 code that expects temporaries to be 80 bits.
25097 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25098 and the default choice for x86-32 targets with the SSE2 instruction set
25099 when @option{-ffast-math} is enabled.
25101 @item sse,387
25102 @itemx sse+387
25103 @itemx both
25104 Attempt to utilize both instruction sets at once.  This effectively doubles the
25105 amount of available registers, and on chips with separate execution units for
25106 387 and SSE the execution resources too.  Use this option with care, as it is
25107 still experimental, because the GCC register allocator does not model separate
25108 functional units well, resulting in unstable performance.
25109 @end table
25111 @item -masm=@var{dialect}
25112 @opindex masm=@var{dialect}
25113 Output assembly instructions using selected @var{dialect}.  Also affects
25114 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25115 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25116 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25117 not support @samp{intel}.
25119 @item -mieee-fp
25120 @itemx -mno-ieee-fp
25121 @opindex mieee-fp
25122 @opindex mno-ieee-fp
25123 Control whether or not the compiler uses IEEE floating-point
25124 comparisons.  These correctly handle the case where the result of a
25125 comparison is unordered.
25127 @item -m80387
25128 @item -mhard-float
25129 @opindex 80387
25130 @opindex mhard-float
25131 Generate output containing 80387 instructions for floating point.
25133 @item -mno-80387
25134 @item -msoft-float
25135 @opindex no-80387
25136 @opindex msoft-float
25137 Generate output containing library calls for floating point.
25139 @strong{Warning:} the requisite libraries are not part of GCC@.
25140 Normally the facilities of the machine's usual C compiler are used, but
25141 this cannot be done directly in cross-compilation.  You must make your
25142 own arrangements to provide suitable library functions for
25143 cross-compilation.
25145 On machines where a function returns floating-point results in the 80387
25146 register stack, some floating-point opcodes may be emitted even if
25147 @option{-msoft-float} is used.
25149 @item -mno-fp-ret-in-387
25150 @opindex mno-fp-ret-in-387
25151 Do not use the FPU registers for return values of functions.
25153 The usual calling convention has functions return values of types
25154 @code{float} and @code{double} in an FPU register, even if there
25155 is no FPU@.  The idea is that the operating system should emulate
25156 an FPU@.
25158 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25159 in ordinary CPU registers instead.
25161 @item -mno-fancy-math-387
25162 @opindex mno-fancy-math-387
25163 Some 387 emulators do not support the @code{sin}, @code{cos} and
25164 @code{sqrt} instructions for the 387.  Specify this option to avoid
25165 generating those instructions.  This option is the default on
25166 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25167 indicates that the target CPU always has an FPU and so the
25168 instruction does not need emulation.  These
25169 instructions are not generated unless you also use the
25170 @option{-funsafe-math-optimizations} switch.
25172 @item -malign-double
25173 @itemx -mno-align-double
25174 @opindex malign-double
25175 @opindex mno-align-double
25176 Control whether GCC aligns @code{double}, @code{long double}, and
25177 @code{long long} variables on a two-word boundary or a one-word
25178 boundary.  Aligning @code{double} variables on a two-word boundary
25179 produces code that runs somewhat faster on a Pentium at the
25180 expense of more memory.
25182 On x86-64, @option{-malign-double} is enabled by default.
25184 @strong{Warning:} if you use the @option{-malign-double} switch,
25185 structures containing the above types are aligned differently than
25186 the published application binary interface specifications for the x86-32
25187 and are not binary compatible with structures in code compiled
25188 without that switch.
25190 @item -m96bit-long-double
25191 @itemx -m128bit-long-double
25192 @opindex m96bit-long-double
25193 @opindex m128bit-long-double
25194 These switches control the size of @code{long double} type.  The x86-32
25195 application binary interface specifies the size to be 96 bits,
25196 so @option{-m96bit-long-double} is the default in 32-bit mode.
25198 Modern architectures (Pentium and newer) prefer @code{long double}
25199 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25200 conforming to the ABI, this is not possible.  So specifying
25201 @option{-m128bit-long-double} aligns @code{long double}
25202 to a 16-byte boundary by padding the @code{long double} with an additional
25203 32-bit zero.
25205 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25206 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25208 Notice that neither of these options enable any extra precision over the x87
25209 standard of 80 bits for a @code{long double}.
25211 @strong{Warning:} if you override the default value for your target ABI, this
25212 changes the size of 
25213 structures and arrays containing @code{long double} variables,
25214 as well as modifying the function calling convention for functions taking
25215 @code{long double}.  Hence they are not binary-compatible
25216 with code compiled without that switch.
25218 @item -mlong-double-64
25219 @itemx -mlong-double-80
25220 @itemx -mlong-double-128
25221 @opindex mlong-double-64
25222 @opindex mlong-double-80
25223 @opindex mlong-double-128
25224 These switches control the size of @code{long double} type. A size
25225 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25226 type. This is the default for 32-bit Bionic C library.  A size
25227 of 128 bits makes the @code{long double} type equivalent to the
25228 @code{__float128} type. This is the default for 64-bit Bionic C library.
25230 @strong{Warning:} if you override the default value for your target ABI, this
25231 changes the size of
25232 structures and arrays containing @code{long double} variables,
25233 as well as modifying the function calling convention for functions taking
25234 @code{long double}.  Hence they are not binary-compatible
25235 with code compiled without that switch.
25237 @item -malign-data=@var{type}
25238 @opindex malign-data
25239 Control how GCC aligns variables.  Supported values for @var{type} are
25240 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25241 and earlier, @samp{abi} uses alignment value as specified by the
25242 psABI, and @samp{cacheline} uses increased alignment value to match
25243 the cache line size.  @samp{compat} is the default.
25245 @item -mlarge-data-threshold=@var{threshold}
25246 @opindex mlarge-data-threshold
25247 When @option{-mcmodel=medium} is specified, data objects larger than
25248 @var{threshold} are placed in the large data section.  This value must be the
25249 same across all objects linked into the binary, and defaults to 65535.
25251 @item -mrtd
25252 @opindex mrtd
25253 Use a different function-calling convention, in which functions that
25254 take a fixed number of arguments return with the @code{ret @var{num}}
25255 instruction, which pops their arguments while returning.  This saves one
25256 instruction in the caller since there is no need to pop the arguments
25257 there.
25259 You can specify that an individual function is called with this calling
25260 sequence with the function attribute @code{stdcall}.  You can also
25261 override the @option{-mrtd} option by using the function attribute
25262 @code{cdecl}.  @xref{Function Attributes}.
25264 @strong{Warning:} this calling convention is incompatible with the one
25265 normally used on Unix, so you cannot use it if you need to call
25266 libraries compiled with the Unix compiler.
25268 Also, you must provide function prototypes for all functions that
25269 take variable numbers of arguments (including @code{printf});
25270 otherwise incorrect code is generated for calls to those
25271 functions.
25273 In addition, seriously incorrect code results if you call a
25274 function with too many arguments.  (Normally, extra arguments are
25275 harmlessly ignored.)
25277 @item -mregparm=@var{num}
25278 @opindex mregparm
25279 Control how many registers are used to pass integer arguments.  By
25280 default, no registers are used to pass arguments, and at most 3
25281 registers can be used.  You can control this behavior for a specific
25282 function by using the function attribute @code{regparm}.
25283 @xref{Function Attributes}.
25285 @strong{Warning:} if you use this switch, and
25286 @var{num} is nonzero, then you must build all modules with the same
25287 value, including any libraries.  This includes the system libraries and
25288 startup modules.
25290 @item -msseregparm
25291 @opindex msseregparm
25292 Use SSE register passing conventions for float and double arguments
25293 and return values.  You can control this behavior for a specific
25294 function by using the function attribute @code{sseregparm}.
25295 @xref{Function Attributes}.
25297 @strong{Warning:} if you use this switch then you must build all
25298 modules with the same value, including any libraries.  This includes
25299 the system libraries and startup modules.
25301 @item -mvect8-ret-in-mem
25302 @opindex mvect8-ret-in-mem
25303 Return 8-byte vectors in memory instead of MMX registers.  This is the
25304 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25305 Studio compilers until version 12.  Later compiler versions (starting
25306 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25307 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25308 you need to remain compatible with existing code produced by those
25309 previous compiler versions or older versions of GCC@.
25311 @item -mpc32
25312 @itemx -mpc64
25313 @itemx -mpc80
25314 @opindex mpc32
25315 @opindex mpc64
25316 @opindex mpc80
25318 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25319 is specified, the significands of results of floating-point operations are
25320 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25321 significands of results of floating-point operations to 53 bits (double
25322 precision) and @option{-mpc80} rounds the significands of results of
25323 floating-point operations to 64 bits (extended double precision), which is
25324 the default.  When this option is used, floating-point operations in higher
25325 precisions are not available to the programmer without setting the FPU
25326 control word explicitly.
25328 Setting the rounding of floating-point operations to less than the default
25329 80 bits can speed some programs by 2% or more.  Note that some mathematical
25330 libraries assume that extended-precision (80-bit) floating-point operations
25331 are enabled by default; routines in such libraries could suffer significant
25332 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25333 when this option is used to set the precision to less than extended precision.
25335 @item -mstackrealign
25336 @opindex mstackrealign
25337 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25338 option generates an alternate prologue and epilogue that realigns the
25339 run-time stack if necessary.  This supports mixing legacy codes that keep
25340 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25341 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25342 applicable to individual functions.
25344 @item -mpreferred-stack-boundary=@var{num}
25345 @opindex mpreferred-stack-boundary
25346 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25347 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25348 the default is 4 (16 bytes or 128 bits).
25350 @strong{Warning:} When generating code for the x86-64 architecture with
25351 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25352 used to keep the stack boundary aligned to 8 byte boundary.  Since
25353 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25354 intended to be used in controlled environment where stack space is
25355 important limitation.  This option leads to wrong code when functions
25356 compiled with 16 byte stack alignment (such as functions from a standard
25357 library) are called with misaligned stack.  In this case, SSE
25358 instructions may lead to misaligned memory access traps.  In addition,
25359 variable arguments are handled incorrectly for 16 byte aligned
25360 objects (including x87 long double and __int128), leading to wrong
25361 results.  You must build all modules with
25362 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25363 includes the system libraries and startup modules.
25365 @item -mincoming-stack-boundary=@var{num}
25366 @opindex mincoming-stack-boundary
25367 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25368 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25369 the one specified by @option{-mpreferred-stack-boundary} is used.
25371 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25372 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25373 suffer significant run time performance penalties.  On Pentium III, the
25374 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25375 properly if it is not 16-byte aligned.
25377 To ensure proper alignment of this values on the stack, the stack boundary
25378 must be as aligned as that required by any value stored on the stack.
25379 Further, every function must be generated such that it keeps the stack
25380 aligned.  Thus calling a function compiled with a higher preferred
25381 stack boundary from a function compiled with a lower preferred stack
25382 boundary most likely misaligns the stack.  It is recommended that
25383 libraries that use callbacks always use the default setting.
25385 This extra alignment does consume extra stack space, and generally
25386 increases code size.  Code that is sensitive to stack space usage, such
25387 as embedded systems and operating system kernels, may want to reduce the
25388 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25390 @need 200
25391 @item -mmmx
25392 @opindex mmmx
25393 @need 200
25394 @itemx -msse
25395 @opindex msse
25396 @need 200
25397 @itemx -msse2
25398 @opindex msse2
25399 @need 200
25400 @itemx -msse3
25401 @opindex msse3
25402 @need 200
25403 @itemx -mssse3
25404 @opindex mssse3
25405 @need 200
25406 @itemx -msse4
25407 @opindex msse4
25408 @need 200
25409 @itemx -msse4a
25410 @opindex msse4a
25411 @need 200
25412 @itemx -msse4.1
25413 @opindex msse4.1
25414 @need 200
25415 @itemx -msse4.2
25416 @opindex msse4.2
25417 @need 200
25418 @itemx -mavx
25419 @opindex mavx
25420 @need 200
25421 @itemx -mavx2
25422 @opindex mavx2
25423 @need 200
25424 @itemx -mavx512f
25425 @opindex mavx512f
25426 @need 200
25427 @itemx -mavx512pf
25428 @opindex mavx512pf
25429 @need 200
25430 @itemx -mavx512er
25431 @opindex mavx512er
25432 @need 200
25433 @itemx -mavx512cd
25434 @opindex mavx512cd
25435 @need 200
25436 @itemx -mavx512vl
25437 @opindex mavx512vl
25438 @need 200
25439 @itemx -mavx512bw
25440 @opindex mavx512bw
25441 @need 200
25442 @itemx -mavx512dq
25443 @opindex mavx512dq
25444 @need 200
25445 @itemx -mavx512ifma
25446 @opindex mavx512ifma
25447 @need 200
25448 @itemx -mavx512vbmi
25449 @opindex mavx512vbmi
25450 @need 200
25451 @itemx -msha
25452 @opindex msha
25453 @need 200
25454 @itemx -maes
25455 @opindex maes
25456 @need 200
25457 @itemx -mpclmul
25458 @opindex mpclmul
25459 @need 200
25460 @itemx -mclfushopt
25461 @opindex mclfushopt
25462 @need 200
25463 @itemx -mfsgsbase
25464 @opindex mfsgsbase
25465 @need 200
25466 @itemx -mrdrnd
25467 @opindex mrdrnd
25468 @need 200
25469 @itemx -mf16c
25470 @opindex mf16c
25471 @need 200
25472 @itemx -mfma
25473 @opindex mfma
25474 @need 200
25475 @itemx -mfma4
25476 @opindex mfma4
25477 @need 200
25478 @itemx -mprefetchwt1
25479 @opindex mprefetchwt1
25480 @need 200
25481 @itemx -mxop
25482 @opindex mxop
25483 @need 200
25484 @itemx -mlwp
25485 @opindex mlwp
25486 @need 200
25487 @itemx -m3dnow
25488 @opindex m3dnow
25489 @need 200
25490 @itemx -m3dnowa
25491 @opindex m3dnowa
25492 @need 200
25493 @itemx -mpopcnt
25494 @opindex mpopcnt
25495 @need 200
25496 @itemx -mabm
25497 @opindex mabm
25498 @need 200
25499 @itemx -mbmi
25500 @opindex mbmi
25501 @need 200
25502 @itemx -mbmi2
25503 @need 200
25504 @itemx -mlzcnt
25505 @opindex mlzcnt
25506 @need 200
25507 @itemx -mfxsr
25508 @opindex mfxsr
25509 @need 200
25510 @itemx -mxsave
25511 @opindex mxsave
25512 @need 200
25513 @itemx -mxsaveopt
25514 @opindex mxsaveopt
25515 @need 200
25516 @itemx -mxsavec
25517 @opindex mxsavec
25518 @need 200
25519 @itemx -mxsaves
25520 @opindex mxsaves
25521 @need 200
25522 @itemx -mrtm
25523 @opindex mrtm
25524 @need 200
25525 @itemx -mtbm
25526 @opindex mtbm
25527 @need 200
25528 @itemx -mmpx
25529 @opindex mmpx
25530 @need 200
25531 @itemx -mmwaitx
25532 @opindex mmwaitx
25533 @need 200
25534 @itemx -mclzero
25535 @opindex mclzero
25536 @itemx -mpku
25537 @opindex mpku
25538 These switches enable the use of instructions in the MMX, SSE,
25539 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25540 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25541 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25542 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25543 extended instruction sets.  Each has a corresponding @option{-mno-} option
25544 to disable use of these instructions.
25546 These extensions are also available as built-in functions: see
25547 @ref{x86 Built-in Functions}, for details of the functions enabled and
25548 disabled by these switches.
25550 To generate SSE/SSE2 instructions automatically from floating-point
25551 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25553 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25554 generates new AVX instructions or AVX equivalence for all SSEx instructions
25555 when needed.
25557 These options enable GCC to use these extended instructions in
25558 generated code, even without @option{-mfpmath=sse}.  Applications that
25559 perform run-time CPU detection must compile separate files for each
25560 supported architecture, using the appropriate flags.  In particular,
25561 the file containing the CPU detection code should be compiled without
25562 these options.
25564 @item -mdump-tune-features
25565 @opindex mdump-tune-features
25566 This option instructs GCC to dump the names of the x86 performance 
25567 tuning features and default settings. The names can be used in 
25568 @option{-mtune-ctrl=@var{feature-list}}.
25570 @item -mtune-ctrl=@var{feature-list}
25571 @opindex mtune-ctrl=@var{feature-list}
25572 This option is used to do fine grain control of x86 code generation features.
25573 @var{feature-list} is a comma separated list of @var{feature} names. See also
25574 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25575 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25576 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25577 developers. Using it may lead to code paths not covered by testing and can
25578 potentially result in compiler ICEs or runtime errors.
25580 @item -mno-default
25581 @opindex mno-default
25582 This option instructs GCC to turn off all tunable features. See also 
25583 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25585 @item -mcld
25586 @opindex mcld
25587 This option instructs GCC to emit a @code{cld} instruction in the prologue
25588 of functions that use string instructions.  String instructions depend on
25589 the DF flag to select between autoincrement or autodecrement mode.  While the
25590 ABI specifies the DF flag to be cleared on function entry, some operating
25591 systems violate this specification by not clearing the DF flag in their
25592 exception dispatchers.  The exception handler can be invoked with the DF flag
25593 set, which leads to wrong direction mode when string instructions are used.
25594 This option can be enabled by default on 32-bit x86 targets by configuring
25595 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25596 instructions can be suppressed with the @option{-mno-cld} compiler option
25597 in this case.
25599 @item -mvzeroupper
25600 @opindex mvzeroupper
25601 This option instructs GCC to emit a @code{vzeroupper} instruction
25602 before a transfer of control flow out of the function to minimize
25603 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25604 intrinsics.
25606 @item -mprefer-avx128
25607 @opindex mprefer-avx128
25608 This option instructs GCC to use 128-bit AVX instructions instead of
25609 256-bit AVX instructions in the auto-vectorizer.
25611 @item -mcx16
25612 @opindex mcx16
25613 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25614 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25615 objects.  This is useful for atomic updates of data structures exceeding one
25616 machine word in size.  The compiler uses this instruction to implement
25617 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25618 128-bit integers, a library call is always used.
25620 @item -msahf
25621 @opindex msahf
25622 This option enables generation of @code{SAHF} instructions in 64-bit code.
25623 Early Intel Pentium 4 CPUs with Intel 64 support,
25624 prior to the introduction of Pentium 4 G1 step in December 2005,
25625 lacked the @code{LAHF} and @code{SAHF} instructions
25626 which are supported by AMD64.
25627 These are load and store instructions, respectively, for certain status flags.
25628 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25629 @code{drem}, and @code{remainder} built-in functions;
25630 see @ref{Other Builtins} for details.
25632 @item -mmovbe
25633 @opindex mmovbe
25634 This option enables use of the @code{movbe} instruction to implement
25635 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25637 @item -mcrc32
25638 @opindex mcrc32
25639 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25640 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25641 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25643 @item -mrecip
25644 @opindex mrecip
25645 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25646 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25647 with an additional Newton-Raphson step
25648 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25649 (and their vectorized
25650 variants) for single-precision floating-point arguments.  These instructions
25651 are generated only when @option{-funsafe-math-optimizations} is enabled
25652 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25653 Note that while the throughput of the sequence is higher than the throughput
25654 of the non-reciprocal instruction, the precision of the sequence can be
25655 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25657 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25658 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25659 combination), and doesn't need @option{-mrecip}.
25661 Also note that GCC emits the above sequence with additional Newton-Raphson step
25662 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25663 already with @option{-ffast-math} (or the above option combination), and
25664 doesn't need @option{-mrecip}.
25666 @item -mrecip=@var{opt}
25667 @opindex mrecip=opt
25668 This option controls which reciprocal estimate instructions
25669 may be used.  @var{opt} is a comma-separated list of options, which may
25670 be preceded by a @samp{!} to invert the option:
25672 @table @samp
25673 @item all
25674 Enable all estimate instructions.
25676 @item default
25677 Enable the default instructions, equivalent to @option{-mrecip}.
25679 @item none
25680 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25682 @item div
25683 Enable the approximation for scalar division.
25685 @item vec-div
25686 Enable the approximation for vectorized division.
25688 @item sqrt
25689 Enable the approximation for scalar square root.
25691 @item vec-sqrt
25692 Enable the approximation for vectorized square root.
25693 @end table
25695 So, for example, @option{-mrecip=all,!sqrt} enables
25696 all of the reciprocal approximations, except for square root.
25698 @item -mveclibabi=@var{type}
25699 @opindex mveclibabi
25700 Specifies the ABI type to use for vectorizing intrinsics using an
25701 external library.  Supported values for @var{type} are @samp{svml} 
25702 for the Intel short
25703 vector math library and @samp{acml} for the AMD math core library.
25704 To use this option, both @option{-ftree-vectorize} and
25705 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25706 ABI-compatible library must be specified at link time.
25708 GCC currently emits calls to @code{vmldExp2},
25709 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25710 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25711 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25712 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25713 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25714 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25715 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25716 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25717 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25718 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25719 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25720 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25721 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25722 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25723 when @option{-mveclibabi=acml} is used.  
25725 @item -mabi=@var{name}
25726 @opindex mabi
25727 Generate code for the specified calling convention.  Permissible values
25728 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25729 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25730 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25731 You can control this behavior for specific functions by
25732 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25733 @xref{Function Attributes}.
25735 @item -mcall-ms2sysv-xlogues
25736 @opindex mcall-ms2sysv-xlogues
25737 @opindex mno-call-ms2sysv-xlogues
25738 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25739 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25740 default, the code for saving and restoring these registers is emitted inline,
25741 resulting in fairly lengthy prologues and epilogues.  Using
25742 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25743 use stubs in the static portion of libgcc to perform these saves and restores,
25744 thus reducing function size at the cost of a few extra instructions.
25746 @item -mtls-dialect=@var{type}
25747 @opindex mtls-dialect
25748 Generate code to access thread-local storage using the @samp{gnu} or
25749 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25750 @samp{gnu2} is more efficient, but it may add compile- and run-time
25751 requirements that cannot be satisfied on all systems.
25753 @item -mpush-args
25754 @itemx -mno-push-args
25755 @opindex mpush-args
25756 @opindex mno-push-args
25757 Use PUSH operations to store outgoing parameters.  This method is shorter
25758 and usually equally fast as method using SUB/MOV operations and is enabled
25759 by default.  In some cases disabling it may improve performance because of
25760 improved scheduling and reduced dependencies.
25762 @item -maccumulate-outgoing-args
25763 @opindex maccumulate-outgoing-args
25764 If enabled, the maximum amount of space required for outgoing arguments is
25765 computed in the function prologue.  This is faster on most modern CPUs
25766 because of reduced dependencies, improved scheduling and reduced stack usage
25767 when the preferred stack boundary is not equal to 2.  The drawback is a notable
25768 increase in code size.  This switch implies @option{-mno-push-args}.
25770 @item -mthreads
25771 @opindex mthreads
25772 Support thread-safe exception handling on MinGW.  Programs that rely
25773 on thread-safe exception handling must compile and link all code with the
25774 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
25775 @option{-D_MT}; when linking, it links in a special thread helper library
25776 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
25778 @item -mms-bitfields
25779 @itemx -mno-ms-bitfields
25780 @opindex mms-bitfields
25781 @opindex mno-ms-bitfields
25783 Enable/disable bit-field layout compatible with the native Microsoft
25784 Windows compiler.  
25786 If @code{packed} is used on a structure, or if bit-fields are used,
25787 it may be that the Microsoft ABI lays out the structure differently
25788 than the way GCC normally does.  Particularly when moving packed
25789 data between functions compiled with GCC and the native Microsoft compiler
25790 (either via function call or as data in a file), it may be necessary to access
25791 either format.
25793 This option is enabled by default for Microsoft Windows
25794 targets.  This behavior can also be controlled locally by use of variable
25795 or type attributes.  For more information, see @ref{x86 Variable Attributes}
25796 and @ref{x86 Type Attributes}.
25798 The Microsoft structure layout algorithm is fairly simple with the exception
25799 of the bit-field packing.  
25800 The padding and alignment of members of structures and whether a bit-field 
25801 can straddle a storage-unit boundary are determine by these rules:
25803 @enumerate
25804 @item Structure members are stored sequentially in the order in which they are
25805 declared: the first member has the lowest memory address and the last member
25806 the highest.
25808 @item Every data object has an alignment requirement.  The alignment requirement
25809 for all data except structures, unions, and arrays is either the size of the
25810 object or the current packing size (specified with either the
25811 @code{aligned} attribute or the @code{pack} pragma),
25812 whichever is less.  For structures, unions, and arrays,
25813 the alignment requirement is the largest alignment requirement of its members.
25814 Every object is allocated an offset so that:
25816 @smallexample
25817 offset % alignment_requirement == 0
25818 @end smallexample
25820 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
25821 unit if the integral types are the same size and if the next bit-field fits
25822 into the current allocation unit without crossing the boundary imposed by the
25823 common alignment requirements of the bit-fields.
25824 @end enumerate
25826 MSVC interprets zero-length bit-fields in the following ways:
25828 @enumerate
25829 @item If a zero-length bit-field is inserted between two bit-fields that
25830 are normally coalesced, the bit-fields are not coalesced.
25832 For example:
25834 @smallexample
25835 struct
25836  @{
25837    unsigned long bf_1 : 12;
25838    unsigned long : 0;
25839    unsigned long bf_2 : 12;
25840  @} t1;
25841 @end smallexample
25843 @noindent
25844 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
25845 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
25847 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
25848 alignment of the zero-length bit-field is greater than the member that follows it,
25849 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
25851 For example:
25853 @smallexample
25854 struct
25855  @{
25856    char foo : 4;
25857    short : 0;
25858    char bar;
25859  @} t2;
25861 struct
25862  @{
25863    char foo : 4;
25864    short : 0;
25865    double bar;
25866  @} t3;
25867 @end smallexample
25869 @noindent
25870 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
25871 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
25872 bit-field does not affect the alignment of @code{bar} or, as a result, the size
25873 of the structure.
25875 Taking this into account, it is important to note the following:
25877 @enumerate
25878 @item If a zero-length bit-field follows a normal bit-field, the type of the
25879 zero-length bit-field may affect the alignment of the structure as whole. For
25880 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
25881 normal bit-field, and is of type short.
25883 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
25884 still affect the alignment of the structure:
25886 @smallexample
25887 struct
25888  @{
25889    char foo : 6;
25890    long : 0;
25891  @} t4;
25892 @end smallexample
25894 @noindent
25895 Here, @code{t4} takes up 4 bytes.
25896 @end enumerate
25898 @item Zero-length bit-fields following non-bit-field members are ignored:
25900 @smallexample
25901 struct
25902  @{
25903    char foo;
25904    long : 0;
25905    char bar;
25906  @} t5;
25907 @end smallexample
25909 @noindent
25910 Here, @code{t5} takes up 2 bytes.
25911 @end enumerate
25914 @item -mno-align-stringops
25915 @opindex mno-align-stringops
25916 Do not align the destination of inlined string operations.  This switch reduces
25917 code size and improves performance in case the destination is already aligned,
25918 but GCC doesn't know about it.
25920 @item -minline-all-stringops
25921 @opindex minline-all-stringops
25922 By default GCC inlines string operations only when the destination is 
25923 known to be aligned to least a 4-byte boundary.  
25924 This enables more inlining and increases code
25925 size, but may improve performance of code that depends on fast
25926 @code{memcpy}, @code{strlen},
25927 and @code{memset} for short lengths.
25929 @item -minline-stringops-dynamically
25930 @opindex minline-stringops-dynamically
25931 For string operations of unknown size, use run-time checks with
25932 inline code for small blocks and a library call for large blocks.
25934 @item -mstringop-strategy=@var{alg}
25935 @opindex mstringop-strategy=@var{alg}
25936 Override the internal decision heuristic for the particular algorithm to use
25937 for inlining string operations.  The allowed values for @var{alg} are:
25939 @table @samp
25940 @item rep_byte
25941 @itemx rep_4byte
25942 @itemx rep_8byte
25943 Expand using i386 @code{rep} prefix of the specified size.
25945 @item byte_loop
25946 @itemx loop
25947 @itemx unrolled_loop
25948 Expand into an inline loop.
25950 @item libcall
25951 Always use a library call.
25952 @end table
25954 @item -mmemcpy-strategy=@var{strategy}
25955 @opindex mmemcpy-strategy=@var{strategy}
25956 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
25957 should be inlined and what inline algorithm to use when the expected size
25958 of the copy operation is known. @var{strategy} 
25959 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
25960 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
25961 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
25962 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
25963 in the list must be specified in increasing order.  The minimal byte size for 
25964 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
25965 preceding range.
25967 @item -mmemset-strategy=@var{strategy}
25968 @opindex mmemset-strategy=@var{strategy}
25969 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
25970 @code{__builtin_memset} expansion.
25972 @item -momit-leaf-frame-pointer
25973 @opindex momit-leaf-frame-pointer
25974 Don't keep the frame pointer in a register for leaf functions.  This
25975 avoids the instructions to save, set up, and restore frame pointers and
25976 makes an extra register available in leaf functions.  The option
25977 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
25978 which might make debugging harder.
25980 @item -mtls-direct-seg-refs
25981 @itemx -mno-tls-direct-seg-refs
25982 @opindex mtls-direct-seg-refs
25983 Controls whether TLS variables may be accessed with offsets from the
25984 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
25985 or whether the thread base pointer must be added.  Whether or not this
25986 is valid depends on the operating system, and whether it maps the
25987 segment to cover the entire TLS area.
25989 For systems that use the GNU C Library, the default is on.
25991 @item -msse2avx
25992 @itemx -mno-sse2avx
25993 @opindex msse2avx
25994 Specify that the assembler should encode SSE instructions with VEX
25995 prefix.  The option @option{-mavx} turns this on by default.
25997 @item -mfentry
25998 @itemx -mno-fentry
25999 @opindex mfentry
26000 If profiling is active (@option{-pg}), put the profiling
26001 counter call before the prologue.
26002 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26003 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26005 @item -mrecord-mcount
26006 @itemx -mno-record-mcount
26007 @opindex mrecord-mcount
26008 If profiling is active (@option{-pg}), generate a __mcount_loc section
26009 that contains pointers to each profiling call. This is useful for
26010 automatically patching and out calls.
26012 @item -mnop-mcount
26013 @itemx -mno-nop-mcount
26014 @opindex mnop-mcount
26015 If profiling is active (@option{-pg}), generate the calls to
26016 the profiling functions as NOPs. This is useful when they
26017 should be patched in later dynamically. This is likely only
26018 useful together with @option{-mrecord-mcount}.
26020 @item -mskip-rax-setup
26021 @itemx -mno-skip-rax-setup
26022 @opindex mskip-rax-setup
26023 When generating code for the x86-64 architecture with SSE extensions
26024 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26025 register when there are no variable arguments passed in vector registers.
26027 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26028 saving vector registers on stack when passing variable arguments, the
26029 impacts of this option are callees may waste some stack space,
26030 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26031 those issues, regardless the RAX register value.
26033 @item -m8bit-idiv
26034 @itemx -mno-8bit-idiv
26035 @opindex m8bit-idiv
26036 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26037 much faster than 32-bit/64-bit integer divide.  This option generates a
26038 run-time check.  If both dividend and divisor are within range of 0
26039 to 255, 8-bit unsigned integer divide is used instead of
26040 32-bit/64-bit integer divide.
26042 @item -mavx256-split-unaligned-load
26043 @itemx -mavx256-split-unaligned-store
26044 @opindex mavx256-split-unaligned-load
26045 @opindex mavx256-split-unaligned-store
26046 Split 32-byte AVX unaligned load and store.
26048 @item -mstack-protector-guard=@var{guard}
26049 @opindex mstack-protector-guard=@var{guard}
26050 Generate stack protection code using canary at @var{guard}.  Supported
26051 locations are @samp{global} for global canary or @samp{tls} for per-thread
26052 canary in the TLS block (the default).  This option has effect only when
26053 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26055 @item -mmitigate-rop
26056 @opindex mmitigate-rop
26057 Try to avoid generating code sequences that contain unintended return
26058 opcodes, to mitigate against certain forms of attack. At the moment,
26059 this option is limited in what it can do and should not be relied
26060 on to provide serious protection.
26062 @item -mgeneral-regs-only
26063 @opindex mgeneral-regs-only
26064 Generate code that uses only the general-purpose registers.  This
26065 prevents the compiler from using floating-point, vector, mask and bound
26066 registers.
26068 @end table
26070 These @samp{-m} switches are supported in addition to the above
26071 on x86-64 processors in 64-bit environments.
26073 @table @gcctabopt
26074 @item -m32
26075 @itemx -m64
26076 @itemx -mx32
26077 @itemx -m16
26078 @itemx -miamcu
26079 @opindex m32
26080 @opindex m64
26081 @opindex mx32
26082 @opindex m16
26083 @opindex miamcu
26084 Generate code for a 16-bit, 32-bit or 64-bit environment.
26085 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26086 to 32 bits, and
26087 generates code that runs on any i386 system.
26089 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26090 types to 64 bits, and generates code for the x86-64 architecture.
26091 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26092 and @option{-mdynamic-no-pic} options.
26094 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26095 to 32 bits, and
26096 generates code for the x86-64 architecture.
26098 The @option{-m16} option is the same as @option{-m32}, except for that
26099 it outputs the @code{.code16gcc} assembly directive at the beginning of
26100 the assembly output so that the binary can run in 16-bit mode.
26102 The @option{-miamcu} option generates code which conforms to Intel MCU
26103 psABI.  It requires the @option{-m32} option to be turned on.
26105 @item -mno-red-zone
26106 @opindex mno-red-zone
26107 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26108 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26109 stack pointer that is not modified by signal or interrupt handlers
26110 and therefore can be used for temporary data without adjusting the stack
26111 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26113 @item -mcmodel=small
26114 @opindex mcmodel=small
26115 Generate code for the small code model: the program and its symbols must
26116 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26117 Programs can be statically or dynamically linked.  This is the default
26118 code model.
26120 @item -mcmodel=kernel
26121 @opindex mcmodel=kernel
26122 Generate code for the kernel code model.  The kernel runs in the
26123 negative 2 GB of the address space.
26124 This model has to be used for Linux kernel code.
26126 @item -mcmodel=medium
26127 @opindex mcmodel=medium
26128 Generate code for the medium model: the program is linked in the lower 2
26129 GB of the address space.  Small symbols are also placed there.  Symbols
26130 with sizes larger than @option{-mlarge-data-threshold} are put into
26131 large data or BSS sections and can be located above 2GB.  Programs can
26132 be statically or dynamically linked.
26134 @item -mcmodel=large
26135 @opindex mcmodel=large
26136 Generate code for the large model.  This model makes no assumptions
26137 about addresses and sizes of sections.
26139 @item -maddress-mode=long
26140 @opindex maddress-mode=long
26141 Generate code for long address mode.  This is only supported for 64-bit
26142 and x32 environments.  It is the default address mode for 64-bit
26143 environments.
26145 @item -maddress-mode=short
26146 @opindex maddress-mode=short
26147 Generate code for short address mode.  This is only supported for 32-bit
26148 and x32 environments.  It is the default address mode for 32-bit and
26149 x32 environments.
26150 @end table
26152 @node x86 Windows Options
26153 @subsection x86 Windows Options
26154 @cindex x86 Windows Options
26155 @cindex Windows Options for x86
26157 These additional options are available for Microsoft Windows targets:
26159 @table @gcctabopt
26160 @item -mconsole
26161 @opindex mconsole
26162 This option
26163 specifies that a console application is to be generated, by
26164 instructing the linker to set the PE header subsystem type
26165 required for console applications.
26166 This option is available for Cygwin and MinGW targets and is
26167 enabled by default on those targets.
26169 @item -mdll
26170 @opindex mdll
26171 This option is available for Cygwin and MinGW targets.  It
26172 specifies that a DLL---a dynamic link library---is to be
26173 generated, enabling the selection of the required runtime
26174 startup object and entry point.
26176 @item -mnop-fun-dllimport
26177 @opindex mnop-fun-dllimport
26178 This option is available for Cygwin and MinGW targets.  It
26179 specifies that the @code{dllimport} attribute should be ignored.
26181 @item -mthread
26182 @opindex mthread
26183 This option is available for MinGW targets. It specifies
26184 that MinGW-specific thread support is to be used.
26186 @item -municode
26187 @opindex municode
26188 This option is available for MinGW-w64 targets.  It causes
26189 the @code{UNICODE} preprocessor macro to be predefined, and
26190 chooses Unicode-capable runtime startup code.
26192 @item -mwin32
26193 @opindex mwin32
26194 This option is available for Cygwin and MinGW targets.  It
26195 specifies that the typical Microsoft Windows predefined macros are to
26196 be set in the pre-processor, but does not influence the choice
26197 of runtime library/startup code.
26199 @item -mwindows
26200 @opindex mwindows
26201 This option is available for Cygwin and MinGW targets.  It
26202 specifies that a GUI application is to be generated by
26203 instructing the linker to set the PE header subsystem type
26204 appropriately.
26206 @item -fno-set-stack-executable
26207 @opindex fno-set-stack-executable
26208 This option is available for MinGW targets. It specifies that
26209 the executable flag for the stack used by nested functions isn't
26210 set. This is necessary for binaries running in kernel mode of
26211 Microsoft Windows, as there the User32 API, which is used to set executable
26212 privileges, isn't available.
26214 @item -fwritable-relocated-rdata
26215 @opindex fno-writable-relocated-rdata
26216 This option is available for MinGW and Cygwin targets.  It specifies
26217 that relocated-data in read-only section is put into the @code{.data}
26218 section.  This is a necessary for older runtimes not supporting
26219 modification of @code{.rdata} sections for pseudo-relocation.
26221 @item -mpe-aligned-commons
26222 @opindex mpe-aligned-commons
26223 This option is available for Cygwin and MinGW targets.  It
26224 specifies that the GNU extension to the PE file format that
26225 permits the correct alignment of COMMON variables should be
26226 used when generating code.  It is enabled by default if
26227 GCC detects that the target assembler found during configuration
26228 supports the feature.
26229 @end table
26231 See also under @ref{x86 Options} for standard options.
26233 @node Xstormy16 Options
26234 @subsection Xstormy16 Options
26235 @cindex Xstormy16 Options
26237 These options are defined for Xstormy16:
26239 @table @gcctabopt
26240 @item -msim
26241 @opindex msim
26242 Choose startup files and linker script suitable for the simulator.
26243 @end table
26245 @node Xtensa Options
26246 @subsection Xtensa Options
26247 @cindex Xtensa Options
26249 These options are supported for Xtensa targets:
26251 @table @gcctabopt
26252 @item -mconst16
26253 @itemx -mno-const16
26254 @opindex mconst16
26255 @opindex mno-const16
26256 Enable or disable use of @code{CONST16} instructions for loading
26257 constant values.  The @code{CONST16} instruction is currently not a
26258 standard option from Tensilica.  When enabled, @code{CONST16}
26259 instructions are always used in place of the standard @code{L32R}
26260 instructions.  The use of @code{CONST16} is enabled by default only if
26261 the @code{L32R} instruction is not available.
26263 @item -mfused-madd
26264 @itemx -mno-fused-madd
26265 @opindex mfused-madd
26266 @opindex mno-fused-madd
26267 Enable or disable use of fused multiply/add and multiply/subtract
26268 instructions in the floating-point option.  This has no effect if the
26269 floating-point option is not also enabled.  Disabling fused multiply/add
26270 and multiply/subtract instructions forces the compiler to use separate
26271 instructions for the multiply and add/subtract operations.  This may be
26272 desirable in some cases where strict IEEE 754-compliant results are
26273 required: the fused multiply add/subtract instructions do not round the
26274 intermediate result, thereby producing results with @emph{more} bits of
26275 precision than specified by the IEEE standard.  Disabling fused multiply
26276 add/subtract instructions also ensures that the program output is not
26277 sensitive to the compiler's ability to combine multiply and add/subtract
26278 operations.
26280 @item -mserialize-volatile
26281 @itemx -mno-serialize-volatile
26282 @opindex mserialize-volatile
26283 @opindex mno-serialize-volatile
26284 When this option is enabled, GCC inserts @code{MEMW} instructions before
26285 @code{volatile} memory references to guarantee sequential consistency.
26286 The default is @option{-mserialize-volatile}.  Use
26287 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26289 @item -mforce-no-pic
26290 @opindex mforce-no-pic
26291 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26292 position-independent code (PIC), this option disables PIC for compiling
26293 kernel code.
26295 @item -mtext-section-literals
26296 @itemx -mno-text-section-literals
26297 @opindex mtext-section-literals
26298 @opindex mno-text-section-literals
26299 These options control the treatment of literal pools.  The default is
26300 @option{-mno-text-section-literals}, which places literals in a separate
26301 section in the output file.  This allows the literal pool to be placed
26302 in a data RAM/ROM, and it also allows the linker to combine literal
26303 pools from separate object files to remove redundant literals and
26304 improve code size.  With @option{-mtext-section-literals}, the literals
26305 are interspersed in the text section in order to keep them as close as
26306 possible to their references.  This may be necessary for large assembly
26307 files.  Literals for each function are placed right before that function.
26309 @item -mauto-litpools
26310 @itemx -mno-auto-litpools
26311 @opindex mauto-litpools
26312 @opindex mno-auto-litpools
26313 These options control the treatment of literal pools.  The default is
26314 @option{-mno-auto-litpools}, which places literals in a separate
26315 section in the output file unless @option{-mtext-section-literals} is
26316 used.  With @option{-mauto-litpools} the literals are interspersed in
26317 the text section by the assembler.  Compiler does not produce explicit
26318 @code{.literal} directives and loads literals into registers with
26319 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26320 do relaxation and place literals as necessary.  This option allows
26321 assembler to create several literal pools per function and assemble
26322 very big functions, which may not be possible with
26323 @option{-mtext-section-literals}.
26325 @item -mtarget-align
26326 @itemx -mno-target-align
26327 @opindex mtarget-align
26328 @opindex mno-target-align
26329 When this option is enabled, GCC instructs the assembler to
26330 automatically align instructions to reduce branch penalties at the
26331 expense of some code density.  The assembler attempts to widen density
26332 instructions to align branch targets and the instructions following call
26333 instructions.  If there are not enough preceding safe density
26334 instructions to align a target, no widening is performed.  The
26335 default is @option{-mtarget-align}.  These options do not affect the
26336 treatment of auto-aligned instructions like @code{LOOP}, which the
26337 assembler always aligns, either by widening density instructions or
26338 by inserting NOP instructions.
26340 @item -mlongcalls
26341 @itemx -mno-longcalls
26342 @opindex mlongcalls
26343 @opindex mno-longcalls
26344 When this option is enabled, GCC instructs the assembler to translate
26345 direct calls to indirect calls unless it can determine that the target
26346 of a direct call is in the range allowed by the call instruction.  This
26347 translation typically occurs for calls to functions in other source
26348 files.  Specifically, the assembler translates a direct @code{CALL}
26349 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26350 The default is @option{-mno-longcalls}.  This option should be used in
26351 programs where the call target can potentially be out of range.  This
26352 option is implemented in the assembler, not the compiler, so the
26353 assembly code generated by GCC still shows direct call
26354 instructions---look at the disassembled object code to see the actual
26355 instructions.  Note that the assembler uses an indirect call for
26356 every cross-file call, not just those that really are out of range.
26357 @end table
26359 @node zSeries Options
26360 @subsection zSeries Options
26361 @cindex zSeries options
26363 These are listed under @xref{S/390 and zSeries Options}.
26366 @c man end
26368 @node Spec Files
26369 @section Specifying Subprocesses and the Switches to Pass to Them
26370 @cindex Spec Files
26372 @command{gcc} is a driver program.  It performs its job by invoking a
26373 sequence of other programs to do the work of compiling, assembling and
26374 linking.  GCC interprets its command-line parameters and uses these to
26375 deduce which programs it should invoke, and which command-line options
26376 it ought to place on their command lines.  This behavior is controlled
26377 by @dfn{spec strings}.  In most cases there is one spec string for each
26378 program that GCC can invoke, but a few programs have multiple spec
26379 strings to control their behavior.  The spec strings built into GCC can
26380 be overridden by using the @option{-specs=} command-line switch to specify
26381 a spec file.
26383 @dfn{Spec files} are plain-text files that are used to construct spec
26384 strings.  They consist of a sequence of directives separated by blank
26385 lines.  The type of directive is determined by the first non-whitespace
26386 character on the line, which can be one of the following:
26388 @table @code
26389 @item %@var{command}
26390 Issues a @var{command} to the spec file processor.  The commands that can
26391 appear here are:
26393 @table @code
26394 @item %include <@var{file}>
26395 @cindex @code{%include}
26396 Search for @var{file} and insert its text at the current point in the
26397 specs file.
26399 @item %include_noerr <@var{file}>
26400 @cindex @code{%include_noerr}
26401 Just like @samp{%include}, but do not generate an error message if the include
26402 file cannot be found.
26404 @item %rename @var{old_name} @var{new_name}
26405 @cindex @code{%rename}
26406 Rename the spec string @var{old_name} to @var{new_name}.
26408 @end table
26410 @item *[@var{spec_name}]:
26411 This tells the compiler to create, override or delete the named spec
26412 string.  All lines after this directive up to the next directive or
26413 blank line are considered to be the text for the spec string.  If this
26414 results in an empty string then the spec is deleted.  (Or, if the
26415 spec did not exist, then nothing happens.)  Otherwise, if the spec
26416 does not currently exist a new spec is created.  If the spec does
26417 exist then its contents are overridden by the text of this
26418 directive, unless the first character of that text is the @samp{+}
26419 character, in which case the text is appended to the spec.
26421 @item [@var{suffix}]:
26422 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26423 and up to the next directive or blank line are considered to make up the
26424 spec string for the indicated suffix.  When the compiler encounters an
26425 input file with the named suffix, it processes the spec string in
26426 order to work out how to compile that file.  For example:
26428 @smallexample
26429 .ZZ:
26430 z-compile -input %i
26431 @end smallexample
26433 This says that any input file whose name ends in @samp{.ZZ} should be
26434 passed to the program @samp{z-compile}, which should be invoked with the
26435 command-line switch @option{-input} and with the result of performing the
26436 @samp{%i} substitution.  (See below.)
26438 As an alternative to providing a spec string, the text following a
26439 suffix directive can be one of the following:
26441 @table @code
26442 @item @@@var{language}
26443 This says that the suffix is an alias for a known @var{language}.  This is
26444 similar to using the @option{-x} command-line switch to GCC to specify a
26445 language explicitly.  For example:
26447 @smallexample
26448 .ZZ:
26449 @@c++
26450 @end smallexample
26452 Says that .ZZ files are, in fact, C++ source files.
26454 @item #@var{name}
26455 This causes an error messages saying:
26457 @smallexample
26458 @var{name} compiler not installed on this system.
26459 @end smallexample
26460 @end table
26462 GCC already has an extensive list of suffixes built into it.
26463 This directive adds an entry to the end of the list of suffixes, but
26464 since the list is searched from the end backwards, it is effectively
26465 possible to override earlier entries using this technique.
26467 @end table
26469 GCC has the following spec strings built into it.  Spec files can
26470 override these strings or create their own.  Note that individual
26471 targets can also add their own spec strings to this list.
26473 @smallexample
26474 asm          Options to pass to the assembler
26475 asm_final    Options to pass to the assembler post-processor
26476 cpp          Options to pass to the C preprocessor
26477 cc1          Options to pass to the C compiler
26478 cc1plus      Options to pass to the C++ compiler
26479 endfile      Object files to include at the end of the link
26480 link         Options to pass to the linker
26481 lib          Libraries to include on the command line to the linker
26482 libgcc       Decides which GCC support library to pass to the linker
26483 linker       Sets the name of the linker
26484 predefines   Defines to be passed to the C preprocessor
26485 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26486              by default
26487 startfile    Object files to include at the start of the link
26488 @end smallexample
26490 Here is a small example of a spec file:
26492 @smallexample
26493 %rename lib                 old_lib
26495 *lib:
26496 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26497 @end smallexample
26499 This example renames the spec called @samp{lib} to @samp{old_lib} and
26500 then overrides the previous definition of @samp{lib} with a new one.
26501 The new definition adds in some extra command-line options before
26502 including the text of the old definition.
26504 @dfn{Spec strings} are a list of command-line options to be passed to their
26505 corresponding program.  In addition, the spec strings can contain
26506 @samp{%}-prefixed sequences to substitute variable text or to
26507 conditionally insert text into the command line.  Using these constructs
26508 it is possible to generate quite complex command lines.
26510 Here is a table of all defined @samp{%}-sequences for spec
26511 strings.  Note that spaces are not generated automatically around the
26512 results of expanding these sequences.  Therefore you can concatenate them
26513 together or combine them with constant text in a single argument.
26515 @table @code
26516 @item %%
26517 Substitute one @samp{%} into the program name or argument.
26519 @item %i
26520 Substitute the name of the input file being processed.
26522 @item %b
26523 Substitute the basename of the input file being processed.
26524 This is the substring up to (and not including) the last period
26525 and not including the directory.
26527 @item %B
26528 This is the same as @samp{%b}, but include the file suffix (text after
26529 the last period).
26531 @item %d
26532 Marks the argument containing or following the @samp{%d} as a
26533 temporary file name, so that that file is deleted if GCC exits
26534 successfully.  Unlike @samp{%g}, this contributes no text to the
26535 argument.
26537 @item %g@var{suffix}
26538 Substitute a file name that has suffix @var{suffix} and is chosen
26539 once per compilation, and mark the argument in the same way as
26540 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26541 name is now chosen in a way that is hard to predict even when previously
26542 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26543 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26544 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26545 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26546 was simply substituted with a file name chosen once per compilation,
26547 without regard to any appended suffix (which was therefore treated
26548 just like ordinary text), making such attacks more likely to succeed.
26550 @item %u@var{suffix}
26551 Like @samp{%g}, but generates a new temporary file name
26552 each time it appears instead of once per compilation.
26554 @item %U@var{suffix}
26555 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26556 new one if there is no such last file name.  In the absence of any
26557 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26558 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26559 involves the generation of two distinct file names, one
26560 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26561 simply substituted with a file name chosen for the previous @samp{%u},
26562 without regard to any appended suffix.
26564 @item %j@var{suffix}
26565 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26566 writable, and if @option{-save-temps} is not used; 
26567 otherwise, substitute the name
26568 of a temporary file, just like @samp{%u}.  This temporary file is not
26569 meant for communication between processes, but rather as a junk
26570 disposal mechanism.
26572 @item %|@var{suffix}
26573 @itemx %m@var{suffix}
26574 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26575 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26576 all.  These are the two most common ways to instruct a program that it
26577 should read from standard input or write to standard output.  If you
26578 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26579 construct: see for example @file{f/lang-specs.h}.
26581 @item %.@var{SUFFIX}
26582 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26583 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26584 terminated by the next space or %.
26586 @item %w
26587 Marks the argument containing or following the @samp{%w} as the
26588 designated output file of this compilation.  This puts the argument
26589 into the sequence of arguments that @samp{%o} substitutes.
26591 @item %o
26592 Substitutes the names of all the output files, with spaces
26593 automatically placed around them.  You should write spaces
26594 around the @samp{%o} as well or the results are undefined.
26595 @samp{%o} is for use in the specs for running the linker.
26596 Input files whose names have no recognized suffix are not compiled
26597 at all, but they are included among the output files, so they are
26598 linked.
26600 @item %O
26601 Substitutes the suffix for object files.  Note that this is
26602 handled specially when it immediately follows @samp{%g, %u, or %U},
26603 because of the need for those to form complete file names.  The
26604 handling is such that @samp{%O} is treated exactly as if it had already
26605 been substituted, except that @samp{%g, %u, and %U} do not currently
26606 support additional @var{suffix} characters following @samp{%O} as they do
26607 following, for example, @samp{.o}.
26609 @item %p
26610 Substitutes the standard macro predefinitions for the
26611 current target machine.  Use this when running @command{cpp}.
26613 @item %P
26614 Like @samp{%p}, but puts @samp{__} before and after the name of each
26615 predefined macro, except for macros that start with @samp{__} or with
26616 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26619 @item %I
26620 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26621 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26622 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26623 and @option{-imultilib} as necessary.
26625 @item %s
26626 Current argument is the name of a library or startup file of some sort.
26627 Search for that file in a standard list of directories and substitute
26628 the full name found.  The current working directory is included in the
26629 list of directories scanned.
26631 @item %T
26632 Current argument is the name of a linker script.  Search for that file
26633 in the current list of directories to scan for libraries. If the file
26634 is located insert a @option{--script} option into the command line
26635 followed by the full path name found.  If the file is not found then
26636 generate an error message.  Note: the current working directory is not
26637 searched.
26639 @item %e@var{str}
26640 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26641 Use this when inconsistent options are detected.
26643 @item %(@var{name})
26644 Substitute the contents of spec string @var{name} at this point.
26646 @item %x@{@var{option}@}
26647 Accumulate an option for @samp{%X}.
26649 @item %X
26650 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26651 spec string.
26653 @item %Y
26654 Output the accumulated assembler options specified by @option{-Wa}.
26656 @item %Z
26657 Output the accumulated preprocessor options specified by @option{-Wp}.
26659 @item %a
26660 Process the @code{asm} spec.  This is used to compute the
26661 switches to be passed to the assembler.
26663 @item %A
26664 Process the @code{asm_final} spec.  This is a spec string for
26665 passing switches to an assembler post-processor, if such a program is
26666 needed.
26668 @item %l
26669 Process the @code{link} spec.  This is the spec for computing the
26670 command line passed to the linker.  Typically it makes use of the
26671 @samp{%L %G %S %D and %E} sequences.
26673 @item %D
26674 Dump out a @option{-L} option for each directory that GCC believes might
26675 contain startup files.  If the target supports multilibs then the
26676 current multilib directory is prepended to each of these paths.
26678 @item %L
26679 Process the @code{lib} spec.  This is a spec string for deciding which
26680 libraries are included on the command line to the linker.
26682 @item %G
26683 Process the @code{libgcc} spec.  This is a spec string for deciding
26684 which GCC support library is included on the command line to the linker.
26686 @item %S
26687 Process the @code{startfile} spec.  This is a spec for deciding which
26688 object files are the first ones passed to the linker.  Typically
26689 this might be a file named @file{crt0.o}.
26691 @item %E
26692 Process the @code{endfile} spec.  This is a spec string that specifies
26693 the last object files that are passed to the linker.
26695 @item %C
26696 Process the @code{cpp} spec.  This is used to construct the arguments
26697 to be passed to the C preprocessor.
26699 @item %1
26700 Process the @code{cc1} spec.  This is used to construct the options to be
26701 passed to the actual C compiler (@command{cc1}).
26703 @item %2
26704 Process the @code{cc1plus} spec.  This is used to construct the options to be
26705 passed to the actual C++ compiler (@command{cc1plus}).
26707 @item %*
26708 Substitute the variable part of a matched option.  See below.
26709 Note that each comma in the substituted string is replaced by
26710 a single space.
26712 @item %<S
26713 Remove all occurrences of @code{-S} from the command line.  Note---this
26714 command is position dependent.  @samp{%} commands in the spec string
26715 before this one see @code{-S}, @samp{%} commands in the spec string
26716 after this one do not.
26718 @item %:@var{function}(@var{args})
26719 Call the named function @var{function}, passing it @var{args}.
26720 @var{args} is first processed as a nested spec string, then split
26721 into an argument vector in the usual fashion.  The function returns
26722 a string which is processed as if it had appeared literally as part
26723 of the current spec.
26725 The following built-in spec functions are provided:
26727 @table @code
26728 @item @code{getenv}
26729 The @code{getenv} spec function takes two arguments: an environment
26730 variable name and a string.  If the environment variable is not
26731 defined, a fatal error is issued.  Otherwise, the return value is the
26732 value of the environment variable concatenated with the string.  For
26733 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26735 @smallexample
26736 %:getenv(TOPDIR /include)
26737 @end smallexample
26739 expands to @file{/path/to/top/include}.
26741 @item @code{if-exists}
26742 The @code{if-exists} spec function takes one argument, an absolute
26743 pathname to a file.  If the file exists, @code{if-exists} returns the
26744 pathname.  Here is a small example of its usage:
26746 @smallexample
26747 *startfile:
26748 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
26749 @end smallexample
26751 @item @code{if-exists-else}
26752 The @code{if-exists-else} spec function is similar to the @code{if-exists}
26753 spec function, except that it takes two arguments.  The first argument is
26754 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
26755 returns the pathname.  If it does not exist, it returns the second argument.
26756 This way, @code{if-exists-else} can be used to select one file or another,
26757 based on the existence of the first.  Here is a small example of its usage:
26759 @smallexample
26760 *startfile:
26761 crt0%O%s %:if-exists(crti%O%s) \
26762 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
26763 @end smallexample
26765 @item @code{replace-outfile}
26766 The @code{replace-outfile} spec function takes two arguments.  It looks for the
26767 first argument in the outfiles array and replaces it with the second argument.  Here
26768 is a small example of its usage:
26770 @smallexample
26771 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
26772 @end smallexample
26774 @item @code{remove-outfile}
26775 The @code{remove-outfile} spec function takes one argument.  It looks for the
26776 first argument in the outfiles array and removes it.  Here is a small example
26777 its usage:
26779 @smallexample
26780 %:remove-outfile(-lm)
26781 @end smallexample
26783 @item @code{pass-through-libs}
26784 The @code{pass-through-libs} spec function takes any number of arguments.  It
26785 finds any @option{-l} options and any non-options ending in @file{.a} (which it
26786 assumes are the names of linker input library archive files) and returns a
26787 result containing all the found arguments each prepended by
26788 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
26789 intended to be passed to the LTO linker plugin.
26791 @smallexample
26792 %:pass-through-libs(%G %L %G)
26793 @end smallexample
26795 @item @code{print-asm-header}
26796 The @code{print-asm-header} function takes no arguments and simply
26797 prints a banner like:
26799 @smallexample
26800 Assembler options
26801 =================
26803 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
26804 @end smallexample
26806 It is used to separate compiler options from assembler options
26807 in the @option{--target-help} output.
26808 @end table
26810 @item %@{S@}
26811 Substitutes the @code{-S} switch, if that switch is given to GCC@.
26812 If that switch is not specified, this substitutes nothing.  Note that
26813 the leading dash is omitted when specifying this option, and it is
26814 automatically inserted if the substitution is performed.  Thus the spec
26815 string @samp{%@{foo@}} matches the command-line option @option{-foo}
26816 and outputs the command-line option @option{-foo}.
26818 @item %W@{S@}
26819 Like %@{@code{S}@} but mark last argument supplied within as a file to be
26820 deleted on failure.
26822 @item %@{S*@}
26823 Substitutes all the switches specified to GCC whose names start
26824 with @code{-S}, but which also take an argument.  This is used for
26825 switches like @option{-o}, @option{-D}, @option{-I}, etc.
26826 GCC considers @option{-o foo} as being
26827 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
26828 text, including the space.  Thus two arguments are generated.
26830 @item %@{S*&T*@}
26831 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
26832 (the order of @code{S} and @code{T} in the spec is not significant).
26833 There can be any number of ampersand-separated variables; for each the
26834 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
26836 @item %@{S:X@}
26837 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
26839 @item %@{!S:X@}
26840 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
26842 @item %@{S*:X@}
26843 Substitutes @code{X} if one or more switches whose names start with
26844 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
26845 once, no matter how many such switches appeared.  However, if @code{%*}
26846 appears somewhere in @code{X}, then @code{X} is substituted once
26847 for each matching switch, with the @code{%*} replaced by the part of
26848 that switch matching the @code{*}.
26850 If @code{%*} appears as the last part of a spec sequence then a space
26851 is added after the end of the last substitution.  If there is more
26852 text in the sequence, however, then a space is not generated.  This
26853 allows the @code{%*} substitution to be used as part of a larger
26854 string.  For example, a spec string like this:
26856 @smallexample
26857 %@{mcu=*:--script=%*/memory.ld@}
26858 @end smallexample
26860 @noindent
26861 when matching an option like @option{-mcu=newchip} produces:
26863 @smallexample
26864 --script=newchip/memory.ld
26865 @end smallexample
26867 @item %@{.S:X@}
26868 Substitutes @code{X}, if processing a file with suffix @code{S}.
26870 @item %@{!.S:X@}
26871 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
26873 @item %@{,S:X@}
26874 Substitutes @code{X}, if processing a file for language @code{S}.
26876 @item %@{!,S:X@}
26877 Substitutes @code{X}, if not processing a file for language @code{S}.
26879 @item %@{S|P:X@}
26880 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
26881 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
26882 @code{*} sequences as well, although they have a stronger binding than
26883 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
26884 alternatives must be starred, and only the first matching alternative
26885 is substituted.
26887 For example, a spec string like this:
26889 @smallexample
26890 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
26891 @end smallexample
26893 @noindent
26894 outputs the following command-line options from the following input
26895 command-line options:
26897 @smallexample
26898 fred.c        -foo -baz
26899 jim.d         -bar -boggle
26900 -d fred.c     -foo -baz -boggle
26901 -d jim.d      -bar -baz -boggle
26902 @end smallexample
26904 @item %@{S:X; T:Y; :D@}
26906 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
26907 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
26908 be as many clauses as you need.  This may be combined with @code{.},
26909 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
26912 @end table
26914 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
26915 or similar construct can use a backslash to ignore the special meaning
26916 of the character following it, thus allowing literal matching of a
26917 character that is otherwise specially treated.  For example,
26918 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
26919 @option{-std=iso9899:1999} option is given.
26921 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
26922 construct may contain other nested @samp{%} constructs or spaces, or
26923 even newlines.  They are processed as usual, as described above.
26924 Trailing white space in @code{X} is ignored.  White space may also
26925 appear anywhere on the left side of the colon in these constructs,
26926 except between @code{.} or @code{*} and the corresponding word.
26928 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
26929 handled specifically in these constructs.  If another value of
26930 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
26931 @option{-W} switch is found later in the command line, the earlier
26932 switch value is ignored, except with @{@code{S}*@} where @code{S} is
26933 just one letter, which passes all matching options.
26935 The character @samp{|} at the beginning of the predicate text is used to
26936 indicate that a command should be piped to the following command, but
26937 only if @option{-pipe} is specified.
26939 It is built into GCC which switches take arguments and which do not.
26940 (You might think it would be useful to generalize this to allow each
26941 compiler's spec to say which switches take arguments.  But this cannot
26942 be done in a consistent fashion.  GCC cannot even decide which input
26943 files have been specified without knowing which switches take arguments,
26944 and it must know which input files to compile in order to tell which
26945 compilers to run).
26947 GCC also knows implicitly that arguments starting in @option{-l} are to be
26948 treated as compiler output files, and passed to the linker in their
26949 proper position among the other output files.
26951 @node Environment Variables
26952 @section Environment Variables Affecting GCC
26953 @cindex environment variables
26955 @c man begin ENVIRONMENT
26956 This section describes several environment variables that affect how GCC
26957 operates.  Some of them work by specifying directories or prefixes to use
26958 when searching for various kinds of files.  Some are used to specify other
26959 aspects of the compilation environment.
26961 Note that you can also specify places to search using options such as
26962 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
26963 take precedence over places specified using environment variables, which
26964 in turn take precedence over those specified by the configuration of GCC@.
26965 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
26966 GNU Compiler Collection (GCC) Internals}.
26968 @table @env
26969 @item LANG
26970 @itemx LC_CTYPE
26971 @c @itemx LC_COLLATE
26972 @itemx LC_MESSAGES
26973 @c @itemx LC_MONETARY
26974 @c @itemx LC_NUMERIC
26975 @c @itemx LC_TIME
26976 @itemx LC_ALL
26977 @findex LANG
26978 @findex LC_CTYPE
26979 @c @findex LC_COLLATE
26980 @findex LC_MESSAGES
26981 @c @findex LC_MONETARY
26982 @c @findex LC_NUMERIC
26983 @c @findex LC_TIME
26984 @findex LC_ALL
26985 @cindex locale
26986 These environment variables control the way that GCC uses
26987 localization information which allows GCC to work with different
26988 national conventions.  GCC inspects the locale categories
26989 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
26990 so.  These locale categories can be set to any value supported by your
26991 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
26992 Kingdom encoded in UTF-8.
26994 The @env{LC_CTYPE} environment variable specifies character
26995 classification.  GCC uses it to determine the character boundaries in
26996 a string; this is needed for some multibyte encodings that contain quote
26997 and escape characters that are otherwise interpreted as a string
26998 end or escape.
27000 The @env{LC_MESSAGES} environment variable specifies the language to
27001 use in diagnostic messages.
27003 If the @env{LC_ALL} environment variable is set, it overrides the value
27004 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27005 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27006 environment variable.  If none of these variables are set, GCC
27007 defaults to traditional C English behavior.
27009 @item TMPDIR
27010 @findex TMPDIR
27011 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27012 files.  GCC uses temporary files to hold the output of one stage of
27013 compilation which is to be used as input to the next stage: for example,
27014 the output of the preprocessor, which is the input to the compiler
27015 proper.
27017 @item GCC_COMPARE_DEBUG
27018 @findex GCC_COMPARE_DEBUG
27019 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27020 @option{-fcompare-debug} to the compiler driver.  See the documentation
27021 of this option for more details.
27023 @item GCC_EXEC_PREFIX
27024 @findex GCC_EXEC_PREFIX
27025 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27026 names of the subprograms executed by the compiler.  No slash is added
27027 when this prefix is combined with the name of a subprogram, but you can
27028 specify a prefix that ends with a slash if you wish.
27030 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27031 an appropriate prefix to use based on the pathname it is invoked with.
27033 If GCC cannot find the subprogram using the specified prefix, it
27034 tries looking in the usual places for the subprogram.
27036 The default value of @env{GCC_EXEC_PREFIX} is
27037 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27038 the installed compiler. In many cases @var{prefix} is the value
27039 of @code{prefix} when you ran the @file{configure} script.
27041 Other prefixes specified with @option{-B} take precedence over this prefix.
27043 This prefix is also used for finding files such as @file{crt0.o} that are
27044 used for linking.
27046 In addition, the prefix is used in an unusual way in finding the
27047 directories to search for header files.  For each of the standard
27048 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27049 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27050 replacing that beginning with the specified prefix to produce an
27051 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27052 @file{foo/bar} just before it searches the standard directory 
27053 @file{/usr/local/lib/bar}.
27054 If a standard directory begins with the configured
27055 @var{prefix} then the value of @var{prefix} is replaced by
27056 @env{GCC_EXEC_PREFIX} when looking for header files.
27058 @item COMPILER_PATH
27059 @findex COMPILER_PATH
27060 The value of @env{COMPILER_PATH} is a colon-separated list of
27061 directories, much like @env{PATH}.  GCC tries the directories thus
27062 specified when searching for subprograms, if it cannot find the
27063 subprograms using @env{GCC_EXEC_PREFIX}.
27065 @item LIBRARY_PATH
27066 @findex LIBRARY_PATH
27067 The value of @env{LIBRARY_PATH} is a colon-separated list of
27068 directories, much like @env{PATH}.  When configured as a native compiler,
27069 GCC tries the directories thus specified when searching for special
27070 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27071 using GCC also uses these directories when searching for ordinary
27072 libraries for the @option{-l} option (but directories specified with
27073 @option{-L} come first).
27075 @item LANG
27076 @findex LANG
27077 @cindex locale definition
27078 This variable is used to pass locale information to the compiler.  One way in
27079 which this information is used is to determine the character set to be used
27080 when character literals, string literals and comments are parsed in C and C++.
27081 When the compiler is configured to allow multibyte characters,
27082 the following values for @env{LANG} are recognized:
27084 @table @samp
27085 @item C-JIS
27086 Recognize JIS characters.
27087 @item C-SJIS
27088 Recognize SJIS characters.
27089 @item C-EUCJP
27090 Recognize EUCJP characters.
27091 @end table
27093 If @env{LANG} is not defined, or if it has some other value, then the
27094 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27095 recognize and translate multibyte characters.
27096 @end table
27098 @noindent
27099 Some additional environment variables affect the behavior of the
27100 preprocessor.
27102 @include cppenv.texi
27104 @c man end
27106 @node Precompiled Headers
27107 @section Using Precompiled Headers
27108 @cindex precompiled headers
27109 @cindex speed of compilation
27111 Often large projects have many header files that are included in every
27112 source file.  The time the compiler takes to process these header files
27113 over and over again can account for nearly all of the time required to
27114 build the project.  To make builds faster, GCC allows you to
27115 @dfn{precompile} a header file.
27117 To create a precompiled header file, simply compile it as you would any
27118 other file, if necessary using the @option{-x} option to make the driver
27119 treat it as a C or C++ header file.  You may want to use a
27120 tool like @command{make} to keep the precompiled header up-to-date when
27121 the headers it contains change.
27123 A precompiled header file is searched for when @code{#include} is
27124 seen in the compilation.  As it searches for the included file
27125 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27126 compiler looks for a precompiled header in each directory just before it
27127 looks for the include file in that directory.  The name searched for is
27128 the name specified in the @code{#include} with @samp{.gch} appended.  If
27129 the precompiled header file cannot be used, it is ignored.
27131 For instance, if you have @code{#include "all.h"}, and you have
27132 @file{all.h.gch} in the same directory as @file{all.h}, then the
27133 precompiled header file is used if possible, and the original
27134 header is used otherwise.
27136 Alternatively, you might decide to put the precompiled header file in a
27137 directory and use @option{-I} to ensure that directory is searched
27138 before (or instead of) the directory containing the original header.
27139 Then, if you want to check that the precompiled header file is always
27140 used, you can put a file of the same name as the original header in this
27141 directory containing an @code{#error} command.
27143 This also works with @option{-include}.  So yet another way to use
27144 precompiled headers, good for projects not designed with precompiled
27145 header files in mind, is to simply take most of the header files used by
27146 a project, include them from another header file, precompile that header
27147 file, and @option{-include} the precompiled header.  If the header files
27148 have guards against multiple inclusion, they are skipped because
27149 they've already been included (in the precompiled header).
27151 If you need to precompile the same header file for different
27152 languages, targets, or compiler options, you can instead make a
27153 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27154 header in the directory, perhaps using @option{-o}.  It doesn't matter
27155 what you call the files in the directory; every precompiled header in
27156 the directory is considered.  The first precompiled header
27157 encountered in the directory that is valid for this compilation is
27158 used; they're searched in no particular order.
27160 There are many other possibilities, limited only by your imagination,
27161 good sense, and the constraints of your build system.
27163 A precompiled header file can be used only when these conditions apply:
27165 @itemize
27166 @item
27167 Only one precompiled header can be used in a particular compilation.
27169 @item
27170 A precompiled header cannot be used once the first C token is seen.  You
27171 can have preprocessor directives before a precompiled header; you cannot
27172 include a precompiled header from inside another header.
27174 @item
27175 The precompiled header file must be produced for the same language as
27176 the current compilation.  You cannot use a C precompiled header for a C++
27177 compilation.
27179 @item
27180 The precompiled header file must have been produced by the same compiler
27181 binary as the current compilation is using.
27183 @item
27184 Any macros defined before the precompiled header is included must
27185 either be defined in the same way as when the precompiled header was
27186 generated, or must not affect the precompiled header, which usually
27187 means that they don't appear in the precompiled header at all.
27189 The @option{-D} option is one way to define a macro before a
27190 precompiled header is included; using a @code{#define} can also do it.
27191 There are also some options that define macros implicitly, like
27192 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27193 defined this way.
27195 @item If debugging information is output when using the precompiled
27196 header, using @option{-g} or similar, the same kind of debugging information
27197 must have been output when building the precompiled header.  However,
27198 a precompiled header built using @option{-g} can be used in a compilation
27199 when no debugging information is being output.
27201 @item The same @option{-m} options must generally be used when building
27202 and using the precompiled header.  @xref{Submodel Options},
27203 for any cases where this rule is relaxed.
27205 @item Each of the following options must be the same when building and using
27206 the precompiled header:
27208 @gccoptlist{-fexceptions}
27210 @item
27211 Some other command-line options starting with @option{-f},
27212 @option{-p}, or @option{-O} must be defined in the same way as when
27213 the precompiled header was generated.  At present, it's not clear
27214 which options are safe to change and which are not; the safest choice
27215 is to use exactly the same options when generating and using the
27216 precompiled header.  The following are known to be safe:
27218 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27219 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27220 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27221 -pedantic-errors}
27223 @end itemize
27225 For all of these except the last, the compiler automatically
27226 ignores the precompiled header if the conditions aren't met.  If you
27227 find an option combination that doesn't work and doesn't cause the
27228 precompiled header to be ignored, please consider filing a bug report,
27229 see @ref{Bugs}.
27231 If you do use differing options when generating and using the
27232 precompiled header, the actual behavior is a mixture of the
27233 behavior for the options.  For instance, if you use @option{-g} to
27234 generate the precompiled header but not when using it, you may or may
27235 not get debugging information for routines in the precompiled header.