2018-11-09 Richard Biener <rguenther@suse.de>
[official-gcc.git] / gcc / doc / invoke.texi
blob028a8962fd2daaf3d0a1ae9198e167982aeaf898
1 @c Copyright (C) 1988-2018 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-2018 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), dbx(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 Some options take one or more arguments typically separated either
125 by a space or by the equals sign (@samp{=}) from the option name.
126 Unless documented otherwise, an argument can be either numeric or
127 a string.  Numeric arguments must typically be small unsigned decimal
128 or hexadecimal integers.  Hexadecimal arguments must begin with
129 the @samp{0x} prefix.  Arguments to options that specify a size
130 threshold of some sort may be arbitrarily large decimal or hexadecimal
131 integers followed by a byte size suffix designating a multiple of bytes
132 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
133 @code{MB} and @code{MiB} for megabyte and mebibyte, @code{GB} and
134 @code{GiB} for gigabyte and gigibyte, and so on.  Such arguments are
135 designated by @var{byte-size} in the following text.  Refer to the NIST,
136 IEC, and other relevant national and international standards for the full
137 listing and explanation of the binary and decimal byte size prefixes.
139 @c man end
141 @xref{Option Index}, for an index to GCC's options.
143 @menu
144 * Option Summary::      Brief list of all options, without explanations.
145 * Overall Options::     Controlling the kind of output:
146                         an executable, object files, assembler files,
147                         or preprocessed source.
148 * Invoking G++::        Compiling C++ programs.
149 * C Dialect Options::   Controlling the variant of C language compiled.
150 * C++ Dialect Options:: Variations on C++.
151 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
152                         and Objective-C++.
153 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
154                         be formatted.
155 * Warning Options::     How picky should the compiler be?
156 * Debugging Options::   Producing debuggable code.
157 * Optimize Options::    How much optimization?
158 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
159 * Preprocessor Options:: Controlling header files and macro definitions.
160                          Also, getting dependency information for Make.
161 * Assembler Options::   Passing options to the assembler.
162 * Link Options::        Specifying libraries and so on.
163 * Directory Options::   Where to find header files and libraries.
164                         Where to find the compiler executable files.
165 * Code Gen Options::    Specifying conventions for function calls, data layout
166                         and register usage.
167 * Developer Options::   Printing GCC configuration info, statistics, and
168                         debugging dumps.
169 * Submodel Options::    Target-specific options, such as compiling for a
170                         specific processor variant.
171 * Spec Files::          How to pass switches to sub-processes.
172 * Environment Variables:: Env vars that affect GCC.
173 * Precompiled Headers:: Compiling a header once, and using it many times.
174 @end menu
176 @c man begin OPTIONS
178 @node Option Summary
179 @section Option Summary
181 Here is a summary of all the options, grouped by type.  Explanations are
182 in the following sections.
184 @table @emph
185 @item Overall Options
186 @xref{Overall Options,,Options Controlling the Kind of Output}.
187 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
188 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
189 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
190 @@@var{file}  -ffile-prefix-map=@var{old}=@var{new}  @gol
191 -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
192 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
194 @item C Language Options
195 @xref{C Dialect Options,,Options Controlling C Dialect}.
196 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
197 -fpermitted-flt-eval-methods=@var{standard} @gol
198 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
199 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
200 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
201 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
202 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
203 -fsigned-bitfields  -fsigned-char @gol
204 -funsigned-bitfields  -funsigned-char}
206 @item C++ Language Options
207 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
208 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
209 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
210 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
211 -fno-elide-constructors @gol
212 -fno-enforce-eh-specs @gol
213 -fno-gnu-keywords @gol
214 -fno-implicit-templates @gol
215 -fno-implicit-inline-templates @gol
216 -fno-implement-inlines  -fms-extensions @gol
217 -fnew-inheriting-ctors @gol
218 -fnew-ttp-matching @gol
219 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
220 -fno-optional-diags  -fpermissive @gol
221 -fno-pretty-templates @gol
222 -frepo  -fno-rtti  -fsized-deallocation @gol
223 -ftemplate-backtrace-limit=@var{n} @gol
224 -ftemplate-depth=@var{n} @gol
225 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
226 -fno-weak  -nostdinc++ @gol
227 -fvisibility-inlines-hidden @gol
228 -fvisibility-ms-compat @gol
229 -fext-numeric-literals @gol
230 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
231 -Wdelete-non-virtual-dtor -Wdeprecated-copy  -Wliteral-suffix @gol
232 -Wmultiple-inheritance -Wno-init-list-lifetime @gol
233 -Wnamespaces  -Wnarrowing @gol
234 -Wpessimizing-move  -Wredundant-move @gol
235 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
236 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
237 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
238 -Wno-non-template-friend  -Wold-style-cast @gol
239 -Woverloaded-virtual  -Wno-pmf-conversions @gol
240 -Wno-class-conversion  -Wno-terminate @gol
241 -Wsign-promo  -Wvirtual-inheritance}
243 @item Objective-C and Objective-C++ Language Options
244 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
245 Objective-C and Objective-C++ Dialects}.
246 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
247 -fgnu-runtime  -fnext-runtime @gol
248 -fno-nil-receivers @gol
249 -fobjc-abi-version=@var{n} @gol
250 -fobjc-call-cxx-cdtors @gol
251 -fobjc-direct-dispatch @gol
252 -fobjc-exceptions @gol
253 -fobjc-gc @gol
254 -fobjc-nilcheck @gol
255 -fobjc-std=objc1 @gol
256 -fno-local-ivars @gol
257 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
258 -freplace-objc-classes @gol
259 -fzero-link @gol
260 -gen-decls @gol
261 -Wassign-intercept @gol
262 -Wno-protocol  -Wselector @gol
263 -Wstrict-selector-match @gol
264 -Wundeclared-selector}
266 @item Diagnostic Message Formatting Options
267 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
268 @gccoptlist{-fmessage-length=@var{n}  @gol
269 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
270 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
271 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
272 -fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers @gol
273 -fdiagnostics-minimum-margin-width=@var{width} @gol
274 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
275 -fdiagnostics-show-template-tree -fno-elide-type @gol
276 -fno-show-column}
278 @item Warning Options
279 @xref{Warning Options,,Options to Request or Suppress Warnings}.
280 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
281 -pedantic-errors @gol
282 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Waligned-new @gol
283 -Walloc-zero  -Walloc-size-larger-than=@var{byte-size}
284 -Walloca  -Walloca-larger-than=@var{byte-size} @gol
285 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
286 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
287 -Wno-builtin-declaration-mismatch @gol
288 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
289 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  -Wc++17-compat  @gol
290 -Wcast-align  -Wcast-align=strict  -Wcast-function-type  -Wcast-qual  @gol
291 -Wchar-subscripts  -Wcatch-value  -Wcatch-value=@var{n} @gol
292 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
293 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
294 -Wdelete-incomplete @gol
295 -Wno-attribute-warning @gol
296 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
297 -Wdisabled-optimization @gol
298 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
299 -Wno-div-by-zero  -Wdouble-promotion @gol
300 -Wduplicated-branches  -Wduplicated-cond @gol
301 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
302 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
303 -Wfloat-equal  -Wformat  -Wformat=2 @gol
304 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
305 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
306 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
307 -Wformat-y2k  -Wframe-address @gol
308 -Wframe-larger-than=@var{byte-size}  -Wno-free-nonheap-object @gol
309 -Wjump-misses-init @gol
310 -Wif-not-aligned @gol
311 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
312 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
313 -Wimplicit-function-declaration  -Wimplicit-int @gol
314 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
315 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
316 -Winvalid-pch  -Wlarger-than=@var{byte-size} @gol
317 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
318 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
319 -Wmisleading-indentation  -Wmissing-attributes -Wmissing-braces @gol
320 -Wmissing-field-initializers  -Wmissing-include-dirs  -Wmissing-profile @gol
321 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
322 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
323 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
324 -Woverride-init-side-effects  -Woverlength-strings @gol
325 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
326 -Wparentheses  -Wno-pedantic-ms-format @gol
327 -Wplacement-new  -Wplacement-new=@var{n} @gol
328 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
329 -Wno-pragmas  -Wno-prio-ctor-dtor -Wredundant-decls @gol
330 -Wrestrict  -Wno-return-local-addr @gol
331 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
332 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
333 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
334 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
335 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
336 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
337 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
338 -Wstack-protector  -Wstack-usage=@var{byte-size}  -Wstrict-aliasing @gol
339 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
340 -Wstringop-overflow=@var{n} -Wstringop-truncation @gol
341 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
342 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
343 -Wmissing-format-attribute  -Wsubobject-linkage @gol
344 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
345 -Wswitch-unreachable  -Wsync-nand @gol
346 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
347 -Wtype-limits  -Wundef @gol
348 -Wuninitialized  -Wunknown-pragmas @gol
349 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
350 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
351 -Wunused-parameter  -Wno-unused-result @gol
352 -Wunused-value  -Wunused-variable @gol
353 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
354 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
355 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
356 -Wvla  -Wvla-larger-than=@var{byte-size}  -Wvolatile-register-var @gol
357 -Wwrite-strings @gol
358 -Wzero-as-null-pointer-constant  -Whsa}
360 @item C and Objective-C-only Warning Options
361 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
362 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
363 -Wold-style-declaration  -Wold-style-definition @gol
364 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
365 -Wdeclaration-after-statement  -Wpointer-sign}
367 @item Debugging Options
368 @xref{Debugging Options,,Options for Debugging Your Program}.
369 @gccoptlist{-g  -g@var{level}  -gdwarf  -gdwarf-@var{version} @gol
370 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
371 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
372 -gas-loc-support  -gno-as-loc-support @gol
373 -gas-locview-support  -gno-as-locview-support @gol
374 -gcolumn-info  -gno-column-info @gol
375 -gstatement-frontiers  -gno-statement-frontiers @gol
376 -gvariable-location-views  -gno-variable-location-views @gol
377 -ginternal-reset-location-views  -gno-internal-reset-location-views @gol
378 -ginline-points  -gno-inline-points @gol
379 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
380 -gsplit-dwarf -gdescribe-dies -gno-describe-dies @gol
381 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
382 -fno-eliminate-unused-debug-types @gol
383 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
384 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
385 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
386 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
387 -fvar-tracking  -fvar-tracking-assignments}
389 @item Optimization Options
390 @xref{Optimize Options,,Options that Control Optimization}.
391 @gccoptlist{-faggressive-loop-optimizations @gol
392 -falign-functions[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
393 -falign-jumps[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
394 -falign-labels[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
395 -falign-loops[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
396 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
397 -fauto-inc-dec  -fbranch-probabilities @gol
398 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
399 -fbtr-bb-exclusive  -fcaller-saves @gol
400 -fcombine-stack-adjustments  -fconserve-stack @gol
401 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
402 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
403 -fcx-limited-range @gol
404 -fdata-sections  -fdce  -fdelayed-branch @gol
405 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
406 -fdevirtualize-at-ltrans  -fdse @gol
407 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
408 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
409 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
410 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
411 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
412 -fif-conversion2  -findirect-inlining @gol
413 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
414 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
415 -fipa-bit-cp -fipa-vrp @gol
416 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
417 -fira-algorithm=@var{algorithm} @gol
418 -fira-region=@var{region}  -fira-hoist-pressure @gol
419 -fira-loop-pressure  -fno-ira-share-save-slots @gol
420 -fno-ira-share-spill-slots @gol
421 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
422 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
423 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
424 -floop-block  -floop-interchange  -floop-strip-mine @gol
425 -floop-unroll-and-jam  -floop-nest-optimize @gol
426 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
427 -flto-partition=@var{alg}  -fmerge-all-constants @gol
428 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
429 -fmove-loop-invariants  -fno-branch-count-reg @gol
430 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
431 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
432 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
433 -fno-sched-spec  -fno-signed-zeros @gol
434 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
435 -fomit-frame-pointer  -foptimize-sibling-calls @gol
436 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
437 -fprefetch-loop-arrays @gol
438 -fprofile-correction @gol
439 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
440 -fprofile-reorder-functions @gol
441 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
442 -freorder-blocks-algorithm=@var{algorithm} @gol
443 -freorder-blocks-and-partition  -freorder-functions @gol
444 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
445 -frounding-math  -fsave-optimization-record @gol
446 -fsched2-use-superblocks  -fsched-pressure @gol
447 -fsched-spec-load  -fsched-spec-load-dangerous @gol
448 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
449 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
450 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
451 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
452 -fschedule-fusion @gol
453 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
454 -fselective-scheduling  -fselective-scheduling2 @gol
455 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
456 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
457 -fsignaling-nans @gol
458 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
459 -fsplit-paths @gol
460 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
461 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
462 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
463 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
464 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
465 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
466 -ftree-loop-if-convert  -ftree-loop-im @gol
467 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
468 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
469 -ftree-loop-vectorize @gol
470 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
471 -ftree-reassoc  -ftree-scev-cprop  -ftree-sink  -ftree-slsr  -ftree-sra @gol
472 -ftree-switch-conversion  -ftree-tail-merge @gol
473 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
474 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
475 -funsafe-math-optimizations  -funswitch-loops @gol
476 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
477 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
478 --param @var{name}=@var{value}
479 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
481 @item Program Instrumentation Options
482 @xref{Instrumentation Options,,Program Instrumentation Options}.
483 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
484 -fprofile-abs-path @gol
485 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
486 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
487 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
488 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
489 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
490 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
491 -fstack-protector-explicit  -fstack-check @gol
492 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
493 -fno-stack-limit  -fsplit-stack @gol
494 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
495 -fvtv-counts  -fvtv-debug @gol
496 -finstrument-functions @gol
497 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
498 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
500 @item Preprocessor Options
501 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
502 @gccoptlist{-A@var{question}=@var{answer} @gol
503 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
504 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
505 -dD  -dI  -dM  -dN  -dU @gol
506 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
507 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
508 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new}  @gol
509 -fno-canonical-system-headers @gol -fpch-deps  -fpch-preprocess  @gol
510 -fpreprocessed -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
511 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
512 -H  -imacros @var{file}  -include @var{file} @gol
513 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
514 -no-integrated-cpp  -P  -pthread  -remap @gol
515 -traditional  -traditional-cpp  -trigraphs @gol
516 -U@var{macro}  -undef  @gol
517 -Wp,@var{option}  -Xpreprocessor @var{option}}
519 @item Assembler Options
520 @xref{Assembler Options,,Passing Options to the Assembler}.
521 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
523 @item Linker Options
524 @xref{Link Options,,Options for Linking}.
525 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
526 -nostartfiles  -nodefaultlibs  -nolibc  -nostdlib @gol
527 -e @var{entry}  --entry=@var{entry} @gol
528 -pie  -pthread  -r  -rdynamic @gol
529 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
530 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
531 -shared  -shared-libgcc  -symbolic @gol
532 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
533 -u @var{symbol}  -z @var{keyword}}
535 @item Directory Options
536 @xref{Directory Options,,Options for Directory Search}.
537 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
538 -idirafter @var{dir} @gol
539 -imacros @var{file}  -imultilib @var{dir} @gol
540 -iplugindir=@var{dir}  -iprefix @var{file} @gol
541 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
542 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
543 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
544 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
546 @item Code Generation Options
547 @xref{Code Gen Options,,Options for Code Generation Conventions}.
548 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
549 -ffixed-@var{reg}  -fexceptions @gol
550 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
551 -fasynchronous-unwind-tables @gol
552 -fno-gnu-unique @gol
553 -finhibit-size-directive  -fno-common  -fno-ident @gol
554 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
555 -fno-jump-tables @gol
556 -frecord-gcc-switches @gol
557 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
558 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
559 -fleading-underscore  -ftls-model=@var{model} @gol
560 -fstack-reuse=@var{reuse_level} @gol
561 -ftrampolines  -ftrapv  -fwrapv @gol
562 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
563 -fstrict-volatile-bitfields  -fsync-libcalls}
565 @item Developer Options
566 @xref{Developer Options,,GCC Developer Options}.
567 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
568 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
569 -fdbg-cnt=@var{counter-value-list} @gol
570 -fdisable-ipa-@var{pass_name} @gol
571 -fdisable-rtl-@var{pass_name} @gol
572 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
573 -fdisable-tree-@var{pass_name} @gol
574 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
575 -fdump-debug -fdump-earlydebug @gol
576 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
577 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
578 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
579 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
580 -fdump-lang-all @gol
581 -fdump-lang-@var{switch} @gol
582 -fdump-lang-@var{switch}-@var{options} @gol
583 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
584 -fdump-passes @gol
585 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
586 -fdump-statistics @gol
587 -fdump-tree-all @gol
588 -fdump-tree-@var{switch} @gol
589 -fdump-tree-@var{switch}-@var{options} @gol
590 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
591 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
592 -fenable-@var{kind}-@var{pass} @gol
593 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
594 -fira-verbose=@var{n} @gol
595 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
596 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
597 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
598 -fprofile-report @gol
599 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
600 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
601 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
602 -fvar-tracking-assignments-toggle  -gtoggle @gol
603 -print-file-name=@var{library}  -print-libgcc-file-name @gol
604 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
605 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
606 -print-sysroot  -print-sysroot-headers-suffix @gol
607 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
609 @item Machine-Dependent Options
610 @xref{Submodel Options,,Machine-Dependent Options}.
611 @c This list is ordered alphanumerically by subsection name.
612 @c Try and put the significant identifier (CPU or system) first,
613 @c so users have a clue at guessing where the ones they want will be.
615 @emph{AArch64 Options}
616 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
617 -mgeneral-regs-only @gol
618 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
619 -mstrict-align -mno-strict-align @gol
620 -momit-leaf-frame-pointer @gol
621 -mtls-dialect=desc  -mtls-dialect=traditional @gol
622 -mtls-size=@var{size} @gol
623 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
624 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
625 -mpc-relative-literal-loads @gol
626 -msign-return-address=@var{scope} @gol
627 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
628 -moverride=@var{string}  -mverbose-cost-dump -mtrack-speculation} 
630 @emph{Adapteva Epiphany Options}
631 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
632 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
633 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
634 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
635 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
636 -msplit-vecmove-early  -m1reg-@var{reg}}
638 @emph{ARC Options}
639 @gccoptlist{-mbarrel-shifter -mjli-always @gol
640 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
641 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
642 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
643 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
644 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
645 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
646 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
647 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
648 -mvolatile-cache  -mtp-regno=@var{regno} @gol
649 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
650 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
651 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
652 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
653 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
654 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
655 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
656 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu} -mrf16  -mbranch-index}
658 @emph{ARM Options}
659 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
660 -mabi=@var{name} @gol
661 -mapcs-stack-check  -mno-apcs-stack-check @gol
662 -mapcs-reentrant  -mno-apcs-reentrant @gol
663 -msched-prolog  -mno-sched-prolog @gol
664 -mlittle-endian  -mbig-endian @gol
665 -mbe8 -mbe32 @gol
666 -mfloat-abi=@var{name} @gol
667 -mfp16-format=@var{name}
668 -mthumb-interwork  -mno-thumb-interwork @gol
669 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
670 -mtune=@var{name}  -mprint-tune-info @gol
671 -mstructure-size-boundary=@var{n} @gol
672 -mabort-on-noreturn @gol
673 -mlong-calls  -mno-long-calls @gol
674 -msingle-pic-base  -mno-single-pic-base @gol
675 -mpic-register=@var{reg} @gol
676 -mnop-fun-dllimport @gol
677 -mpoke-function-name @gol
678 -mthumb  -marm  -mflip-thumb @gol
679 -mtpcs-frame  -mtpcs-leaf-frame @gol
680 -mcaller-super-interworking  -mcallee-super-interworking @gol
681 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
682 -mword-relocations @gol
683 -mfix-cortex-m3-ldrd @gol
684 -munaligned-access @gol
685 -mneon-for-64bits @gol
686 -mslow-flash-data @gol
687 -masm-syntax-unified @gol
688 -mrestrict-it @gol
689 -mverbose-cost-dump @gol
690 -mpure-code @gol
691 -mcmse}
693 @emph{AVR Options}
694 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
695 -mbranch-cost=@var{cost} @gol
696 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
697 -mn_flash=@var{size}  -mno-interrupts @gol
698 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
699 -mfract-convert-truncate @gol
700 -mshort-calls  -nodevicelib @gol
701 -Waddr-space-convert  -Wmisspelled-isr}
703 @emph{Blackfin Options}
704 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
705 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
706 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
707 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
708 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
709 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
710 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
711 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
712 -micplb}
714 @emph{C6X Options}
715 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
716 -msim  -msdata=@var{sdata-type}}
718 @emph{CRIS Options}
719 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
720 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
721 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
722 -mstack-align  -mdata-align  -mconst-align @gol
723 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
724 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
725 -mmul-bug-workaround  -mno-mul-bug-workaround}
727 @emph{CR16 Options}
728 @gccoptlist{-mmac @gol
729 -mcr16cplus  -mcr16c @gol
730 -msim  -mint32  -mbit-ops
731 -mdata-model=@var{model}}
733 @emph{C-SKY Options}
734 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu} @gol
735 -mbig-endian  -EB  -mlittle-endian  -EL @gol
736 -mhard-float  -msoft-float  -mfpu=@var{fpu}  -mdouble-float  -mfdivdu @gol
737 -melrw  -mistack  -mmp  -mcp  -mcache  -msecurity  -mtrust @gol
738 -mdsp  -medsp  -mvdsp @gol
739 -mdiv  -msmart  -mhigh-registers  -manchor @gol
740 -mpushpop  -mmultiple-stld  -mconstpool  -mstack-size  -mccrt @gol
741 -mbranch-cost=@var{n}  -mcse-cc  -msched-prolog}
743 @emph{Darwin Options}
744 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
745 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
746 -client_name  -compatibility_version  -current_version @gol
747 -dead_strip @gol
748 -dependency-file  -dylib_file  -dylinker_install_name @gol
749 -dynamic  -dynamiclib  -exported_symbols_list @gol
750 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
751 -force_flat_namespace  -headerpad_max_install_names @gol
752 -iframework @gol
753 -image_base  -init  -install_name  -keep_private_externs @gol
754 -multi_module  -multiply_defined  -multiply_defined_unused @gol
755 -noall_load   -no_dead_strip_inits_and_terms @gol
756 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
757 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
758 -private_bundle  -read_only_relocs  -sectalign @gol
759 -sectobjectsymbols  -whyload  -seg1addr @gol
760 -sectcreate  -sectobjectsymbols  -sectorder @gol
761 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
762 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
763 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
764 -single_module  -static  -sub_library  -sub_umbrella @gol
765 -twolevel_namespace  -umbrella  -undefined @gol
766 -unexported_symbols_list  -weak_reference_mismatches @gol
767 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
768 -mkernel  -mone-byte-bool}
770 @emph{DEC Alpha Options}
771 @gccoptlist{-mno-fp-regs  -msoft-float @gol
772 -mieee  -mieee-with-inexact  -mieee-conformant @gol
773 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
774 -mtrap-precision=@var{mode}  -mbuild-constants @gol
775 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
776 -mbwx  -mmax  -mfix  -mcix @gol
777 -mfloat-vax  -mfloat-ieee @gol
778 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
779 -msmall-text  -mlarge-text @gol
780 -mmemory-latency=@var{time}}
782 @emph{FR30 Options}
783 @gccoptlist{-msmall-model  -mno-lsim}
785 @emph{FT32 Options}
786 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
788 @emph{FRV Options}
789 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
790 -mhard-float  -msoft-float @gol
791 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
792 -mdouble  -mno-double @gol
793 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
794 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
795 -mlinked-fp  -mlong-calls  -malign-labels @gol
796 -mlibrary-pic  -macc-4  -macc-8 @gol
797 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
798 -moptimize-membar  -mno-optimize-membar @gol
799 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
800 -mvliw-branch  -mno-vliw-branch @gol
801 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
802 -mno-nested-cond-exec  -mtomcat-stats @gol
803 -mTLS  -mtls @gol
804 -mcpu=@var{cpu}}
806 @emph{GNU/Linux Options}
807 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
808 -tno-android-cc  -tno-android-ld}
810 @emph{H8/300 Options}
811 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
813 @emph{HPPA Options}
814 @gccoptlist{-march=@var{architecture-type} @gol
815 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
816 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
817 -mfixed-range=@var{register-range} @gol
818 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
819 -mlong-load-store  -mno-disable-fpregs @gol
820 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
821 -mno-jump-in-delay  -mno-long-load-store @gol
822 -mno-portable-runtime  -mno-soft-float @gol
823 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
824 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
825 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
826 -munix=@var{unix-std}  -nolibdld  -static  -threads}
828 @emph{IA-64 Options}
829 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
830 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
831 -mconstant-gp  -mauto-pic  -mfused-madd @gol
832 -minline-float-divide-min-latency @gol
833 -minline-float-divide-max-throughput @gol
834 -mno-inline-float-divide @gol
835 -minline-int-divide-min-latency @gol
836 -minline-int-divide-max-throughput  @gol
837 -mno-inline-int-divide @gol
838 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
839 -mno-inline-sqrt @gol
840 -mdwarf2-asm  -mearly-stop-bits @gol
841 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
842 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
843 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
844 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
845 -msched-spec-ldc  -msched-spec-control-ldc @gol
846 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
847 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
848 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
849 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
851 @emph{LM32 Options}
852 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
853 -msign-extend-enabled  -muser-enabled}
855 @emph{M32R/D Options}
856 @gccoptlist{-m32r2  -m32rx  -m32r @gol
857 -mdebug @gol
858 -malign-loops  -mno-align-loops @gol
859 -missue-rate=@var{number} @gol
860 -mbranch-cost=@var{number} @gol
861 -mmodel=@var{code-size-model-type} @gol
862 -msdata=@var{sdata-type} @gol
863 -mno-flush-func  -mflush-func=@var{name} @gol
864 -mno-flush-trap  -mflush-trap=@var{number} @gol
865 -G @var{num}}
867 @emph{M32C Options}
868 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
870 @emph{M680x0 Options}
871 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
872 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
873 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
874 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
875 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
876 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
877 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
878 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
879 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
881 @emph{MCore Options}
882 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
883 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
884 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
885 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
886 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
888 @emph{MeP Options}
889 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
890 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
891 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
892 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
893 -mtiny=@var{n}}
895 @emph{MicroBlaze Options}
896 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
897 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
898 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
899 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
900 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}
901 -mpic-data-is-text-relative}
903 @emph{MIPS Options}
904 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
905 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
906 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
907 -mips16  -mno-mips16  -mflip-mips16 @gol
908 -minterlink-compressed  -mno-interlink-compressed @gol
909 -minterlink-mips16  -mno-interlink-mips16 @gol
910 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
911 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
912 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
913 -mno-float  -msingle-float  -mdouble-float @gol
914 -modd-spreg  -mno-odd-spreg @gol
915 -mabs=@var{mode}  -mnan=@var{encoding} @gol
916 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
917 -mmcu  -mmno-mcu @gol
918 -meva  -mno-eva @gol
919 -mvirt  -mno-virt @gol
920 -mxpa  -mno-xpa @gol
921 -mcrc -mno-crc @gol
922 -mginv -mno-ginv @gol
923 -mmicromips  -mno-micromips @gol
924 -mmsa  -mno-msa @gol
925 -mloongson-mmi  -mno-loongson-mmi @gol
926 -mloongson-ext  -mno-loongson-ext @gol
927 -mloongson-ext2  -mno-loongson-ext2 @gol
928 -mfpu=@var{fpu-type} @gol
929 -msmartmips  -mno-smartmips @gol
930 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
931 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
932 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
933 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
934 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
935 -membedded-data  -mno-embedded-data @gol
936 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
937 -mcode-readable=@var{setting} @gol
938 -msplit-addresses  -mno-split-addresses @gol
939 -mexplicit-relocs  -mno-explicit-relocs @gol
940 -mcheck-zero-division  -mno-check-zero-division @gol
941 -mdivide-traps  -mdivide-breaks @gol
942 -mload-store-pairs  -mno-load-store-pairs @gol
943 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
944 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
945 -mfix-24k  -mno-fix-24k @gol
946 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
947 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
948 -mfix-vr4120  -mno-fix-vr4120 @gol
949 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
950 -mflush-func=@var{func}  -mno-flush-func @gol
951 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
952 -mcompact-branches=@var{policy} @gol
953 -mfp-exceptions  -mno-fp-exceptions @gol
954 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
955 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
956 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
957 -mframe-header-opt  -mno-frame-header-opt}
959 @emph{MMIX Options}
960 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
961 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
962 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
963 -mno-base-addresses  -msingle-exit  -mno-single-exit}
965 @emph{MN10300 Options}
966 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
967 -mno-am33  -mam33  -mam33-2  -mam34 @gol
968 -mtune=@var{cpu-type} @gol
969 -mreturn-pointer-on-d0 @gol
970 -mno-crt0  -mrelax  -mliw  -msetlb}
972 @emph{Moxie Options}
973 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
975 @emph{MSP430 Options}
976 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
977 -mwarn-mcu @gol
978 -mcode-region=  -mdata-region= @gol
979 -msilicon-errata=  -msilicon-errata-warn= @gol
980 -mhwmult=  -minrt}
982 @emph{NDS32 Options}
983 @gccoptlist{-mbig-endian  -mlittle-endian @gol
984 -mreduced-regs  -mfull-regs @gol
985 -mcmov  -mno-cmov @gol
986 -mext-perf  -mno-ext-perf @gol
987 -mext-perf2  -mno-ext-perf2 @gol
988 -mext-string  -mno-ext-string @gol
989 -mv3push  -mno-v3push @gol
990 -m16bit  -mno-16bit @gol
991 -misr-vector-size=@var{num} @gol
992 -mcache-block-size=@var{num} @gol
993 -march=@var{arch} @gol
994 -mcmodel=@var{code-model} @gol
995 -mctor-dtor  -mrelax}
997 @emph{Nios II Options}
998 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
999 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
1000 -mel  -meb @gol
1001 -mno-bypass-cache  -mbypass-cache @gol
1002 -mno-cache-volatile  -mcache-volatile @gol
1003 -mno-fast-sw-div  -mfast-sw-div @gol
1004 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
1005 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
1006 -mcustom-fpu-cfg=@var{name} @gol
1007 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
1008 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
1010 @emph{Nvidia PTX Options}
1011 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
1013 @emph{OpenRISC Options}
1014 @gccoptlist{-mboard=@var{name} -mnewlib -mhard-mul -mhard-div @gol
1015 -msoft-mul -msoft-div @gol
1016 -mcmov -mror -msext -msfimm -mshftimm}
1018 @emph{PDP-11 Options}
1019 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
1020 -mint32  -mno-int16 -mint16  -mno-int32 @gol
1021 -msplit -munix-asm  -mdec-asm -mgnu-asm -mlra}
1023 @emph{picoChip Options}
1024 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
1025 -msymbol-as-address  -mno-inefficient-warnings}
1027 @emph{PowerPC Options}
1028 See RS/6000 and PowerPC Options.
1030 @emph{PowerPC SPE Options}
1031 @gccoptlist{-mcpu=@var{cpu-type} @gol
1032 -mtune=@var{cpu-type} @gol
1033 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
1034 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1035 -m32  -mxl-compat  -mno-xl-compat @gol
1036 -malign-power  -malign-natural @gol
1037 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1038 -msingle-float  -mdouble-float @gol
1039 -mupdate  -mno-update @gol
1040 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1041 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1042 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1043 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1044 -msingle-pic-base @gol
1045 -mprioritize-restricted-insns=@var{priority} @gol
1046 -msched-costly-dep=@var{dependence_type} @gol
1047 -minsert-sched-nops=@var{scheme} @gol
1048 -mcall-sysv  -mcall-netbsd @gol
1049 -maix-struct-return  -msvr4-struct-return @gol
1050 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1051 -mblock-move-inline-limit=@var{num} @gol
1052 -misel  -mno-isel @gol
1053 -misel=yes  -misel=no @gol
1054 -mspe  -mno-spe @gol
1055 -mspe=yes  -mspe=no @gol
1056 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1057 -mprototype  -mno-prototype @gol
1058 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1059 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1060 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1061 -mno-recip-precision @gol
1062 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1063 -msave-toc-indirect  -mno-save-toc-indirect @gol
1064 -mcompat-align-parm  -mno-compat-align-parm @gol
1065 -mfloat128  -mno-float128 @gol
1066 -mgnu-attribute  -mno-gnu-attribute @gol
1067 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1068 -mstack-protector-guard-offset=@var{offset}}
1070 @emph{RISC-V Options}
1071 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1072 -mplt  -mno-plt @gol
1073 -mabi=@var{ABI-string} @gol
1074 -mfdiv  -mno-fdiv @gol
1075 -mdiv  -mno-div @gol
1076 -march=@var{ISA-string} @gol
1077 -mtune=@var{processor-string} @gol
1078 -mpreferred-stack-boundary=@var{num} @gol
1079 -msmall-data-limit=@var{N-bytes} @gol
1080 -msave-restore  -mno-save-restore @gol
1081 -mstrict-align -mno-strict-align @gol
1082 -mcmodel=medlow -mcmodel=medany @gol
1083 -mexplicit-relocs  -mno-explicit-relocs @gol
1084 -mrelax -mno-relax @gol}
1086 @emph{RL78 Options}
1087 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1088 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1089 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1091 @emph{RS/6000 and PowerPC Options}
1092 @gccoptlist{-mcpu=@var{cpu-type} @gol
1093 -mtune=@var{cpu-type} @gol
1094 -mcmodel=@var{code-model} @gol
1095 -mpowerpc64 @gol
1096 -maltivec  -mno-altivec @gol
1097 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1098 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1099 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1100 -mfprnd  -mno-fprnd @gol
1101 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1102 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1103 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1104 -malign-power  -malign-natural @gol
1105 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1106 -mupdate  -mno-update @gol
1107 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1108 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1109 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1110 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1111 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1112 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1113 -mprioritize-restricted-insns=@var{priority} @gol
1114 -msched-costly-dep=@var{dependence_type} @gol
1115 -minsert-sched-nops=@var{scheme} @gol
1116 -mcall-aixdesc  -mcall-eabi  -mcall-freebsd  @gol
1117 -mcall-linux  -mcall-netbsd  -mcall-openbsd  @gol
1118 -mcall-sysv  -mcall-sysv-eabi  -mcall-sysv-noeabi @gol
1119 -mtraceback=@var{traceback_type} @gol
1120 -maix-struct-return  -msvr4-struct-return @gol
1121 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1122 -mblock-move-inline-limit=@var{num} @gol
1123 -mblock-compare-inline-limit=@var{num} @gol
1124 -mblock-compare-inline-loop-limit=@var{num} @gol
1125 -mstring-compare-inline-limit=@var{num} @gol
1126 -misel  -mno-isel @gol
1127 -mvrsave  -mno-vrsave @gol
1128 -mmulhw  -mno-mulhw @gol
1129 -mdlmzb  -mno-dlmzb @gol
1130 -mprototype  -mno-prototype @gol
1131 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1132 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1133 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1134 -mno-recip-precision @gol
1135 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1136 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1137 -msave-toc-indirect  -mno-save-toc-indirect @gol
1138 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1139 -mcrypto  -mno-crypto  -mhtm  -mno-htm @gol
1140 -mquad-memory  -mno-quad-memory @gol
1141 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1142 -mcompat-align-parm  -mno-compat-align-parm @gol
1143 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1144 -mgnu-attribute  -mno-gnu-attribute @gol
1145 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1146 -mstack-protector-guard-offset=@var{offset}}
1148 @emph{RX Options}
1149 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1150 -mcpu=@gol
1151 -mbig-endian-data  -mlittle-endian-data @gol
1152 -msmall-data @gol
1153 -msim  -mno-sim@gol
1154 -mas100-syntax  -mno-as100-syntax@gol
1155 -mrelax@gol
1156 -mmax-constant-size=@gol
1157 -mint-register=@gol
1158 -mpid@gol
1159 -mallow-string-insns  -mno-allow-string-insns@gol
1160 -mjsr@gol
1161 -mno-warn-multiple-fast-interrupts@gol
1162 -msave-acc-in-interrupts}
1164 @emph{S/390 and zSeries Options}
1165 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1166 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1167 -mlong-double-64  -mlong-double-128 @gol
1168 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1169 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1170 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1171 -mhtm  -mvx  -mzvector @gol
1172 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1173 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1174 -mhotpatch=@var{halfwords},@var{halfwords}}
1176 @emph{Score Options}
1177 @gccoptlist{-meb  -mel @gol
1178 -mnhwloop @gol
1179 -muls @gol
1180 -mmac @gol
1181 -mscore5  -mscore5u  -mscore7  -mscore7d}
1183 @emph{SH Options}
1184 @gccoptlist{-m1  -m2  -m2e @gol
1185 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1186 -m3  -m3e @gol
1187 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1188 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1189 -mb  -ml  -mdalign  -mrelax @gol
1190 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1191 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1192 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1193 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1194 -maccumulate-outgoing-args @gol
1195 -matomic-model=@var{atomic-model} @gol
1196 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1197 -mcbranch-force-delay-slot @gol
1198 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1199 -mpretend-cmove  -mtas}
1201 @emph{Solaris 2 Options}
1202 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1203 -pthreads}
1205 @emph{SPARC Options}
1206 @gccoptlist{-mcpu=@var{cpu-type} @gol
1207 -mtune=@var{cpu-type} @gol
1208 -mcmodel=@var{code-model} @gol
1209 -mmemory-model=@var{mem-model} @gol
1210 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1211 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1212 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1213 -mhard-quad-float  -msoft-quad-float @gol
1214 -mstack-bias  -mno-stack-bias @gol
1215 -mstd-struct-return  -mno-std-struct-return @gol
1216 -munaligned-doubles  -mno-unaligned-doubles @gol
1217 -muser-mode  -mno-user-mode @gol
1218 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1219 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1220 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1221 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1222 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1223 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1224 -mlra  -mno-lra}
1226 @emph{SPU Options}
1227 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1228 -msafe-dma  -munsafe-dma @gol
1229 -mbranch-hints @gol
1230 -msmall-mem  -mlarge-mem  -mstdmain @gol
1231 -mfixed-range=@var{register-range} @gol
1232 -mea32  -mea64 @gol
1233 -maddress-space-conversion  -mno-address-space-conversion @gol
1234 -mcache-size=@var{cache-size} @gol
1235 -matomic-updates  -mno-atomic-updates}
1237 @emph{System V Options}
1238 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1240 @emph{TILE-Gx Options}
1241 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1242 -mcmodel=@var{code-model}}
1244 @emph{TILEPro Options}
1245 @gccoptlist{-mcpu=@var{cpu}  -m32}
1247 @emph{V850 Options}
1248 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1249 -mprolog-function  -mno-prolog-function  -mspace @gol
1250 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1251 -mapp-regs  -mno-app-regs @gol
1252 -mdisable-callt  -mno-disable-callt @gol
1253 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1254 -mv850e  -mv850  -mv850e3v5 @gol
1255 -mloop @gol
1256 -mrelax @gol
1257 -mlong-jumps @gol
1258 -msoft-float @gol
1259 -mhard-float @gol
1260 -mgcc-abi @gol
1261 -mrh850-abi @gol
1262 -mbig-switch}
1264 @emph{VAX Options}
1265 @gccoptlist{-mg  -mgnu  -munix}
1267 @emph{Visium Options}
1268 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1269 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1271 @emph{VMS Options}
1272 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1273 -mpointer-size=@var{size}}
1275 @emph{VxWorks Options}
1276 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1277 -Xbind-lazy  -Xbind-now}
1279 @emph{x86 Options}
1280 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1281 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1282 -mfpmath=@var{unit} @gol
1283 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1284 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1285 -mno-wide-multiply  -mrtd  -malign-double @gol
1286 -mpreferred-stack-boundary=@var{num} @gol
1287 -mincoming-stack-boundary=@var{num} @gol
1288 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1289 -mrecip  -mrecip=@var{opt} @gol
1290 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1291 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1292 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1293 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1294 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd -mptwrite @gol
1295 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1296 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1297 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp @gol
1298 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  -mwaitpkg @gol
1299 -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1300 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq
1301 -mcldemote @gol
1302 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1303 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1304 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1305 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1306 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1307 -mregparm=@var{num}  -msseregparm @gol
1308 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1309 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1310 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1311 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1312 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1313 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1314 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1315 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1316 -mstack-protector-guard-reg=@var{reg} @gol
1317 -mstack-protector-guard-offset=@var{offset} @gol
1318 -mstack-protector-guard-symbol=@var{symbol} @gol
1319 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1320 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1321 -mindirect-branch-register}
1323 @emph{x86 Windows Options}
1324 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1325 -mnop-fun-dllimport  -mthread @gol
1326 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1328 @emph{Xstormy16 Options}
1329 @gccoptlist{-msim}
1331 @emph{Xtensa Options}
1332 @gccoptlist{-mconst16  -mno-const16 @gol
1333 -mfused-madd  -mno-fused-madd @gol
1334 -mforce-no-pic @gol
1335 -mserialize-volatile  -mno-serialize-volatile @gol
1336 -mtext-section-literals  -mno-text-section-literals @gol
1337 -mauto-litpools  -mno-auto-litpools @gol
1338 -mtarget-align  -mno-target-align @gol
1339 -mlongcalls  -mno-longcalls}
1341 @emph{zSeries Options}
1342 See S/390 and zSeries Options.
1343 @end table
1346 @node Overall Options
1347 @section Options Controlling the Kind of Output
1349 Compilation can involve up to four stages: preprocessing, compilation
1350 proper, assembly and linking, always in that order.  GCC is capable of
1351 preprocessing and compiling several files either into several
1352 assembler input files, or into one assembler input file; then each
1353 assembler input file produces an object file, and linking combines all
1354 the object files (those newly compiled, and those specified as input)
1355 into an executable file.
1357 @cindex file name suffix
1358 For any given input file, the file name suffix determines what kind of
1359 compilation is done:
1361 @table @gcctabopt
1362 @item @var{file}.c
1363 C source code that must be preprocessed.
1365 @item @var{file}.i
1366 C source code that should not be preprocessed.
1368 @item @var{file}.ii
1369 C++ source code that should not be preprocessed.
1371 @item @var{file}.m
1372 Objective-C source code.  Note that you must link with the @file{libobjc}
1373 library to make an Objective-C program work.
1375 @item @var{file}.mi
1376 Objective-C source code that should not be preprocessed.
1378 @item @var{file}.mm
1379 @itemx @var{file}.M
1380 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1381 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1382 to a literal capital M@.
1384 @item @var{file}.mii
1385 Objective-C++ source code that should not be preprocessed.
1387 @item @var{file}.h
1388 C, C++, Objective-C or Objective-C++ header file to be turned into a
1389 precompiled header (default), or C, C++ header file to be turned into an
1390 Ada spec (via the @option{-fdump-ada-spec} switch).
1392 @item @var{file}.cc
1393 @itemx @var{file}.cp
1394 @itemx @var{file}.cxx
1395 @itemx @var{file}.cpp
1396 @itemx @var{file}.CPP
1397 @itemx @var{file}.c++
1398 @itemx @var{file}.C
1399 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1400 the last two letters must both be literally @samp{x}.  Likewise,
1401 @samp{.C} refers to a literal capital C@.
1403 @item @var{file}.mm
1404 @itemx @var{file}.M
1405 Objective-C++ source code that must be preprocessed.
1407 @item @var{file}.mii
1408 Objective-C++ source code that should not be preprocessed.
1410 @item @var{file}.hh
1411 @itemx @var{file}.H
1412 @itemx @var{file}.hp
1413 @itemx @var{file}.hxx
1414 @itemx @var{file}.hpp
1415 @itemx @var{file}.HPP
1416 @itemx @var{file}.h++
1417 @itemx @var{file}.tcc
1418 C++ header file to be turned into a precompiled header or Ada spec.
1420 @item @var{file}.f
1421 @itemx @var{file}.for
1422 @itemx @var{file}.ftn
1423 Fixed form Fortran source code that should not be preprocessed.
1425 @item @var{file}.F
1426 @itemx @var{file}.FOR
1427 @itemx @var{file}.fpp
1428 @itemx @var{file}.FPP
1429 @itemx @var{file}.FTN
1430 Fixed form Fortran source code that must be preprocessed (with the traditional
1431 preprocessor).
1433 @item @var{file}.f90
1434 @itemx @var{file}.f95
1435 @itemx @var{file}.f03
1436 @itemx @var{file}.f08
1437 Free form Fortran source code that should not be preprocessed.
1439 @item @var{file}.F90
1440 @itemx @var{file}.F95
1441 @itemx @var{file}.F03
1442 @itemx @var{file}.F08
1443 Free form Fortran source code that must be preprocessed (with the
1444 traditional preprocessor).
1446 @item @var{file}.go
1447 Go source code.
1449 @item @var{file}.brig
1450 BRIG files (binary representation of HSAIL).
1452 @item @var{file}.d
1453 D source code.
1455 @item @var{file}.di
1456 D interface file.
1458 @item @var{file}.dd
1459 D documentation code (Ddoc).
1461 @item @var{file}.ads
1462 Ada source code file that contains a library unit declaration (a
1463 declaration of a package, subprogram, or generic, or a generic
1464 instantiation), or a library unit renaming declaration (a package,
1465 generic, or subprogram renaming declaration).  Such files are also
1466 called @dfn{specs}.
1468 @item @var{file}.adb
1469 Ada source code file containing a library unit body (a subprogram or
1470 package body).  Such files are also called @dfn{bodies}.
1472 @c GCC also knows about some suffixes for languages not yet included:
1473 @c Ratfor:
1474 @c @var{file}.r
1476 @item @var{file}.s
1477 Assembler code.
1479 @item @var{file}.S
1480 @itemx @var{file}.sx
1481 Assembler code that must be preprocessed.
1483 @item @var{other}
1484 An object file to be fed straight into linking.
1485 Any file name with no recognized suffix is treated this way.
1486 @end table
1488 @opindex x
1489 You can specify the input language explicitly with the @option{-x} option:
1491 @table @gcctabopt
1492 @item -x @var{language}
1493 Specify explicitly the @var{language} for the following input files
1494 (rather than letting the compiler choose a default based on the file
1495 name suffix).  This option applies to all following input files until
1496 the next @option{-x} option.  Possible values for @var{language} are:
1497 @smallexample
1498 c  c-header  cpp-output
1499 c++  c++-header  c++-cpp-output
1500 objective-c  objective-c-header  objective-c-cpp-output
1501 objective-c++ objective-c++-header objective-c++-cpp-output
1502 assembler  assembler-with-cpp
1505 f77  f77-cpp-input f95  f95-cpp-input
1507 brig
1508 @end smallexample
1510 @item -x none
1511 Turn off any specification of a language, so that subsequent files are
1512 handled according to their file name suffixes (as they are if @option{-x}
1513 has not been used at all).
1514 @end table
1516 If you only want some of the stages of compilation, you can use
1517 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1518 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1519 @command{gcc} is to stop.  Note that some combinations (for example,
1520 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1522 @table @gcctabopt
1523 @item -c
1524 @opindex c
1525 Compile or assemble the source files, but do not link.  The linking
1526 stage simply is not done.  The ultimate output is in the form of an
1527 object file for each source file.
1529 By default, the object file name for a source file is made by replacing
1530 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1532 Unrecognized input files, not requiring compilation or assembly, are
1533 ignored.
1535 @item -S
1536 @opindex S
1537 Stop after the stage of compilation proper; do not assemble.  The output
1538 is in the form of an assembler code file for each non-assembler input
1539 file specified.
1541 By default, the assembler file name for a source file is made by
1542 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1544 Input files that don't require compilation are ignored.
1546 @item -E
1547 @opindex E
1548 Stop after the preprocessing stage; do not run the compiler proper.  The
1549 output is in the form of preprocessed source code, which is sent to the
1550 standard output.
1552 Input files that don't require preprocessing are ignored.
1554 @cindex output file option
1555 @item -o @var{file}
1556 @opindex o
1557 Place output in file @var{file}.  This applies to whatever
1558 sort of output is being produced, whether it be an executable file,
1559 an object file, an assembler file or preprocessed C code.
1561 If @option{-o} is not specified, the default is to put an executable
1562 file in @file{a.out}, the object file for
1563 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1564 assembler file in @file{@var{source}.s}, a precompiled header file in
1565 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1566 standard output.
1568 @item -v
1569 @opindex v
1570 Print (on standard error output) the commands executed to run the stages
1571 of compilation.  Also print the version number of the compiler driver
1572 program and of the preprocessor and the compiler proper.
1574 @item -###
1575 @opindex ###
1576 Like @option{-v} except the commands are not executed and arguments
1577 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1578 This is useful for shell scripts to capture the driver-generated command lines.
1580 @item --help
1581 @opindex help
1582 Print (on the standard output) a description of the command-line options
1583 understood by @command{gcc}.  If the @option{-v} option is also specified
1584 then @option{--help} is also passed on to the various processes
1585 invoked by @command{gcc}, so that they can display the command-line options
1586 they accept.  If the @option{-Wextra} option has also been specified
1587 (prior to the @option{--help} option), then command-line options that
1588 have no documentation associated with them are also displayed.
1590 @item --target-help
1591 @opindex target-help
1592 Print (on the standard output) a description of target-specific command-line
1593 options for each tool.  For some targets extra target-specific
1594 information may also be printed.
1596 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1597 Print (on the standard output) a description of the command-line
1598 options understood by the compiler that fit into all specified classes
1599 and qualifiers.  These are the supported classes:
1601 @table @asis
1602 @item @samp{optimizers}
1603 Display all of the optimization options supported by the
1604 compiler.
1606 @item @samp{warnings}
1607 Display all of the options controlling warning messages
1608 produced by the compiler.
1610 @item @samp{target}
1611 Display target-specific options.  Unlike the
1612 @option{--target-help} option however, target-specific options of the
1613 linker and assembler are not displayed.  This is because those
1614 tools do not currently support the extended @option{--help=} syntax.
1616 @item @samp{params}
1617 Display the values recognized by the @option{--param}
1618 option.
1620 @item @var{language}
1621 Display the options supported for @var{language}, where
1622 @var{language} is the name of one of the languages supported in this
1623 version of GCC@.
1625 @item @samp{common}
1626 Display the options that are common to all languages.
1627 @end table
1629 These are the supported qualifiers:
1631 @table @asis
1632 @item @samp{undocumented}
1633 Display only those options that are undocumented.
1635 @item @samp{joined}
1636 Display options taking an argument that appears after an equal
1637 sign in the same continuous piece of text, such as:
1638 @samp{--help=target}.
1640 @item @samp{separate}
1641 Display options taking an argument that appears as a separate word
1642 following the original option, such as: @samp{-o output-file}.
1643 @end table
1645 Thus for example to display all the undocumented target-specific
1646 switches supported by the compiler, use:
1648 @smallexample
1649 --help=target,undocumented
1650 @end smallexample
1652 The sense of a qualifier can be inverted by prefixing it with the
1653 @samp{^} character, so for example to display all binary warning
1654 options (i.e., ones that are either on or off and that do not take an
1655 argument) that have a description, use:
1657 @smallexample
1658 --help=warnings,^joined,^undocumented
1659 @end smallexample
1661 The argument to @option{--help=} should not consist solely of inverted
1662 qualifiers.
1664 Combining several classes is possible, although this usually
1665 restricts the output so much that there is nothing to display.  One
1666 case where it does work, however, is when one of the classes is
1667 @var{target}.  For example, to display all the target-specific
1668 optimization options, use:
1670 @smallexample
1671 --help=target,optimizers
1672 @end smallexample
1674 The @option{--help=} option can be repeated on the command line.  Each
1675 successive use displays its requested class of options, skipping
1676 those that have already been displayed.
1678 If the @option{-Q} option appears on the command line before the
1679 @option{--help=} option, then the descriptive text displayed by
1680 @option{--help=} is changed.  Instead of describing the displayed
1681 options, an indication is given as to whether the option is enabled,
1682 disabled or set to a specific value (assuming that the compiler
1683 knows this at the point where the @option{--help=} option is used).
1685 Here is a truncated example from the ARM port of @command{gcc}:
1687 @smallexample
1688   % gcc -Q -mabi=2 --help=target -c
1689   The following options are target specific:
1690   -mabi=                                2
1691   -mabort-on-noreturn                   [disabled]
1692   -mapcs                                [disabled]
1693 @end smallexample
1695 The output is sensitive to the effects of previous command-line
1696 options, so for example it is possible to find out which optimizations
1697 are enabled at @option{-O2} by using:
1699 @smallexample
1700 -Q -O2 --help=optimizers
1701 @end smallexample
1703 Alternatively you can discover which binary optimizations are enabled
1704 by @option{-O3} by using:
1706 @smallexample
1707 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1708 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1709 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1710 @end smallexample
1712 @item --version
1713 @opindex version
1714 Display the version number and copyrights of the invoked GCC@.
1716 @item -pass-exit-codes
1717 @opindex pass-exit-codes
1718 Normally the @command{gcc} program exits with the code of 1 if any
1719 phase of the compiler returns a non-success return code.  If you specify
1720 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1721 the numerically highest error produced by any phase returning an error
1722 indication.  The C, C++, and Fortran front ends return 4 if an internal
1723 compiler error is encountered.
1725 @item -pipe
1726 @opindex pipe
1727 Use pipes rather than temporary files for communication between the
1728 various stages of compilation.  This fails to work on some systems where
1729 the assembler is unable to read from a pipe; but the GNU assembler has
1730 no trouble.
1732 @item -specs=@var{file}
1733 @opindex specs
1734 Process @var{file} after the compiler reads in the standard @file{specs}
1735 file, in order to override the defaults which the @command{gcc} driver
1736 program uses when determining what switches to pass to @command{cc1},
1737 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1738 @option{-specs=@var{file}} can be specified on the command line, and they
1739 are processed in order, from left to right.  @xref{Spec Files}, for
1740 information about the format of the @var{file}.
1742 @item -wrapper
1743 @opindex wrapper
1744 Invoke all subcommands under a wrapper program.  The name of the
1745 wrapper program and its parameters are passed as a comma separated
1746 list.
1748 @smallexample
1749 gcc -c t.c -wrapper gdb,--args
1750 @end smallexample
1752 @noindent
1753 This invokes all subprograms of @command{gcc} under
1754 @samp{gdb --args}, thus the invocation of @command{cc1} is
1755 @samp{gdb --args cc1 @dots{}}.
1757 @item -ffile-prefix-map=@var{old}=@var{new}
1758 @opindex ffile-prefix-map
1759 When compiling files residing in directory @file{@var{old}}, record
1760 any references to them in the result of the compilation as if the
1761 files resided in directory @file{@var{new}} instead.  Specifying this
1762 option is equivalent to specifying all the individual
1763 @option{-f*-prefix-map} options.  This can be used to make reproducible
1764 builds that are location independent.  See also
1765 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1767 @item -fplugin=@var{name}.so
1768 @opindex fplugin
1769 Load the plugin code in file @var{name}.so, assumed to be a
1770 shared object to be dlopen'd by the compiler.  The base name of
1771 the shared object file is used to identify the plugin for the
1772 purposes of argument parsing (See
1773 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1774 Each plugin should define the callback functions specified in the
1775 Plugins API.
1777 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1778 @opindex fplugin-arg
1779 Define an argument called @var{key} with a value of @var{value}
1780 for the plugin called @var{name}.
1782 @item -fdump-ada-spec@r{[}-slim@r{]}
1783 @opindex fdump-ada-spec
1784 For C and C++ source and include files, generate corresponding Ada specs.
1785 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1786 GNAT User's Guide}, which provides detailed documentation on this feature.
1788 @item -fada-spec-parent=@var{unit}
1789 @opindex fada-spec-parent
1790 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1791 Ada specs as child units of parent @var{unit}.
1793 @item -fdump-go-spec=@var{file}
1794 @opindex fdump-go-spec
1795 For input files in any language, generate corresponding Go
1796 declarations in @var{file}.  This generates Go @code{const},
1797 @code{type}, @code{var}, and @code{func} declarations which may be a
1798 useful way to start writing a Go interface to code written in some
1799 other language.
1801 @include @value{srcdir}/../libiberty/at-file.texi
1802 @end table
1804 @node Invoking G++
1805 @section Compiling C++ Programs
1807 @cindex suffixes for C++ source
1808 @cindex C++ source file suffixes
1809 C++ source files conventionally use one of the suffixes @samp{.C},
1810 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1811 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1812 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1813 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1814 files with these names and compiles them as C++ programs even if you
1815 call the compiler the same way as for compiling C programs (usually
1816 with the name @command{gcc}).
1818 @findex g++
1819 @findex c++
1820 However, the use of @command{gcc} does not add the C++ library.
1821 @command{g++} is a program that calls GCC and automatically specifies linking
1822 against the C++ library.  It treats @samp{.c},
1823 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1824 files unless @option{-x} is used.  This program is also useful when
1825 precompiling a C header file with a @samp{.h} extension for use in C++
1826 compilations.  On many systems, @command{g++} is also installed with
1827 the name @command{c++}.
1829 @cindex invoking @command{g++}
1830 When you compile C++ programs, you may specify many of the same
1831 command-line options that you use for compiling programs in any
1832 language; or command-line options meaningful for C and related
1833 languages; or options that are meaningful only for C++ programs.
1834 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1835 explanations of options for languages related to C@.
1836 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1837 explanations of options that are meaningful only for C++ programs.
1839 @node C Dialect Options
1840 @section Options Controlling C Dialect
1841 @cindex dialect options
1842 @cindex language dialect options
1843 @cindex options, dialect
1845 The following options control the dialect of C (or languages derived
1846 from C, such as C++, Objective-C and Objective-C++) that the compiler
1847 accepts:
1849 @table @gcctabopt
1850 @cindex ANSI support
1851 @cindex ISO support
1852 @item -ansi
1853 @opindex ansi
1854 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1855 equivalent to @option{-std=c++98}.
1857 This turns off certain features of GCC that are incompatible with ISO
1858 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1859 such as the @code{asm} and @code{typeof} keywords, and
1860 predefined macros such as @code{unix} and @code{vax} that identify the
1861 type of system you are using.  It also enables the undesirable and
1862 rarely used ISO trigraph feature.  For the C compiler,
1863 it disables recognition of C++ style @samp{//} comments as well as
1864 the @code{inline} keyword.
1866 The alternate keywords @code{__asm__}, @code{__extension__},
1867 @code{__inline__} and @code{__typeof__} continue to work despite
1868 @option{-ansi}.  You would not want to use them in an ISO C program, of
1869 course, but it is useful to put them in header files that might be included
1870 in compilations done with @option{-ansi}.  Alternate predefined macros
1871 such as @code{__unix__} and @code{__vax__} are also available, with or
1872 without @option{-ansi}.
1874 The @option{-ansi} option does not cause non-ISO programs to be
1875 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1876 addition to @option{-ansi}.  @xref{Warning Options}.
1878 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1879 option is used.  Some header files may notice this macro and refrain
1880 from declaring certain functions or defining certain macros that the
1881 ISO standard doesn't call for; this is to avoid interfering with any
1882 programs that might use these names for other things.
1884 Functions that are normally built in but do not have semantics
1885 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1886 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1887 built-in functions provided by GCC}, for details of the functions
1888 affected.
1890 @item -std=
1891 @opindex std
1892 Determine the language standard. @xref{Standards,,Language Standards
1893 Supported by GCC}, for details of these standard versions.  This option
1894 is currently only supported when compiling C or C++.
1896 The compiler can accept several base standards, such as @samp{c90} or
1897 @samp{c++98}, and GNU dialects of those standards, such as
1898 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1899 compiler accepts all programs following that standard plus those
1900 using GNU extensions that do not contradict it.  For example,
1901 @option{-std=c90} turns off certain features of GCC that are
1902 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1903 keywords, but not other GNU extensions that do not have a meaning in
1904 ISO C90, such as omitting the middle term of a @code{?:}
1905 expression. On the other hand, when a GNU dialect of a standard is
1906 specified, all features supported by the compiler are enabled, even when
1907 those features change the meaning of the base standard.  As a result, some
1908 strict-conforming programs may be rejected.  The particular standard
1909 is used by @option{-Wpedantic} to identify which features are GNU
1910 extensions given that version of the standard. For example
1911 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1912 comments, while @option{-std=gnu99 -Wpedantic} does not.
1914 A value for this option must be provided; possible values are
1916 @table @samp
1917 @item c90
1918 @itemx c89
1919 @itemx iso9899:1990
1920 Support all ISO C90 programs (certain GNU extensions that conflict
1921 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1923 @item iso9899:199409
1924 ISO C90 as modified in amendment 1.
1926 @item c99
1927 @itemx c9x
1928 @itemx iso9899:1999
1929 @itemx iso9899:199x
1930 ISO C99.  This standard is substantially completely supported, modulo
1931 bugs and floating-point issues
1932 (mainly but not entirely relating to optional C99 features from
1933 Annexes F and G).  See
1934 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1935 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1937 @item c11
1938 @itemx c1x
1939 @itemx iso9899:2011
1940 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1941 substantially completely supported, modulo bugs, floating-point issues
1942 (mainly but not entirely relating to optional C11 features from
1943 Annexes F and G) and the optional Annexes K (Bounds-checking
1944 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1946 @item c17
1947 @itemx c18
1948 @itemx iso9899:2017
1949 @itemx iso9899:2018
1950 ISO C17, the 2017 revision of the ISO C standard
1951 (published in 2018).  This standard is
1952 same as C11 except for corrections of defects (all of which are also
1953 applied with @option{-std=c11}) and a new value of
1954 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1956 @item c2x
1957 The next version of the ISO C standard, still under development.  The
1958 support for this version is experimental and incomplete.
1960 @item gnu90
1961 @itemx gnu89
1962 GNU dialect of ISO C90 (including some C99 features).
1964 @item gnu99
1965 @itemx gnu9x
1966 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1968 @item gnu11
1969 @itemx gnu1x
1970 GNU dialect of ISO C11.
1971 The name @samp{gnu1x} is deprecated.
1973 @item gnu17
1974 @itemx gnu18
1975 GNU dialect of ISO C17.  This is the default for C code.
1977 @item gnu2x
1978 The next version of the ISO C standard, still under development, plus
1979 GNU extensions.  The support for this version is experimental and
1980 incomplete.
1982 @item c++98
1983 @itemx c++03
1984 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1985 additional defect reports. Same as @option{-ansi} for C++ code.
1987 @item gnu++98
1988 @itemx gnu++03
1989 GNU dialect of @option{-std=c++98}.
1991 @item c++11
1992 @itemx c++0x
1993 The 2011 ISO C++ standard plus amendments.
1994 The name @samp{c++0x} is deprecated.
1996 @item gnu++11
1997 @itemx gnu++0x
1998 GNU dialect of @option{-std=c++11}.
1999 The name @samp{gnu++0x} is deprecated.
2001 @item c++14
2002 @itemx c++1y
2003 The 2014 ISO C++ standard plus amendments.
2004 The name @samp{c++1y} is deprecated.
2006 @item gnu++14
2007 @itemx gnu++1y
2008 GNU dialect of @option{-std=c++14}.
2009 This is the default for C++ code.
2010 The name @samp{gnu++1y} is deprecated.
2012 @item c++17
2013 @itemx c++1z
2014 The 2017 ISO C++ standard plus amendments.
2015 The name @samp{c++1z} is deprecated.
2017 @item gnu++17
2018 @itemx gnu++1z
2019 GNU dialect of @option{-std=c++17}.
2020 The name @samp{gnu++1z} is deprecated.
2022 @item c++2a
2023 The next revision of the ISO C++ standard, tentatively planned for
2024 2020.  Support is highly experimental, and will almost certainly
2025 change in incompatible ways in future releases.
2027 @item gnu++2a
2028 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
2029 and will almost certainly change in incompatible ways in future
2030 releases.
2031 @end table
2033 @item -fgnu89-inline
2034 @opindex fgnu89-inline
2035 The option @option{-fgnu89-inline} tells GCC to use the traditional
2036 GNU semantics for @code{inline} functions when in C99 mode.
2037 @xref{Inline,,An Inline Function is As Fast As a Macro}.
2038 Using this option is roughly equivalent to adding the
2039 @code{gnu_inline} function attribute to all inline functions
2040 (@pxref{Function Attributes}).
2042 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
2043 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
2044 specifies the default behavior).
2045 This option is not supported in @option{-std=c90} or
2046 @option{-std=gnu90} mode.
2048 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
2049 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
2050 in effect for @code{inline} functions.  @xref{Common Predefined
2051 Macros,,,cpp,The C Preprocessor}.
2053 @item -fpermitted-flt-eval-methods=@var{style}
2054 @opindex fpermitted-flt-eval-methods
2055 @opindex fpermitted-flt-eval-methods=c11
2056 @opindex fpermitted-flt-eval-methods=ts-18661-3
2057 ISO/IEC TS 18661-3 defines new permissible values for
2058 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2059 a semantic type that is an interchange or extended format should be
2060 evaluated to the precision and range of that type.  These new values are
2061 a superset of those permitted under C99/C11, which does not specify the
2062 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2063 conforming to C11 may not have been written expecting the possibility of
2064 the new values.
2066 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2067 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2068 or the extended set of values specified in ISO/IEC TS 18661-3.
2070 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2072 The default when in a standards compliant mode (@option{-std=c11} or similar)
2073 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2074 dialect (@option{-std=gnu11} or similar) is
2075 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2077 @item -aux-info @var{filename}
2078 @opindex aux-info
2079 Output to the given filename prototyped declarations for all functions
2080 declared and/or defined in a translation unit, including those in header
2081 files.  This option is silently ignored in any language other than C@.
2083 Besides declarations, the file indicates, in comments, the origin of
2084 each declaration (source file and line), whether the declaration was
2085 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2086 @samp{O} for old, respectively, in the first character after the line
2087 number and the colon), and whether it came from a declaration or a
2088 definition (@samp{C} or @samp{F}, respectively, in the following
2089 character).  In the case of function definitions, a K&R-style list of
2090 arguments followed by their declarations is also provided, inside
2091 comments, after the declaration.
2093 @item -fallow-parameterless-variadic-functions
2094 @opindex fallow-parameterless-variadic-functions
2095 Accept variadic functions without named parameters.
2097 Although it is possible to define such a function, this is not very
2098 useful as it is not possible to read the arguments.  This is only
2099 supported for C as this construct is allowed by C++.
2101 @item -fno-asm
2102 @opindex fno-asm
2103 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2104 keyword, so that code can use these words as identifiers.  You can use
2105 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2106 instead.  @option{-ansi} implies @option{-fno-asm}.
2108 In C++, this switch only affects the @code{typeof} keyword, since
2109 @code{asm} and @code{inline} are standard keywords.  You may want to
2110 use the @option{-fno-gnu-keywords} flag instead, which has the same
2111 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2112 switch only affects the @code{asm} and @code{typeof} keywords, since
2113 @code{inline} is a standard keyword in ISO C99.
2115 @item -fno-builtin
2116 @itemx -fno-builtin-@var{function}
2117 @opindex fno-builtin
2118 @cindex built-in functions
2119 Don't recognize built-in functions that do not begin with
2120 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2121 functions provided by GCC}, for details of the functions affected,
2122 including those which are not built-in functions when @option{-ansi} or
2123 @option{-std} options for strict ISO C conformance are used because they
2124 do not have an ISO standard meaning.
2126 GCC normally generates special code to handle certain built-in functions
2127 more efficiently; for instance, calls to @code{alloca} may become single
2128 instructions which adjust the stack directly, and calls to @code{memcpy}
2129 may become inline copy loops.  The resulting code is often both smaller
2130 and faster, but since the function calls no longer appear as such, you
2131 cannot set a breakpoint on those calls, nor can you change the behavior
2132 of the functions by linking with a different library.  In addition,
2133 when a function is recognized as a built-in function, GCC may use
2134 information about that function to warn about problems with calls to
2135 that function, or to generate more efficient code, even if the
2136 resulting code still contains calls to that function.  For example,
2137 warnings are given with @option{-Wformat} for bad calls to
2138 @code{printf} when @code{printf} is built in and @code{strlen} is
2139 known not to modify global memory.
2141 With the @option{-fno-builtin-@var{function}} option
2142 only the built-in function @var{function} is
2143 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2144 function is named that is not built-in in this version of GCC, this
2145 option is ignored.  There is no corresponding
2146 @option{-fbuiltin-@var{function}} option; if you wish to enable
2147 built-in functions selectively when using @option{-fno-builtin} or
2148 @option{-ffreestanding}, you may define macros such as:
2150 @smallexample
2151 #define abs(n)          __builtin_abs ((n))
2152 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2153 @end smallexample
2155 @item -fgimple
2156 @opindex fgimple
2158 Enable parsing of function definitions marked with @code{__GIMPLE}.
2159 This is an experimental feature that allows unit testing of GIMPLE
2160 passes.
2162 @item -fhosted
2163 @opindex fhosted
2164 @cindex hosted environment
2166 Assert that compilation targets a hosted environment.  This implies
2167 @option{-fbuiltin}.  A hosted environment is one in which the
2168 entire standard library is available, and in which @code{main} has a return
2169 type of @code{int}.  Examples are nearly everything except a kernel.
2170 This is equivalent to @option{-fno-freestanding}.
2172 @item -ffreestanding
2173 @opindex ffreestanding
2174 @cindex hosted environment
2176 Assert that compilation targets a freestanding environment.  This
2177 implies @option{-fno-builtin}.  A freestanding environment
2178 is one in which the standard library may not exist, and program startup may
2179 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2180 This is equivalent to @option{-fno-hosted}.
2182 @xref{Standards,,Language Standards Supported by GCC}, for details of
2183 freestanding and hosted environments.
2185 @item -fopenacc
2186 @opindex fopenacc
2187 @cindex OpenACC accelerator programming
2188 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2189 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2190 compiler generates accelerated code according to the OpenACC Application
2191 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2192 implies @option{-pthread}, and thus is only supported on targets that
2193 have support for @option{-pthread}.
2195 @item -fopenacc-dim=@var{geom}
2196 @opindex fopenacc-dim
2197 @cindex OpenACC accelerator programming
2198 Specify default compute dimensions for parallel offload regions that do
2199 not explicitly specify.  The @var{geom} value is a triple of
2200 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2201 can be omitted, to use a target-specific default value.
2203 @item -fopenmp
2204 @opindex fopenmp
2205 @cindex OpenMP parallel
2206 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2207 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2208 compiler generates parallel code according to the OpenMP Application
2209 Program Interface v4.5 @w{@uref{https://www.openmp.org}}.  This option
2210 implies @option{-pthread}, and thus is only supported on targets that
2211 have support for @option{-pthread}. @option{-fopenmp} implies
2212 @option{-fopenmp-simd}.
2214 @item -fopenmp-simd
2215 @opindex fopenmp-simd
2216 @cindex OpenMP SIMD
2217 @cindex SIMD
2218 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2219 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2220 are ignored.
2222 @item -fgnu-tm
2223 @opindex fgnu-tm
2224 When the option @option{-fgnu-tm} is specified, the compiler
2225 generates code for the Linux variant of Intel's current Transactional
2226 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2227 an experimental feature whose interface may change in future versions
2228 of GCC, as the official specification changes.  Please note that not
2229 all architectures are supported for this feature.
2231 For more information on GCC's support for transactional memory,
2232 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2233 Transactional Memory Library}.
2235 Note that the transactional memory feature is not supported with
2236 non-call exceptions (@option{-fnon-call-exceptions}).
2238 @item -fms-extensions
2239 @opindex fms-extensions
2240 Accept some non-standard constructs used in Microsoft header files.
2242 In C++ code, this allows member names in structures to be similar
2243 to previous types declarations.
2245 @smallexample
2246 typedef int UOW;
2247 struct ABC @{
2248   UOW UOW;
2250 @end smallexample
2252 Some cases of unnamed fields in structures and unions are only
2253 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2254 fields within structs/unions}, for details.
2256 Note that this option is off for all targets but x86 
2257 targets using ms-abi.
2259 @item -fplan9-extensions
2260 @opindex fplan9-extensions
2261 Accept some non-standard constructs used in Plan 9 code.
2263 This enables @option{-fms-extensions}, permits passing pointers to
2264 structures with anonymous fields to functions that expect pointers to
2265 elements of the type of the field, and permits referring to anonymous
2266 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2267 struct/union fields within structs/unions}, for details.  This is only
2268 supported for C, not C++.
2270 @item -fcond-mismatch
2271 @opindex fcond-mismatch
2272 Allow conditional expressions with mismatched types in the second and
2273 third arguments.  The value of such an expression is void.  This option
2274 is not supported for C++.
2276 @item -flax-vector-conversions
2277 @opindex flax-vector-conversions
2278 Allow implicit conversions between vectors with differing numbers of
2279 elements and/or incompatible element types.  This option should not be
2280 used for new code.
2282 @item -funsigned-char
2283 @opindex funsigned-char
2284 Let the type @code{char} be unsigned, like @code{unsigned char}.
2286 Each kind of machine has a default for what @code{char} should
2287 be.  It is either like @code{unsigned char} by default or like
2288 @code{signed char} by default.
2290 Ideally, a portable program should always use @code{signed char} or
2291 @code{unsigned char} when it depends on the signedness of an object.
2292 But many programs have been written to use plain @code{char} and
2293 expect it to be signed, or expect it to be unsigned, depending on the
2294 machines they were written for.  This option, and its inverse, let you
2295 make such a program work with the opposite default.
2297 The type @code{char} is always a distinct type from each of
2298 @code{signed char} or @code{unsigned char}, even though its behavior
2299 is always just like one of those two.
2301 @item -fsigned-char
2302 @opindex fsigned-char
2303 Let the type @code{char} be signed, like @code{signed char}.
2305 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2306 the negative form of @option{-funsigned-char}.  Likewise, the option
2307 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2309 @item -fsigned-bitfields
2310 @itemx -funsigned-bitfields
2311 @itemx -fno-signed-bitfields
2312 @itemx -fno-unsigned-bitfields
2313 @opindex fsigned-bitfields
2314 @opindex funsigned-bitfields
2315 @opindex fno-signed-bitfields
2316 @opindex fno-unsigned-bitfields
2317 These options control whether a bit-field is signed or unsigned, when the
2318 declaration does not use either @code{signed} or @code{unsigned}.  By
2319 default, such a bit-field is signed, because this is consistent: the
2320 basic integer types such as @code{int} are signed types.
2322 @item -fsso-struct=@var{endianness}
2323 @opindex fsso-struct
2324 Set the default scalar storage order of structures and unions to the
2325 specified endianness.  The accepted values are @samp{big-endian},
2326 @samp{little-endian} and @samp{native} for the native endianness of
2327 the target (the default).  This option is not supported for C++.
2329 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2330 code that is not binary compatible with code generated without it if the
2331 specified endianness is not the native endianness of the target.
2332 @end table
2334 @node C++ Dialect Options
2335 @section Options Controlling C++ Dialect
2337 @cindex compiler options, C++
2338 @cindex C++ options, command-line
2339 @cindex options, C++
2340 This section describes the command-line options that are only meaningful
2341 for C++ programs.  You can also use most of the GNU compiler options
2342 regardless of what language your program is in.  For example, you
2343 might compile a file @file{firstClass.C} like this:
2345 @smallexample
2346 g++ -g -fstrict-enums -O -c firstClass.C
2347 @end smallexample
2349 @noindent
2350 In this example, only @option{-fstrict-enums} is an option meant
2351 only for C++ programs; you can use the other options with any
2352 language supported by GCC@.
2354 Some options for compiling C programs, such as @option{-std}, are also
2355 relevant for C++ programs.
2356 @xref{C Dialect Options,,Options Controlling C Dialect}.
2358 Here is a list of options that are @emph{only} for compiling C++ programs:
2360 @table @gcctabopt
2362 @item -fabi-version=@var{n}
2363 @opindex fabi-version
2364 Use version @var{n} of the C++ ABI@.  The default is version 0.
2366 Version 0 refers to the version conforming most closely to
2367 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2368 will change in different versions of G++ as ABI bugs are fixed.
2370 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2372 Version 2 is the version of the C++ ABI that first appeared in G++
2373 3.4, and was the default through G++ 4.9.
2375 Version 3 corrects an error in mangling a constant address as a
2376 template argument.
2378 Version 4, which first appeared in G++ 4.5, implements a standard
2379 mangling for vector types.
2381 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2382 attribute const/volatile on function pointer types, decltype of a
2383 plain decl, and use of a function parameter in the declaration of
2384 another parameter.
2386 Version 6, which first appeared in G++ 4.7, corrects the promotion
2387 behavior of C++11 scoped enums and the mangling of template argument
2388 packs, const/static_cast, prefix ++ and --, and a class scope function
2389 used as a template argument.
2391 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2392 builtin type and corrects the mangling of lambdas in default argument
2393 scope.
2395 Version 8, which first appeared in G++ 4.9, corrects the substitution
2396 behavior of function types with function-cv-qualifiers.
2398 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2399 @code{nullptr_t}.
2401 Version 10, which first appeared in G++ 6.1, adds mangling of
2402 attributes that affect type identity, such as ia32 calling convention
2403 attributes (e.g.@: @samp{stdcall}).
2405 Version 11, which first appeared in G++ 7, corrects the mangling of
2406 sizeof... expressions and operator names.  For multiple entities with
2407 the same name within a function, that are declared in different scopes,
2408 the mangling now changes starting with the twelfth occurrence.  It also
2409 implies @option{-fnew-inheriting-ctors}.
2411 Version 12, which first appeared in G++ 8, corrects the calling
2412 conventions for empty classes on the x86_64 target and for classes
2413 with only deleted copy/move constructors.  It accidentally changes the
2414 calling convention for classes with a deleted copy constructor and a
2415 trivial move constructor.
2417 Version 13, which first appeared in G++ 8.2, fixes the accidental
2418 change in version 12.
2420 See also @option{-Wabi}.
2422 @item -fabi-compat-version=@var{n}
2423 @opindex fabi-compat-version
2424 On targets that support strong aliases, G++
2425 works around mangling changes by creating an alias with the correct
2426 mangled name when defining a symbol with an incorrect mangled name.
2427 This switch specifies which ABI version to use for the alias.
2429 With @option{-fabi-version=0} (the default), this defaults to 11 (GCC 7
2430 compatibility).  If another ABI version is explicitly selected, this
2431 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2432 use @option{-fabi-compat-version=2}.
2434 If this option is not provided but @option{-Wabi=@var{n}} is, that
2435 version is used for compatibility aliases.  If this option is provided
2436 along with @option{-Wabi} (without the version), the version from this
2437 option is used for the warning.
2439 @item -fno-access-control
2440 @opindex fno-access-control
2441 Turn off all access checking.  This switch is mainly useful for working
2442 around bugs in the access control code.
2444 @item -faligned-new
2445 @opindex faligned-new
2446 Enable support for C++17 @code{new} of types that require more
2447 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2448 numeric argument such as @code{-faligned-new=32} can be used to
2449 specify how much alignment (in bytes) is provided by that function,
2450 but few users will need to override the default of
2451 @code{alignof(std::max_align_t)}.
2453 This flag is enabled by default for @option{-std=c++17}.
2455 @item -fcheck-new
2456 @opindex fcheck-new
2457 Check that the pointer returned by @code{operator new} is non-null
2458 before attempting to modify the storage allocated.  This check is
2459 normally unnecessary because the C++ standard specifies that
2460 @code{operator new} only returns @code{0} if it is declared
2461 @code{throw()}, in which case the compiler always checks the
2462 return value even without this option.  In all other cases, when
2463 @code{operator new} has a non-empty exception specification, memory
2464 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2465 @samp{new (nothrow)}.
2467 @item -fconcepts
2468 @opindex fconcepts
2469 Enable support for the C++ Extensions for Concepts Technical
2470 Specification, ISO 19217 (2015), which allows code like
2472 @smallexample
2473 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2474 template <Addable T> T add (T a, T b) @{ return a + b; @}
2475 @end smallexample
2477 @item -fconstexpr-depth=@var{n}
2478 @opindex fconstexpr-depth
2479 Set the maximum nested evaluation depth for C++11 constexpr functions
2480 to @var{n}.  A limit is needed to detect endless recursion during
2481 constant expression evaluation.  The minimum specified by the standard
2482 is 512.
2484 @item -fconstexpr-loop-limit=@var{n}
2485 @opindex fconstexpr-loop-limit
2486 Set the maximum number of iterations for a loop in C++14 constexpr functions
2487 to @var{n}.  A limit is needed to detect infinite loops during
2488 constant expression evaluation.  The default is 262144 (1<<18).
2490 @item -fdeduce-init-list
2491 @opindex fdeduce-init-list
2492 Enable deduction of a template type parameter as
2493 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2495 @smallexample
2496 template <class T> auto forward(T t) -> decltype (realfn (t))
2498   return realfn (t);
2501 void f()
2503   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2505 @end smallexample
2507 This deduction was implemented as a possible extension to the
2508 originally proposed semantics for the C++11 standard, but was not part
2509 of the final standard, so it is disabled by default.  This option is
2510 deprecated, and may be removed in a future version of G++.
2512 @item -fno-elide-constructors
2513 @opindex fno-elide-constructors
2514 The C++ standard allows an implementation to omit creating a temporary
2515 that is only used to initialize another object of the same type.
2516 Specifying this option disables that optimization, and forces G++ to
2517 call the copy constructor in all cases.  This option also causes G++
2518 to call trivial member functions which otherwise would be expanded inline.
2520 In C++17, the compiler is required to omit these temporaries, but this
2521 option still affects trivial member functions.
2523 @item -fno-enforce-eh-specs
2524 @opindex fno-enforce-eh-specs
2525 Don't generate code to check for violation of exception specifications
2526 at run time.  This option violates the C++ standard, but may be useful
2527 for reducing code size in production builds, much like defining
2528 @code{NDEBUG}.  This does not give user code permission to throw
2529 exceptions in violation of the exception specifications; the compiler
2530 still optimizes based on the specifications, so throwing an
2531 unexpected exception results in undefined behavior at run time.
2533 @item -fextern-tls-init
2534 @itemx -fno-extern-tls-init
2535 @opindex fextern-tls-init
2536 @opindex fno-extern-tls-init
2537 The C++11 and OpenMP standards allow @code{thread_local} and
2538 @code{threadprivate} variables to have dynamic (runtime)
2539 initialization.  To support this, any use of such a variable goes
2540 through a wrapper function that performs any necessary initialization.
2541 When the use and definition of the variable are in the same
2542 translation unit, this overhead can be optimized away, but when the
2543 use is in a different translation unit there is significant overhead
2544 even if the variable doesn't actually need dynamic initialization.  If
2545 the programmer can be sure that no use of the variable in a
2546 non-defining TU needs to trigger dynamic initialization (either
2547 because the variable is statically initialized, or a use of the
2548 variable in the defining TU will be executed before any uses in
2549 another TU), they can avoid this overhead with the
2550 @option{-fno-extern-tls-init} option.
2552 On targets that support symbol aliases, the default is
2553 @option{-fextern-tls-init}.  On targets that do not support symbol
2554 aliases, the default is @option{-fno-extern-tls-init}.
2556 @item -fno-gnu-keywords
2557 @opindex fno-gnu-keywords
2558 Do not recognize @code{typeof} as a keyword, so that code can use this
2559 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2560 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2561 @option{-std=c++98}, @option{-std=c++11}, etc.
2563 @item -fno-implicit-templates
2564 @opindex fno-implicit-templates
2565 Never emit code for non-inline templates that are instantiated
2566 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2567 @xref{Template Instantiation}, for more information.
2569 @item -fno-implicit-inline-templates
2570 @opindex fno-implicit-inline-templates
2571 Don't emit code for implicit instantiations of inline templates, either.
2572 The default is to handle inlines differently so that compiles with and
2573 without optimization need the same set of explicit instantiations.
2575 @item -fno-implement-inlines
2576 @opindex fno-implement-inlines
2577 To save space, do not emit out-of-line copies of inline functions
2578 controlled by @code{#pragma implementation}.  This causes linker
2579 errors if these functions are not inlined everywhere they are called.
2581 @item -fms-extensions
2582 @opindex fms-extensions
2583 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2584 int and getting a pointer to member function via non-standard syntax.
2586 @item -fnew-inheriting-ctors
2587 @opindex fnew-inheriting-ctors
2588 Enable the P0136 adjustment to the semantics of C++11 constructor
2589 inheritance.  This is part of C++17 but also considered to be a Defect
2590 Report against C++11 and C++14.  This flag is enabled by default
2591 unless @option{-fabi-version=10} or lower is specified.
2593 @item -fnew-ttp-matching
2594 @opindex fnew-ttp-matching
2595 Enable the P0522 resolution to Core issue 150, template template
2596 parameters and default arguments: this allows a template with default
2597 template arguments as an argument for a template template parameter
2598 with fewer template parameters.  This flag is enabled by default for
2599 @option{-std=c++17}.
2601 @item -fno-nonansi-builtins
2602 @opindex fno-nonansi-builtins
2603 Disable built-in declarations of functions that are not mandated by
2604 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2605 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2607 @item -fnothrow-opt
2608 @opindex fnothrow-opt
2609 Treat a @code{throw()} exception specification as if it were a
2610 @code{noexcept} specification to reduce or eliminate the text size
2611 overhead relative to a function with no exception specification.  If
2612 the function has local variables of types with non-trivial
2613 destructors, the exception specification actually makes the
2614 function smaller because the EH cleanups for those variables can be
2615 optimized away.  The semantic effect is that an exception thrown out of
2616 a function with such an exception specification results in a call
2617 to @code{terminate} rather than @code{unexpected}.
2619 @item -fno-operator-names
2620 @opindex fno-operator-names
2621 Do not treat the operator name keywords @code{and}, @code{bitand},
2622 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2623 synonyms as keywords.
2625 @item -fno-optional-diags
2626 @opindex fno-optional-diags
2627 Disable diagnostics that the standard says a compiler does not need to
2628 issue.  Currently, the only such diagnostic issued by G++ is the one for
2629 a name having multiple meanings within a class.
2631 @item -fpermissive
2632 @opindex fpermissive
2633 Downgrade some diagnostics about nonconformant code from errors to
2634 warnings.  Thus, using @option{-fpermissive} allows some
2635 nonconforming code to compile.
2637 @item -fno-pretty-templates
2638 @opindex fno-pretty-templates
2639 When an error message refers to a specialization of a function
2640 template, the compiler normally prints the signature of the
2641 template followed by the template arguments and any typedefs or
2642 typenames in the signature (e.g.@: @code{void f(T) [with T = int]}
2643 rather than @code{void f(int)}) so that it's clear which template is
2644 involved.  When an error message refers to a specialization of a class
2645 template, the compiler omits any template arguments that match
2646 the default template arguments for that template.  If either of these
2647 behaviors make it harder to understand the error message rather than
2648 easier, you can use @option{-fno-pretty-templates} to disable them.
2650 @item -frepo
2651 @opindex frepo
2652 Enable automatic template instantiation at link time.  This option also
2653 implies @option{-fno-implicit-templates}.  @xref{Template
2654 Instantiation}, for more information.
2656 @item -fno-rtti
2657 @opindex fno-rtti
2658 Disable generation of information about every class with virtual
2659 functions for use by the C++ run-time type identification features
2660 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2661 of the language, you can save some space by using this flag.  Note that
2662 exception handling uses the same information, but G++ generates it as
2663 needed. The @code{dynamic_cast} operator can still be used for casts that
2664 do not require run-time type information, i.e.@: casts to @code{void *} or to
2665 unambiguous base classes.
2667 @item -fsized-deallocation
2668 @opindex fsized-deallocation
2669 Enable the built-in global declarations
2670 @smallexample
2671 void operator delete (void *, std::size_t) noexcept;
2672 void operator delete[] (void *, std::size_t) noexcept;
2673 @end smallexample
2674 as introduced in C++14.  This is useful for user-defined replacement
2675 deallocation functions that, for example, use the size of the object
2676 to make deallocation faster.  Enabled by default under
2677 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2678 warns about places that might want to add a definition.
2680 @item -fstrict-enums
2681 @opindex fstrict-enums
2682 Allow the compiler to optimize using the assumption that a value of
2683 enumerated type can only be one of the values of the enumeration (as
2684 defined in the C++ standard; basically, a value that can be
2685 represented in the minimum number of bits needed to represent all the
2686 enumerators).  This assumption may not be valid if the program uses a
2687 cast to convert an arbitrary integer value to the enumerated type.
2689 @item -fstrong-eval-order
2690 @opindex fstrong-eval-order
2691 Evaluate member access, array subscripting, and shift expressions in
2692 left-to-right order, and evaluate assignment in right-to-left order,
2693 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2694 @option{-fstrong-eval-order=some} enables just the ordering of member
2695 access and shift expressions, and is the default without
2696 @option{-std=c++17}.
2698 @item -ftemplate-backtrace-limit=@var{n}
2699 @opindex ftemplate-backtrace-limit
2700 Set the maximum number of template instantiation notes for a single
2701 warning or error to @var{n}.  The default value is 10.
2703 @item -ftemplate-depth=@var{n}
2704 @opindex ftemplate-depth
2705 Set the maximum instantiation depth for template classes to @var{n}.
2706 A limit on the template instantiation depth is needed to detect
2707 endless recursions during template class instantiation.  ANSI/ISO C++
2708 conforming programs must not rely on a maximum depth greater than 17
2709 (changed to 1024 in C++11).  The default value is 900, as the compiler
2710 can run out of stack space before hitting 1024 in some situations.
2712 @item -fno-threadsafe-statics
2713 @opindex fno-threadsafe-statics
2714 Do not emit the extra code to use the routines specified in the C++
2715 ABI for thread-safe initialization of local statics.  You can use this
2716 option to reduce code size slightly in code that doesn't need to be
2717 thread-safe.
2719 @item -fuse-cxa-atexit
2720 @opindex fuse-cxa-atexit
2721 Register destructors for objects with static storage duration with the
2722 @code{__cxa_atexit} function rather than the @code{atexit} function.
2723 This option is required for fully standards-compliant handling of static
2724 destructors, but only works if your C library supports
2725 @code{__cxa_atexit}.
2727 @item -fno-use-cxa-get-exception-ptr
2728 @opindex fno-use-cxa-get-exception-ptr
2729 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2730 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2731 if the runtime routine is not available.
2733 @item -fvisibility-inlines-hidden
2734 @opindex fvisibility-inlines-hidden
2735 This switch declares that the user does not attempt to compare
2736 pointers to inline functions or methods where the addresses of the two functions
2737 are taken in different shared objects.
2739 The effect of this is that GCC may, effectively, mark inline methods with
2740 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2741 appear in the export table of a DSO and do not require a PLT indirection
2742 when used within the DSO@.  Enabling this option can have a dramatic effect
2743 on load and link times of a DSO as it massively reduces the size of the
2744 dynamic export table when the library makes heavy use of templates.
2746 The behavior of this switch is not quite the same as marking the
2747 methods as hidden directly, because it does not affect static variables
2748 local to the function or cause the compiler to deduce that
2749 the function is defined in only one shared object.
2751 You may mark a method as having a visibility explicitly to negate the
2752 effect of the switch for that method.  For example, if you do want to
2753 compare pointers to a particular inline method, you might mark it as
2754 having default visibility.  Marking the enclosing class with explicit
2755 visibility has no effect.
2757 Explicitly instantiated inline methods are unaffected by this option
2758 as their linkage might otherwise cross a shared library boundary.
2759 @xref{Template Instantiation}.
2761 @item -fvisibility-ms-compat
2762 @opindex fvisibility-ms-compat
2763 This flag attempts to use visibility settings to make GCC's C++
2764 linkage model compatible with that of Microsoft Visual Studio.
2766 The flag makes these changes to GCC's linkage model:
2768 @enumerate
2769 @item
2770 It sets the default visibility to @code{hidden}, like
2771 @option{-fvisibility=hidden}.
2773 @item
2774 Types, but not their members, are not hidden by default.
2776 @item
2777 The One Definition Rule is relaxed for types without explicit
2778 visibility specifications that are defined in more than one
2779 shared object: those declarations are permitted if they are
2780 permitted when this option is not used.
2781 @end enumerate
2783 In new code it is better to use @option{-fvisibility=hidden} and
2784 export those classes that are intended to be externally visible.
2785 Unfortunately it is possible for code to rely, perhaps accidentally,
2786 on the Visual Studio behavior.
2788 Among the consequences of these changes are that static data members
2789 of the same type with the same name but defined in different shared
2790 objects are different, so changing one does not change the other;
2791 and that pointers to function members defined in different shared
2792 objects may not compare equal.  When this flag is given, it is a
2793 violation of the ODR to define types with the same name differently.
2795 @item -fno-weak
2796 @opindex fno-weak
2797 Do not use weak symbol support, even if it is provided by the linker.
2798 By default, G++ uses weak symbols if they are available.  This
2799 option exists only for testing, and should not be used by end-users;
2800 it results in inferior code and has no benefits.  This option may
2801 be removed in a future release of G++.
2803 @item -nostdinc++
2804 @opindex nostdinc++
2805 Do not search for header files in the standard directories specific to
2806 C++, but do still search the other standard directories.  (This option
2807 is used when building the C++ library.)
2808 @end table
2810 In addition, these optimization, warning, and code generation options
2811 have meanings only for C++ programs:
2813 @table @gcctabopt
2814 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2815 @opindex Wabi
2816 @opindex Wno-abi
2817 Warn when G++ it generates code that is probably not compatible with
2818 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2819 ABI with each major release, normally @option{-Wabi} will warn only if
2820 there is a check added later in a release series for an ABI issue
2821 discovered since the initial release.  @option{-Wabi} will warn about
2822 more things if an older ABI version is selected (with
2823 @option{-fabi-version=@var{n}}).
2825 @option{-Wabi} can also be used with an explicit version number to
2826 warn about compatibility with a particular @option{-fabi-version}
2827 level, e.g.@: @option{-Wabi=2} to warn about changes relative to
2828 @option{-fabi-version=2}.
2830 If an explicit version number is provided and
2831 @option{-fabi-compat-version} is not specified, the version number
2832 from this option is used for compatibility aliases.  If no explicit
2833 version number is provided with this option, but
2834 @option{-fabi-compat-version} is specified, that version number is
2835 used for ABI warnings.
2837 Although an effort has been made to warn about
2838 all such cases, there are probably some cases that are not warned about,
2839 even though G++ is generating incompatible code.  There may also be
2840 cases where warnings are emitted even though the code that is generated
2841 is compatible.
2843 You should rewrite your code to avoid these warnings if you are
2844 concerned about the fact that code generated by G++ may not be binary
2845 compatible with code generated by other compilers.
2847 Known incompatibilities in @option{-fabi-version=2} (which was the
2848 default from GCC 3.4 to 4.9) include:
2850 @itemize @bullet
2852 @item
2853 A template with a non-type template parameter of reference type was
2854 mangled incorrectly:
2855 @smallexample
2856 extern int N;
2857 template <int &> struct S @{@};
2858 void n (S<N>) @{2@}
2859 @end smallexample
2861 This was fixed in @option{-fabi-version=3}.
2863 @item
2864 SIMD vector types declared using @code{__attribute ((vector_size))} were
2865 mangled in a non-standard way that does not allow for overloading of
2866 functions taking vectors of different sizes.
2868 The mangling was changed in @option{-fabi-version=4}.
2870 @item
2871 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2872 qualifiers, and @code{decltype} of a plain declaration was folded away.
2874 These mangling issues were fixed in @option{-fabi-version=5}.
2876 @item
2877 Scoped enumerators passed as arguments to a variadic function are
2878 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2879 On most targets this does not actually affect the parameter passing
2880 ABI, as there is no way to pass an argument smaller than @code{int}.
2882 Also, the ABI changed the mangling of template argument packs,
2883 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2884 a class scope function used as a template argument.
2886 These issues were corrected in @option{-fabi-version=6}.
2888 @item
2889 Lambdas in default argument scope were mangled incorrectly, and the
2890 ABI changed the mangling of @code{nullptr_t}.
2892 These issues were corrected in @option{-fabi-version=7}.
2894 @item
2895 When mangling a function type with function-cv-qualifiers, the
2896 un-qualified function type was incorrectly treated as a substitution
2897 candidate.
2899 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2901 @item
2902 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2903 unaligned accesses.  Note that this did not affect the ABI of a
2904 function with a @code{nullptr_t} parameter, as parameters have a
2905 minimum alignment.
2907 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2909 @item
2910 Target-specific attributes that affect the identity of a type, such as
2911 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2912 did not affect the mangled name, leading to name collisions when
2913 function pointers were used as template arguments.
2915 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2917 @end itemize
2919 It also warns about psABI-related changes.  The known psABI changes at this
2920 point include:
2922 @itemize @bullet
2924 @item
2925 For SysV/x86-64, unions with @code{long double} members are 
2926 passed in memory as specified in psABI.  For example:
2928 @smallexample
2929 union U @{
2930   long double ld;
2931   int i;
2933 @end smallexample
2935 @noindent
2936 @code{union U} is always passed in memory.
2938 @end itemize
2940 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2941 @opindex Wabi-tag
2942 @opindex Wabi-tag
2943 Warn when a type with an ABI tag is used in a context that does not
2944 have that ABI tag.  See @ref{C++ Attributes} for more information
2945 about ABI tags.
2947 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2948 @opindex Wctor-dtor-privacy
2949 @opindex Wno-ctor-dtor-privacy
2950 Warn when a class seems unusable because all the constructors or
2951 destructors in that class are private, and it has neither friends nor
2952 public static member functions.  Also warn if there are no non-private
2953 methods, and there's at least one private member function that isn't
2954 a constructor or destructor.
2956 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2957 @opindex Wdelete-non-virtual-dtor
2958 @opindex Wno-delete-non-virtual-dtor
2959 Warn when @code{delete} is used to destroy an instance of a class that
2960 has virtual functions and non-virtual destructor. It is unsafe to delete
2961 an instance of a derived class through a pointer to a base class if the
2962 base class does not have a virtual destructor.  This warning is enabled
2963 by @option{-Wall}.
2965 @item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
2966 @opindex Wdeprecated-copy
2967 @opindex Wno-deprecated-copy
2968 Warn that the implicit declaration of a copy constructor or copy
2969 assignment operator is deprecated if the class has a user-provided
2970 copy constructor, copy assignment operator, or destructor, in C++11
2971 and up.  This warning is enabled by @option{-Wall}.
2973 @item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)}
2974 @opindex Winit-list-lifetime
2975 @opindex Wno-init-list-lifetime
2976 Do not warn about uses of @code{std::initializer_list} that are likely
2977 to result in dangling pointers.  Since the underlying array for an
2978 @code{initializer_list} is handled like a normal C++ temporary object,
2979 it is easy to inadvertently keep a pointer to the array past the end
2980 of the array's lifetime.  For example:
2982 @itemize @bullet
2983 @item
2984 If a function returns a temporary @code{initializer_list}, or a local
2985 @code{initializer_list} variable, the array's lifetime ends at the end
2986 of the return statement, so the value returned has a dangling pointer.
2988 @item
2989 If a new-expression creates an @code{initializer_list}, the array only
2990 lives until the end of the enclosing full-expression, so the
2991 @code{initializer_list} in the heap has a dangling pointer.
2993 @item
2994 When an @code{initializer_list} variable is assigned from a
2995 brace-enclosed initializer list, the temporary array created for the
2996 right side of the assignment only lives until the end of the
2997 full-expression, so at the next statement the @code{initializer_list}
2998 variable has a dangling pointer.
3000 @smallexample
3001 // li's initial underlying array lives as long as li
3002 std::initializer_list<int> li = @{ 1,2,3 @};
3003 // assignment changes li to point to a temporary array
3004 li = @{ 4, 5 @};
3005 // now the temporary is gone and li has a dangling pointer
3006 int i = li.begin()[0] // undefined behavior
3007 @end smallexample
3009 @item
3010 When a list constructor stores the @code{begin} pointer from the
3011 @code{initializer_list} argument, this doesn't extend the lifetime of
3012 the array, so if a class variable is constructed from a temporary
3013 @code{initializer_list}, the pointer is left dangling by the end of
3014 the variable declaration statement.
3016 @end itemize
3018 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
3019 @opindex Wliteral-suffix
3020 @opindex Wno-literal-suffix
3021 Warn when a string or character literal is followed by a ud-suffix which does
3022 not begin with an underscore.  As a conforming extension, GCC treats such
3023 suffixes as separate preprocessing tokens in order to maintain backwards
3024 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
3025 For example:
3027 @smallexample
3028 #define __STDC_FORMAT_MACROS
3029 #include <inttypes.h>
3030 #include <stdio.h>
3032 int main() @{
3033   int64_t i64 = 123;
3034   printf("My int64: %" PRId64"\n", i64);
3036 @end smallexample
3038 In this case, @code{PRId64} is treated as a separate preprocessing token.
3040 Additionally, warn when a user-defined literal operator is declared with
3041 a literal suffix identifier that doesn't begin with an underscore. Literal
3042 suffix identifiers that don't begin with an underscore are reserved for
3043 future standardization.
3045 This warning is enabled by default.
3047 @item -Wlto-type-mismatch
3048 @opindex Wlto-type-mismatch
3049 @opindex Wno-lto-type-mismatch
3051 During the link-time optimization warn about type mismatches in
3052 global declarations from different compilation units.
3053 Requires @option{-flto} to be enabled.  Enabled by default.
3055 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
3056 @opindex Wnarrowing
3057 @opindex Wno-narrowing
3058 For C++11 and later standards, narrowing conversions are diagnosed by default,
3059 as required by the standard.  A narrowing conversion from a constant produces
3060 an error, and a narrowing conversion from a non-constant produces a warning,
3061 but @option{-Wno-narrowing} suppresses the diagnostic.
3062 Note that this does not affect the meaning of well-formed code;
3063 narrowing conversions are still considered ill-formed in SFINAE contexts.
3065 With @option{-Wnarrowing} in C++98, warn when a narrowing
3066 conversion prohibited by C++11 occurs within
3067 @samp{@{ @}}, e.g.
3069 @smallexample
3070 int i = @{ 2.2 @}; // error: narrowing from double to int
3071 @end smallexample
3073 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
3075 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
3076 @opindex Wnoexcept
3077 @opindex Wno-noexcept
3078 Warn when a noexcept-expression evaluates to false because of a call
3079 to a function that does not have a non-throwing exception
3080 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
3081 the compiler to never throw an exception.
3083 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
3084 @opindex Wnoexcept-type
3085 @opindex Wno-noexcept-type
3086 Warn if the C++17 feature making @code{noexcept} part of a function
3087 type changes the mangled name of a symbol relative to C++14.  Enabled
3088 by @option{-Wabi} and @option{-Wc++17-compat}.
3090 As an example:
3092 @smallexample
3093 template <class T> void f(T t) @{ t(); @};
3094 void g() noexcept;
3095 void h() @{ f(g); @} 
3096 @end smallexample
3098 @noindent
3099 In C++14, @code{f} calls @code{f<void(*)()>}, but in
3100 C++17 it calls @code{f<void(*)()noexcept>}.
3102 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3103 @opindex Wclass-memaccess
3104 @opindex Wno-class-memaccess
3105 Warn when the destination of a call to a raw memory function such as
3106 @code{memset} or @code{memcpy} is an object of class type, and when writing
3107 into such an object might bypass the class non-trivial or deleted constructor
3108 or copy assignment, violate const-correctness or encapsulation, or corrupt
3109 virtual table pointers.  Modifying the representation of such objects may
3110 violate invariants maintained by member functions of the class.  For example,
3111 the call to @code{memset} below is undefined because it modifies a non-trivial
3112 class object and is, therefore, diagnosed.  The safe way to either initialize
3113 or clear the storage of objects of such types is by using the appropriate
3114 constructor or assignment operator, if one is available.
3115 @smallexample
3116 std::string str = "abc";
3117 memset (&str, 0, sizeof str);
3118 @end smallexample
3119 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3120 Explicitly casting the pointer to the class object to @code{void *} or
3121 to a type that can be safely accessed by the raw memory function suppresses
3122 the warning.
3124 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3125 @opindex Wnon-virtual-dtor
3126 @opindex Wno-non-virtual-dtor
3127 Warn when a class has virtual functions and an accessible non-virtual
3128 destructor itself or in an accessible polymorphic base class, in which
3129 case it is possible but unsafe to delete an instance of a derived
3130 class through a pointer to the class itself or base class.  This
3131 warning is automatically enabled if @option{-Weffc++} is specified.
3133 @item -Wregister @r{(C++ and Objective-C++ only)}
3134 @opindex Wregister
3135 @opindex Wno-register
3136 Warn on uses of the @code{register} storage class specifier, except
3137 when it is part of the GNU @ref{Explicit Register Variables} extension.
3138 The use of the @code{register} keyword as storage class specifier has
3139 been deprecated in C++11 and removed in C++17.
3140 Enabled by default with @option{-std=c++17}.
3142 @item -Wreorder @r{(C++ and Objective-C++ only)}
3143 @opindex Wreorder
3144 @opindex Wno-reorder
3145 @cindex reordering, warning
3146 @cindex warning for reordering of member initializers
3147 Warn when the order of member initializers given in the code does not
3148 match the order in which they must be executed.  For instance:
3150 @smallexample
3151 struct A @{
3152   int i;
3153   int j;
3154   A(): j (0), i (1) @{ @}
3156 @end smallexample
3158 @noindent
3159 The compiler rearranges the member initializers for @code{i}
3160 and @code{j} to match the declaration order of the members, emitting
3161 a warning to that effect.  This warning is enabled by @option{-Wall}.
3163 @item -Wno-pessimizing-move @r{(C++ and Objective-C++ only)}
3164 @opindex Wpessimizing-move
3165 @opindex Wno-pessimizing-move
3166 This warning warns when a call to @code{std::move} prevents copy
3167 elision.  A typical scenario when copy elision can occur is when returning in
3168 a function with a class return type, when the expression being returned is the
3169 name of a non-volatile automatic object, and is not a function parameter, and
3170 has the same type as the function return type.
3172 @smallexample
3173 struct T @{
3174 @dots{}
3176 T fn()
3178   T t;
3179   @dots{}
3180   return std::move (t);
3182 @end smallexample
3184 But in this example, the @code{std::move} call prevents copy elision.
3186 This warning is enabled by @option{-Wall}.
3188 @item -Wno-redundant-move @r{(C++ and Objective-C++ only)}
3189 @opindex Wredundant-move
3190 @opindex Wno-redundant-move
3191 This warning warns about redundant calls to @code{std::move}; that is, when
3192 a move operation would have been performed even without the @code{std::move}
3193 call.  This happens because the compiler is forced to treat the object as if
3194 it were an rvalue in certain situations such as returning a local variable,
3195 where copy elision isn't applicable.  Consider:
3197 @smallexample
3198 struct T @{
3199 @dots{}
3201 T fn(T t)
3203   @dots{}
3204   return std::move (t);
3206 @end smallexample
3208 Here, the @code{std::move} call is redundant.  Because G++ implements Core
3209 Issue 1579, another example is:
3211 @smallexample
3212 struct T @{ // convertible to U
3213 @dots{}
3215 struct U @{
3216 @dots{}
3218 U fn()
3220   T t;
3221   @dots{}
3222   return std::move (t);
3224 @end smallexample
3225 In this example, copy elision isn't applicable because the type of the
3226 expression being returned and the function return type differ, yet G++
3227 treats the return value as if it were designated by an rvalue.
3229 This warning is enabled by @option{-Wextra}.
3231 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3232 @opindex fext-numeric-literals
3233 @opindex fno-ext-numeric-literals
3234 Accept imaginary, fixed-point, or machine-defined
3235 literal number suffixes as GNU extensions.
3236 When this option is turned off these suffixes are treated
3237 as C++11 user-defined literal numeric suffixes.
3238 This is on by default for all pre-C++11 dialects and all GNU dialects:
3239 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3240 @option{-std=gnu++14}.
3241 This option is off by default
3242 for ISO C++11 onwards (@option{-std=c++11}, ...).
3243 @end table
3245 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3247 @table @gcctabopt
3248 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3249 @opindex Weffc++
3250 @opindex Wno-effc++
3251 Warn about violations of the following style guidelines from Scott Meyers'
3252 @cite{Effective C++} series of books:
3254 @itemize @bullet
3255 @item
3256 Define a copy constructor and an assignment operator for classes
3257 with dynamically-allocated memory.
3259 @item
3260 Prefer initialization to assignment in constructors.
3262 @item
3263 Have @code{operator=} return a reference to @code{*this}.
3265 @item
3266 Don't try to return a reference when you must return an object.
3268 @item
3269 Distinguish between prefix and postfix forms of increment and
3270 decrement operators.
3272 @item
3273 Never overload @code{&&}, @code{||}, or @code{,}.
3275 @end itemize
3277 This option also enables @option{-Wnon-virtual-dtor}, which is also
3278 one of the effective C++ recommendations.  However, the check is
3279 extended to warn about the lack of virtual destructor in accessible
3280 non-polymorphic bases classes too.
3282 When selecting this option, be aware that the standard library
3283 headers do not obey all of these guidelines; use @samp{grep -v}
3284 to filter out those warnings.
3286 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3287 @opindex Wstrict-null-sentinel
3288 @opindex Wno-strict-null-sentinel
3289 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3290 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3291 to @code{__null}.  Although it is a null pointer constant rather than a
3292 null pointer, it is guaranteed to be of the same size as a pointer.
3293 But this use is not portable across different compilers.
3295 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3296 @opindex Wno-non-template-friend
3297 @opindex Wnon-template-friend
3298 Disable warnings when non-template friend functions are declared
3299 within a template.  In very old versions of GCC that predate implementation
3300 of the ISO standard, declarations such as 
3301 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3302 could be interpreted as a particular specialization of a template
3303 function; the warning exists to diagnose compatibility problems, 
3304 and is enabled by default.
3306 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3307 @opindex Wold-style-cast
3308 @opindex Wno-old-style-cast
3309 Warn if an old-style (C-style) cast to a non-void type is used within
3310 a C++ program.  The new-style casts (@code{dynamic_cast},
3311 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3312 less vulnerable to unintended effects and much easier to search for.
3314 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3315 @opindex Woverloaded-virtual
3316 @opindex Wno-overloaded-virtual
3317 @cindex overloaded virtual function, warning
3318 @cindex warning for overloaded virtual function
3319 Warn when a function declaration hides virtual functions from a
3320 base class.  For example, in:
3322 @smallexample
3323 struct A @{
3324   virtual void f();
3327 struct B: public A @{
3328   void f(int);
3330 @end smallexample
3332 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3333 like:
3335 @smallexample
3336 B* b;
3337 b->f();
3338 @end smallexample
3340 @noindent
3341 fails to compile.
3343 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3344 @opindex Wno-pmf-conversions
3345 @opindex Wpmf-conversions
3346 Disable the diagnostic for converting a bound pointer to member function
3347 to a plain pointer.
3349 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3350 @opindex Wsign-promo
3351 @opindex Wno-sign-promo
3352 Warn when overload resolution chooses a promotion from unsigned or
3353 enumerated type to a signed type, over a conversion to an unsigned type of
3354 the same size.  Previous versions of G++ tried to preserve
3355 unsignedness, but the standard mandates the current behavior.
3357 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3358 @opindex Wtemplates
3359 @opindex Wno-templates
3360 Warn when a primary template declaration is encountered.  Some coding
3361 rules disallow templates, and this may be used to enforce that rule.
3362 The warning is inactive inside a system header file, such as the STL, so
3363 one can still use the STL.  One may also instantiate or specialize
3364 templates.
3366 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3367 @opindex Wmultiple-inheritance
3368 @opindex Wno-multiple-inheritance
3369 Warn when a class is defined with multiple direct base classes.  Some
3370 coding rules disallow multiple inheritance, and this may be used to
3371 enforce that rule.  The warning is inactive inside a system header file,
3372 such as the STL, so one can still use the STL.  One may also define
3373 classes that indirectly use multiple inheritance.
3375 @item -Wvirtual-inheritance
3376 @opindex Wvirtual-inheritance
3377 @opindex Wno-virtual-inheritance
3378 Warn when a class is defined with a virtual direct base class.  Some
3379 coding rules disallow multiple inheritance, and this may be used to
3380 enforce that rule.  The warning is inactive inside a system header file,
3381 such as the STL, so one can still use the STL.  One may also define
3382 classes that indirectly use virtual inheritance.
3384 @item -Wnamespaces
3385 @opindex Wnamespaces
3386 @opindex Wno-namespaces
3387 Warn when a namespace definition is opened.  Some coding rules disallow
3388 namespaces, and this may be used to enforce that rule.  The warning is
3389 inactive inside a system header file, such as the STL, so one can still
3390 use the STL.  One may also use using directives and qualified names.
3392 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3393 @opindex Wterminate
3394 @opindex Wno-terminate
3395 Disable the warning about a throw-expression that will immediately
3396 result in a call to @code{terminate}.
3398 @item -Wno-class-conversion @r{(C++ and Objective-C++ only)}
3399 @opindex Wno-class-conversion
3400 @opindex Wclass-conversion
3401 Disable the warning about the case when a conversion function converts an
3402 object to the same type, to a base class of that type, or to void; such
3403 a conversion function will never be called.
3404 @end table
3406 @node Objective-C and Objective-C++ Dialect Options
3407 @section Options Controlling Objective-C and Objective-C++ Dialects
3409 @cindex compiler options, Objective-C and Objective-C++
3410 @cindex Objective-C and Objective-C++ options, command-line
3411 @cindex options, Objective-C and Objective-C++
3412 (NOTE: This manual does not describe the Objective-C and Objective-C++
3413 languages themselves.  @xref{Standards,,Language Standards
3414 Supported by GCC}, for references.)
3416 This section describes the command-line options that are only meaningful
3417 for Objective-C and Objective-C++ programs.  You can also use most of
3418 the language-independent GNU compiler options.
3419 For example, you might compile a file @file{some_class.m} like this:
3421 @smallexample
3422 gcc -g -fgnu-runtime -O -c some_class.m
3423 @end smallexample
3425 @noindent
3426 In this example, @option{-fgnu-runtime} is an option meant only for
3427 Objective-C and Objective-C++ programs; you can use the other options with
3428 any language supported by GCC@.
3430 Note that since Objective-C is an extension of the C language, Objective-C
3431 compilations may also use options specific to the C front-end (e.g.,
3432 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3433 C++-specific options (e.g., @option{-Wabi}).
3435 Here is a list of options that are @emph{only} for compiling Objective-C
3436 and Objective-C++ programs:
3438 @table @gcctabopt
3439 @item -fconstant-string-class=@var{class-name}
3440 @opindex fconstant-string-class
3441 Use @var{class-name} as the name of the class to instantiate for each
3442 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3443 class name is @code{NXConstantString} if the GNU runtime is being used, and
3444 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3445 @option{-fconstant-cfstrings} option, if also present, overrides the
3446 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3447 to be laid out as constant CoreFoundation strings.
3449 @item -fgnu-runtime
3450 @opindex fgnu-runtime
3451 Generate object code compatible with the standard GNU Objective-C
3452 runtime.  This is the default for most types of systems.
3454 @item -fnext-runtime
3455 @opindex fnext-runtime
3456 Generate output compatible with the NeXT runtime.  This is the default
3457 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3458 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3459 used.
3461 @item -fno-nil-receivers
3462 @opindex fno-nil-receivers
3463 Assume that all Objective-C message dispatches (@code{[receiver
3464 message:arg]}) in this translation unit ensure that the receiver is
3465 not @code{nil}.  This allows for more efficient entry points in the
3466 runtime to be used.  This option is only available in conjunction with
3467 the NeXT runtime and ABI version 0 or 1.
3469 @item -fobjc-abi-version=@var{n}
3470 @opindex fobjc-abi-version
3471 Use version @var{n} of the Objective-C ABI for the selected runtime.
3472 This option is currently supported only for the NeXT runtime.  In that
3473 case, Version 0 is the traditional (32-bit) ABI without support for
3474 properties and other Objective-C 2.0 additions.  Version 1 is the
3475 traditional (32-bit) ABI with support for properties and other
3476 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3477 nothing is specified, the default is Version 0 on 32-bit target
3478 machines, and Version 2 on 64-bit target machines.
3480 @item -fobjc-call-cxx-cdtors
3481 @opindex fobjc-call-cxx-cdtors
3482 For each Objective-C class, check if any of its instance variables is a
3483 C++ object with a non-trivial default constructor.  If so, synthesize a
3484 special @code{- (id) .cxx_construct} instance method which runs
3485 non-trivial default constructors on any such instance variables, in order,
3486 and then return @code{self}.  Similarly, check if any instance variable
3487 is a C++ object with a non-trivial destructor, and if so, synthesize a
3488 special @code{- (void) .cxx_destruct} method which runs
3489 all such default destructors, in reverse order.
3491 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3492 methods thusly generated only operate on instance variables
3493 declared in the current Objective-C class, and not those inherited
3494 from superclasses.  It is the responsibility of the Objective-C
3495 runtime to invoke all such methods in an object's inheritance
3496 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3497 by the runtime immediately after a new object instance is allocated;
3498 the @code{- (void) .cxx_destruct} methods are invoked immediately
3499 before the runtime deallocates an object instance.
3501 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3502 support for invoking the @code{- (id) .cxx_construct} and
3503 @code{- (void) .cxx_destruct} methods.
3505 @item -fobjc-direct-dispatch
3506 @opindex fobjc-direct-dispatch
3507 Allow fast jumps to the message dispatcher.  On Darwin this is
3508 accomplished via the comm page.
3510 @item -fobjc-exceptions
3511 @opindex fobjc-exceptions
3512 Enable syntactic support for structured exception handling in
3513 Objective-C, similar to what is offered by C++.  This option
3514 is required to use the Objective-C keywords @code{@@try},
3515 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3516 @code{@@synchronized}.  This option is available with both the GNU
3517 runtime and the NeXT runtime (but not available in conjunction with
3518 the NeXT runtime on Mac OS X 10.2 and earlier).
3520 @item -fobjc-gc
3521 @opindex fobjc-gc
3522 Enable garbage collection (GC) in Objective-C and Objective-C++
3523 programs.  This option is only available with the NeXT runtime; the
3524 GNU runtime has a different garbage collection implementation that
3525 does not require special compiler flags.
3527 @item -fobjc-nilcheck
3528 @opindex fobjc-nilcheck
3529 For the NeXT runtime with version 2 of the ABI, check for a nil
3530 receiver in method invocations before doing the actual method call.
3531 This is the default and can be disabled using
3532 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3533 checked for nil in this way no matter what this flag is set to.
3534 Currently this flag does nothing when the GNU runtime, or an older
3535 version of the NeXT runtime ABI, is used.
3537 @item -fobjc-std=objc1
3538 @opindex fobjc-std
3539 Conform to the language syntax of Objective-C 1.0, the language
3540 recognized by GCC 4.0.  This only affects the Objective-C additions to
3541 the C/C++ language; it does not affect conformance to C/C++ standards,
3542 which is controlled by the separate C/C++ dialect option flags.  When
3543 this option is used with the Objective-C or Objective-C++ compiler,
3544 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3545 This is useful if you need to make sure that your Objective-C code can
3546 be compiled with older versions of GCC@.
3548 @item -freplace-objc-classes
3549 @opindex freplace-objc-classes
3550 Emit a special marker instructing @command{ld(1)} not to statically link in
3551 the resulting object file, and allow @command{dyld(1)} to load it in at
3552 run time instead.  This is used in conjunction with the Fix-and-Continue
3553 debugging mode, where the object file in question may be recompiled and
3554 dynamically reloaded in the course of program execution, without the need
3555 to restart the program itself.  Currently, Fix-and-Continue functionality
3556 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3557 and later.
3559 @item -fzero-link
3560 @opindex fzero-link
3561 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3562 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3563 compile time) with static class references that get initialized at load time,
3564 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3565 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3566 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3567 for individual class implementations to be modified during program execution.
3568 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3569 regardless of command-line options.
3571 @item -fno-local-ivars
3572 @opindex fno-local-ivars
3573 @opindex flocal-ivars
3574 By default instance variables in Objective-C can be accessed as if
3575 they were local variables from within the methods of the class they're
3576 declared in.  This can lead to shadowing between instance variables
3577 and other variables declared either locally inside a class method or
3578 globally with the same name.  Specifying the @option{-fno-local-ivars}
3579 flag disables this behavior thus avoiding variable shadowing issues.
3581 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3582 @opindex fivar-visibility
3583 Set the default instance variable visibility to the specified option
3584 so that instance variables declared outside the scope of any access
3585 modifier directives default to the specified visibility.
3587 @item -gen-decls
3588 @opindex gen-decls
3589 Dump interface declarations for all classes seen in the source file to a
3590 file named @file{@var{sourcename}.decl}.
3592 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3593 @opindex Wassign-intercept
3594 @opindex Wno-assign-intercept
3595 Warn whenever an Objective-C assignment is being intercepted by the
3596 garbage collector.
3598 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3599 @opindex Wno-protocol
3600 @opindex Wprotocol
3601 If a class is declared to implement a protocol, a warning is issued for
3602 every method in the protocol that is not implemented by the class.  The
3603 default behavior is to issue a warning for every method not explicitly
3604 implemented in the class, even if a method implementation is inherited
3605 from the superclass.  If you use the @option{-Wno-protocol} option, then
3606 methods inherited from the superclass are considered to be implemented,
3607 and no warning is issued for them.
3609 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3610 @opindex Wselector
3611 @opindex Wno-selector
3612 Warn if multiple methods of different types for the same selector are
3613 found during compilation.  The check is performed on the list of methods
3614 in the final stage of compilation.  Additionally, a check is performed
3615 for each selector appearing in a @code{@@selector(@dots{})}
3616 expression, and a corresponding method for that selector has been found
3617 during compilation.  Because these checks scan the method table only at
3618 the end of compilation, these warnings are not produced if the final
3619 stage of compilation is not reached, for example because an error is
3620 found during compilation, or because the @option{-fsyntax-only} option is
3621 being used.
3623 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3624 @opindex Wstrict-selector-match
3625 @opindex Wno-strict-selector-match
3626 Warn if multiple methods with differing argument and/or return types are
3627 found for a given selector when attempting to send a message using this
3628 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3629 is off (which is the default behavior), the compiler omits such warnings
3630 if any differences found are confined to types that share the same size
3631 and alignment.
3633 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3634 @opindex Wundeclared-selector
3635 @opindex Wno-undeclared-selector
3636 Warn if a @code{@@selector(@dots{})} expression referring to an
3637 undeclared selector is found.  A selector is considered undeclared if no
3638 method with that name has been declared before the
3639 @code{@@selector(@dots{})} expression, either explicitly in an
3640 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3641 an @code{@@implementation} section.  This option always performs its
3642 checks as soon as a @code{@@selector(@dots{})} expression is found,
3643 while @option{-Wselector} only performs its checks in the final stage of
3644 compilation.  This also enforces the coding style convention
3645 that methods and selectors must be declared before being used.
3647 @item -print-objc-runtime-info
3648 @opindex print-objc-runtime-info
3649 Generate C header describing the largest structure that is passed by
3650 value, if any.
3652 @end table
3654 @node Diagnostic Message Formatting Options
3655 @section Options to Control Diagnostic Messages Formatting
3656 @cindex options to control diagnostics formatting
3657 @cindex diagnostic messages
3658 @cindex message formatting
3660 Traditionally, diagnostic messages have been formatted irrespective of
3661 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3662 options described below
3663 to control the formatting algorithm for diagnostic messages, 
3664 e.g.@: how many characters per line, how often source location
3665 information should be reported.  Note that some language front ends may not
3666 honor these options.
3668 @table @gcctabopt
3669 @item -fmessage-length=@var{n}
3670 @opindex fmessage-length
3671 Try to format error messages so that they fit on lines of about
3672 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3673 done; each error message appears on a single line.  This is the
3674 default for all front ends.
3676 Note - this option also affects the display of the @samp{#error} and
3677 @samp{#warning} pre-processor directives, and the @samp{deprecated}
3678 function/type/variable attribute.  It does not however affect the
3679 @samp{pragma GCC warning} and @samp{pragma GCC error} pragmas.
3681 @item -fdiagnostics-show-location=once
3682 @opindex fdiagnostics-show-location
3683 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3684 reporter to emit source location information @emph{once}; that is, in
3685 case the message is too long to fit on a single physical line and has to
3686 be wrapped, the source location won't be emitted (as prefix) again,
3687 over and over, in subsequent continuation lines.  This is the default
3688 behavior.
3690 @item -fdiagnostics-show-location=every-line
3691 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3692 messages reporter to emit the same source location information (as
3693 prefix) for physical lines that result from the process of breaking
3694 a message which is too long to fit on a single line.
3696 @item -fdiagnostics-color[=@var{WHEN}]
3697 @itemx -fno-diagnostics-color
3698 @opindex fdiagnostics-color
3699 @cindex highlight, color
3700 @vindex GCC_COLORS @r{environment variable}
3701 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3702 or @samp{auto}.  The default depends on how the compiler has been configured,
3703 it can be any of the above @var{WHEN} options or also @samp{never}
3704 if @env{GCC_COLORS} environment variable isn't present in the environment,
3705 and @samp{auto} otherwise.
3706 @samp{auto} means to use color only when the standard error is a terminal.
3707 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3708 aliases for @option{-fdiagnostics-color=always} and
3709 @option{-fdiagnostics-color=never}, respectively.
3711 The colors are defined by the environment variable @env{GCC_COLORS}.
3712 Its value is a colon-separated list of capabilities and Select Graphic
3713 Rendition (SGR) substrings. SGR commands are interpreted by the
3714 terminal or terminal emulator.  (See the section in the documentation
3715 of your text terminal for permitted values and their meanings as
3716 character attributes.)  These substring values are integers in decimal
3717 representation and can be concatenated with semicolons.
3718 Common values to concatenate include
3719 @samp{1} for bold,
3720 @samp{4} for underline,
3721 @samp{5} for blink,
3722 @samp{7} for inverse,
3723 @samp{39} for default foreground color,
3724 @samp{30} to @samp{37} for foreground colors,
3725 @samp{90} to @samp{97} for 16-color mode foreground colors,
3726 @samp{38;5;0} to @samp{38;5;255}
3727 for 88-color and 256-color modes foreground colors,
3728 @samp{49} for default background color,
3729 @samp{40} to @samp{47} for background colors,
3730 @samp{100} to @samp{107} for 16-color mode background colors,
3731 and @samp{48;5;0} to @samp{48;5;255}
3732 for 88-color and 256-color modes background colors.
3734 The default @env{GCC_COLORS} is
3735 @smallexample
3736 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3737 quote=01:fixit-insert=32:fixit-delete=31:\
3738 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3739 type-diff=01;32
3740 @end smallexample
3741 @noindent
3742 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3743 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3744 @samp{01} is bold, and @samp{31} is red.
3745 Setting @env{GCC_COLORS} to the empty string disables colors.
3746 Supported capabilities are as follows.
3748 @table @code
3749 @item error=
3750 @vindex error GCC_COLORS @r{capability}
3751 SGR substring for error: markers.
3753 @item warning=
3754 @vindex warning GCC_COLORS @r{capability}
3755 SGR substring for warning: markers.
3757 @item note=
3758 @vindex note GCC_COLORS @r{capability}
3759 SGR substring for note: markers.
3761 @item range1=
3762 @vindex range1 GCC_COLORS @r{capability}
3763 SGR substring for first additional range.
3765 @item range2=
3766 @vindex range2 GCC_COLORS @r{capability}
3767 SGR substring for second additional range.
3769 @item locus=
3770 @vindex locus GCC_COLORS @r{capability}
3771 SGR substring for location information, @samp{file:line} or
3772 @samp{file:line:column} etc.
3774 @item quote=
3775 @vindex quote GCC_COLORS @r{capability}
3776 SGR substring for information printed within quotes.
3778 @item fixit-insert=
3779 @vindex fixit-insert GCC_COLORS @r{capability}
3780 SGR substring for fix-it hints suggesting text to
3781 be inserted or replaced.
3783 @item fixit-delete=
3784 @vindex fixit-delete GCC_COLORS @r{capability}
3785 SGR substring for fix-it hints suggesting text to
3786 be deleted.
3788 @item diff-filename=
3789 @vindex diff-filename GCC_COLORS @r{capability}
3790 SGR substring for filename headers within generated patches.
3792 @item diff-hunk=
3793 @vindex diff-hunk GCC_COLORS @r{capability}
3794 SGR substring for the starts of hunks within generated patches.
3796 @item diff-delete=
3797 @vindex diff-delete GCC_COLORS @r{capability}
3798 SGR substring for deleted lines within generated patches.
3800 @item diff-insert=
3801 @vindex diff-insert GCC_COLORS @r{capability}
3802 SGR substring for inserted lines within generated patches.
3804 @item type-diff=
3805 @vindex type-diff GCC_COLORS @r{capability}
3806 SGR substring for highlighting mismatching types within template
3807 arguments in the C++ frontend.
3808 @end table
3810 @item -fno-diagnostics-show-option
3811 @opindex fno-diagnostics-show-option
3812 @opindex fdiagnostics-show-option
3813 By default, each diagnostic emitted includes text indicating the
3814 command-line option that directly controls the diagnostic (if such an
3815 option is known to the diagnostic machinery).  Specifying the
3816 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3818 @item -fno-diagnostics-show-caret
3819 @opindex fno-diagnostics-show-caret
3820 @opindex fdiagnostics-show-caret
3821 By default, each diagnostic emitted includes the original source line
3822 and a caret @samp{^} indicating the column.  This option suppresses this
3823 information.  The source line is truncated to @var{n} characters, if
3824 the @option{-fmessage-length=n} option is given.  When the output is done
3825 to the terminal, the width is limited to the width given by the
3826 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3828 @item -fno-diagnostics-show-labels
3829 @opindex fno-diagnostics-show-labels
3830 @opindex fdiagnostics-show-labels
3831 By default, when printing source code (via @option{-fdiagnostics-show-caret}),
3832 diagnostics can label ranges of source code with pertinent information, such
3833 as the types of expressions:
3835 @smallexample
3836     printf ("foo %s bar", long_i + long_j);
3837                  ~^       ~~~~~~~~~~~~~~~
3838                   |              |
3839                   char *         long int
3840 @end smallexample
3842 This option suppresses the printing of these labels (in the example above,
3843 the vertical bars and the ``char *'' and ``long int'' text).
3845 @item -fno-diagnostics-show-line-numbers
3846 @opindex fno-diagnostics-show-line-numbers
3847 @opindex fdiagnostics-show-line-numbers
3848 By default, when printing source code (via @option{-fdiagnostics-show-caret}),
3849 a left margin is printed, showing line numbers.  This option suppresses this
3850 left margin.
3852 @item -fdiagnostics-minimum-margin-width=@var{width}
3853 @opindex fdiagnostics-minimum-margin-width
3854 This option controls the minimum width of the left margin printed by
3855 @option{-fdiagnostics-show-line-numbers}.  It defaults to 6.
3857 @item -fdiagnostics-parseable-fixits
3858 @opindex fdiagnostics-parseable-fixits
3859 Emit fix-it hints in a machine-parseable format, suitable for consumption
3860 by IDEs.  For each fix-it, a line will be printed after the relevant
3861 diagnostic, starting with the string ``fix-it:''.  For example:
3863 @smallexample
3864 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3865 @end smallexample
3867 The location is expressed as a half-open range, expressed as a count of
3868 bytes, starting at byte 1 for the initial column.  In the above example,
3869 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3870 given string:
3872 @smallexample
3873 00000000011111111112222222222
3874 12345678901234567890123456789
3875   gtk_widget_showall (dlg);
3876   ^^^^^^^^^^^^^^^^^^
3877   gtk_widget_show_all
3878 @end smallexample
3880 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3881 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3882 (e.g. vertical tab as ``\013'').
3884 An empty replacement string indicates that the given range is to be removed.
3885 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3886 be inserted at the given position.
3888 @item -fdiagnostics-generate-patch
3889 @opindex fdiagnostics-generate-patch
3890 Print fix-it hints to stderr in unified diff format, after any diagnostics
3891 are printed.  For example:
3893 @smallexample
3894 --- test.c
3895 +++ test.c
3896 @@ -42,5 +42,5 @@
3898  void show_cb(GtkDialog *dlg)
3899  @{
3900 -  gtk_widget_showall(dlg);
3901 +  gtk_widget_show_all(dlg);
3902  @}
3904 @end smallexample
3906 The diff may or may not be colorized, following the same rules
3907 as for diagnostics (see @option{-fdiagnostics-color}).
3909 @item -fdiagnostics-show-template-tree
3910 @opindex fdiagnostics-show-template-tree
3912 In the C++ frontend, when printing diagnostics showing mismatching
3913 template types, such as:
3915 @smallexample
3916   could not convert 'std::map<int, std::vector<double> >()'
3917     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3918 @end smallexample
3920 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3921 tree-like structure showing the common and differing parts of the types,
3922 such as:
3924 @smallexample
3925   map<
3926     [...],
3927     vector<
3928       [double != float]>>
3929 @end smallexample
3931 The parts that differ are highlighted with color (``double'' and
3932 ``float'' in this case).
3934 @item -fno-elide-type
3935 @opindex fno-elide-type
3936 @opindex felide-type
3937 By default when the C++ frontend prints diagnostics showing mismatching
3938 template types, common parts of the types are printed as ``[...]'' to
3939 simplify the error message.  For example:
3941 @smallexample
3942   could not convert 'std::map<int, std::vector<double> >()'
3943     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3944 @end smallexample
3946 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3947 This flag also affects the output of the
3948 @option{-fdiagnostics-show-template-tree} flag.
3950 @item -fno-show-column
3951 @opindex fno-show-column
3952 Do not print column numbers in diagnostics.  This may be necessary if
3953 diagnostics are being scanned by a program that does not understand the
3954 column numbers, such as @command{dejagnu}.
3956 @end table
3958 @node Warning Options
3959 @section Options to Request or Suppress Warnings
3960 @cindex options to control warnings
3961 @cindex warning messages
3962 @cindex messages, warning
3963 @cindex suppressing warnings
3965 Warnings are diagnostic messages that report constructions that
3966 are not inherently erroneous but that are risky or suggest there
3967 may have been an error.
3969 The following language-independent options do not enable specific
3970 warnings but control the kinds of diagnostics produced by GCC@.
3972 @table @gcctabopt
3973 @cindex syntax checking
3974 @item -fsyntax-only
3975 @opindex fsyntax-only
3976 Check the code for syntax errors, but don't do anything beyond that.
3978 @item -fmax-errors=@var{n}
3979 @opindex fmax-errors
3980 Limits the maximum number of error messages to @var{n}, at which point
3981 GCC bails out rather than attempting to continue processing the source
3982 code.  If @var{n} is 0 (the default), there is no limit on the number
3983 of error messages produced.  If @option{-Wfatal-errors} is also
3984 specified, then @option{-Wfatal-errors} takes precedence over this
3985 option.
3987 @item -w
3988 @opindex w
3989 Inhibit all warning messages.
3991 @item -Werror
3992 @opindex Werror
3993 @opindex Wno-error
3994 Make all warnings into errors.
3996 @item -Werror=
3997 @opindex Werror=
3998 @opindex Wno-error=
3999 Make the specified warning into an error.  The specifier for a warning
4000 is appended; for example @option{-Werror=switch} turns the warnings
4001 controlled by @option{-Wswitch} into errors.  This switch takes a
4002 negative form, to be used to negate @option{-Werror} for specific
4003 warnings; for example @option{-Wno-error=switch} makes
4004 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
4005 is in effect.
4007 The warning message for each controllable warning includes the
4008 option that controls the warning.  That option can then be used with
4009 @option{-Werror=} and @option{-Wno-error=} as described above.
4010 (Printing of the option in the warning message can be disabled using the
4011 @option{-fno-diagnostics-show-option} flag.)
4013 Note that specifying @option{-Werror=}@var{foo} automatically implies
4014 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
4015 imply anything.
4017 @item -Wfatal-errors
4018 @opindex Wfatal-errors
4019 @opindex Wno-fatal-errors
4020 This option causes the compiler to abort compilation on the first error
4021 occurred rather than trying to keep going and printing further error
4022 messages.
4024 @end table
4026 You can request many specific warnings with options beginning with
4027 @samp{-W}, for example @option{-Wimplicit} to request warnings on
4028 implicit declarations.  Each of these specific warning options also
4029 has a negative form beginning @samp{-Wno-} to turn off warnings; for
4030 example, @option{-Wno-implicit}.  This manual lists only one of the
4031 two forms, whichever is not the default.  For further
4032 language-specific options also refer to @ref{C++ Dialect Options} and
4033 @ref{Objective-C and Objective-C++ Dialect Options}.
4035 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
4036 options, such as @option{-Wunused}, which may turn on further options,
4037 such as @option{-Wunused-value}. The combined effect of positive and
4038 negative forms is that more specific options have priority over less
4039 specific ones, independently of their position in the command-line. For
4040 options of the same specificity, the last one takes effect. Options
4041 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
4042 as if they appeared at the end of the command-line.
4044 When an unrecognized warning option is requested (e.g.,
4045 @option{-Wunknown-warning}), GCC emits a diagnostic stating
4046 that the option is not recognized.  However, if the @option{-Wno-} form
4047 is used, the behavior is slightly different: no diagnostic is
4048 produced for @option{-Wno-unknown-warning} unless other diagnostics
4049 are being produced.  This allows the use of new @option{-Wno-} options
4050 with old compilers, but if something goes wrong, the compiler
4051 warns that an unrecognized option is present.
4053 @table @gcctabopt
4054 @item -Wpedantic
4055 @itemx -pedantic
4056 @opindex pedantic
4057 @opindex Wpedantic
4058 @opindex Wno-pedantic
4059 Issue all the warnings demanded by strict ISO C and ISO C++;
4060 reject all programs that use forbidden extensions, and some other
4061 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
4062 version of the ISO C standard specified by any @option{-std} option used.
4064 Valid ISO C and ISO C++ programs should compile properly with or without
4065 this option (though a rare few require @option{-ansi} or a
4066 @option{-std} option specifying the required version of ISO C)@.  However,
4067 without this option, certain GNU extensions and traditional C and C++
4068 features are supported as well.  With this option, they are rejected.
4070 @option{-Wpedantic} does not cause warning messages for use of the
4071 alternate keywords whose names begin and end with @samp{__}.  Pedantic
4072 warnings are also disabled in the expression that follows
4073 @code{__extension__}.  However, only system header files should use
4074 these escape routes; application programs should avoid them.
4075 @xref{Alternate Keywords}.
4077 Some users try to use @option{-Wpedantic} to check programs for strict ISO
4078 C conformance.  They soon find that it does not do quite what they want:
4079 it finds some non-ISO practices, but not all---only those for which
4080 ISO C @emph{requires} a diagnostic, and some others for which
4081 diagnostics have been added.
4083 A feature to report any failure to conform to ISO C might be useful in
4084 some instances, but would require considerable additional work and would
4085 be quite different from @option{-Wpedantic}.  We don't have plans to
4086 support such a feature in the near future.
4088 Where the standard specified with @option{-std} represents a GNU
4089 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
4090 corresponding @dfn{base standard}, the version of ISO C on which the GNU
4091 extended dialect is based.  Warnings from @option{-Wpedantic} are given
4092 where they are required by the base standard.  (It does not make sense
4093 for such warnings to be given only for features not in the specified GNU
4094 C dialect, since by definition the GNU dialects of C include all
4095 features the compiler supports with the given option, and there would be
4096 nothing to warn about.)
4098 @item -pedantic-errors
4099 @opindex pedantic-errors
4100 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
4101 requires a diagnostic, in some cases where there is undefined behavior
4102 at compile-time and in some other cases that do not prevent compilation
4103 of programs that are valid according to the standard. This is not
4104 equivalent to @option{-Werror=pedantic}, since there are errors enabled
4105 by this option and not enabled by the latter and vice versa.
4107 @item -Wall
4108 @opindex Wall
4109 @opindex Wno-all
4110 This enables all the warnings about constructions that some users
4111 consider questionable, and that are easy to avoid (or modify to
4112 prevent the warning), even in conjunction with macros.  This also
4113 enables some language-specific warnings described in @ref{C++ Dialect
4114 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
4116 @option{-Wall} turns on the following warning flags:
4118 @gccoptlist{-Waddress   @gol
4119 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
4120 -Wbool-compare  @gol
4121 -Wbool-operation  @gol
4122 -Wc++11-compat  -Wc++14-compat  @gol
4123 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
4124 -Wchar-subscripts  @gol
4125 -Wcomment  @gol
4126 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
4127 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
4128 -Wformat   @gol
4129 -Wint-in-bool-context  @gol
4130 -Wimplicit @r{(C and Objective-C only)} @gol
4131 -Wimplicit-int @r{(C and Objective-C only)} @gol
4132 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
4133 -Winit-self @r{(only for C++)} @gol
4134 -Wlogical-not-parentheses @gol
4135 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
4136 -Wmaybe-uninitialized @gol
4137 -Wmemset-elt-size @gol
4138 -Wmemset-transposed-args @gol
4139 -Wmisleading-indentation @r{(only for C/C++)} @gol
4140 -Wmissing-attributes @gol
4141 -Wmissing-braces @r{(only for C/ObjC)} @gol
4142 -Wmultistatement-macros  @gol
4143 -Wnarrowing @r{(only for C++)}  @gol
4144 -Wnonnull  @gol
4145 -Wnonnull-compare  @gol
4146 -Wopenmp-simd @gol
4147 -Wparentheses  @gol
4148 -Wpessimizing-move @r{(only for C++)}  @gol
4149 -Wpointer-sign  @gol
4150 -Wreorder   @gol
4151 -Wrestrict   @gol
4152 -Wreturn-type  @gol
4153 -Wsequence-point  @gol
4154 -Wsign-compare @r{(only in C++)}  @gol
4155 -Wsizeof-pointer-div @gol
4156 -Wsizeof-pointer-memaccess @gol
4157 -Wstrict-aliasing  @gol
4158 -Wstrict-overflow=1  @gol
4159 -Wswitch  @gol
4160 -Wtautological-compare  @gol
4161 -Wtrigraphs  @gol
4162 -Wuninitialized  @gol
4163 -Wunknown-pragmas  @gol
4164 -Wunused-function  @gol
4165 -Wunused-label     @gol
4166 -Wunused-value     @gol
4167 -Wunused-variable  @gol
4168 -Wvolatile-register-var @gol
4171 Note that some warning flags are not implied by @option{-Wall}.  Some of
4172 them warn about constructions that users generally do not consider
4173 questionable, but which occasionally you might wish to check for;
4174 others warn about constructions that are necessary or hard to avoid in
4175 some cases, and there is no simple way to modify the code to suppress
4176 the warning. Some of them are enabled by @option{-Wextra} but many of
4177 them must be enabled individually.
4179 @item -Wextra
4180 @opindex W
4181 @opindex Wextra
4182 @opindex Wno-extra
4183 This enables some extra warning flags that are not enabled by
4184 @option{-Wall}. (This option used to be called @option{-W}.  The older
4185 name is still supported, but the newer name is more descriptive.)
4187 @gccoptlist{-Wclobbered  @gol
4188 -Wcast-function-type  @gol
4189 -Wempty-body  @gol
4190 -Wignored-qualifiers @gol
4191 -Wimplicit-fallthrough=3 @gol
4192 -Wmissing-field-initializers  @gol
4193 -Wmissing-parameter-type @r{(C only)}  @gol
4194 -Wold-style-declaration @r{(C only)}  @gol
4195 -Woverride-init  @gol
4196 -Wsign-compare @r{(C only)} @gol
4197 -Wredundant-move @r{(only for C++)}  @gol
4198 -Wtype-limits  @gol
4199 -Wuninitialized  @gol
4200 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
4201 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
4202 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
4205 The option @option{-Wextra} also prints warning messages for the
4206 following cases:
4208 @itemize @bullet
4210 @item
4211 A pointer is compared against integer zero with @code{<}, @code{<=},
4212 @code{>}, or @code{>=}.
4214 @item
4215 (C++ only) An enumerator and a non-enumerator both appear in a
4216 conditional expression.
4218 @item
4219 (C++ only) Ambiguous virtual bases.
4221 @item
4222 (C++ only) Subscripting an array that has been declared @code{register}.
4224 @item
4225 (C++ only) Taking the address of a variable that has been declared
4226 @code{register}.
4228 @item
4229 (C++ only) A base class is not initialized in the copy constructor
4230 of a derived class.
4232 @end itemize
4234 @item -Wchar-subscripts
4235 @opindex Wchar-subscripts
4236 @opindex Wno-char-subscripts
4237 Warn if an array subscript has type @code{char}.  This is a common cause
4238 of error, as programmers often forget that this type is signed on some
4239 machines.
4240 This warning is enabled by @option{-Wall}.
4242 @item -Wchkp
4243 @opindex Wchkp
4244 @opindex Wno-chkp
4245 Warn about an invalid memory access that is found by Pointer Bounds Checker
4246 (@option{-fcheck-pointer-bounds}).
4248 @item -Wno-coverage-mismatch
4249 @opindex Wno-coverage-mismatch
4250 @opindex Wcoverage-mismatch
4251 Warn if feedback profiles do not match when using the
4252 @option{-fprofile-use} option.
4253 If a source file is changed between compiling with @option{-fprofile-generate}
4254 and with @option{-fprofile-use}, the files with the profile feedback can fail
4255 to match the source file and GCC cannot use the profile feedback
4256 information.  By default, this warning is enabled and is treated as an
4257 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4258 warning or @option{-Wno-error=coverage-mismatch} can be used to
4259 disable the error.  Disabling the error for this warning can result in
4260 poorly optimized code and is useful only in the
4261 case of very minor changes such as bug fixes to an existing code-base.
4262 Completely disabling the warning is not recommended.
4264 @item -Wno-cpp
4265 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4267 Suppress warning messages emitted by @code{#warning} directives.
4269 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4270 @opindex Wdouble-promotion
4271 @opindex Wno-double-promotion
4272 Give a warning when a value of type @code{float} is implicitly
4273 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4274 floating-point unit implement @code{float} in hardware, but emulate
4275 @code{double} in software.  On such a machine, doing computations
4276 using @code{double} values is much more expensive because of the
4277 overhead required for software emulation.
4279 It is easy to accidentally do computations with @code{double} because
4280 floating-point literals are implicitly of type @code{double}.  For
4281 example, in:
4282 @smallexample
4283 @group
4284 float area(float radius)
4286    return 3.14159 * radius * radius;
4288 @end group
4289 @end smallexample
4290 the compiler performs the entire computation with @code{double}
4291 because the floating-point literal is a @code{double}.
4293 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4294 @opindex Wduplicate-decl-specifier
4295 @opindex Wno-duplicate-decl-specifier
4296 Warn if a declaration has duplicate @code{const}, @code{volatile},
4297 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4298 @option{-Wall}.
4300 @item -Wformat
4301 @itemx -Wformat=@var{n}
4302 @opindex Wformat
4303 @opindex Wno-format
4304 @opindex ffreestanding
4305 @opindex fno-builtin
4306 @opindex Wformat=
4307 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4308 the arguments supplied have types appropriate to the format string
4309 specified, and that the conversions specified in the format string make
4310 sense.  This includes standard functions, and others specified by format
4311 attributes (@pxref{Function Attributes}), in the @code{printf},
4312 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4313 not in the C standard) families (or other target-specific families).
4314 Which functions are checked without format attributes having been
4315 specified depends on the standard version selected, and such checks of
4316 functions without the attribute specified are disabled by
4317 @option{-ffreestanding} or @option{-fno-builtin}.
4319 The formats are checked against the format features supported by GNU
4320 libc version 2.2.  These include all ISO C90 and C99 features, as well
4321 as features from the Single Unix Specification and some BSD and GNU
4322 extensions.  Other library implementations may not support all these
4323 features; GCC does not support warning about features that go beyond a
4324 particular library's limitations.  However, if @option{-Wpedantic} is used
4325 with @option{-Wformat}, warnings are given about format features not
4326 in the selected standard version (but not for @code{strfmon} formats,
4327 since those are not in any version of the C standard).  @xref{C Dialect
4328 Options,,Options Controlling C Dialect}.
4330 @table @gcctabopt
4331 @item -Wformat=1
4332 @itemx -Wformat
4333 @opindex Wformat
4334 @opindex Wformat=1
4335 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4336 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4337 @option{-Wformat} also checks for null format arguments for several
4338 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4339 aspects of this level of format checking can be disabled by the
4340 options: @option{-Wno-format-contains-nul},
4341 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4342 @option{-Wformat} is enabled by @option{-Wall}.
4344 @item -Wno-format-contains-nul
4345 @opindex Wno-format-contains-nul
4346 @opindex Wformat-contains-nul
4347 If @option{-Wformat} is specified, do not warn about format strings that
4348 contain NUL bytes.
4350 @item -Wno-format-extra-args
4351 @opindex Wno-format-extra-args
4352 @opindex Wformat-extra-args
4353 If @option{-Wformat} is specified, do not warn about excess arguments to a
4354 @code{printf} or @code{scanf} format function.  The C standard specifies
4355 that such arguments are ignored.
4357 Where the unused arguments lie between used arguments that are
4358 specified with @samp{$} operand number specifications, normally
4359 warnings are still given, since the implementation could not know what
4360 type to pass to @code{va_arg} to skip the unused arguments.  However,
4361 in the case of @code{scanf} formats, this option suppresses the
4362 warning if the unused arguments are all pointers, since the Single
4363 Unix Specification says that such unused arguments are allowed.
4365 @item -Wformat-overflow
4366 @itemx -Wformat-overflow=@var{level}
4367 @opindex Wformat-overflow
4368 @opindex Wno-format-overflow
4369 Warn about calls to formatted input/output functions such as @code{sprintf}
4370 and @code{vsprintf} that might overflow the destination buffer.  When the
4371 exact number of bytes written by a format directive cannot be determined
4372 at compile-time it is estimated based on heuristics that depend on the
4373 @var{level} argument and on optimization.  While enabling optimization
4374 will in most cases improve the accuracy of the warning, it may also
4375 result in false positives.
4377 @table @gcctabopt
4378 @item -Wformat-overflow
4379 @itemx -Wformat-overflow=1
4380 @opindex Wformat-overflow
4381 @opindex Wno-format-overflow
4382 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4383 employs a conservative approach that warns only about calls that most
4384 likely overflow the buffer.  At this level, numeric arguments to format
4385 directives with unknown values are assumed to have the value of one, and
4386 strings of unknown length to be empty.  Numeric arguments that are known
4387 to be bounded to a subrange of their type, or string arguments whose output
4388 is bounded either by their directive's precision or by a finite set of
4389 string literals, are assumed to take on the value within the range that
4390 results in the most bytes on output.  For example, the call to @code{sprintf}
4391 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4392 the terminating NUL character (@code{'\0'}) appended by the function
4393 to the destination buffer will be written past its end.  Increasing
4394 the size of the buffer by a single byte is sufficient to avoid the
4395 warning, though it may not be sufficient to avoid the overflow.
4397 @smallexample
4398 void f (int a, int b)
4400   char buf [13];
4401   sprintf (buf, "a = %i, b = %i\n", a, b);
4403 @end smallexample
4405 @item -Wformat-overflow=2
4406 Level @var{2} warns also about calls that might overflow the destination
4407 buffer given an argument of sufficient length or magnitude.  At level
4408 @var{2}, unknown numeric arguments are assumed to have the minimum
4409 representable value for signed types with a precision greater than 1, and
4410 the maximum representable value otherwise.  Unknown string arguments whose
4411 length cannot be assumed to be bounded either by the directive's precision,
4412 or by a finite set of string literals they may evaluate to, or the character
4413 array they may point to, are assumed to be 1 character long.
4415 At level @var{2}, the call in the example above is again diagnosed, but
4416 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4417 @code{%i} directive will write some of its digits beyond the end of
4418 the destination buffer.  To make the call safe regardless of the values
4419 of the two variables, the size of the destination buffer must be increased
4420 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4421 an informational note following the warning.
4423 An alternative to increasing the size of the destination buffer is to
4424 constrain the range of formatted values.  The maximum length of string
4425 arguments can be bounded by specifying the precision in the format
4426 directive.  When numeric arguments of format directives can be assumed
4427 to be bounded by less than the precision of their type, choosing
4428 an appropriate length modifier to the format specifier will reduce
4429 the required buffer size.  For example, if @var{a} and @var{b} in the
4430 example above can be assumed to be within the precision of
4431 the @code{short int} type then using either the @code{%hi} format
4432 directive or casting the argument to @code{short} reduces the maximum
4433 required size of the buffer to 24 bytes.
4435 @smallexample
4436 void f (int a, int b)
4438   char buf [23];
4439   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4441 @end smallexample
4442 @end table
4444 @item -Wno-format-zero-length
4445 @opindex Wno-format-zero-length
4446 @opindex Wformat-zero-length
4447 If @option{-Wformat} is specified, do not warn about zero-length formats.
4448 The C standard specifies that zero-length formats are allowed.
4451 @item -Wformat=2
4452 @opindex Wformat=2
4453 Enable @option{-Wformat} plus additional format checks.  Currently
4454 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4455 -Wformat-y2k}.
4457 @item -Wformat-nonliteral
4458 @opindex Wformat-nonliteral
4459 @opindex Wno-format-nonliteral
4460 If @option{-Wformat} is specified, also warn if the format string is not a
4461 string literal and so cannot be checked, unless the format function
4462 takes its format arguments as a @code{va_list}.
4464 @item -Wformat-security
4465 @opindex Wformat-security
4466 @opindex Wno-format-security
4467 If @option{-Wformat} is specified, also warn about uses of format
4468 functions that represent possible security problems.  At present, this
4469 warns about calls to @code{printf} and @code{scanf} functions where the
4470 format string is not a string literal and there are no format arguments,
4471 as in @code{printf (foo);}.  This may be a security hole if the format
4472 string came from untrusted input and contains @samp{%n}.  (This is
4473 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4474 in future warnings may be added to @option{-Wformat-security} that are not
4475 included in @option{-Wformat-nonliteral}.)
4477 @item -Wformat-signedness
4478 @opindex Wformat-signedness
4479 @opindex Wno-format-signedness
4480 If @option{-Wformat} is specified, also warn if the format string
4481 requires an unsigned argument and the argument is signed and vice versa.
4483 @item -Wformat-truncation
4484 @itemx -Wformat-truncation=@var{level}
4485 @opindex Wformat-truncation
4486 @opindex Wno-format-truncation
4487 Warn about calls to formatted input/output functions such as @code{snprintf}
4488 and @code{vsnprintf} that might result in output truncation.  When the exact
4489 number of bytes written by a format directive cannot be determined at
4490 compile-time it is estimated based on heuristics that depend on
4491 the @var{level} argument and on optimization.  While enabling optimization
4492 will in most cases improve the accuracy of the warning, it may also result
4493 in false positives.  Except as noted otherwise, the option uses the same
4494 logic @option{-Wformat-overflow}.
4496 @table @gcctabopt
4497 @item -Wformat-truncation
4498 @itemx -Wformat-truncation=1
4499 @opindex Wformat-truncation
4500 @opindex Wno-format-truncation
4501 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4502 employs a conservative approach that warns only about calls to bounded
4503 functions whose return value is unused and that will most likely result
4504 in output truncation.
4506 @item -Wformat-truncation=2
4507 Level @var{2} warns also about calls to bounded functions whose return
4508 value is used and that might result in truncation given an argument of
4509 sufficient length or magnitude.
4510 @end table
4512 @item -Wformat-y2k
4513 @opindex Wformat-y2k
4514 @opindex Wno-format-y2k
4515 If @option{-Wformat} is specified, also warn about @code{strftime}
4516 formats that may yield only a two-digit year.
4517 @end table
4519 @item -Wnonnull
4520 @opindex Wnonnull
4521 @opindex Wno-nonnull
4522 Warn about passing a null pointer for arguments marked as
4523 requiring a non-null value by the @code{nonnull} function attribute.
4525 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4526 can be disabled with the @option{-Wno-nonnull} option.
4528 @item -Wnonnull-compare
4529 @opindex Wnonnull-compare
4530 @opindex Wno-nonnull-compare
4531 Warn when comparing an argument marked with the @code{nonnull}
4532 function attribute against null inside the function.
4534 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4535 can be disabled with the @option{-Wno-nonnull-compare} option.
4537 @item -Wnull-dereference
4538 @opindex Wnull-dereference
4539 @opindex Wno-null-dereference
4540 Warn if the compiler detects paths that trigger erroneous or
4541 undefined behavior due to dereferencing a null pointer.  This option
4542 is only active when @option{-fdelete-null-pointer-checks} is active,
4543 which is enabled by optimizations in most targets.  The precision of
4544 the warnings depends on the optimization options used.
4546 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4547 @opindex Winit-self
4548 @opindex Wno-init-self
4549 Warn about uninitialized variables that are initialized with themselves.
4550 Note this option can only be used with the @option{-Wuninitialized} option.
4552 For example, GCC warns about @code{i} being uninitialized in the
4553 following snippet only when @option{-Winit-self} has been specified:
4554 @smallexample
4555 @group
4556 int f()
4558   int i = i;
4559   return i;
4561 @end group
4562 @end smallexample
4564 This warning is enabled by @option{-Wall} in C++.
4566 @item -Wimplicit-int @r{(C and Objective-C only)}
4567 @opindex Wimplicit-int
4568 @opindex Wno-implicit-int
4569 Warn when a declaration does not specify a type.
4570 This warning is enabled by @option{-Wall}.
4572 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4573 @opindex Wimplicit-function-declaration
4574 @opindex Wno-implicit-function-declaration
4575 Give a warning whenever a function is used before being declared. In
4576 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4577 enabled by default and it is made into an error by
4578 @option{-pedantic-errors}. This warning is also enabled by
4579 @option{-Wall}.
4581 @item -Wimplicit @r{(C and Objective-C only)}
4582 @opindex Wimplicit
4583 @opindex Wno-implicit
4584 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4585 This warning is enabled by @option{-Wall}.
4587 @item -Wimplicit-fallthrough
4588 @opindex Wimplicit-fallthrough
4589 @opindex Wno-implicit-fallthrough
4590 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4591 and @option{-Wno-implicit-fallthrough} is the same as
4592 @option{-Wimplicit-fallthrough=0}.
4594 @item -Wimplicit-fallthrough=@var{n}
4595 @opindex Wimplicit-fallthrough=
4596 Warn when a switch case falls through.  For example:
4598 @smallexample
4599 @group
4600 switch (cond)
4601   @{
4602   case 1:
4603     a = 1;
4604     break;
4605   case 2:
4606     a = 2;
4607   case 3:
4608     a = 3;
4609     break;
4610   @}
4611 @end group
4612 @end smallexample
4614 This warning does not warn when the last statement of a case cannot
4615 fall through, e.g. when there is a return statement or a call to function
4616 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4617 also takes into account control flow statements, such as ifs, and only
4618 warns when appropriate.  E.g.@:
4620 @smallexample
4621 @group
4622 switch (cond)
4623   @{
4624   case 1:
4625     if (i > 3) @{
4626       bar (5);
4627       break;
4628     @} else if (i < 1) @{
4629       bar (0);
4630     @} else
4631       return;
4632   default:
4633     @dots{}
4634   @}
4635 @end group
4636 @end smallexample
4638 Since there are occasions where a switch case fall through is desirable,
4639 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4640 to be used along with a null statement to suppress this warning that
4641 would normally occur:
4643 @smallexample
4644 @group
4645 switch (cond)
4646   @{
4647   case 1:
4648     bar (0);
4649     __attribute__ ((fallthrough));
4650   default:
4651     @dots{}
4652   @}
4653 @end group
4654 @end smallexample
4656 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4657 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4658 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4659 Instead of these attributes, it is also possible to add a fallthrough comment
4660 to silence the warning.  The whole body of the C or C++ style comment should
4661 match the given regular expressions listed below.  The option argument @var{n}
4662 specifies what kind of comments are accepted:
4664 @itemize @bullet
4666 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4668 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4669 expression, any comment is used as fallthrough comment.
4671 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4672 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4674 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4675 following regular expressions:
4677 @itemize @bullet
4679 @item @code{-fallthrough}
4681 @item @code{@@fallthrough@@}
4683 @item @code{lint -fallthrough[ \t]*}
4685 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4687 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4689 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4691 @end itemize
4693 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4694 following regular expressions:
4696 @itemize @bullet
4698 @item @code{-fallthrough}
4700 @item @code{@@fallthrough@@}
4702 @item @code{lint -fallthrough[ \t]*}
4704 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4706 @end itemize
4708 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4709 fallthrough comments, only attributes disable the warning.
4711 @end itemize
4713 The comment needs to be followed after optional whitespace and other comments
4714 by @code{case} or @code{default} keywords or by a user label that precedes some
4715 @code{case} or @code{default} label.
4717 @smallexample
4718 @group
4719 switch (cond)
4720   @{
4721   case 1:
4722     bar (0);
4723     /* FALLTHRU */
4724   default:
4725     @dots{}
4726   @}
4727 @end group
4728 @end smallexample
4730 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4732 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4733 @opindex Wif-not-aligned
4734 @opindex Wno-if-not-aligned
4735 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4736 should be issued.  This is enabled by default.
4737 Use @option{-Wno-if-not-aligned} to disable it.
4739 @item -Wignored-qualifiers @r{(C and C++ only)}
4740 @opindex Wignored-qualifiers
4741 @opindex Wno-ignored-qualifiers
4742 Warn if the return type of a function has a type qualifier
4743 such as @code{const}.  For ISO C such a type qualifier has no effect,
4744 since the value returned by a function is not an lvalue.
4745 For C++, the warning is only emitted for scalar types or @code{void}.
4746 ISO C prohibits qualified @code{void} return types on function
4747 definitions, so such return types always receive a warning
4748 even without this option.
4750 This warning is also enabled by @option{-Wextra}.
4752 @item -Wignored-attributes @r{(C and C++ only)}
4753 @opindex Wignored-attributes
4754 @opindex Wno-ignored-attributes
4755 Warn when an attribute is ignored.  This is different from the
4756 @option{-Wattributes} option in that it warns whenever the compiler decides
4757 to drop an attribute, not that the attribute is either unknown, used in a
4758 wrong place, etc.  This warning is enabled by default.
4760 @item -Wmain
4761 @opindex Wmain
4762 @opindex Wno-main
4763 Warn if the type of @code{main} is suspicious.  @code{main} should be
4764 a function with external linkage, returning int, taking either zero
4765 arguments, two, or three arguments of appropriate types.  This warning
4766 is enabled by default in C++ and is enabled by either @option{-Wall}
4767 or @option{-Wpedantic}.
4769 @item -Wmisleading-indentation @r{(C and C++ only)}
4770 @opindex Wmisleading-indentation
4771 @opindex Wno-misleading-indentation
4772 Warn when the indentation of the code does not reflect the block structure.
4773 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4774 @code{for} clauses with a guarded statement that does not use braces,
4775 followed by an unguarded statement with the same indentation.
4777 In the following example, the call to ``bar'' is misleadingly indented as
4778 if it were guarded by the ``if'' conditional.
4780 @smallexample
4781   if (some_condition ())
4782     foo ();
4783     bar ();  /* Gotcha: this is not guarded by the "if".  */
4784 @end smallexample
4786 In the case of mixed tabs and spaces, the warning uses the
4787 @option{-ftabstop=} option to determine if the statements line up
4788 (defaulting to 8).
4790 The warning is not issued for code involving multiline preprocessor logic
4791 such as the following example.
4793 @smallexample
4794   if (flagA)
4795     foo (0);
4796 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4797   if (flagB)
4798 #endif
4799     foo (1);
4800 @end smallexample
4802 The warning is not issued after a @code{#line} directive, since this
4803 typically indicates autogenerated code, and no assumptions can be made
4804 about the layout of the file that the directive references.
4806 This warning is enabled by @option{-Wall} in C and C++.
4808 @item -Wmissing-attributes
4809 @opindex Wmissing-attributes
4810 @opindex Wno-missing-attributes
4811 Warn when a declaration of a function is missing one or more attributes
4812 that a related function is declared with and whose absence may adversely
4813 affect the correctness or efficiency of generated code.  For example, in
4814 C++, the warning is issued when an explicit specialization of a primary
4815 template declared with attribute @code{alloc_align}, @code{alloc_size},
4816 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4817 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4818 @code{error}, and @code{warning} suppress the warning.
4819 (@pxref{Function Attributes}).
4821 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4823 For example, since the declaration of the primary function template
4824 below makes use of both attribute @code{malloc} and @code{alloc_size}
4825 the declaration of the explicit specialization of the template is
4826 diagnosed because it is missing one of the attributes.
4828 @smallexample
4829 template <class T>
4830 T* __attribute__ ((malloc, alloc_size (1)))
4831 allocate (size_t);
4833 template <>
4834 void* __attribute__ ((malloc))   // missing alloc_size
4835 allocate<void> (size_t);
4836 @end smallexample
4838 @item -Wmissing-braces
4839 @opindex Wmissing-braces
4840 @opindex Wno-missing-braces
4841 Warn if an aggregate or union initializer is not fully bracketed.  In
4842 the following example, the initializer for @code{a} is not fully
4843 bracketed, but that for @code{b} is fully bracketed.  This warning is
4844 enabled by @option{-Wall} in C.
4846 @smallexample
4847 int a[2][2] = @{ 0, 1, 2, 3 @};
4848 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4849 @end smallexample
4851 This warning is enabled by @option{-Wall}.
4853 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4854 @opindex Wmissing-include-dirs
4855 @opindex Wno-missing-include-dirs
4856 Warn if a user-supplied include directory does not exist.
4858 @item -Wmissing-profile
4859 @opindex Wmissing-profile
4860 @opindex Wno-missing-profile
4861 Warn if feedback profiles are missing when using the
4862 @option{-fprofile-use} option.
4863 This option diagnoses those cases where a new function or a new file is added
4864 to the user code between compiling with @option{-fprofile-generate} and with
4865 @option{-fprofile-use}, without regenerating the profiles.  In these cases, the
4866 profile feedback data files do not contain any profile feedback information for
4867 the newly added function or file respectively.  Also, in the case when profile
4868 count data (.gcda) files are removed, GCC cannot use any profile feedback
4869 information.  In all these cases, warnings are issued to inform the user that a
4870 profile generation step is due.  @option{-Wno-missing-profile} can be used to
4871 disable the warning.  Ignoring the warning can result in poorly optimized code.
4872 Completely disabling the warning is not recommended and should be done only
4873 when non-existent profile data is justified.
4875 @item -Wmultistatement-macros
4876 @opindex Wmultistatement-macros
4877 @opindex Wno-multistatement-macros
4878 Warn about unsafe multiple statement macros that appear to be guarded
4879 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4880 @code{while}, in which only the first statement is actually guarded after
4881 the macro is expanded.
4883 For example:
4885 @smallexample
4886 #define DOIT x++; y++
4887 if (c)
4888   DOIT;
4889 @end smallexample
4891 will increment @code{y} unconditionally, not just when @code{c} holds.
4892 The can usually be fixed by wrapping the macro in a do-while loop:
4893 @smallexample
4894 #define DOIT do @{ x++; y++; @} while (0)
4895 if (c)
4896   DOIT;
4897 @end smallexample
4899 This warning is enabled by @option{-Wall} in C and C++.
4901 @item -Wparentheses
4902 @opindex Wparentheses
4903 @opindex Wno-parentheses
4904 Warn if parentheses are omitted in certain contexts, such
4905 as when there is an assignment in a context where a truth value
4906 is expected, or when operators are nested whose precedence people
4907 often get confused about.
4909 Also warn if a comparison like @code{x<=y<=z} appears; this is
4910 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4911 interpretation from that of ordinary mathematical notation.
4913 Also warn for dangerous uses of the GNU extension to
4914 @code{?:} with omitted middle operand. When the condition
4915 in the @code{?}: operator is a boolean expression, the omitted value is
4916 always 1.  Often programmers expect it to be a value computed
4917 inside the conditional expression instead.
4919 For C++ this also warns for some cases of unnecessary parentheses in
4920 declarations, which can indicate an attempt at a function call instead
4921 of a declaration:
4922 @smallexample
4924   // Declares a local variable called mymutex.
4925   std::unique_lock<std::mutex> (mymutex);
4926   // User meant std::unique_lock<std::mutex> lock (mymutex);
4928 @end smallexample
4930 This warning is enabled by @option{-Wall}.
4932 @item -Wsequence-point
4933 @opindex Wsequence-point
4934 @opindex Wno-sequence-point
4935 Warn about code that may have undefined semantics because of violations
4936 of sequence point rules in the C and C++ standards.
4938 The C and C++ standards define the order in which expressions in a C/C++
4939 program are evaluated in terms of @dfn{sequence points}, which represent
4940 a partial ordering between the execution of parts of the program: those
4941 executed before the sequence point, and those executed after it.  These
4942 occur after the evaluation of a full expression (one which is not part
4943 of a larger expression), after the evaluation of the first operand of a
4944 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4945 function is called (but after the evaluation of its arguments and the
4946 expression denoting the called function), and in certain other places.
4947 Other than as expressed by the sequence point rules, the order of
4948 evaluation of subexpressions of an expression is not specified.  All
4949 these rules describe only a partial order rather than a total order,
4950 since, for example, if two functions are called within one expression
4951 with no sequence point between them, the order in which the functions
4952 are called is not specified.  However, the standards committee have
4953 ruled that function calls do not overlap.
4955 It is not specified when between sequence points modifications to the
4956 values of objects take effect.  Programs whose behavior depends on this
4957 have undefined behavior; the C and C++ standards specify that ``Between
4958 the previous and next sequence point an object shall have its stored
4959 value modified at most once by the evaluation of an expression.
4960 Furthermore, the prior value shall be read only to determine the value
4961 to be stored.''.  If a program breaks these rules, the results on any
4962 particular implementation are entirely unpredictable.
4964 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4965 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4966 diagnosed by this option, and it may give an occasional false positive
4967 result, but in general it has been found fairly effective at detecting
4968 this sort of problem in programs.
4970 The C++17 standard will define the order of evaluation of operands in
4971 more cases: in particular it requires that the right-hand side of an
4972 assignment be evaluated before the left-hand side, so the above
4973 examples are no longer undefined.  But this warning will still warn
4974 about them, to help people avoid writing code that is undefined in C
4975 and earlier revisions of C++.
4977 The standard is worded confusingly, therefore there is some debate
4978 over the precise meaning of the sequence point rules in subtle cases.
4979 Links to discussions of the problem, including proposed formal
4980 definitions, may be found on the GCC readings page, at
4981 @uref{http://gcc.gnu.org/@/readings.html}.
4983 This warning is enabled by @option{-Wall} for C and C++.
4985 @item -Wno-return-local-addr
4986 @opindex Wno-return-local-addr
4987 @opindex Wreturn-local-addr
4988 Do not warn about returning a pointer (or in C++, a reference) to a
4989 variable that goes out of scope after the function returns.
4991 @item -Wreturn-type
4992 @opindex Wreturn-type
4993 @opindex Wno-return-type
4994 Warn whenever a function is defined with a return type that defaults
4995 to @code{int}.  Also warn about any @code{return} statement with no
4996 return value in a function whose return type is not @code{void}
4997 (falling off the end of the function body is considered returning
4998 without a value).
5000 For C only, warn about a @code{return} statement with an expression in a
5001 function whose return type is @code{void}, unless the expression type is
5002 also @code{void}.  As a GNU extension, the latter case is accepted
5003 without a warning unless @option{-Wpedantic} is used.
5005 For C++, a function without return type always produces a diagnostic
5006 message, even when @option{-Wno-return-type} is specified.  The only
5007 exceptions are @code{main} and functions defined in system headers.
5009 This warning is enabled by default for C++ and is enabled by @option{-Wall}.
5011 @item -Wshift-count-negative
5012 @opindex Wshift-count-negative
5013 @opindex Wno-shift-count-negative
5014 Warn if shift count is negative. This warning is enabled by default.
5016 @item -Wshift-count-overflow
5017 @opindex Wshift-count-overflow
5018 @opindex Wno-shift-count-overflow
5019 Warn if shift count >= width of type. This warning is enabled by default.
5021 @item -Wshift-negative-value
5022 @opindex Wshift-negative-value
5023 @opindex Wno-shift-negative-value
5024 Warn if left shifting a negative value.  This warning is enabled by
5025 @option{-Wextra} in C99 and C++11 modes (and newer).
5027 @item -Wshift-overflow
5028 @itemx -Wshift-overflow=@var{n}
5029 @opindex Wshift-overflow
5030 @opindex Wno-shift-overflow
5031 Warn about left shift overflows.  This warning is enabled by
5032 default in C99 and C++11 modes (and newer).
5034 @table @gcctabopt
5035 @item -Wshift-overflow=1
5036 This is the warning level of @option{-Wshift-overflow} and is enabled
5037 by default in C99 and C++11 modes (and newer).  This warning level does
5038 not warn about left-shifting 1 into the sign bit.  (However, in C, such
5039 an overflow is still rejected in contexts where an integer constant expression
5040 is required.)
5042 @item -Wshift-overflow=2
5043 This warning level also warns about left-shifting 1 into the sign bit,
5044 unless C++14 mode is active.
5045 @end table
5047 @item -Wswitch
5048 @opindex Wswitch
5049 @opindex Wno-switch
5050 Warn whenever a @code{switch} statement has an index of enumerated type
5051 and lacks a @code{case} for one or more of the named codes of that
5052 enumeration.  (The presence of a @code{default} label prevents this
5053 warning.)  @code{case} labels outside the enumeration range also
5054 provoke warnings when this option is used (even if there is a
5055 @code{default} label).
5056 This warning is enabled by @option{-Wall}.
5058 @item -Wswitch-default
5059 @opindex Wswitch-default
5060 @opindex Wno-switch-default
5061 Warn whenever a @code{switch} statement does not have a @code{default}
5062 case.
5064 @item -Wswitch-enum
5065 @opindex Wswitch-enum
5066 @opindex Wno-switch-enum
5067 Warn whenever a @code{switch} statement has an index of enumerated type
5068 and lacks a @code{case} for one or more of the named codes of that
5069 enumeration.  @code{case} labels outside the enumeration range also
5070 provoke warnings when this option is used.  The only difference
5071 between @option{-Wswitch} and this option is that this option gives a
5072 warning about an omitted enumeration code even if there is a
5073 @code{default} label.
5075 @item -Wswitch-bool
5076 @opindex Wswitch-bool
5077 @opindex Wno-switch-bool
5078 Warn whenever a @code{switch} statement has an index of boolean type
5079 and the case values are outside the range of a boolean type.
5080 It is possible to suppress this warning by casting the controlling
5081 expression to a type other than @code{bool}.  For example:
5082 @smallexample
5083 @group
5084 switch ((int) (a == 4))
5085   @{
5086   @dots{}
5087   @}
5088 @end group
5089 @end smallexample
5090 This warning is enabled by default for C and C++ programs.
5092 @item -Wswitch-unreachable
5093 @opindex Wswitch-unreachable
5094 @opindex Wno-switch-unreachable
5095 Warn whenever a @code{switch} statement contains statements between the
5096 controlling expression and the first case label, which will never be
5097 executed.  For example:
5098 @smallexample
5099 @group
5100 switch (cond)
5101   @{
5102    i = 15;
5103   @dots{}
5104    case 5:
5105   @dots{}
5106   @}
5107 @end group
5108 @end smallexample
5109 @option{-Wswitch-unreachable} does not warn if the statement between the
5110 controlling expression and the first case label is just a declaration:
5111 @smallexample
5112 @group
5113 switch (cond)
5114   @{
5115    int i;
5116   @dots{}
5117    case 5:
5118    i = 5;
5119   @dots{}
5120   @}
5121 @end group
5122 @end smallexample
5123 This warning is enabled by default for C and C++ programs.
5125 @item -Wsync-nand @r{(C and C++ only)}
5126 @opindex Wsync-nand
5127 @opindex Wno-sync-nand
5128 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
5129 built-in functions are used.  These functions changed semantics in GCC 4.4.
5131 @item -Wunused-but-set-parameter
5132 @opindex Wunused-but-set-parameter
5133 @opindex Wno-unused-but-set-parameter
5134 Warn whenever a function parameter is assigned to, but otherwise unused
5135 (aside from its declaration).
5137 To suppress this warning use the @code{unused} attribute
5138 (@pxref{Variable Attributes}).
5140 This warning is also enabled by @option{-Wunused} together with
5141 @option{-Wextra}.
5143 @item -Wunused-but-set-variable
5144 @opindex Wunused-but-set-variable
5145 @opindex Wno-unused-but-set-variable
5146 Warn whenever a local variable is assigned to, but otherwise unused
5147 (aside from its declaration).
5148 This warning is enabled by @option{-Wall}.
5150 To suppress this warning use the @code{unused} attribute
5151 (@pxref{Variable Attributes}).
5153 This warning is also enabled by @option{-Wunused}, which is enabled
5154 by @option{-Wall}.
5156 @item -Wunused-function
5157 @opindex Wunused-function
5158 @opindex Wno-unused-function
5159 Warn whenever a static function is declared but not defined or a
5160 non-inline static function is unused.
5161 This warning is enabled by @option{-Wall}.
5163 @item -Wunused-label
5164 @opindex Wunused-label
5165 @opindex Wno-unused-label
5166 Warn whenever a label is declared but not used.
5167 This warning is enabled by @option{-Wall}.
5169 To suppress this warning use the @code{unused} attribute
5170 (@pxref{Variable Attributes}).
5172 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
5173 @opindex Wunused-local-typedefs
5174 @opindex Wno-unused-local-typedefs
5175 Warn when a typedef locally defined in a function is not used.
5176 This warning is enabled by @option{-Wall}.
5178 @item -Wunused-parameter
5179 @opindex Wunused-parameter
5180 @opindex Wno-unused-parameter
5181 Warn whenever a function parameter is unused aside from its declaration.
5183 To suppress this warning use the @code{unused} attribute
5184 (@pxref{Variable Attributes}).
5186 @item -Wno-unused-result
5187 @opindex Wunused-result
5188 @opindex Wno-unused-result
5189 Do not warn if a caller of a function marked with attribute
5190 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
5191 its return value. The default is @option{-Wunused-result}.
5193 @item -Wunused-variable
5194 @opindex Wunused-variable
5195 @opindex Wno-unused-variable
5196 Warn whenever a local or static variable is unused aside from its
5197 declaration. This option implies @option{-Wunused-const-variable=1} for C,
5198 but not for C++. This warning is enabled by @option{-Wall}.
5200 To suppress this warning use the @code{unused} attribute
5201 (@pxref{Variable Attributes}).
5203 @item -Wunused-const-variable
5204 @itemx -Wunused-const-variable=@var{n}
5205 @opindex Wunused-const-variable
5206 @opindex Wno-unused-const-variable
5207 Warn whenever a constant static variable is unused aside from its declaration.
5208 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
5209 for C, but not for C++. In C this declares variable storage, but in C++ this
5210 is not an error since const variables take the place of @code{#define}s.
5212 To suppress this warning use the @code{unused} attribute
5213 (@pxref{Variable Attributes}).
5215 @table @gcctabopt
5216 @item -Wunused-const-variable=1
5217 This is the warning level that is enabled by @option{-Wunused-variable} for
5218 C.  It warns only about unused static const variables defined in the main
5219 compilation unit, but not about static const variables declared in any
5220 header included.
5222 @item -Wunused-const-variable=2
5223 This warning level also warns for unused constant static variables in
5224 headers (excluding system headers).  This is the warning level of
5225 @option{-Wunused-const-variable} and must be explicitly requested since
5226 in C++ this isn't an error and in C it might be harder to clean up all
5227 headers included.
5228 @end table
5230 @item -Wunused-value
5231 @opindex Wunused-value
5232 @opindex Wno-unused-value
5233 Warn whenever a statement computes a result that is explicitly not
5234 used. To suppress this warning cast the unused expression to
5235 @code{void}. This includes an expression-statement or the left-hand
5236 side of a comma expression that contains no side effects. For example,
5237 an expression such as @code{x[i,j]} causes a warning, while
5238 @code{x[(void)i,j]} does not.
5240 This warning is enabled by @option{-Wall}.
5242 @item -Wunused
5243 @opindex Wunused
5244 @opindex Wno-unused
5245 All the above @option{-Wunused} options combined.
5247 In order to get a warning about an unused function parameter, you must
5248 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5249 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5251 @item -Wuninitialized
5252 @opindex Wuninitialized
5253 @opindex Wno-uninitialized
5254 Warn if an automatic variable is used without first being initialized
5255 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5256 warn if a non-static reference or non-static @code{const} member
5257 appears in a class without constructors.
5259 If you want to warn about code that uses the uninitialized value of the
5260 variable in its own initializer, use the @option{-Winit-self} option.
5262 These warnings occur for individual uninitialized or clobbered
5263 elements of structure, union or array variables as well as for
5264 variables that are uninitialized or clobbered as a whole.  They do
5265 not occur for variables or elements declared @code{volatile}.  Because
5266 these warnings depend on optimization, the exact variables or elements
5267 for which there are warnings depends on the precise optimization
5268 options and version of GCC used.
5270 Note that there may be no warning about a variable that is used only
5271 to compute a value that itself is never used, because such
5272 computations may be deleted by data flow analysis before the warnings
5273 are printed.
5275 @item -Winvalid-memory-model
5276 @opindex Winvalid-memory-model
5277 @opindex Wno-invalid-memory-model
5278 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5279 and the C11 atomic generic functions with a memory consistency argument
5280 that is either invalid for the operation or outside the range of values
5281 of the @code{memory_order} enumeration.  For example, since the
5282 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5283 defined for the relaxed, release, and sequentially consistent memory
5284 orders the following code is diagnosed:
5286 @smallexample
5287 void store (int *i)
5289   __atomic_store_n (i, 0, memory_order_consume);
5291 @end smallexample
5293 @option{-Winvalid-memory-model} is enabled by default.
5295 @item -Wmaybe-uninitialized
5296 @opindex Wmaybe-uninitialized
5297 @opindex Wno-maybe-uninitialized
5298 For an automatic (i.e.@: local) variable, if there exists a path from the
5299 function entry to a use of the variable that is initialized, but there exist
5300 some other paths for which the variable is not initialized, the compiler
5301 emits a warning if it cannot prove the uninitialized paths are not
5302 executed at run time.
5304 These warnings are only possible in optimizing compilation, because otherwise
5305 GCC does not keep track of the state of variables.
5307 These warnings are made optional because GCC may not be able to determine when
5308 the code is correct in spite of appearing to have an error.  Here is one
5309 example of how this can happen:
5311 @smallexample
5312 @group
5314   int x;
5315   switch (y)
5316     @{
5317     case 1: x = 1;
5318       break;
5319     case 2: x = 4;
5320       break;
5321     case 3: x = 5;
5322     @}
5323   foo (x);
5325 @end group
5326 @end smallexample
5328 @noindent
5329 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5330 always initialized, but GCC doesn't know this. To suppress the
5331 warning, you need to provide a default case with assert(0) or
5332 similar code.
5334 @cindex @code{longjmp} warnings
5335 This option also warns when a non-volatile automatic variable might be
5336 changed by a call to @code{longjmp}.
5337 The compiler sees only the calls to @code{setjmp}.  It cannot know
5338 where @code{longjmp} will be called; in fact, a signal handler could
5339 call it at any point in the code.  As a result, you may get a warning
5340 even when there is in fact no problem because @code{longjmp} cannot
5341 in fact be called at the place that would cause a problem.
5343 Some spurious warnings can be avoided if you declare all the functions
5344 you use that never return as @code{noreturn}.  @xref{Function
5345 Attributes}.
5347 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5349 @item -Wunknown-pragmas
5350 @opindex Wunknown-pragmas
5351 @opindex Wno-unknown-pragmas
5352 @cindex warning for unknown pragmas
5353 @cindex unknown pragmas, warning
5354 @cindex pragmas, warning of unknown
5355 Warn when a @code{#pragma} directive is encountered that is not understood by 
5356 GCC@.  If this command-line option is used, warnings are even issued
5357 for unknown pragmas in system header files.  This is not the case if
5358 the warnings are only enabled by the @option{-Wall} command-line option.
5360 @item -Wno-pragmas
5361 @opindex Wno-pragmas
5362 @opindex Wpragmas
5363 Do not warn about misuses of pragmas, such as incorrect parameters,
5364 invalid syntax, or conflicts between pragmas.  See also
5365 @option{-Wunknown-pragmas}.
5367 @item -Wno-prio-ctor-dtor
5368 @opindex Wno-prio-ctor-dtor
5369 @opindex Wprio-ctor-dtor
5370 Do not warn if a priority from 0 to 100 is used for constructor or destructor.
5371 The use of constructor and destructor attributes allow you to assign a
5372 priority to the constructor/destructor to control its order of execution
5373 before @code{main} is called or after it returns.  The priority values must be
5374 greater than 100 as the compiler reserves priority values between 0--100 for
5375 the implementation.
5377 @item -Wstrict-aliasing
5378 @opindex Wstrict-aliasing
5379 @opindex Wno-strict-aliasing
5380 This option is only active when @option{-fstrict-aliasing} is active.
5381 It warns about code that might break the strict aliasing rules that the
5382 compiler is using for optimization.  The warning does not catch all
5383 cases, but does attempt to catch the more common pitfalls.  It is
5384 included in @option{-Wall}.
5385 It is equivalent to @option{-Wstrict-aliasing=3}
5387 @item -Wstrict-aliasing=n
5388 @opindex Wstrict-aliasing=n
5389 This option is only active when @option{-fstrict-aliasing} is active.
5390 It warns about code that might break the strict aliasing rules that the
5391 compiler is using for optimization.
5392 Higher levels correspond to higher accuracy (fewer false positives).
5393 Higher levels also correspond to more effort, similar to the way @option{-O} 
5394 works.
5395 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5397 Level 1: Most aggressive, quick, least accurate.
5398 Possibly useful when higher levels
5399 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5400 false negatives.  However, it has many false positives.
5401 Warns for all pointer conversions between possibly incompatible types,
5402 even if never dereferenced.  Runs in the front end only.
5404 Level 2: Aggressive, quick, not too precise.
5405 May still have many false positives (not as many as level 1 though),
5406 and few false negatives (but possibly more than level 1).
5407 Unlike level 1, it only warns when an address is taken.  Warns about
5408 incomplete types.  Runs in the front end only.
5410 Level 3 (default for @option{-Wstrict-aliasing}):
5411 Should have very few false positives and few false
5412 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5413 Takes care of the common pun+dereference pattern in the front end:
5414 @code{*(int*)&some_float}.
5415 If optimization is enabled, it also runs in the back end, where it deals
5416 with multiple statement cases using flow-sensitive points-to information.
5417 Only warns when the converted pointer is dereferenced.
5418 Does not warn about incomplete types.
5420 @item -Wstrict-overflow
5421 @itemx -Wstrict-overflow=@var{n}
5422 @opindex Wstrict-overflow
5423 @opindex Wno-strict-overflow
5424 This option is only active when signed overflow is undefined.
5425 It warns about cases where the compiler optimizes based on the
5426 assumption that signed overflow does not occur.  Note that it does not
5427 warn about all cases where the code might overflow: it only warns
5428 about cases where the compiler implements some optimization.  Thus
5429 this warning depends on the optimization level.
5431 An optimization that assumes that signed overflow does not occur is
5432 perfectly safe if the values of the variables involved are such that
5433 overflow never does, in fact, occur.  Therefore this warning can
5434 easily give a false positive: a warning about code that is not
5435 actually a problem.  To help focus on important issues, several
5436 warning levels are defined.  No warnings are issued for the use of
5437 undefined signed overflow when estimating how many iterations a loop
5438 requires, in particular when determining whether a loop will be
5439 executed at all.
5441 @table @gcctabopt
5442 @item -Wstrict-overflow=1
5443 Warn about cases that are both questionable and easy to avoid.  For
5444 example the compiler simplifies
5445 @code{x + 1 > x} to @code{1}.  This level of
5446 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5447 are not, and must be explicitly requested.
5449 @item -Wstrict-overflow=2
5450 Also warn about other cases where a comparison is simplified to a
5451 constant.  For example: @code{abs (x) >= 0}.  This can only be
5452 simplified when signed integer overflow is undefined, because
5453 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5454 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5455 @option{-Wstrict-overflow=2}.
5457 @item -Wstrict-overflow=3
5458 Also warn about other cases where a comparison is simplified.  For
5459 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5461 @item -Wstrict-overflow=4
5462 Also warn about other simplifications not covered by the above cases.
5463 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5465 @item -Wstrict-overflow=5
5466 Also warn about cases where the compiler reduces the magnitude of a
5467 constant involved in a comparison.  For example: @code{x + 2 > y} is
5468 simplified to @code{x + 1 >= y}.  This is reported only at the
5469 highest warning level because this simplification applies to many
5470 comparisons, so this warning level gives a very large number of
5471 false positives.
5472 @end table
5474 @item -Wstringop-overflow
5475 @itemx -Wstringop-overflow=@var{type}
5476 @opindex Wstringop-overflow
5477 @opindex Wno-stringop-overflow
5478 Warn for calls to string manipulation functions such as @code{memcpy} and
5479 @code{strcpy} that are determined to overflow the destination buffer.  The
5480 optional argument is one greater than the type of Object Size Checking to
5481 perform to determine the size of the destination.  @xref{Object Size Checking}.
5482 The argument is meaningful only for functions that operate on character arrays
5483 but not for raw memory functions like @code{memcpy} which always make use
5484 of Object Size type-0.  The option also warns for calls that specify a size
5485 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5486 The option produces the best results with optimization enabled but can detect
5487 a small subset of simple buffer overflows even without optimization in
5488 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5489 correspond to the standard functions.  In any case, the option warns about
5490 just a subset of buffer overflows detected by the corresponding overflow
5491 checking built-ins.  For example, the option will issue a warning for
5492 the @code{strcpy} call below because it copies at least 5 characters
5493 (the string @code{"blue"} including the terminating NUL) into the buffer
5494 of size 4.
5496 @smallexample
5497 enum Color @{ blue, purple, yellow @};
5498 const char* f (enum Color clr)
5500   static char buf [4];
5501   const char *str;
5502   switch (clr)
5503     @{
5504       case blue: str = "blue"; break;
5505       case purple: str = "purple"; break;
5506       case yellow: str = "yellow"; break;
5507     @}
5509   return strcpy (buf, str);   // warning here
5511 @end smallexample
5513 Option @option{-Wstringop-overflow=2} is enabled by default.
5515 @table @gcctabopt
5516 @item -Wstringop-overflow
5517 @itemx -Wstringop-overflow=1
5518 @opindex Wstringop-overflow
5519 @opindex Wno-stringop-overflow
5520 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5521 to determine the sizes of destination objects.  This is the default setting
5522 of the option.  At this setting the option will not warn for writes past
5523 the end of subobjects of larger objects accessed by pointers unless the
5524 size of the largest surrounding object is known.  When the destination may
5525 be one of several objects it is assumed to be the largest one of them.  On
5526 Linux systems, when optimization is enabled at this setting the option warns
5527 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5528 a non-zero value.
5530 @item -Wstringop-overflow=2
5531 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5532 to determine the sizes of destination objects.  At this setting the option
5533 will warn about overflows when writing to members of the largest complete
5534 objects whose exact size is known.  It will, however, not warn for excessive
5535 writes to the same members of unknown objects referenced by pointers since
5536 they may point to arrays containing unknown numbers of elements.
5538 @item -Wstringop-overflow=3
5539 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5540 to determine the sizes of destination objects.  At this setting the option
5541 warns about overflowing the smallest object or data member.  This is the
5542 most restrictive setting of the option that may result in warnings for safe
5543 code.
5545 @item -Wstringop-overflow=4
5546 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5547 to determine the sizes of destination objects.  At this setting the option
5548 will warn about overflowing any data members, and when the destination is
5549 one of several objects it uses the size of the largest of them to decide
5550 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5551 setting of the option may result in warnings for benign code.
5552 @end table
5554 @item -Wstringop-truncation
5555 @opindex Wstringop-truncation
5556 @opindex Wno-stringop-truncation
5557 Warn for calls to bounded string manipulation functions such as @code{strncat},
5558 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5559 or leave the destination unchanged.
5561 In the following example, the call to @code{strncat} specifies a bound that
5562 is less than the length of the source string.  As a result, the copy of
5563 the source will be truncated and so the call is diagnosed.  To avoid the
5564 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5566 @smallexample
5567 void append (char *buf, size_t bufsize)
5569   strncat (buf, ".txt", 3);
5571 @end smallexample
5573 As another example, the following call to @code{strncpy} results in copying
5574 to @code{d} just the characters preceding the terminating NUL, without
5575 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5576 necessarily a NUL-terminated string is a common mistake, and so the call
5577 is diagnosed.  To avoid the warning when the result is not expected to be
5578 NUL-terminated, call @code{memcpy} instead.
5580 @smallexample
5581 void copy (char *d, const char *s)
5583   strncpy (d, s, strlen (s));
5585 @end smallexample
5587 In the following example, the call to @code{strncpy} specifies the size
5588 of the destination buffer as the bound.  If the length of the source
5589 string is equal to or greater than this size the result of the copy will
5590 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5591 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5592 element of the buffer to @code{NUL}.
5594 @smallexample
5595 void copy (const char *s)
5597   char buf[80];
5598   strncpy (buf, s, sizeof buf);
5599   @dots{}
5601 @end smallexample
5603 In situations where a character array is intended to store a sequence
5604 of bytes with no terminating @code{NUL} such an array may be annotated
5605 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5606 however, are not suitable arguments to functions that expect
5607 @code{NUL}-terminated strings.  To help detect accidental misuses of
5608 such arrays GCC issues warnings unless it can prove that the use is
5609 safe.  @xref{Common Variable Attributes}.
5611 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5612 @opindex Wsuggest-attribute=
5613 @opindex Wno-suggest-attribute=
5614 Warn for cases where adding an attribute may be beneficial. The
5615 attributes currently supported are listed below.
5617 @table @gcctabopt
5618 @item -Wsuggest-attribute=pure
5619 @itemx -Wsuggest-attribute=const
5620 @itemx -Wsuggest-attribute=noreturn
5621 @itemx -Wsuggest-attribute=malloc
5622 @opindex Wsuggest-attribute=pure
5623 @opindex Wno-suggest-attribute=pure
5624 @opindex Wsuggest-attribute=const
5625 @opindex Wno-suggest-attribute=const
5626 @opindex Wsuggest-attribute=noreturn
5627 @opindex Wno-suggest-attribute=noreturn
5628 @opindex Wsuggest-attribute=malloc
5629 @opindex Wno-suggest-attribute=malloc
5631 Warn about functions that might be candidates for attributes
5632 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5633 only warns for functions visible in other compilation units or (in the case of
5634 @code{pure} and @code{const}) if it cannot prove that the function returns
5635 normally. A function returns normally if it doesn't contain an infinite loop or
5636 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5637 requires option @option{-fipa-pure-const}, which is enabled by default at
5638 @option{-O} and higher.  Higher optimization levels improve the accuracy
5639 of the analysis.
5641 @item -Wsuggest-attribute=format
5642 @itemx -Wmissing-format-attribute
5643 @opindex Wsuggest-attribute=format
5644 @opindex Wmissing-format-attribute
5645 @opindex Wno-suggest-attribute=format
5646 @opindex Wno-missing-format-attribute
5647 @opindex Wformat
5648 @opindex Wno-format
5650 Warn about function pointers that might be candidates for @code{format}
5651 attributes.  Note these are only possible candidates, not absolute ones.
5652 GCC guesses that function pointers with @code{format} attributes that
5653 are used in assignment, initialization, parameter passing or return
5654 statements should have a corresponding @code{format} attribute in the
5655 resulting type.  I.e.@: the left-hand side of the assignment or
5656 initialization, the type of the parameter variable, or the return type
5657 of the containing function respectively should also have a @code{format}
5658 attribute to avoid the warning.
5660 GCC also warns about function definitions that might be
5661 candidates for @code{format} attributes.  Again, these are only
5662 possible candidates.  GCC guesses that @code{format} attributes
5663 might be appropriate for any function that calls a function like
5664 @code{vprintf} or @code{vscanf}, but this might not always be the
5665 case, and some functions for which @code{format} attributes are
5666 appropriate may not be detected.
5668 @item -Wsuggest-attribute=cold
5669 @opindex Wsuggest-attribute=cold
5670 @opindex Wno-suggest-attribute=cold
5672 Warn about functions that might be candidates for @code{cold} attribute.  This
5673 is based on static detection and generally will only warn about functions which
5674 always leads to a call to another @code{cold} function such as wrappers of
5675 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5676 @end table
5678 @item -Wsuggest-final-types
5679 @opindex Wno-suggest-final-types
5680 @opindex Wsuggest-final-types
5681 Warn about types with virtual methods where code quality would be improved
5682 if the type were declared with the C++11 @code{final} specifier, 
5683 or, if possible,
5684 declared in an anonymous namespace. This allows GCC to more aggressively
5685 devirtualize the polymorphic calls. This warning is more effective with link
5686 time optimization, where the information about the class hierarchy graph is
5687 more complete.
5689 @item -Wsuggest-final-methods
5690 @opindex Wno-suggest-final-methods
5691 @opindex Wsuggest-final-methods
5692 Warn about virtual methods where code quality would be improved if the method
5693 were declared with the C++11 @code{final} specifier, 
5694 or, if possible, its type were
5695 declared in an anonymous namespace or with the @code{final} specifier.
5696 This warning is
5697 more effective with link-time optimization, where the information about the
5698 class hierarchy graph is more complete. It is recommended to first consider
5699 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5700 annotations.
5702 @item -Wsuggest-override
5703 Warn about overriding virtual functions that are not marked with the override
5704 keyword.
5706 @item -Walloc-zero
5707 @opindex Wno-alloc-zero
5708 @opindex Walloc-zero
5709 Warn about calls to allocation functions decorated with attribute
5710 @code{alloc_size} that specify zero bytes, including those to the built-in
5711 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5712 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5713 when called with a zero size differs among implementations (and in the case
5714 of @code{realloc} has been deprecated) relying on it may result in subtle
5715 portability bugs and should be avoided.
5717 @item -Walloc-size-larger-than=@var{byte-size}
5718 @opindex Walloc-size-larger-than=
5719 @opindex Wno-alloc-size-larger-than
5720 Warn about calls to functions decorated with attribute @code{alloc_size}
5721 that attempt to allocate objects larger than the specified number of bytes,
5722 or where the result of the size computation in an integer type with infinite
5723 precision would exceed the value of @samp{PTRDIFF_MAX} on the target.
5724 @option{-Walloc-size-larger-than=}@samp{PTRDIFF_MAX} is enabled by default.
5725 Warnings controlled by the option can be disabled either by specifying
5726 @var{byte-size} of @samp{SIZE_MAX} or more or by
5727 @option{-Wno-alloc-size-larger-than}.
5728 @xref{Function Attributes}.
5730 @item -Wno-alloc-size-larger-than
5731 @opindex Wno-alloc-size-larger-than
5732 Disable @option{-Walloc-size-larger-than=} warnings.  The option is
5733 equivalent to @option{-Walloc-size-larger-than=}@samp{SIZE_MAX} or
5734 larger.
5736 @item -Walloca
5737 @opindex Wno-alloca
5738 @opindex Walloca
5739 This option warns on all uses of @code{alloca} in the source.
5741 @item -Walloca-larger-than=@var{byte-size}
5742 @opindex Walloca-larger-than=
5743 @opindex Wno-alloca-larger-than
5744 This option warns on calls to @code{alloca} with an integer argument whose
5745 value is either zero, or that is not bounded by a controlling predicate
5746 that limits its value to at most @var{byte-size}.  It also warns for calls
5747 to @code{alloca} where the bound value is unknown.  Arguments of non-integer
5748 types are considered unbounded even if they appear to be constrained to
5749 the expected range.
5751 For example, a bounded case of @code{alloca} could be:
5753 @smallexample
5754 void func (size_t n)
5756   void *p;
5757   if (n <= 1000)
5758     p = alloca (n);
5759   else
5760     p = malloc (n);
5761   f (p);
5763 @end smallexample
5765 In the above example, passing @code{-Walloca-larger-than=1000} would not
5766 issue a warning because the call to @code{alloca} is known to be at most
5767 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5768 the compiler would emit a warning.
5770 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5771 controlling predicate constraining its integer argument.  For example:
5773 @smallexample
5774 void func ()
5776   void *p = alloca (n);
5777   f (p);
5779 @end smallexample
5781 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5782 a warning, but this time because of the lack of bounds checking.
5784 Note, that even seemingly correct code involving signed integers could
5785 cause a warning:
5787 @smallexample
5788 void func (signed int n)
5790   if (n < 500)
5791     @{
5792       p = alloca (n);
5793       f (p);
5794     @}
5796 @end smallexample
5798 In the above example, @var{n} could be negative, causing a larger than
5799 expected argument to be implicitly cast into the @code{alloca} call.
5801 This option also warns when @code{alloca} is used in a loop.
5803 @option{-Walloca-larger-than=}@samp{PTRDIFF_MAX} is enabled by default
5804 but is usually only effective  when @option{-ftree-vrp} is active (default
5805 for @option{-O2} and above).
5807 See also @option{-Wvla-larger-than=}@samp{byte-size}.
5809 @item -Wno-alloca-larger-than
5810 @opindex Wno-alloca-larger-than
5811 Disable @option{-Walloca-larger-than=} warnings.  The option is
5812 equivalent to @option{-Walloca-larger-than=}@samp{SIZE_MAX} or larger.
5814 @item -Warray-bounds
5815 @itemx -Warray-bounds=@var{n}
5816 @opindex Wno-array-bounds
5817 @opindex Warray-bounds
5818 This option is only active when @option{-ftree-vrp} is active
5819 (default for @option{-O2} and above). It warns about subscripts to arrays
5820 that are always out of bounds. This warning is enabled by @option{-Wall}.
5822 @table @gcctabopt
5823 @item -Warray-bounds=1
5824 This is the warning level of @option{-Warray-bounds} and is enabled
5825 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5827 @item -Warray-bounds=2
5828 This warning level also warns about out of bounds access for
5829 arrays at the end of a struct and for arrays accessed through
5830 pointers. This warning level may give a larger number of
5831 false positives and is deactivated by default.
5832 @end table
5834 @item -Wattribute-alias
5835 Warn about declarations using the @code{alias} and similar attributes whose
5836 target is incompatible with the type of the alias.  @xref{Function Attributes,
5837 ,Declaring Attributes of Functions}.
5839 @item -Wbool-compare
5840 @opindex Wno-bool-compare
5841 @opindex Wbool-compare
5842 Warn about boolean expression compared with an integer value different from
5843 @code{true}/@code{false}.  For instance, the following comparison is
5844 always false:
5845 @smallexample
5846 int n = 5;
5847 @dots{}
5848 if ((n > 1) == 2) @{ @dots{} @}
5849 @end smallexample
5850 This warning is enabled by @option{-Wall}.
5852 @item -Wbool-operation
5853 @opindex Wno-bool-operation
5854 @opindex Wbool-operation
5855 Warn about suspicious operations on expressions of a boolean type.  For
5856 instance, bitwise negation of a boolean is very likely a bug in the program.
5857 For C, this warning also warns about incrementing or decrementing a boolean,
5858 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5859 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5861 This warning is enabled by @option{-Wall}.
5863 @item -Wduplicated-branches
5864 @opindex Wno-duplicated-branches
5865 @opindex Wduplicated-branches
5866 Warn when an if-else has identical branches.  This warning detects cases like
5867 @smallexample
5868 if (p != NULL)
5869   return 0;
5870 else
5871   return 0;
5872 @end smallexample
5873 It doesn't warn when both branches contain just a null statement.  This warning
5874 also warn for conditional operators:
5875 @smallexample
5876   int i = x ? *p : *p;
5877 @end smallexample
5879 @item -Wduplicated-cond
5880 @opindex Wno-duplicated-cond
5881 @opindex Wduplicated-cond
5882 Warn about duplicated conditions in an if-else-if chain.  For instance,
5883 warn for the following code:
5884 @smallexample
5885 if (p->q != NULL) @{ @dots{} @}
5886 else if (p->q != NULL) @{ @dots{} @}
5887 @end smallexample
5889 @item -Wframe-address
5890 @opindex Wno-frame-address
5891 @opindex Wframe-address
5892 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5893 is called with an argument greater than 0.  Such calls may return indeterminate
5894 values or crash the program.  The warning is included in @option{-Wall}.
5896 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5897 @opindex Wno-discarded-qualifiers
5898 @opindex Wdiscarded-qualifiers
5899 Do not warn if type qualifiers on pointers are being discarded.
5900 Typically, the compiler warns if a @code{const char *} variable is
5901 passed to a function that takes a @code{char *} parameter.  This option
5902 can be used to suppress such a warning.
5904 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5905 @opindex Wno-discarded-array-qualifiers
5906 @opindex Wdiscarded-array-qualifiers
5907 Do not warn if type qualifiers on arrays which are pointer targets
5908 are being discarded. Typically, the compiler warns if a
5909 @code{const int (*)[]} variable is passed to a function that
5910 takes a @code{int (*)[]} parameter.  This option can be used to
5911 suppress such a warning.
5913 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5914 @opindex Wno-incompatible-pointer-types
5915 @opindex Wincompatible-pointer-types
5916 Do not warn when there is a conversion between pointers that have incompatible
5917 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5918 which warns for pointer argument passing or assignment with different
5919 signedness.
5921 @item -Wno-int-conversion @r{(C and Objective-C only)}
5922 @opindex Wno-int-conversion
5923 @opindex Wint-conversion
5924 Do not warn about incompatible integer to pointer and pointer to integer
5925 conversions.  This warning is about implicit conversions; for explicit
5926 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5927 @option{-Wno-pointer-to-int-cast} may be used.
5929 @item -Wno-div-by-zero
5930 @opindex Wno-div-by-zero
5931 @opindex Wdiv-by-zero
5932 Do not warn about compile-time integer division by zero.  Floating-point
5933 division by zero is not warned about, as it can be a legitimate way of
5934 obtaining infinities and NaNs.
5936 @item -Wsystem-headers
5937 @opindex Wsystem-headers
5938 @opindex Wno-system-headers
5939 @cindex warnings from system headers
5940 @cindex system headers, warnings from
5941 Print warning messages for constructs found in system header files.
5942 Warnings from system headers are normally suppressed, on the assumption
5943 that they usually do not indicate real problems and would only make the
5944 compiler output harder to read.  Using this command-line option tells
5945 GCC to emit warnings from system headers as if they occurred in user
5946 code.  However, note that using @option{-Wall} in conjunction with this
5947 option does @emph{not} warn about unknown pragmas in system
5948 headers---for that, @option{-Wunknown-pragmas} must also be used.
5950 @item -Wtautological-compare
5951 @opindex Wtautological-compare
5952 @opindex Wno-tautological-compare
5953 Warn if a self-comparison always evaluates to true or false.  This
5954 warning detects various mistakes such as:
5955 @smallexample
5956 int i = 1;
5957 @dots{}
5958 if (i > i) @{ @dots{} @}
5959 @end smallexample
5961 This warning also warns about bitwise comparisons that always evaluate
5962 to true or false, for instance:
5963 @smallexample
5964 if ((a & 16) == 10) @{ @dots{} @}
5965 @end smallexample
5966 will always be false.
5968 This warning is enabled by @option{-Wall}.
5970 @item -Wtrampolines
5971 @opindex Wtrampolines
5972 @opindex Wno-trampolines
5973 Warn about trampolines generated for pointers to nested functions.
5974 A trampoline is a small piece of data or code that is created at run
5975 time on the stack when the address of a nested function is taken, and is
5976 used to call the nested function indirectly.  For some targets, it is
5977 made up of data only and thus requires no special treatment.  But, for
5978 most targets, it is made up of code and thus requires the stack to be
5979 made executable in order for the program to work properly.
5981 @item -Wfloat-equal
5982 @opindex Wfloat-equal
5983 @opindex Wno-float-equal
5984 Warn if floating-point values are used in equality comparisons.
5986 The idea behind this is that sometimes it is convenient (for the
5987 programmer) to consider floating-point values as approximations to
5988 infinitely precise real numbers.  If you are doing this, then you need
5989 to compute (by analyzing the code, or in some other way) the maximum or
5990 likely maximum error that the computation introduces, and allow for it
5991 when performing comparisons (and when producing output, but that's a
5992 different problem).  In particular, instead of testing for equality, you
5993 should check to see whether the two values have ranges that overlap; and
5994 this is done with the relational operators, so equality comparisons are
5995 probably mistaken.
5997 @item -Wtraditional @r{(C and Objective-C only)}
5998 @opindex Wtraditional
5999 @opindex Wno-traditional
6000 Warn about certain constructs that behave differently in traditional and
6001 ISO C@.  Also warn about ISO C constructs that have no traditional C
6002 equivalent, and/or problematic constructs that should be avoided.
6004 @itemize @bullet
6005 @item
6006 Macro parameters that appear within string literals in the macro body.
6007 In traditional C macro replacement takes place within string literals,
6008 but in ISO C it does not.
6010 @item
6011 In traditional C, some preprocessor directives did not exist.
6012 Traditional preprocessors only considered a line to be a directive
6013 if the @samp{#} appeared in column 1 on the line.  Therefore
6014 @option{-Wtraditional} warns about directives that traditional C
6015 understands but ignores because the @samp{#} does not appear as the
6016 first character on the line.  It also suggests you hide directives like
6017 @code{#pragma} not understood by traditional C by indenting them.  Some
6018 traditional implementations do not recognize @code{#elif}, so this option
6019 suggests avoiding it altogether.
6021 @item
6022 A function-like macro that appears without arguments.
6024 @item
6025 The unary plus operator.
6027 @item
6028 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
6029 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
6030 constants.)  Note, these suffixes appear in macros defined in the system
6031 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
6032 Use of these macros in user code might normally lead to spurious
6033 warnings, however GCC's integrated preprocessor has enough context to
6034 avoid warning in these cases.
6036 @item
6037 A function declared external in one block and then used after the end of
6038 the block.
6040 @item
6041 A @code{switch} statement has an operand of type @code{long}.
6043 @item
6044 A non-@code{static} function declaration follows a @code{static} one.
6045 This construct is not accepted by some traditional C compilers.
6047 @item
6048 The ISO type of an integer constant has a different width or
6049 signedness from its traditional type.  This warning is only issued if
6050 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
6051 typically represent bit patterns, are not warned about.
6053 @item
6054 Usage of ISO string concatenation is detected.
6056 @item
6057 Initialization of automatic aggregates.
6059 @item
6060 Identifier conflicts with labels.  Traditional C lacks a separate
6061 namespace for labels.
6063 @item
6064 Initialization of unions.  If the initializer is zero, the warning is
6065 omitted.  This is done under the assumption that the zero initializer in
6066 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
6067 initializer warnings and relies on default initialization to zero in the
6068 traditional C case.
6070 @item
6071 Conversions by prototypes between fixed/floating-point values and vice
6072 versa.  The absence of these prototypes when compiling with traditional
6073 C causes serious problems.  This is a subset of the possible
6074 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
6076 @item
6077 Use of ISO C style function definitions.  This warning intentionally is
6078 @emph{not} issued for prototype declarations or variadic functions
6079 because these ISO C features appear in your code when using
6080 libiberty's traditional C compatibility macros, @code{PARAMS} and
6081 @code{VPARAMS}.  This warning is also bypassed for nested functions
6082 because that feature is already a GCC extension and thus not relevant to
6083 traditional C compatibility.
6084 @end itemize
6086 @item -Wtraditional-conversion @r{(C and Objective-C only)}
6087 @opindex Wtraditional-conversion
6088 @opindex Wno-traditional-conversion
6089 Warn if a prototype causes a type conversion that is different from what
6090 would happen to the same argument in the absence of a prototype.  This
6091 includes conversions of fixed point to floating and vice versa, and
6092 conversions changing the width or signedness of a fixed-point argument
6093 except when the same as the default promotion.
6095 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
6096 @opindex Wdeclaration-after-statement
6097 @opindex Wno-declaration-after-statement
6098 Warn when a declaration is found after a statement in a block.  This
6099 construct, known from C++, was introduced with ISO C99 and is by default
6100 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
6102 @item -Wshadow
6103 @opindex Wshadow
6104 @opindex Wno-shadow
6105 Warn whenever a local variable or type declaration shadows another
6106 variable, parameter, type, class member (in C++), or instance variable
6107 (in Objective-C) or whenever a built-in function is shadowed. Note
6108 that in C++, the compiler warns if a local variable shadows an
6109 explicit typedef, but not if it shadows a struct/class/enum.
6110 Same as @option{-Wshadow=global}.
6112 @item -Wno-shadow-ivar @r{(Objective-C only)}
6113 @opindex Wno-shadow-ivar
6114 @opindex Wshadow-ivar
6115 Do not warn whenever a local variable shadows an instance variable in an
6116 Objective-C method.
6118 @item -Wshadow=global
6119 @opindex Wshadow=local
6120 The default for @option{-Wshadow}. Warns for any (global) shadowing.
6122 @item -Wshadow=local
6123 @opindex Wshadow=local
6124 Warn when a local variable shadows another local variable or parameter.
6125 This warning is enabled by @option{-Wshadow=global}.
6127 @item -Wshadow=compatible-local
6128 @opindex Wshadow=compatible-local
6129 Warn when a local variable shadows another local variable or parameter
6130 whose type is compatible with that of the shadowing variable. In C++,
6131 type compatibility here means the type of the shadowing variable can be
6132 converted to that of the shadowed variable. The creation of this flag
6133 (in addition to @option{-Wshadow=local}) is based on the idea that when
6134 a local variable shadows another one of incompatible type, it is most
6135 likely intentional, not a bug or typo, as shown in the following example:
6137 @smallexample
6138 @group
6139 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
6141   for (int i = 0; i < N; ++i)
6142   @{
6143     ...
6144   @}
6145   ...
6147 @end group
6148 @end smallexample
6150 Since the two variable @code{i} in the example above have incompatible types,
6151 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
6152 Because their types are incompatible, if a programmer accidentally uses one
6153 in place of the other, type checking will catch that and emit an error or
6154 warning. So not warning (about shadowing) in this case will not lead to
6155 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
6156 possibly reduce the number of warnings triggered by intentional shadowing.
6158 This warning is enabled by @option{-Wshadow=local}.
6160 @item -Wlarger-than=@var{byte-size}
6161 @opindex Wlarger-than=
6162 @opindex Wlarger-than-@var{byte-size}
6163 Warn whenever an object is defined whose size exceeds @var{byte-size}.
6164 @option{-Wlarger-than=}@samp{PTRDIFF_MAX} is enabled by default.
6165 Warnings controlled by the option can be disabled either by specifying
6166 @var{byte-size} of @samp{SIZE_MAX} or more or by
6167 @option{-Wno-larger-than}.
6169 @item -Wno-larger-than
6170 @opindex Wno-larger-than
6171 Disable @option{-Wlarger-than=} warnings.  The option is equivalent
6172 to @option{-Wlarger-than=}@samp{SIZE_MAX} or larger.
6174 @item -Wframe-larger-than=@var{byte-size}
6175 @opindex Wframe-larger-than=
6176 @opindex Wno-frame-larger-than
6177 Warn if the size of a function frame exceeds @var{byte-size}.
6178 The computation done to determine the stack frame size is approximate
6179 and not conservative.
6180 The actual requirements may be somewhat greater than @var{byte-size}
6181 even if you do not get a warning.  In addition, any space allocated
6182 via @code{alloca}, variable-length arrays, or related constructs
6183 is not included by the compiler when determining
6184 whether or not to issue a warning.
6185 @option{-Wframe-larger-than=}@samp{PTRDIFF_MAX} is enabled by default.
6186 Warnings controlled by the option can be disabled either by specifying
6187 @var{byte-size} of @samp{SIZE_MAX} or more or by
6188 @option{-Wno-frame-larger-than}.
6190 @item -Wno-frame-larger-than
6191 @opindex Wno-frame-larger-than
6192 Disable @option{-Wframe-larger-than=} warnings.  The option is equivalent
6193 to @option{-Wframe-larger-than=}@samp{SIZE_MAX} or larger.
6195 @item -Wno-free-nonheap-object
6196 @opindex Wno-free-nonheap-object
6197 @opindex Wfree-nonheap-object
6198 Do not warn when attempting to free an object that was not allocated
6199 on the heap.
6201 @item -Wstack-usage=@var{byte-size}
6202 @opindex Wstack-usage
6203 @opindex Wno-stack-usage
6204 Warn if the stack usage of a function might exceed @var{byte-size}.
6205 The computation done to determine the stack usage is conservative.
6206 Any space allocated via @code{alloca}, variable-length arrays, or related
6207 constructs is included by the compiler when determining whether or not to
6208 issue a warning.
6210 The message is in keeping with the output of @option{-fstack-usage}.
6212 @itemize
6213 @item
6214 If the stack usage is fully static but exceeds the specified amount, it's:
6216 @smallexample
6217   warning: stack usage is 1120 bytes
6218 @end smallexample
6219 @item
6220 If the stack usage is (partly) dynamic but bounded, it's:
6222 @smallexample
6223   warning: stack usage might be 1648 bytes
6224 @end smallexample
6225 @item
6226 If the stack usage is (partly) dynamic and not bounded, it's:
6228 @smallexample
6229   warning: stack usage might be unbounded
6230 @end smallexample
6231 @end itemize
6233 @option{-Wstack-usage=}@samp{PTRDIFF_MAX} is enabled by default.
6234 Warnings controlled by the option can be disabled either by specifying
6235 @var{byte-size} of @samp{SIZE_MAX} or more or by
6236 @option{-Wno-stack-usage}.
6238 @item -Wno-stack-usage
6239 @opindex Wno-stack-usage
6240 Disable @option{-Wstack-usage=} warnings.  The option is equivalent
6241 to @option{-Wstack-usage=}@samp{SIZE_MAX} or larger.
6243 @item -Wunsafe-loop-optimizations
6244 @opindex Wunsafe-loop-optimizations
6245 @opindex Wno-unsafe-loop-optimizations
6246 Warn if the loop cannot be optimized because the compiler cannot
6247 assume anything on the bounds of the loop indices.  With
6248 @option{-funsafe-loop-optimizations} warn if the compiler makes
6249 such assumptions.
6251 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
6252 @opindex Wno-pedantic-ms-format
6253 @opindex Wpedantic-ms-format
6254 When used in combination with @option{-Wformat}
6255 and @option{-pedantic} without GNU extensions, this option
6256 disables the warnings about non-ISO @code{printf} / @code{scanf} format
6257 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
6258 which depend on the MS runtime.
6260 @item -Waligned-new
6261 @opindex Waligned-new
6262 @opindex Wno-aligned-new
6263 Warn about a new-expression of a type that requires greater alignment
6264 than the @code{alignof(std::max_align_t)} but uses an allocation
6265 function without an explicit alignment parameter. This option is
6266 enabled by @option{-Wall}.
6268 Normally this only warns about global allocation functions, but
6269 @option{-Waligned-new=all} also warns about class member allocation
6270 functions.
6272 @item -Wplacement-new
6273 @itemx -Wplacement-new=@var{n}
6274 @opindex Wplacement-new
6275 @opindex Wno-placement-new
6276 Warn about placement new expressions with undefined behavior, such as
6277 constructing an object in a buffer that is smaller than the type of
6278 the object.  For example, the placement new expression below is diagnosed
6279 because it attempts to construct an array of 64 integers in a buffer only
6280 64 bytes large.
6281 @smallexample
6282 char buf [64];
6283 new (buf) int[64];
6284 @end smallexample
6285 This warning is enabled by default.
6287 @table @gcctabopt
6288 @item -Wplacement-new=1
6289 This is the default warning level of @option{-Wplacement-new}.  At this
6290 level the warning is not issued for some strictly undefined constructs that
6291 GCC allows as extensions for compatibility with legacy code.  For example,
6292 the following @code{new} expression is not diagnosed at this level even
6293 though it has undefined behavior according to the C++ standard because
6294 it writes past the end of the one-element array.
6295 @smallexample
6296 struct S @{ int n, a[1]; @};
6297 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6298 new (s->a)int [32]();
6299 @end smallexample
6301 @item -Wplacement-new=2
6302 At this level, in addition to diagnosing all the same constructs as at level
6303 1, a diagnostic is also issued for placement new expressions that construct
6304 an object in the last member of structure whose type is an array of a single
6305 element and whose size is less than the size of the object being constructed.
6306 While the previous example would be diagnosed, the following construct makes
6307 use of the flexible member array extension to avoid the warning at level 2.
6308 @smallexample
6309 struct S @{ int n, a[]; @};
6310 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6311 new (s->a)int [32]();
6312 @end smallexample
6314 @end table
6316 @item -Wpointer-arith
6317 @opindex Wpointer-arith
6318 @opindex Wno-pointer-arith
6319 Warn about anything that depends on the ``size of'' a function type or
6320 of @code{void}.  GNU C assigns these types a size of 1, for
6321 convenience in calculations with @code{void *} pointers and pointers
6322 to functions.  In C++, warn also when an arithmetic operation involves
6323 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6325 @item -Wpointer-compare
6326 @opindex Wpointer-compare
6327 @opindex Wno-pointer-compare
6328 Warn if a pointer is compared with a zero character constant.  This usually
6329 means that the pointer was meant to be dereferenced.  For example:
6331 @smallexample
6332 const char *p = foo ();
6333 if (p == '\0')
6334   return 42;
6335 @end smallexample
6337 Note that the code above is invalid in C++11.
6339 This warning is enabled by default.
6341 @item -Wtype-limits
6342 @opindex Wtype-limits
6343 @opindex Wno-type-limits
6344 Warn if a comparison is always true or always false due to the limited
6345 range of the data type, but do not warn for constant expressions.  For
6346 example, warn if an unsigned variable is compared against zero with
6347 @code{<} or @code{>=}.  This warning is also enabled by
6348 @option{-Wextra}.
6350 @item -Wabsolute-value @r{(C and Objective-C only)}
6351 @opindex Wabsolute-value
6352 @opindex Wno-absolute-value
6353 Warn when a wrong absolute value function seems to be used or when it
6354 does not have any effect because its argument is an unsigned type.
6355 This warning be suppressed with an explicit type cast and it is also
6356 enabled by @option{-Wextra}.
6358 @include cppwarnopts.texi
6360 @item -Wbad-function-cast @r{(C and Objective-C only)}
6361 @opindex Wbad-function-cast
6362 @opindex Wno-bad-function-cast
6363 Warn when a function call is cast to a non-matching type.
6364 For example, warn if a call to a function returning an integer type 
6365 is cast to a pointer type.
6367 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6368 @opindex Wc90-c99-compat
6369 @opindex Wno-c90-c99-compat
6370 Warn about features not present in ISO C90, but present in ISO C99.
6371 For instance, warn about use of variable length arrays, @code{long long}
6372 type, @code{bool} type, compound literals, designated initializers, and so
6373 on.  This option is independent of the standards mode.  Warnings are disabled
6374 in the expression that follows @code{__extension__}.
6376 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6377 @opindex Wc99-c11-compat
6378 @opindex Wno-c99-c11-compat
6379 Warn about features not present in ISO C99, but present in ISO C11.
6380 For instance, warn about use of anonymous structures and unions,
6381 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6382 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6383 and so on.  This option is independent of the standards mode.  Warnings are
6384 disabled in the expression that follows @code{__extension__}.
6386 @item -Wc++-compat @r{(C and Objective-C only)}
6387 @opindex Wc++-compat
6388 @opindex Wno-c++-compat
6389 Warn about ISO C constructs that are outside of the common subset of
6390 ISO C and ISO C++, e.g.@: request for implicit conversion from
6391 @code{void *} to a pointer to non-@code{void} type.
6393 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6394 @opindex Wc++11-compat
6395 @opindex Wno-c++11-compat
6396 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6397 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6398 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6399 enabled by @option{-Wall}.
6401 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6402 @opindex Wc++14-compat
6403 @opindex Wno-c++14-compat
6404 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6405 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6407 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6408 @opindex Wc++17-compat
6409 @opindex Wno-c++17-compat
6410 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6411 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6413 @item -Wcast-qual
6414 @opindex Wcast-qual
6415 @opindex Wno-cast-qual
6416 Warn whenever a pointer is cast so as to remove a type qualifier from
6417 the target type.  For example, warn if a @code{const char *} is cast
6418 to an ordinary @code{char *}.
6420 Also warn when making a cast that introduces a type qualifier in an
6421 unsafe way.  For example, casting @code{char **} to @code{const char **}
6422 is unsafe, as in this example:
6424 @smallexample
6425   /* p is char ** value.  */
6426   const char **q = (const char **) p;
6427   /* Assignment of readonly string to const char * is OK.  */
6428   *q = "string";
6429   /* Now char** pointer points to read-only memory.  */
6430   **p = 'b';
6431 @end smallexample
6433 @item -Wcast-align
6434 @opindex Wcast-align
6435 @opindex Wno-cast-align
6436 Warn whenever a pointer is cast such that the required alignment of the
6437 target is increased.  For example, warn if a @code{char *} is cast to
6438 an @code{int *} on machines where integers can only be accessed at
6439 two- or four-byte boundaries.
6441 @item -Wcast-align=strict
6442 @opindex Wcast-align=strict
6443 Warn whenever a pointer is cast such that the required alignment of the
6444 target is increased.  For example, warn if a @code{char *} is cast to
6445 an @code{int *} regardless of the target machine.
6447 @item -Wcast-function-type
6448 @opindex Wcast-function-type
6449 @opindex Wno-cast-function-type
6450 Warn when a function pointer is cast to an incompatible function pointer.
6451 In a cast involving function types with a variable argument list only
6452 the types of initial arguments that are provided are considered.
6453 Any parameter of pointer-type matches any other pointer-type.  Any benign
6454 differences in integral types are ignored, like @code{int} vs.@: @code{long}
6455 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6456 type @code{void (*) (void)} is special and matches everything, which can
6457 be used to suppress this warning.
6458 In a cast involving pointer to member types this warning warns whenever
6459 the type cast is changing the pointer to member type.
6460 This warning is enabled by @option{-Wextra}.
6462 @item -Wwrite-strings
6463 @opindex Wwrite-strings
6464 @opindex Wno-write-strings
6465 When compiling C, give string constants the type @code{const
6466 char[@var{length}]} so that copying the address of one into a
6467 non-@code{const} @code{char *} pointer produces a warning.  These
6468 warnings help you find at compile time code that can try to write
6469 into a string constant, but only if you have been very careful about
6470 using @code{const} in declarations and prototypes.  Otherwise, it is
6471 just a nuisance. This is why we did not make @option{-Wall} request
6472 these warnings.
6474 When compiling C++, warn about the deprecated conversion from string
6475 literals to @code{char *}.  This warning is enabled by default for C++
6476 programs.
6478 @item -Wcatch-value
6479 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6480 @opindex Wcatch-value
6481 @opindex Wno-catch-value
6482 Warn about catch handlers that do not catch via reference.
6483 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6484 warn about polymorphic class types that are caught by value.
6485 With @option{-Wcatch-value=2} warn about all class types that are caught
6486 by value. With @option{-Wcatch-value=3} warn about all types that are
6487 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6489 @item -Wclobbered
6490 @opindex Wclobbered
6491 @opindex Wno-clobbered
6492 Warn for variables that might be changed by @code{longjmp} or
6493 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6495 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6496 @opindex Wconditionally-supported
6497 @opindex Wno-conditionally-supported
6498 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6500 @item -Wconversion
6501 @opindex Wconversion
6502 @opindex Wno-conversion
6503 Warn for implicit conversions that may alter a value. This includes
6504 conversions between real and integer, like @code{abs (x)} when
6505 @code{x} is @code{double}; conversions between signed and unsigned,
6506 like @code{unsigned ui = -1}; and conversions to smaller types, like
6507 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6508 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6509 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6510 conversions between signed and unsigned integers can be disabled by
6511 using @option{-Wno-sign-conversion}.
6513 For C++, also warn for confusing overload resolution for user-defined
6514 conversions; and conversions that never use a type conversion
6515 operator: conversions to @code{void}, the same type, a base class or a
6516 reference to them. Warnings about conversions between signed and
6517 unsigned integers are disabled by default in C++ unless
6518 @option{-Wsign-conversion} is explicitly enabled.
6520 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6521 @opindex Wconversion-null
6522 @opindex Wno-conversion-null
6523 Do not warn for conversions between @code{NULL} and non-pointer
6524 types. @option{-Wconversion-null} is enabled by default.
6526 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6527 @opindex Wzero-as-null-pointer-constant
6528 @opindex Wno-zero-as-null-pointer-constant
6529 Warn when a literal @samp{0} is used as null pointer constant.  This can
6530 be useful to facilitate the conversion to @code{nullptr} in C++11.
6532 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6533 @opindex Wsubobject-linkage
6534 @opindex Wno-subobject-linkage
6535 Warn if a class type has a base or a field whose type uses the anonymous
6536 namespace or depends on a type with no linkage.  If a type A depends on
6537 a type B with no or internal linkage, defining it in multiple
6538 translation units would be an ODR violation because the meaning of B
6539 is different in each translation unit.  If A only appears in a single
6540 translation unit, the best way to silence the warning is to give it
6541 internal linkage by putting it in an anonymous namespace as well.  The
6542 compiler doesn't give this warning for types defined in the main .C
6543 file, as those are unlikely to have multiple definitions.
6544 @option{-Wsubobject-linkage} is enabled by default.
6546 @item -Wdangling-else
6547 @opindex Wdangling-else
6548 @opindex Wno-dangling-else
6549 Warn about constructions where there may be confusion to which
6550 @code{if} statement an @code{else} branch belongs.  Here is an example of
6551 such a case:
6553 @smallexample
6554 @group
6556   if (a)
6557     if (b)
6558       foo ();
6559   else
6560     bar ();
6562 @end group
6563 @end smallexample
6565 In C/C++, every @code{else} branch belongs to the innermost possible
6566 @code{if} statement, which in this example is @code{if (b)}.  This is
6567 often not what the programmer expected, as illustrated in the above
6568 example by indentation the programmer chose.  When there is the
6569 potential for this confusion, GCC issues a warning when this flag
6570 is specified.  To eliminate the warning, add explicit braces around
6571 the innermost @code{if} statement so there is no way the @code{else}
6572 can belong to the enclosing @code{if}.  The resulting code
6573 looks like this:
6575 @smallexample
6576 @group
6578   if (a)
6579     @{
6580       if (b)
6581         foo ();
6582       else
6583         bar ();
6584     @}
6586 @end group
6587 @end smallexample
6589 This warning is enabled by @option{-Wparentheses}.
6591 @item -Wdate-time
6592 @opindex Wdate-time
6593 @opindex Wno-date-time
6594 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6595 are encountered as they might prevent bit-wise-identical reproducible
6596 compilations.
6598 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6599 @opindex Wdelete-incomplete
6600 @opindex Wno-delete-incomplete
6601 Warn when deleting a pointer to incomplete type, which may cause
6602 undefined behavior at runtime.  This warning is enabled by default.
6604 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6605 @opindex Wuseless-cast
6606 @opindex Wno-useless-cast
6607 Warn when an expression is casted to its own type.
6609 @item -Wempty-body
6610 @opindex Wempty-body
6611 @opindex Wno-empty-body
6612 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6613 while} statement.  This warning is also enabled by @option{-Wextra}.
6615 @item -Wenum-compare
6616 @opindex Wenum-compare
6617 @opindex Wno-enum-compare
6618 Warn about a comparison between values of different enumerated types.
6619 In C++ enumerated type mismatches in conditional expressions are also
6620 diagnosed and the warning is enabled by default.  In C this warning is 
6621 enabled by @option{-Wall}.
6623 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6624 @opindex Wextra-semi
6625 @opindex Wno-extra-semi
6626 Warn about redundant semicolon after in-class function definition.
6628 @item -Wjump-misses-init @r{(C, Objective-C only)}
6629 @opindex Wjump-misses-init
6630 @opindex Wno-jump-misses-init
6631 Warn if a @code{goto} statement or a @code{switch} statement jumps
6632 forward across the initialization of a variable, or jumps backward to a
6633 label after the variable has been initialized.  This only warns about
6634 variables that are initialized when they are declared.  This warning is
6635 only supported for C and Objective-C; in C++ this sort of branch is an
6636 error in any case.
6638 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6639 can be disabled with the @option{-Wno-jump-misses-init} option.
6641 @item -Wsign-compare
6642 @opindex Wsign-compare
6643 @opindex Wno-sign-compare
6644 @cindex warning for comparison of signed and unsigned values
6645 @cindex comparison of signed and unsigned values, warning
6646 @cindex signed and unsigned values, comparison warning
6647 Warn when a comparison between signed and unsigned values could produce
6648 an incorrect result when the signed value is converted to unsigned.
6649 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6650 also enabled by @option{-Wextra}.
6652 @item -Wsign-conversion
6653 @opindex Wsign-conversion
6654 @opindex Wno-sign-conversion
6655 Warn for implicit conversions that may change the sign of an integer
6656 value, like assigning a signed integer expression to an unsigned
6657 integer variable. An explicit cast silences the warning. In C, this
6658 option is enabled also by @option{-Wconversion}.
6660 @item -Wfloat-conversion
6661 @opindex Wfloat-conversion
6662 @opindex Wno-float-conversion
6663 Warn for implicit conversions that reduce the precision of a real value.
6664 This includes conversions from real to integer, and from higher precision
6665 real to lower precision real values.  This option is also enabled by
6666 @option{-Wconversion}.
6668 @item -Wno-scalar-storage-order
6669 @opindex Wno-scalar-storage-order
6670 @opindex Wscalar-storage-order
6671 Do not warn on suspicious constructs involving reverse scalar storage order.
6673 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6674 @opindex Wsized-deallocation
6675 @opindex Wno-sized-deallocation
6676 Warn about a definition of an unsized deallocation function
6677 @smallexample
6678 void operator delete (void *) noexcept;
6679 void operator delete[] (void *) noexcept;
6680 @end smallexample
6681 without a definition of the corresponding sized deallocation function
6682 @smallexample
6683 void operator delete (void *, std::size_t) noexcept;
6684 void operator delete[] (void *, std::size_t) noexcept;
6685 @end smallexample
6686 or vice versa.  Enabled by @option{-Wextra} along with
6687 @option{-fsized-deallocation}.
6689 @item -Wsizeof-pointer-div
6690 @opindex Wsizeof-pointer-div
6691 @opindex Wno-sizeof-pointer-div
6692 Warn for suspicious divisions of two sizeof expressions that divide
6693 the pointer size by the element size, which is the usual way to compute
6694 the array size but won't work out correctly with pointers.  This warning
6695 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6696 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6698 @item -Wsizeof-pointer-memaccess
6699 @opindex Wsizeof-pointer-memaccess
6700 @opindex Wno-sizeof-pointer-memaccess
6701 Warn for suspicious length parameters to certain string and memory built-in
6702 functions if the argument uses @code{sizeof}.  This warning triggers for
6703 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6704 an array, but a pointer, and suggests a possible fix, or about
6705 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6706 also warns about calls to bounded string copy functions like @code{strncat}
6707 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6708 the source array.  For example, in the following function the call to
6709 @code{strncat} specifies the size of the source string as the bound.  That
6710 is almost certainly a mistake and so the call is diagnosed.
6711 @smallexample
6712 void make_file (const char *name)
6714   char path[PATH_MAX];
6715   strncpy (path, name, sizeof path - 1);
6716   strncat (path, ".text", sizeof ".text");
6717   @dots{}
6719 @end smallexample
6721 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6723 @item -Wsizeof-array-argument
6724 @opindex Wsizeof-array-argument
6725 @opindex Wno-sizeof-array-argument
6726 Warn when the @code{sizeof} operator is applied to a parameter that is
6727 declared as an array in a function definition.  This warning is enabled by
6728 default for C and C++ programs.
6730 @item -Wmemset-elt-size
6731 @opindex Wmemset-elt-size
6732 @opindex Wno-memset-elt-size
6733 Warn for suspicious calls to the @code{memset} built-in function, if the
6734 first argument references an array, and the third argument is a number
6735 equal to the number of elements, but not equal to the size of the array
6736 in memory.  This indicates that the user has omitted a multiplication by
6737 the element size.  This warning is enabled by @option{-Wall}.
6739 @item -Wmemset-transposed-args
6740 @opindex Wmemset-transposed-args
6741 @opindex Wno-memset-transposed-args
6742 Warn for suspicious calls to the @code{memset} built-in function, if the
6743 second argument is not zero and the third argument is zero.  This warns e.g.@:
6744 about @code{memset (buf, sizeof buf, 0)} where most probably
6745 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6746 is only emitted if the third argument is literal zero.  If it is some
6747 expression that is folded to zero, a cast of zero to some type, etc., 
6748 it is far less likely that the user has mistakenly exchanged the arguments 
6749 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6751 @item -Waddress
6752 @opindex Waddress
6753 @opindex Wno-address
6754 Warn about suspicious uses of memory addresses. These include using
6755 the address of a function in a conditional expression, such as
6756 @code{void func(void); if (func)}, and comparisons against the memory
6757 address of a string literal, such as @code{if (x == "abc")}.  Such
6758 uses typically indicate a programmer error: the address of a function
6759 always evaluates to true, so their use in a conditional usually
6760 indicate that the programmer forgot the parentheses in a function
6761 call; and comparisons against string literals result in unspecified
6762 behavior and are not portable in C, so they usually indicate that the
6763 programmer intended to use @code{strcmp}.  This warning is enabled by
6764 @option{-Wall}.
6766 @item -Wlogical-op
6767 @opindex Wlogical-op
6768 @opindex Wno-logical-op
6769 Warn about suspicious uses of logical operators in expressions.
6770 This includes using logical operators in contexts where a
6771 bit-wise operator is likely to be expected.  Also warns when
6772 the operands of a logical operator are the same:
6773 @smallexample
6774 extern int a;
6775 if (a < 0 && a < 0) @{ @dots{} @}
6776 @end smallexample
6778 @item -Wlogical-not-parentheses
6779 @opindex Wlogical-not-parentheses
6780 @opindex Wno-logical-not-parentheses
6781 Warn about logical not used on the left hand side operand of a comparison.
6782 This option does not warn if the right operand is considered to be a boolean
6783 expression.  Its purpose is to detect suspicious code like the following:
6784 @smallexample
6785 int a;
6786 @dots{}
6787 if (!a > 1) @{ @dots{} @}
6788 @end smallexample
6790 It is possible to suppress the warning by wrapping the LHS into
6791 parentheses:
6792 @smallexample
6793 if ((!a) > 1) @{ @dots{} @}
6794 @end smallexample
6796 This warning is enabled by @option{-Wall}.
6798 @item -Waggregate-return
6799 @opindex Waggregate-return
6800 @opindex Wno-aggregate-return
6801 Warn if any functions that return structures or unions are defined or
6802 called.  (In languages where you can return an array, this also elicits
6803 a warning.)
6805 @item -Wno-aggressive-loop-optimizations
6806 @opindex Wno-aggressive-loop-optimizations
6807 @opindex Waggressive-loop-optimizations
6808 Warn if in a loop with constant number of iterations the compiler detects
6809 undefined behavior in some statement during one or more of the iterations.
6811 @item -Wno-attributes
6812 @opindex Wno-attributes
6813 @opindex Wattributes
6814 Do not warn if an unexpected @code{__attribute__} is used, such as
6815 unrecognized attributes, function attributes applied to variables,
6816 etc.  This does not stop errors for incorrect use of supported
6817 attributes.
6819 @item -Wno-builtin-declaration-mismatch
6820 @opindex Wno-builtin-declaration-mismatch
6821 @opindex Wbuiltin-declaration-mismatch
6822 Warn if a built-in function is declared with the wrong signature or 
6823 as non-function.
6824 This warning is enabled by default.
6826 @item -Wno-builtin-macro-redefined
6827 @opindex Wno-builtin-macro-redefined
6828 @opindex Wbuiltin-macro-redefined
6829 Do not warn if certain built-in macros are redefined.  This suppresses
6830 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6831 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6833 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6834 @opindex Wstrict-prototypes
6835 @opindex Wno-strict-prototypes
6836 Warn if a function is declared or defined without specifying the
6837 argument types.  (An old-style function definition is permitted without
6838 a warning if preceded by a declaration that specifies the argument
6839 types.)
6841 @item -Wold-style-declaration @r{(C and Objective-C only)}
6842 @opindex Wold-style-declaration
6843 @opindex Wno-old-style-declaration
6844 Warn for obsolescent usages, according to the C Standard, in a
6845 declaration. For example, warn if storage-class specifiers like
6846 @code{static} are not the first things in a declaration.  This warning
6847 is also enabled by @option{-Wextra}.
6849 @item -Wold-style-definition @r{(C and Objective-C only)}
6850 @opindex Wold-style-definition
6851 @opindex Wno-old-style-definition
6852 Warn if an old-style function definition is used.  A warning is given
6853 even if there is a previous prototype.
6855 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6856 @opindex Wmissing-parameter-type
6857 @opindex Wno-missing-parameter-type
6858 A function parameter is declared without a type specifier in K&R-style
6859 functions:
6861 @smallexample
6862 void foo(bar) @{ @}
6863 @end smallexample
6865 This warning is also enabled by @option{-Wextra}.
6867 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6868 @opindex Wmissing-prototypes
6869 @opindex Wno-missing-prototypes
6870 Warn if a global function is defined without a previous prototype
6871 declaration.  This warning is issued even if the definition itself
6872 provides a prototype.  Use this option to detect global functions
6873 that do not have a matching prototype declaration in a header file.
6874 This option is not valid for C++ because all function declarations
6875 provide prototypes and a non-matching declaration declares an
6876 overload rather than conflict with an earlier declaration.
6877 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6879 @item -Wmissing-declarations
6880 @opindex Wmissing-declarations
6881 @opindex Wno-missing-declarations
6882 Warn if a global function is defined without a previous declaration.
6883 Do so even if the definition itself provides a prototype.
6884 Use this option to detect global functions that are not declared in
6885 header files.  In C, no warnings are issued for functions with previous
6886 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6887 missing prototypes.  In C++, no warnings are issued for function templates,
6888 or for inline functions, or for functions in anonymous namespaces.
6890 @item -Wmissing-field-initializers
6891 @opindex Wmissing-field-initializers
6892 @opindex Wno-missing-field-initializers
6893 @opindex W
6894 @opindex Wextra
6895 @opindex Wno-extra
6896 Warn if a structure's initializer has some fields missing.  For
6897 example, the following code causes such a warning, because
6898 @code{x.h} is implicitly zero:
6900 @smallexample
6901 struct s @{ int f, g, h; @};
6902 struct s x = @{ 3, 4 @};
6903 @end smallexample
6905 This option does not warn about designated initializers, so the following
6906 modification does not trigger a warning:
6908 @smallexample
6909 struct s @{ int f, g, h; @};
6910 struct s x = @{ .f = 3, .g = 4 @};
6911 @end smallexample
6913 In C this option does not warn about the universal zero initializer
6914 @samp{@{ 0 @}}:
6916 @smallexample
6917 struct s @{ int f, g, h; @};
6918 struct s x = @{ 0 @};
6919 @end smallexample
6921 Likewise, in C++ this option does not warn about the empty @{ @}
6922 initializer, for example:
6924 @smallexample
6925 struct s @{ int f, g, h; @};
6926 s x = @{ @};
6927 @end smallexample
6929 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6930 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6932 @item -Wno-multichar
6933 @opindex Wno-multichar
6934 @opindex Wmultichar
6935 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6936 Usually they indicate a typo in the user's code, as they have
6937 implementation-defined values, and should not be used in portable code.
6939 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6940 @opindex Wnormalized=
6941 @opindex Wnormalized
6942 @opindex Wno-normalized
6943 @cindex NFC
6944 @cindex NFKC
6945 @cindex character set, input normalization
6946 In ISO C and ISO C++, two identifiers are different if they are
6947 different sequences of characters.  However, sometimes when characters
6948 outside the basic ASCII character set are used, you can have two
6949 different character sequences that look the same.  To avoid confusion,
6950 the ISO 10646 standard sets out some @dfn{normalization rules} which
6951 when applied ensure that two sequences that look the same are turned into
6952 the same sequence.  GCC can warn you if you are using identifiers that
6953 have not been normalized; this option controls that warning.
6955 There are four levels of warning supported by GCC@.  The default is
6956 @option{-Wnormalized=nfc}, which warns about any identifier that is
6957 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6958 recommended form for most uses.  It is equivalent to
6959 @option{-Wnormalized}.
6961 Unfortunately, there are some characters allowed in identifiers by
6962 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6963 identifiers.  That is, there's no way to use these symbols in portable
6964 ISO C or C++ and have all your identifiers in NFC@.
6965 @option{-Wnormalized=id} suppresses the warning for these characters.
6966 It is hoped that future versions of the standards involved will correct
6967 this, which is why this option is not the default.
6969 You can switch the warning off for all characters by writing
6970 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6971 only do this if you are using some other normalization scheme (like
6972 ``D''), because otherwise you can easily create bugs that are
6973 literally impossible to see.
6975 Some characters in ISO 10646 have distinct meanings but look identical
6976 in some fonts or display methodologies, especially once formatting has
6977 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6978 LETTER N'', displays just like a regular @code{n} that has been
6979 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6980 normalization scheme to convert all these into a standard form as
6981 well, and GCC warns if your code is not in NFKC if you use
6982 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6983 about every identifier that contains the letter O because it might be
6984 confused with the digit 0, and so is not the default, but may be
6985 useful as a local coding convention if the programming environment 
6986 cannot be fixed to display these characters distinctly.
6988 @item -Wno-attribute-warning
6989 @opindex Wno-attribute-warning
6990 @opindex Wattribute-warning
6991 Do not warn about usage of functions (@pxref{Function Attributes})
6992 declared with @code{warning} attribute.  By default, this warning is
6993 enabled.  @option{-Wno-attribute-warning} can be used to disable the
6994 warning or @option{-Wno-error=attribute-warning} can be used to
6995 disable the error when compiled with @option{-Werror} flag.
6997 @item -Wno-deprecated
6998 @opindex Wno-deprecated
6999 @opindex Wdeprecated
7000 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
7002 @item -Wno-deprecated-declarations
7003 @opindex Wno-deprecated-declarations
7004 @opindex Wdeprecated-declarations
7005 Do not warn about uses of functions (@pxref{Function Attributes}),
7006 variables (@pxref{Variable Attributes}), and types (@pxref{Type
7007 Attributes}) marked as deprecated by using the @code{deprecated}
7008 attribute.
7010 @item -Wno-overflow
7011 @opindex Wno-overflow
7012 @opindex Woverflow
7013 Do not warn about compile-time overflow in constant expressions.
7015 @item -Wno-odr
7016 @opindex Wno-odr
7017 @opindex Wodr
7018 Warn about One Definition Rule violations during link-time optimization.
7019 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
7021 @item -Wopenmp-simd
7022 @opindex Wopenmp-simd
7023 @opindex Wno-openmp-simd
7024 Warn if the vectorizer cost model overrides the OpenMP
7025 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
7026 option can be used to relax the cost model.
7028 @item -Woverride-init @r{(C and Objective-C only)}
7029 @opindex Woverride-init
7030 @opindex Wno-override-init
7031 @opindex W
7032 @opindex Wextra
7033 @opindex Wno-extra
7034 Warn if an initialized field without side effects is overridden when
7035 using designated initializers (@pxref{Designated Inits, , Designated
7036 Initializers}).
7038 This warning is included in @option{-Wextra}.  To get other
7039 @option{-Wextra} warnings without this one, use @option{-Wextra
7040 -Wno-override-init}.
7042 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
7043 @opindex Woverride-init-side-effects
7044 @opindex Wno-override-init-side-effects
7045 Warn if an initialized field with side effects is overridden when
7046 using designated initializers (@pxref{Designated Inits, , Designated
7047 Initializers}).  This warning is enabled by default.
7049 @item -Wpacked
7050 @opindex Wpacked
7051 @opindex Wno-packed
7052 Warn if a structure is given the packed attribute, but the packed
7053 attribute has no effect on the layout or size of the structure.
7054 Such structures may be mis-aligned for little benefit.  For
7055 instance, in this code, the variable @code{f.x} in @code{struct bar}
7056 is misaligned even though @code{struct bar} does not itself
7057 have the packed attribute:
7059 @smallexample
7060 @group
7061 struct foo @{
7062   int x;
7063   char a, b, c, d;
7064 @} __attribute__((packed));
7065 struct bar @{
7066   char z;
7067   struct foo f;
7069 @end group
7070 @end smallexample
7072 @item -Wpacked-bitfield-compat
7073 @opindex Wpacked-bitfield-compat
7074 @opindex Wno-packed-bitfield-compat
7075 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
7076 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
7077 the change can lead to differences in the structure layout.  GCC
7078 informs you when the offset of such a field has changed in GCC 4.4.
7079 For example there is no longer a 4-bit padding between field @code{a}
7080 and @code{b} in this structure:
7082 @smallexample
7083 struct foo
7085   char a:4;
7086   char b:8;
7087 @} __attribute__ ((packed));
7088 @end smallexample
7090 This warning is enabled by default.  Use
7091 @option{-Wno-packed-bitfield-compat} to disable this warning.
7093 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
7094 @opindex Wpacked-not-aligned
7095 @opindex Wno-packed-not-aligned
7096 Warn if a structure field with explicitly specified alignment in a
7097 packed struct or union is misaligned.  For example, a warning will
7098 be issued on @code{struct S}, like, @code{warning: alignment 1 of
7099 'struct S' is less than 8}, in this code:
7101 @smallexample
7102 @group
7103 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
7104 struct __attribute__ ((packed)) S @{
7105   struct S8 s8;
7107 @end group
7108 @end smallexample
7110 This warning is enabled by @option{-Wall}.
7112 @item -Wpadded
7113 @opindex Wpadded
7114 @opindex Wno-padded
7115 Warn if padding is included in a structure, either to align an element
7116 of the structure or to align the whole structure.  Sometimes when this
7117 happens it is possible to rearrange the fields of the structure to
7118 reduce the padding and so make the structure smaller.
7120 @item -Wredundant-decls
7121 @opindex Wredundant-decls
7122 @opindex Wno-redundant-decls
7123 Warn if anything is declared more than once in the same scope, even in
7124 cases where multiple declaration is valid and changes nothing.
7126 @item -Wno-restrict
7127 @opindex Wrestrict
7128 @opindex Wno-restrict
7129 Warn when an object referenced by a @code{restrict}-qualified parameter
7130 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
7131 argument, or when copies between such objects overlap.  For example,
7132 the call to the @code{strcpy} function below attempts to truncate the string
7133 by replacing its initial characters with the last four.  However, because
7134 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
7135 the call is diagnosed.
7137 @smallexample
7138 void foo (void)
7140   char a[] = "abcd1234";
7141   strcpy (a, a + 4);
7142   @dots{}
7144 @end smallexample
7145 The @option{-Wrestrict} option detects some instances of simple overlap
7146 even without optimization but works best at @option{-O2} and above.  It
7147 is included in @option{-Wall}.
7149 @item -Wnested-externs @r{(C and Objective-C only)}
7150 @opindex Wnested-externs
7151 @opindex Wno-nested-externs
7152 Warn if an @code{extern} declaration is encountered within a function.
7154 @item -Wno-inherited-variadic-ctor
7155 @opindex Winherited-variadic-ctor
7156 @opindex Wno-inherited-variadic-ctor
7157 Suppress warnings about use of C++11 inheriting constructors when the
7158 base class inherited from has a C variadic constructor; the warning is
7159 on by default because the ellipsis is not inherited.
7161 @item -Winline
7162 @opindex Winline
7163 @opindex Wno-inline
7164 Warn if a function that is declared as inline cannot be inlined.
7165 Even with this option, the compiler does not warn about failures to
7166 inline functions declared in system headers.
7168 The compiler uses a variety of heuristics to determine whether or not
7169 to inline a function.  For example, the compiler takes into account
7170 the size of the function being inlined and the amount of inlining
7171 that has already been done in the current function.  Therefore,
7172 seemingly insignificant changes in the source program can cause the
7173 warnings produced by @option{-Winline} to appear or disappear.
7175 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
7176 @opindex Wno-invalid-offsetof
7177 @opindex Winvalid-offsetof
7178 Suppress warnings from applying the @code{offsetof} macro to a non-POD
7179 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
7180 to a non-standard-layout type is undefined.  In existing C++ implementations,
7181 however, @code{offsetof} typically gives meaningful results.
7182 This flag is for users who are aware that they are
7183 writing nonportable code and who have deliberately chosen to ignore the
7184 warning about it.
7186 The restrictions on @code{offsetof} may be relaxed in a future version
7187 of the C++ standard.
7189 @item -Wint-in-bool-context
7190 @opindex Wint-in-bool-context
7191 @opindex Wno-int-in-bool-context
7192 Warn for suspicious use of integer values where boolean values are expected,
7193 such as conditional expressions (?:) using non-boolean integer constants in
7194 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
7195 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
7196 for all kinds of multiplications regardless of the data type.
7197 This warning is enabled by @option{-Wall}.
7199 @item -Wno-int-to-pointer-cast
7200 @opindex Wno-int-to-pointer-cast
7201 @opindex Wint-to-pointer-cast
7202 Suppress warnings from casts to pointer type of an integer of a
7203 different size. In C++, casting to a pointer type of smaller size is
7204 an error. @option{Wint-to-pointer-cast} is enabled by default.
7207 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
7208 @opindex Wno-pointer-to-int-cast
7209 @opindex Wpointer-to-int-cast
7210 Suppress warnings from casts from a pointer to an integer type of a
7211 different size.
7213 @item -Winvalid-pch
7214 @opindex Winvalid-pch
7215 @opindex Wno-invalid-pch
7216 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
7217 the search path but cannot be used.
7219 @item -Wlong-long
7220 @opindex Wlong-long
7221 @opindex Wno-long-long
7222 Warn if @code{long long} type is used.  This is enabled by either
7223 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
7224 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
7226 @item -Wvariadic-macros
7227 @opindex Wvariadic-macros
7228 @opindex Wno-variadic-macros
7229 Warn if variadic macros are used in ISO C90 mode, or if the GNU
7230 alternate syntax is used in ISO C99 mode.  This is enabled by either
7231 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
7232 messages, use @option{-Wno-variadic-macros}.
7234 @item -Wvarargs
7235 @opindex Wvarargs
7236 @opindex Wno-varargs
7237 Warn upon questionable usage of the macros used to handle variable
7238 arguments like @code{va_start}.  This is default.  To inhibit the
7239 warning messages, use @option{-Wno-varargs}.
7241 @item -Wvector-operation-performance
7242 @opindex Wvector-operation-performance
7243 @opindex Wno-vector-operation-performance
7244 Warn if vector operation is not implemented via SIMD capabilities of the
7245 architecture.  Mainly useful for the performance tuning.
7246 Vector operation can be implemented @code{piecewise}, which means that the
7247 scalar operation is performed on every vector element; 
7248 @code{in parallel}, which means that the vector operation is implemented
7249 using scalars of wider type, which normally is more performance efficient;
7250 and @code{as a single scalar}, which means that vector fits into a
7251 scalar type.
7253 @item -Wno-virtual-move-assign
7254 @opindex Wvirtual-move-assign
7255 @opindex Wno-virtual-move-assign
7256 Suppress warnings about inheriting from a virtual base with a
7257 non-trivial C++11 move assignment operator.  This is dangerous because
7258 if the virtual base is reachable along more than one path, it is
7259 moved multiple times, which can mean both objects end up in the
7260 moved-from state.  If the move assignment operator is written to avoid
7261 moving from a moved-from object, this warning can be disabled.
7263 @item -Wvla
7264 @opindex Wvla
7265 @opindex Wno-vla
7266 Warn if a variable-length array is used in the code.
7267 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
7268 the variable-length array.
7270 @item -Wvla-larger-than=@var{byte-size}
7271 @opindex Wvla-larger-than=
7272 @opindex Wno-vla-larger-than
7273 If this option is used, the compiler will warn for declarations of
7274 variable-length arrays whose size is either unbounded, or bounded
7275 by an argument that allows the array size to exceed @var{byte-size}
7276 bytes.  This is similar to how @option{-Walloca-larger-than=}@var{byte-size}
7277 works, but with variable-length arrays.
7279 Note that GCC may optimize small variable-length arrays of a known
7280 value into plain arrays, so this warning may not get triggered for
7281 such arrays.
7283 @option{-Wvla-larger-than=}@samp{PTRDIFF_MAX} is enabled by default but
7284 is typically only effective when @option{-ftree-vrp} is active (default
7285 for @option{-O2} and above).
7287 See also @option{-Walloca-larger-than=@var{byte-size}}.
7289 @item -Wno-vla-larger-than
7290 @opindex Wno-vla-larger-than
7291 Disable @option{-Wvla-larger-than=} warnings.  The option is equivalent
7292 to @option{-Wvla-larger-than=}@samp{SIZE_MAX} or larger.
7294 @item -Wvolatile-register-var
7295 @opindex Wvolatile-register-var
7296 @opindex Wno-volatile-register-var
7297 Warn if a register variable is declared volatile.  The volatile
7298 modifier does not inhibit all optimizations that may eliminate reads
7299 and/or writes to register variables.  This warning is enabled by
7300 @option{-Wall}.
7302 @item -Wdisabled-optimization
7303 @opindex Wdisabled-optimization
7304 @opindex Wno-disabled-optimization
7305 Warn if a requested optimization pass is disabled.  This warning does
7306 not generally indicate that there is anything wrong with your code; it
7307 merely indicates that GCC's optimizers are unable to handle the code
7308 effectively.  Often, the problem is that your code is too big or too
7309 complex; GCC refuses to optimize programs when the optimization
7310 itself is likely to take inordinate amounts of time.
7312 @item -Wpointer-sign @r{(C and Objective-C only)}
7313 @opindex Wpointer-sign
7314 @opindex Wno-pointer-sign
7315 Warn for pointer argument passing or assignment with different signedness.
7316 This option is only supported for C and Objective-C@.  It is implied by
7317 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
7318 @option{-Wno-pointer-sign}.
7320 @item -Wstack-protector
7321 @opindex Wstack-protector
7322 @opindex Wno-stack-protector
7323 This option is only active when @option{-fstack-protector} is active.  It
7324 warns about functions that are not protected against stack smashing.
7326 @item -Woverlength-strings
7327 @opindex Woverlength-strings
7328 @opindex Wno-overlength-strings
7329 Warn about string constants that are longer than the ``minimum
7330 maximum'' length specified in the C standard.  Modern compilers
7331 generally allow string constants that are much longer than the
7332 standard's minimum limit, but very portable programs should avoid
7333 using longer strings.
7335 The limit applies @emph{after} string constant concatenation, and does
7336 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7337 C99, it was raised to 4095.  C++98 does not specify a normative
7338 minimum maximum, so we do not diagnose overlength strings in C++@.
7340 This option is implied by @option{-Wpedantic}, and can be disabled with
7341 @option{-Wno-overlength-strings}.
7343 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7344 @opindex Wunsuffixed-float-constants
7345 @opindex Wno-unsuffixed-float-constants
7347 Issue a warning for any floating constant that does not have
7348 a suffix.  When used together with @option{-Wsystem-headers} it
7349 warns about such constants in system header files.  This can be useful
7350 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7351 from the decimal floating-point extension to C99.
7353 @item -Wno-designated-init @r{(C and Objective-C only)}
7354 Suppress warnings when a positional initializer is used to initialize
7355 a structure that has been marked with the @code{designated_init}
7356 attribute.
7358 @item -Whsa
7359 Issue a warning when HSAIL cannot be emitted for the compiled function or
7360 OpenMP construct.
7362 @end table
7364 @node Debugging Options
7365 @section Options for Debugging Your Program
7366 @cindex options, debugging
7367 @cindex debugging information options
7369 To tell GCC to emit extra information for use by a debugger, in almost 
7370 all cases you need only to add @option{-g} to your other options.
7372 GCC allows you to use @option{-g} with
7373 @option{-O}.  The shortcuts taken by optimized code may occasionally
7374 be surprising: some variables you declared may not exist
7375 at all; flow of control may briefly move where you did not expect it;
7376 some statements may not be executed because they compute constant
7377 results or their values are already at hand; some statements may
7378 execute in different places because they have been moved out of loops.
7379 Nevertheless it is possible to debug optimized output.  This makes
7380 it reasonable to use the optimizer for programs that might have bugs.
7382 If you are not using some other optimization option, consider
7383 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7384 With no @option{-O} option at all, some compiler passes that collect
7385 information useful for debugging do not run at all, so that
7386 @option{-Og} may result in a better debugging experience.
7388 @table @gcctabopt
7389 @item -g
7390 @opindex g
7391 Produce debugging information in the operating system's native format
7392 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7393 information.
7395 On most systems that use stabs format, @option{-g} enables use of extra
7396 debugging information that only GDB can use; this extra information
7397 makes debugging work better in GDB but probably makes other debuggers
7398 crash or
7399 refuse to read the program.  If you want to control for certain whether
7400 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7401 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7403 @item -ggdb
7404 @opindex ggdb
7405 Produce debugging information for use by GDB@.  This means to use the
7406 most expressive format available (DWARF, stabs, or the native format
7407 if neither of those are supported), including GDB extensions if at all
7408 possible.
7410 @item -gdwarf
7411 @itemx -gdwarf-@var{version}
7412 @opindex gdwarf
7413 Produce debugging information in DWARF format (if that is supported).
7414 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7415 for most targets is 4.  DWARF Version 5 is only experimental.
7417 Note that with DWARF Version 2, some ports require and always
7418 use some non-conflicting DWARF 3 extensions in the unwind tables.
7420 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7421 for maximum benefit.
7423 GCC no longer supports DWARF Version 1, which is substantially
7424 different than Version 2 and later.  For historical reasons, some
7425 other DWARF-related options such as
7426 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7427 in their names, but apply to all currently-supported versions of DWARF.
7429 @item -gstabs
7430 @opindex gstabs
7431 Produce debugging information in stabs format (if that is supported),
7432 without GDB extensions.  This is the format used by DBX on most BSD
7433 systems.  On MIPS, Alpha and System V Release 4 systems this option
7434 produces stabs debugging output that is not understood by DBX@.
7435 On System V Release 4 systems this option requires the GNU assembler.
7437 @item -gstabs+
7438 @opindex gstabs+
7439 Produce debugging information in stabs format (if that is supported),
7440 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7441 use of these extensions is likely to make other debuggers crash or
7442 refuse to read the program.
7444 @item -gxcoff
7445 @opindex gxcoff
7446 Produce debugging information in XCOFF format (if that is supported).
7447 This is the format used by the DBX debugger on IBM RS/6000 systems.
7449 @item -gxcoff+
7450 @opindex gxcoff+
7451 Produce debugging information in XCOFF format (if that is supported),
7452 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7453 use of these extensions is likely to make other debuggers crash or
7454 refuse to read the program, and may cause assemblers other than the GNU
7455 assembler (GAS) to fail with an error.
7457 @item -gvms
7458 @opindex gvms
7459 Produce debugging information in Alpha/VMS debug format (if that is
7460 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7462 @item -g@var{level}
7463 @itemx -ggdb@var{level}
7464 @itemx -gstabs@var{level}
7465 @itemx -gxcoff@var{level}
7466 @itemx -gvms@var{level}
7467 Request debugging information and also use @var{level} to specify how
7468 much information.  The default level is 2.
7470 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7471 @option{-g}.
7473 Level 1 produces minimal information, enough for making backtraces in
7474 parts of the program that you don't plan to debug.  This includes
7475 descriptions of functions and external variables, and line number
7476 tables, but no information about local variables.
7478 Level 3 includes extra information, such as all the macro definitions
7479 present in the program.  Some debuggers support macro expansion when
7480 you use @option{-g3}.
7482 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7483 confusion with @option{-gdwarf-@var{level}}.
7484 Instead use an additional @option{-g@var{level}} option to change the
7485 debug level for DWARF.
7487 @item -feliminate-unused-debug-symbols
7488 @opindex feliminate-unused-debug-symbols
7489 Produce debugging information in stabs format (if that is supported),
7490 for only symbols that are actually used.
7492 @item -femit-class-debug-always
7493 @opindex femit-class-debug-always
7494 Instead of emitting debugging information for a C++ class in only one
7495 object file, emit it in all object files using the class.  This option
7496 should be used only with debuggers that are unable to handle the way GCC
7497 normally emits debugging information for classes because using this
7498 option increases the size of debugging information by as much as a
7499 factor of two.
7501 @item -fno-merge-debug-strings
7502 @opindex fmerge-debug-strings
7503 @opindex fno-merge-debug-strings
7504 Direct the linker to not merge together strings in the debugging
7505 information that are identical in different object files.  Merging is
7506 not supported by all assemblers or linkers.  Merging decreases the size
7507 of the debug information in the output file at the cost of increasing
7508 link processing time.  Merging is enabled by default.
7510 @item -fdebug-prefix-map=@var{old}=@var{new}
7511 @opindex fdebug-prefix-map
7512 When compiling files residing in directory @file{@var{old}}, record
7513 debugging information describing them as if the files resided in
7514 directory @file{@var{new}} instead.  This can be used to replace a
7515 build-time path with an install-time path in the debug info.  It can
7516 also be used to change an absolute path to a relative path by using
7517 @file{.} for @var{new}.  This can give more reproducible builds, which
7518 are location independent, but may require an extra command to tell GDB
7519 where to find the source files. See also @option{-ffile-prefix-map}.
7521 @item -fvar-tracking
7522 @opindex fvar-tracking
7523 Run variable tracking pass.  It computes where variables are stored at each
7524 position in code.  Better debugging information is then generated
7525 (if the debugging information format supports this information).
7527 It is enabled by default when compiling with optimization (@option{-Os},
7528 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7529 the debug info format supports it.
7531 @item -fvar-tracking-assignments
7532 @opindex fvar-tracking-assignments
7533 @opindex fno-var-tracking-assignments
7534 Annotate assignments to user variables early in the compilation and
7535 attempt to carry the annotations over throughout the compilation all the
7536 way to the end, in an attempt to improve debug information while
7537 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7539 It can be enabled even if var-tracking is disabled, in which case
7540 annotations are created and maintained, but discarded at the end.
7541 By default, this flag is enabled together with @option{-fvar-tracking},
7542 except when selective scheduling is enabled.
7544 @item -gsplit-dwarf
7545 @opindex gsplit-dwarf
7546 Separate as much DWARF debugging information as possible into a
7547 separate output file with the extension @file{.dwo}.  This option allows
7548 the build system to avoid linking files with debug information.  To
7549 be useful, this option requires a debugger capable of reading @file{.dwo}
7550 files.
7552 @item -gdescribe-dies
7553 @opindex gdescribe-dies
7554 Add description attributes to some DWARF DIEs that have no name attribute,
7555 such as artificial variables, external references and call site
7556 parameter DIEs.
7558 @item -gpubnames
7559 @opindex gpubnames
7560 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7562 @item -ggnu-pubnames
7563 @opindex ggnu-pubnames
7564 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7565 suitable for conversion into a GDB@ index.  This option is only useful
7566 with a linker that can produce GDB@ index version 7.
7568 @item -fdebug-types-section
7569 @opindex fdebug-types-section
7570 @opindex fno-debug-types-section
7571 When using DWARF Version 4 or higher, type DIEs can be put into
7572 their own @code{.debug_types} section instead of making them part of the
7573 @code{.debug_info} section.  It is more efficient to put them in a separate
7574 comdat section since the linker can then remove duplicates.
7575 But not all DWARF consumers support @code{.debug_types} sections yet
7576 and on some objects @code{.debug_types} produces larger instead of smaller
7577 debugging information.
7579 @item -grecord-gcc-switches
7580 @itemx -gno-record-gcc-switches
7581 @opindex grecord-gcc-switches
7582 @opindex gno-record-gcc-switches
7583 This switch causes the command-line options used to invoke the
7584 compiler that may affect code generation to be appended to the
7585 DW_AT_producer attribute in DWARF debugging information.  The options
7586 are concatenated with spaces separating them from each other and from
7587 the compiler version.  
7588 It is enabled by default.
7589 See also @option{-frecord-gcc-switches} for another
7590 way of storing compiler options into the object file.  
7592 @item -gstrict-dwarf
7593 @opindex gstrict-dwarf
7594 Disallow using extensions of later DWARF standard version than selected
7595 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7596 DWARF extensions from later standard versions is allowed.
7598 @item -gno-strict-dwarf
7599 @opindex gno-strict-dwarf
7600 Allow using extensions of later DWARF standard version than selected with
7601 @option{-gdwarf-@var{version}}.
7603 @item -gas-loc-support
7604 @opindex gas-loc-support
7605 Inform the compiler that the assembler supports @code{.loc} directives.
7606 It may then use them for the assembler to generate DWARF2+ line number
7607 tables.
7609 This is generally desirable, because assembler-generated line-number
7610 tables are a lot more compact than those the compiler can generate
7611 itself.
7613 This option will be enabled by default if, at GCC configure time, the
7614 assembler was found to support such directives.
7616 @item -gno-as-loc-support
7617 @opindex gno-as-loc-support
7618 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7619 line number tables are to be generated.
7621 @item gas-locview-support
7622 @opindex gas-locview-support
7623 Inform the compiler that the assembler supports @code{view} assignment
7624 and reset assertion checking in @code{.loc} directives.
7626 This option will be enabled by default if, at GCC configure time, the
7627 assembler was found to support them.
7629 @item gno-as-locview-support
7630 Force GCC to assign view numbers internally, if
7631 @option{-gvariable-location-views} are explicitly requested.
7633 @item -gcolumn-info
7634 @itemx -gno-column-info
7635 @opindex gcolumn-info
7636 @opindex gno-column-info
7637 Emit location column information into DWARF debugging information, rather
7638 than just file and line.
7639 This option is enabled by default.
7641 @item -gstatement-frontiers
7642 @itemx -gno-statement-frontiers
7643 @opindex gstatement-frontiers
7644 @opindex gno-statement-frontiers
7645 This option causes GCC to create markers in the internal representation
7646 at the beginning of statements, and to keep them roughly in place
7647 throughout compilation, using them to guide the output of @code{is_stmt}
7648 markers in the line number table.  This is enabled by default when
7649 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7650 @dots{}), and outputting DWARF 2 debug information at the normal level.
7652 @item -gvariable-location-views
7653 @itemx -gvariable-location-views=incompat5
7654 @itemx -gno-variable-location-views
7655 @opindex gvariable-location-views
7656 @opindex gvariable-location-views=incompat5
7657 @opindex gno-variable-location-views
7658 Augment variable location lists with progressive view numbers implied
7659 from the line number table.  This enables debug information consumers to
7660 inspect state at certain points of the program, even if no instructions
7661 associated with the corresponding source locations are present at that
7662 point.  If the assembler lacks support for view numbers in line number
7663 tables, this will cause the compiler to emit the line number table,
7664 which generally makes them somewhat less compact.  The augmented line
7665 number tables and location lists are fully backward-compatible, so they
7666 can be consumed by debug information consumers that are not aware of
7667 these augmentations, but they won't derive any benefit from them either.
7669 This is enabled by default when outputting DWARF 2 debug information at
7670 the normal level, as long as there is assembler support,
7671 @option{-fvar-tracking-assignments} is enabled and
7672 @option{-gstrict-dwarf} is not.  When assembler support is not
7673 available, this may still be enabled, but it will force GCC to output
7674 internal line number tables, and if
7675 @option{-ginternal-reset-location-views} is not enabled, that will most
7676 certainly lead to silently mismatching location views.
7678 There is a proposed representation for view numbers that is not backward
7679 compatible with the location list format introduced in DWARF 5, that can
7680 be enabled with @option{-gvariable-location-views=incompat5}.  This
7681 option may be removed in the future, is only provided as a reference
7682 implementation of the proposed representation.  Debug information
7683 consumers are not expected to support this extended format, and they
7684 would be rendered unable to decode location lists using it.
7686 @item -ginternal-reset-location-views
7687 @itemx -gnointernal-reset-location-views
7688 @opindex ginternal-reset-location-views
7689 @opindex gno-internal-reset-location-views
7690 Attempt to determine location views that can be omitted from location
7691 view lists.  This requires the compiler to have very accurate insn
7692 length estimates, which isn't always the case, and it may cause
7693 incorrect view lists to be generated silently when using an assembler
7694 that does not support location view lists.  The GNU assembler will flag
7695 any such error as a @code{view number mismatch}.  This is only enabled
7696 on ports that define a reliable estimation function.
7698 @item -ginline-points
7699 @itemx -gno-inline-points
7700 @opindex ginline-points
7701 @opindex gno-inline-points
7702 Generate extended debug information for inlined functions.  Location
7703 view tracking markers are inserted at inlined entry points, so that
7704 address and view numbers can be computed and output in debug
7705 information.  This can be enabled independently of location views, in
7706 which case the view numbers won't be output, but it can only be enabled
7707 along with statement frontiers, and it is only enabled by default if
7708 location views are enabled.
7710 @item -gz@r{[}=@var{type}@r{]}
7711 @opindex gz
7712 Produce compressed debug sections in DWARF format, if that is supported.
7713 If @var{type} is not given, the default type depends on the capabilities
7714 of the assembler and linker used.  @var{type} may be one of
7715 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7716 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7717 compression in traditional GNU format).  If the linker doesn't support
7718 writing compressed debug sections, the option is rejected.  Otherwise,
7719 if the assembler does not support them, @option{-gz} is silently ignored
7720 when producing object files.
7722 @item -femit-struct-debug-baseonly
7723 @opindex femit-struct-debug-baseonly
7724 Emit debug information for struct-like types
7725 only when the base name of the compilation source file
7726 matches the base name of file in which the struct is defined.
7728 This option substantially reduces the size of debugging information,
7729 but at significant potential loss in type information to the debugger.
7730 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7731 See @option{-femit-struct-debug-detailed} for more detailed control.
7733 This option works only with DWARF debug output.
7735 @item -femit-struct-debug-reduced
7736 @opindex femit-struct-debug-reduced
7737 Emit debug information for struct-like types
7738 only when the base name of the compilation source file
7739 matches the base name of file in which the type is defined,
7740 unless the struct is a template or defined in a system header.
7742 This option significantly reduces the size of debugging information,
7743 with some potential loss in type information to the debugger.
7744 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7745 See @option{-femit-struct-debug-detailed} for more detailed control.
7747 This option works only with DWARF debug output.
7749 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7750 @opindex femit-struct-debug-detailed
7751 Specify the struct-like types
7752 for which the compiler generates debug information.
7753 The intent is to reduce duplicate struct debug information
7754 between different object files within the same program.
7756 This option is a detailed version of
7757 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7758 which serves for most needs.
7760 A specification has the syntax@*
7761 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7763 The optional first word limits the specification to
7764 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7765 A struct type is used directly when it is the type of a variable, member.
7766 Indirect uses arise through pointers to structs.
7767 That is, when use of an incomplete struct is valid, the use is indirect.
7768 An example is
7769 @samp{struct one direct; struct two * indirect;}.
7771 The optional second word limits the specification to
7772 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7773 Generic structs are a bit complicated to explain.
7774 For C++, these are non-explicit specializations of template classes,
7775 or non-template classes within the above.
7776 Other programming languages have generics,
7777 but @option{-femit-struct-debug-detailed} does not yet implement them.
7779 The third word specifies the source files for those
7780 structs for which the compiler should emit debug information.
7781 The values @samp{none} and @samp{any} have the normal meaning.
7782 The value @samp{base} means that
7783 the base of name of the file in which the type declaration appears
7784 must match the base of the name of the main compilation file.
7785 In practice, this means that when compiling @file{foo.c}, debug information
7786 is generated for types declared in that file and @file{foo.h},
7787 but not other header files.
7788 The value @samp{sys} means those types satisfying @samp{base}
7789 or declared in system or compiler headers.
7791 You may need to experiment to determine the best settings for your application.
7793 The default is @option{-femit-struct-debug-detailed=all}.
7795 This option works only with DWARF debug output.
7797 @item -fno-dwarf2-cfi-asm
7798 @opindex fdwarf2-cfi-asm
7799 @opindex fno-dwarf2-cfi-asm
7800 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7801 instead of using GAS @code{.cfi_*} directives.
7803 @item -fno-eliminate-unused-debug-types
7804 @opindex feliminate-unused-debug-types
7805 @opindex fno-eliminate-unused-debug-types
7806 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7807 output for types that are nowhere used in the source file being compiled.
7808 Sometimes it is useful to have GCC emit debugging
7809 information for all types declared in a compilation
7810 unit, regardless of whether or not they are actually used
7811 in that compilation unit, for example 
7812 if, in the debugger, you want to cast a value to a type that is
7813 not actually used in your program (but is declared).  More often,
7814 however, this results in a significant amount of wasted space.
7815 @end table
7817 @node Optimize Options
7818 @section Options That Control Optimization
7819 @cindex optimize options
7820 @cindex options, optimization
7822 These options control various sorts of optimizations.
7824 Without any optimization option, the compiler's goal is to reduce the
7825 cost of compilation and to make debugging produce the expected
7826 results.  Statements are independent: if you stop the program with a
7827 breakpoint between statements, you can then assign a new value to any
7828 variable or change the program counter to any other statement in the
7829 function and get exactly the results you expect from the source
7830 code.
7832 Turning on optimization flags makes the compiler attempt to improve
7833 the performance and/or code size at the expense of compilation time
7834 and possibly the ability to debug the program.
7836 The compiler performs optimization based on the knowledge it has of the
7837 program.  Compiling multiple files at once to a single output file mode allows
7838 the compiler to use information gained from all of the files when compiling
7839 each of them.
7841 Not all optimizations are controlled directly by a flag.  Only
7842 optimizations that have a flag are listed in this section.
7844 Most optimizations are only enabled if an @option{-O} level is set on
7845 the command line.  Otherwise they are disabled, even if individual
7846 optimization flags are specified.
7848 Depending on the target and how GCC was configured, a slightly different
7849 set of optimizations may be enabled at each @option{-O} level than
7850 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7851 to find out the exact set of optimizations that are enabled at each level.
7852 @xref{Overall Options}, for examples.
7854 @table @gcctabopt
7855 @item -O
7856 @itemx -O1
7857 @opindex O
7858 @opindex O1
7859 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7860 more memory for a large function.
7862 With @option{-O}, the compiler tries to reduce code size and execution
7863 time, without performing any optimizations that take a great deal of
7864 compilation time.
7866 @option{-O} turns on the following optimization flags:
7867 @gccoptlist{
7868 -fauto-inc-dec @gol
7869 -fbranch-count-reg @gol
7870 -fcombine-stack-adjustments @gol
7871 -fcompare-elim @gol
7872 -fcprop-registers @gol
7873 -fdce @gol
7874 -fdefer-pop @gol
7875 -fdelayed-branch @gol
7876 -fdse @gol
7877 -fforward-propagate @gol
7878 -fguess-branch-probability @gol
7879 -fif-conversion2 @gol
7880 -fif-conversion @gol
7881 -finline-functions-called-once @gol
7882 -fipa-pure-const @gol
7883 -fipa-profile @gol
7884 -fipa-reference @gol
7885 -fmerge-constants @gol
7886 -fmove-loop-invariants @gol
7887 -fomit-frame-pointer @gol
7888 -freorder-blocks @gol
7889 -fshrink-wrap @gol
7890 -fshrink-wrap-separate @gol
7891 -fsplit-wide-types @gol
7892 -fssa-backprop @gol
7893 -fssa-phiopt @gol
7894 -ftree-bit-ccp @gol
7895 -ftree-ccp @gol
7896 -ftree-ch @gol
7897 -ftree-coalesce-vars @gol
7898 -ftree-copy-prop @gol
7899 -ftree-dce @gol
7900 -ftree-dominator-opts @gol
7901 -ftree-dse @gol
7902 -ftree-forwprop @gol
7903 -ftree-fre @gol
7904 -ftree-phiprop @gol
7905 -ftree-scev-cprop @gol
7906 -ftree-sink @gol
7907 -ftree-slsr @gol
7908 -ftree-sra @gol
7909 -ftree-pta @gol
7910 -ftree-ter @gol
7911 -funit-at-a-time}
7913 @item -O2
7914 @opindex O2
7915 Optimize even more.  GCC performs nearly all supported optimizations
7916 that do not involve a space-speed tradeoff.
7917 As compared to @option{-O}, this option increases both compilation time
7918 and the performance of the generated code.
7920 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7921 also turns on the following optimization flags:
7922 @gccoptlist{-fthread-jumps @gol
7923 -falign-functions  -falign-jumps @gol
7924 -falign-loops  -falign-labels @gol
7925 -fcaller-saves @gol
7926 -fcrossjumping @gol
7927 -fcse-follow-jumps  -fcse-skip-blocks @gol
7928 -fdelete-null-pointer-checks @gol
7929 -fdevirtualize -fdevirtualize-speculatively @gol
7930 -fexpensive-optimizations @gol
7931 -fgcse  -fgcse-lm  @gol
7932 -fhoist-adjacent-loads @gol
7933 -finline-small-functions @gol
7934 -findirect-inlining @gol
7935 -fipa-cp @gol
7936 -fipa-bit-cp @gol
7937 -fipa-vrp @gol
7938 -fipa-sra @gol
7939 -fipa-icf @gol
7940 -fisolate-erroneous-paths-dereference @gol
7941 -flra-remat @gol
7942 -foptimize-sibling-calls @gol
7943 -foptimize-strlen @gol
7944 -fpartial-inlining @gol
7945 -fpeephole2 @gol
7946 -freorder-blocks-algorithm=stc @gol
7947 -freorder-blocks-and-partition -freorder-functions @gol
7948 -frerun-cse-after-loop  @gol
7949 -fsched-interblock  -fsched-spec @gol
7950 -fschedule-insns  -fschedule-insns2 @gol
7951 -fstore-merging @gol
7952 -fstrict-aliasing @gol
7953 -ftree-builtin-call-dce @gol
7954 -ftree-switch-conversion -ftree-tail-merge @gol
7955 -fcode-hoisting @gol
7956 -ftree-pre @gol
7957 -ftree-vrp @gol
7958 -fipa-ra}
7960 Please note the warning under @option{-fgcse} about
7961 invoking @option{-O2} on programs that use computed gotos.
7963 @item -O3
7964 @opindex O3
7965 Optimize yet more.  @option{-O3} turns on all optimizations specified
7966 by @option{-O2} and also turns on the following optimization flags:
7967 @gccoptlist{-finline-functions @gol
7968 -funswitch-loops @gol
7969 -fpredictive-commoning @gol
7970 -fgcse-after-reload @gol
7971 -ftree-loop-vectorize @gol
7972 -ftree-loop-distribution @gol
7973 -ftree-loop-distribute-patterns @gol
7974 -floop-interchange @gol
7975 -floop-unroll-and-jam @gol
7976 -fsplit-paths @gol
7977 -ftree-slp-vectorize @gol
7978 -fvect-cost-model @gol
7979 -ftree-partial-pre @gol
7980 -fpeel-loops @gol
7981 -fipa-cp-clone}
7983 @item -O0
7984 @opindex O0
7985 Reduce compilation time and make debugging produce the expected
7986 results.  This is the default.
7988 @item -Os
7989 @opindex Os
7990 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7991 do not typically increase code size.  It also performs further
7992 optimizations designed to reduce code size.
7994 @option{-Os} disables the following optimization flags:
7995 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7996 -falign-labels  -fprefetch-loop-arrays}
7998 @item -Ofast
7999 @opindex Ofast
8000 Disregard strict standards compliance.  @option{-Ofast} enables all
8001 @option{-O3} optimizations.  It also enables optimizations that are not
8002 valid for all standard-compliant programs.
8003 It turns on @option{-ffast-math} and the Fortran-specific
8004 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
8005 specified, and @option{-fno-protect-parens}.
8007 @item -Og
8008 @opindex Og
8009 Optimize debugging experience.  @option{-Og} enables optimizations
8010 that do not interfere with debugging. It should be the optimization
8011 level of choice for the standard edit-compile-debug cycle, offering
8012 a reasonable level of optimization while maintaining fast compilation
8013 and a good debugging experience.
8014 @end table
8016 If you use multiple @option{-O} options, with or without level numbers,
8017 the last such option is the one that is effective.
8019 Options of the form @option{-f@var{flag}} specify machine-independent
8020 flags.  Most flags have both positive and negative forms; the negative
8021 form of @option{-ffoo} is @option{-fno-foo}.  In the table
8022 below, only one of the forms is listed---the one you typically 
8023 use.  You can figure out the other form by either removing @samp{no-}
8024 or adding it.
8026 The following options control specific optimizations.  They are either
8027 activated by @option{-O} options or are related to ones that are.  You
8028 can use the following flags in the rare cases when ``fine-tuning'' of
8029 optimizations to be performed is desired.
8031 @table @gcctabopt
8032 @item -fno-defer-pop
8033 @opindex fno-defer-pop
8034 Always pop the arguments to each function call as soon as that function
8035 returns.  For machines that must pop arguments after a function call,
8036 the compiler normally lets arguments accumulate on the stack for several
8037 function calls and pops them all at once.
8039 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8041 @item -fforward-propagate
8042 @opindex fforward-propagate
8043 Perform a forward propagation pass on RTL@.  The pass tries to combine two
8044 instructions and checks if the result can be simplified.  If loop unrolling
8045 is active, two passes are performed and the second is scheduled after
8046 loop unrolling.
8048 This option is enabled by default at optimization levels @option{-O},
8049 @option{-O2}, @option{-O3}, @option{-Os}.
8051 @item -ffp-contract=@var{style}
8052 @opindex ffp-contract
8053 @option{-ffp-contract=off} disables floating-point expression contraction.
8054 @option{-ffp-contract=fast} enables floating-point expression contraction
8055 such as forming of fused multiply-add operations if the target has
8056 native support for them.
8057 @option{-ffp-contract=on} enables floating-point expression contraction
8058 if allowed by the language standard.  This is currently not implemented
8059 and treated equal to @option{-ffp-contract=off}.
8061 The default is @option{-ffp-contract=fast}.
8063 @item -fomit-frame-pointer
8064 @opindex fomit-frame-pointer
8065 Omit the frame pointer in functions that don't need one.  This avoids the
8066 instructions to save, set up and restore the frame pointer; on many targets
8067 it also makes an extra register available.
8069 On some targets this flag has no effect because the standard calling sequence
8070 always uses a frame pointer, so it cannot be omitted.
8072 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
8073 is used in all functions.  Several targets always omit the frame pointer in
8074 leaf functions.
8076 Enabled by default at @option{-O} and higher.
8078 @item -foptimize-sibling-calls
8079 @opindex foptimize-sibling-calls
8080 Optimize sibling and tail recursive calls.
8082 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8084 @item -foptimize-strlen
8085 @opindex foptimize-strlen
8086 Optimize various standard C string functions (e.g.@: @code{strlen},
8087 @code{strchr} or @code{strcpy}) and
8088 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
8090 Enabled at levels @option{-O2}, @option{-O3}.
8092 @item -fno-inline
8093 @opindex fno-inline
8094 Do not expand any functions inline apart from those marked with
8095 the @code{always_inline} attribute.  This is the default when not
8096 optimizing.
8098 Single functions can be exempted from inlining by marking them
8099 with the @code{noinline} attribute.
8101 @item -finline-small-functions
8102 @opindex finline-small-functions
8103 Integrate functions into their callers when their body is smaller than expected
8104 function call code (so overall size of program gets smaller).  The compiler
8105 heuristically decides which functions are simple enough to be worth integrating
8106 in this way.  This inlining applies to all functions, even those not declared
8107 inline.
8109 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8111 @item -findirect-inlining
8112 @opindex findirect-inlining
8113 Inline also indirect calls that are discovered to be known at compile
8114 time thanks to previous inlining.  This option has any effect only
8115 when inlining itself is turned on by the @option{-finline-functions}
8116 or @option{-finline-small-functions} options.
8118 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8120 @item -finline-functions
8121 @opindex finline-functions
8122 Consider all functions for inlining, even if they are not declared inline.
8123 The compiler heuristically decides which functions are worth integrating
8124 in this way.
8126 If all calls to a given function are integrated, and the function is
8127 declared @code{static}, then the function is normally not output as
8128 assembler code in its own right.
8130 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8132 @item -finline-functions-called-once
8133 @opindex finline-functions-called-once
8134 Consider all @code{static} functions called once for inlining into their
8135 caller even if they are not marked @code{inline}.  If a call to a given
8136 function is integrated, then the function is not output as assembler code
8137 in its own right.
8139 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
8141 @item -fearly-inlining
8142 @opindex fearly-inlining
8143 Inline functions marked by @code{always_inline} and functions whose body seems
8144 smaller than the function call overhead early before doing
8145 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
8146 makes profiling significantly cheaper and usually inlining faster on programs
8147 having large chains of nested wrapper functions.
8149 Enabled by default.
8151 @item -fipa-sra
8152 @opindex fipa-sra
8153 Perform interprocedural scalar replacement of aggregates, removal of
8154 unused parameters and replacement of parameters passed by reference
8155 by parameters passed by value.
8157 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
8159 @item -finline-limit=@var{n}
8160 @opindex finline-limit
8161 By default, GCC limits the size of functions that can be inlined.  This flag
8162 allows coarse control of this limit.  @var{n} is the size of functions that
8163 can be inlined in number of pseudo instructions.
8165 Inlining is actually controlled by a number of parameters, which may be
8166 specified individually by using @option{--param @var{name}=@var{value}}.
8167 The @option{-finline-limit=@var{n}} option sets some of these parameters
8168 as follows:
8170 @table @gcctabopt
8171 @item max-inline-insns-single
8172 is set to @var{n}/2.
8173 @item max-inline-insns-auto
8174 is set to @var{n}/2.
8175 @end table
8177 See below for a documentation of the individual
8178 parameters controlling inlining and for the defaults of these parameters.
8180 @emph{Note:} there may be no value to @option{-finline-limit} that results
8181 in default behavior.
8183 @emph{Note:} pseudo instruction represents, in this particular context, an
8184 abstract measurement of function's size.  In no way does it represent a count
8185 of assembly instructions and as such its exact meaning might change from one
8186 release to an another.
8188 @item -fno-keep-inline-dllexport
8189 @opindex fno-keep-inline-dllexport
8190 This is a more fine-grained version of @option{-fkeep-inline-functions},
8191 which applies only to functions that are declared using the @code{dllexport}
8192 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
8193 Functions}.
8195 @item -fkeep-inline-functions
8196 @opindex fkeep-inline-functions
8197 In C, emit @code{static} functions that are declared @code{inline}
8198 into the object file, even if the function has been inlined into all
8199 of its callers.  This switch does not affect functions using the
8200 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
8201 inline functions into the object file.
8203 @item -fkeep-static-functions
8204 @opindex fkeep-static-functions
8205 Emit @code{static} functions into the object file, even if the function
8206 is never used.
8208 @item -fkeep-static-consts
8209 @opindex fkeep-static-consts
8210 Emit variables declared @code{static const} when optimization isn't turned
8211 on, even if the variables aren't referenced.
8213 GCC enables this option by default.  If you want to force the compiler to
8214 check if a variable is referenced, regardless of whether or not
8215 optimization is turned on, use the @option{-fno-keep-static-consts} option.
8217 @item -fmerge-constants
8218 @opindex fmerge-constants
8219 Attempt to merge identical constants (string constants and floating-point
8220 constants) across compilation units.
8222 This option is the default for optimized compilation if the assembler and
8223 linker support it.  Use @option{-fno-merge-constants} to inhibit this
8224 behavior.
8226 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8228 @item -fmerge-all-constants
8229 @opindex fmerge-all-constants
8230 Attempt to merge identical constants and identical variables.
8232 This option implies @option{-fmerge-constants}.  In addition to
8233 @option{-fmerge-constants} this considers e.g.@: even constant initialized
8234 arrays or initialized constant variables with integral or floating-point
8235 types.  Languages like C or C++ require each variable, including multiple
8236 instances of the same variable in recursive calls, to have distinct locations,
8237 so using this option results in non-conforming
8238 behavior.
8240 @item -fmodulo-sched
8241 @opindex fmodulo-sched
8242 Perform swing modulo scheduling immediately before the first scheduling
8243 pass.  This pass looks at innermost loops and reorders their
8244 instructions by overlapping different iterations.
8246 @item -fmodulo-sched-allow-regmoves
8247 @opindex fmodulo-sched-allow-regmoves
8248 Perform more aggressive SMS-based modulo scheduling with register moves
8249 allowed.  By setting this flag certain anti-dependences edges are
8250 deleted, which triggers the generation of reg-moves based on the
8251 life-range analysis.  This option is effective only with
8252 @option{-fmodulo-sched} enabled.
8254 @item -fno-branch-count-reg
8255 @opindex fno-branch-count-reg
8256 Avoid running a pass scanning for opportunities to use ``decrement and
8257 branch'' instructions on a count register instead of generating sequences
8258 of instructions that decrement a register, compare it against zero, and
8259 then branch based upon the result.  This option is only meaningful on
8260 architectures that support such instructions, which include x86, PowerPC,
8261 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
8262 doesn't remove the decrement and branch instructions from the generated
8263 instruction stream introduced by other optimization passes.
8265 Enabled by default at @option{-O1} and higher.
8267 The default is @option{-fbranch-count-reg}.
8269 @item -fno-function-cse
8270 @opindex fno-function-cse
8271 Do not put function addresses in registers; make each instruction that
8272 calls a constant function contain the function's address explicitly.
8274 This option results in less efficient code, but some strange hacks
8275 that alter the assembler output may be confused by the optimizations
8276 performed when this option is not used.
8278 The default is @option{-ffunction-cse}
8280 @item -fno-zero-initialized-in-bss
8281 @opindex fno-zero-initialized-in-bss
8282 If the target supports a BSS section, GCC by default puts variables that
8283 are initialized to zero into BSS@.  This can save space in the resulting
8284 code.
8286 This option turns off this behavior because some programs explicitly
8287 rely on variables going to the data section---e.g., so that the
8288 resulting executable can find the beginning of that section and/or make
8289 assumptions based on that.
8291 The default is @option{-fzero-initialized-in-bss}.
8293 @item -fthread-jumps
8294 @opindex fthread-jumps
8295 Perform optimizations that check to see if a jump branches to a
8296 location where another comparison subsumed by the first is found.  If
8297 so, the first branch is redirected to either the destination of the
8298 second branch or a point immediately following it, depending on whether
8299 the condition is known to be true or false.
8301 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8303 @item -fsplit-wide-types
8304 @opindex fsplit-wide-types
8305 When using a type that occupies multiple registers, such as @code{long
8306 long} on a 32-bit system, split the registers apart and allocate them
8307 independently.  This normally generates better code for those types,
8308 but may make debugging more difficult.
8310 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8311 @option{-Os}.
8313 @item -fcse-follow-jumps
8314 @opindex fcse-follow-jumps
8315 In common subexpression elimination (CSE), scan through jump instructions
8316 when the target of the jump is not reached by any other path.  For
8317 example, when CSE encounters an @code{if} statement with an
8318 @code{else} clause, CSE follows the jump when the condition
8319 tested is false.
8321 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8323 @item -fcse-skip-blocks
8324 @opindex fcse-skip-blocks
8325 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8326 follow jumps that conditionally skip over blocks.  When CSE
8327 encounters a simple @code{if} statement with no else clause,
8328 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8329 body of the @code{if}.
8331 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8333 @item -frerun-cse-after-loop
8334 @opindex frerun-cse-after-loop
8335 Re-run common subexpression elimination after loop optimizations are
8336 performed.
8338 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8340 @item -fgcse
8341 @opindex fgcse
8342 Perform a global common subexpression elimination pass.
8343 This pass also performs global constant and copy propagation.
8345 @emph{Note:} When compiling a program using computed gotos, a GCC
8346 extension, you may get better run-time performance if you disable
8347 the global common subexpression elimination pass by adding
8348 @option{-fno-gcse} to the command line.
8350 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8352 @item -fgcse-lm
8353 @opindex fgcse-lm
8354 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8355 attempts to move loads that are only killed by stores into themselves.  This
8356 allows a loop containing a load/store sequence to be changed to a load outside
8357 the loop, and a copy/store within the loop.
8359 Enabled by default when @option{-fgcse} is enabled.
8361 @item -fgcse-sm
8362 @opindex fgcse-sm
8363 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8364 global common subexpression elimination.  This pass attempts to move
8365 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8366 loops containing a load/store sequence can be changed to a load before
8367 the loop and a store after the loop.
8369 Not enabled at any optimization level.
8371 @item -fgcse-las
8372 @opindex fgcse-las
8373 When @option{-fgcse-las} is enabled, the global common subexpression
8374 elimination pass eliminates redundant loads that come after stores to the
8375 same memory location (both partial and full redundancies).
8377 Not enabled at any optimization level.
8379 @item -fgcse-after-reload
8380 @opindex fgcse-after-reload
8381 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8382 pass is performed after reload.  The purpose of this pass is to clean up
8383 redundant spilling.
8385 @item -faggressive-loop-optimizations
8386 @opindex faggressive-loop-optimizations
8387 This option tells the loop optimizer to use language constraints to
8388 derive bounds for the number of iterations of a loop.  This assumes that
8389 loop code does not invoke undefined behavior by for example causing signed
8390 integer overflows or out-of-bound array accesses.  The bounds for the
8391 number of iterations of a loop are used to guide loop unrolling and peeling
8392 and loop exit test optimizations.
8393 This option is enabled by default.
8395 @item -funconstrained-commons
8396 @opindex funconstrained-commons
8397 This option tells the compiler that variables declared in common blocks
8398 (e.g.@: Fortran) may later be overridden with longer trailing arrays. This
8399 prevents certain optimizations that depend on knowing the array bounds.
8401 @item -fcrossjumping
8402 @opindex fcrossjumping
8403 Perform cross-jumping transformation.
8404 This transformation unifies equivalent code and saves code size.  The
8405 resulting code may or may not perform better than without cross-jumping.
8407 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8409 @item -fauto-inc-dec
8410 @opindex fauto-inc-dec
8411 Combine increments or decrements of addresses with memory accesses.
8412 This pass is always skipped on architectures that do not have
8413 instructions to support this.  Enabled by default at @option{-O} and
8414 higher on architectures that support this.
8416 @item -fdce
8417 @opindex fdce
8418 Perform dead code elimination (DCE) on RTL@.
8419 Enabled by default at @option{-O} and higher.
8421 @item -fdse
8422 @opindex fdse
8423 Perform dead store elimination (DSE) on RTL@.
8424 Enabled by default at @option{-O} and higher.
8426 @item -fif-conversion
8427 @opindex fif-conversion
8428 Attempt to transform conditional jumps into branch-less equivalents.  This
8429 includes use of conditional moves, min, max, set flags and abs instructions, and
8430 some tricks doable by standard arithmetics.  The use of conditional execution
8431 on chips where it is available is controlled by @option{-fif-conversion2}.
8433 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8435 @item -fif-conversion2
8436 @opindex fif-conversion2
8437 Use conditional execution (where available) to transform conditional jumps into
8438 branch-less equivalents.
8440 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8442 @item -fdeclone-ctor-dtor
8443 @opindex fdeclone-ctor-dtor
8444 The C++ ABI requires multiple entry points for constructors and
8445 destructors: one for a base subobject, one for a complete object, and
8446 one for a virtual destructor that calls operator delete afterwards.
8447 For a hierarchy with virtual bases, the base and complete variants are
8448 clones, which means two copies of the function.  With this option, the
8449 base and complete variants are changed to be thunks that call a common
8450 implementation.
8452 Enabled by @option{-Os}.
8454 @item -fdelete-null-pointer-checks
8455 @opindex fdelete-null-pointer-checks
8456 Assume that programs cannot safely dereference null pointers, and that
8457 no code or data element resides at address zero.
8458 This option enables simple constant
8459 folding optimizations at all optimization levels.  In addition, other
8460 optimization passes in GCC use this flag to control global dataflow
8461 analyses that eliminate useless checks for null pointers; these assume
8462 that a memory access to address zero always results in a trap, so
8463 that if a pointer is checked after it has already been dereferenced,
8464 it cannot be null.
8466 Note however that in some environments this assumption is not true.
8467 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8468 for programs that depend on that behavior.
8470 This option is enabled by default on most targets.  On Nios II ELF, it
8471 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8473 Passes that use the dataflow information
8474 are enabled independently at different optimization levels.
8476 @item -fdevirtualize
8477 @opindex fdevirtualize
8478 Attempt to convert calls to virtual functions to direct calls.  This
8479 is done both within a procedure and interprocedurally as part of
8480 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8481 propagation (@option{-fipa-cp}).
8482 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8484 @item -fdevirtualize-speculatively
8485 @opindex fdevirtualize-speculatively
8486 Attempt to convert calls to virtual functions to speculative direct calls.
8487 Based on the analysis of the type inheritance graph, determine for a given call
8488 the set of likely targets. If the set is small, preferably of size 1, change
8489 the call into a conditional deciding between direct and indirect calls.  The
8490 speculative calls enable more optimizations, such as inlining.  When they seem
8491 useless after further optimization, they are converted back into original form.
8493 @item -fdevirtualize-at-ltrans
8494 @opindex fdevirtualize-at-ltrans
8495 Stream extra information needed for aggressive devirtualization when running
8496 the link-time optimizer in local transformation mode.  
8497 This option enables more devirtualization but
8498 significantly increases the size of streamed data. For this reason it is
8499 disabled by default.
8501 @item -fexpensive-optimizations
8502 @opindex fexpensive-optimizations
8503 Perform a number of minor optimizations that are relatively expensive.
8505 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8507 @item -free
8508 @opindex free
8509 Attempt to remove redundant extension instructions.  This is especially
8510 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8511 registers after writing to their lower 32-bit half.
8513 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8514 @option{-O3}, @option{-Os}.
8516 @item -fno-lifetime-dse
8517 @opindex fno-lifetime-dse
8518 In C++ the value of an object is only affected by changes within its
8519 lifetime: when the constructor begins, the object has an indeterminate
8520 value, and any changes during the lifetime of the object are dead when
8521 the object is destroyed.  Normally dead store elimination will take
8522 advantage of this; if your code relies on the value of the object
8523 storage persisting beyond the lifetime of the object, you can use this
8524 flag to disable this optimization.  To preserve stores before the
8525 constructor starts (e.g.@: because your operator new clears the object
8526 storage) but still treat the object as dead after the destructor you,
8527 can use @option{-flifetime-dse=1}.  The default behavior can be
8528 explicitly selected with @option{-flifetime-dse=2}.
8529 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8531 @item -flive-range-shrinkage
8532 @opindex flive-range-shrinkage
8533 Attempt to decrease register pressure through register live range
8534 shrinkage.  This is helpful for fast processors with small or moderate
8535 size register sets.
8537 @item -fira-algorithm=@var{algorithm}
8538 @opindex fira-algorithm
8539 Use the specified coloring algorithm for the integrated register
8540 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8541 specifies Chow's priority coloring, or @samp{CB}, which specifies
8542 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8543 for all architectures, but for those targets that do support it, it is
8544 the default because it generates better code.
8546 @item -fira-region=@var{region}
8547 @opindex fira-region
8548 Use specified regions for the integrated register allocator.  The
8549 @var{region} argument should be one of the following:
8551 @table @samp
8553 @item all
8554 Use all loops as register allocation regions.
8555 This can give the best results for machines with a small and/or
8556 irregular register set.
8558 @item mixed
8559 Use all loops except for loops with small register pressure 
8560 as the regions.  This value usually gives
8561 the best results in most cases and for most architectures,
8562 and is enabled by default when compiling with optimization for speed
8563 (@option{-O}, @option{-O2}, @dots{}).
8565 @item one
8566 Use all functions as a single region.  
8567 This typically results in the smallest code size, and is enabled by default for
8568 @option{-Os} or @option{-O0}.
8570 @end table
8572 @item -fira-hoist-pressure
8573 @opindex fira-hoist-pressure
8574 Use IRA to evaluate register pressure in the code hoisting pass for
8575 decisions to hoist expressions.  This option usually results in smaller
8576 code, but it can slow the compiler down.
8578 This option is enabled at level @option{-Os} for all targets.
8580 @item -fira-loop-pressure
8581 @opindex fira-loop-pressure
8582 Use IRA to evaluate register pressure in loops for decisions to move
8583 loop invariants.  This option usually results in generation
8584 of faster and smaller code on machines with large register files (>= 32
8585 registers), but it can slow the compiler down.
8587 This option is enabled at level @option{-O3} for some targets.
8589 @item -fno-ira-share-save-slots
8590 @opindex fno-ira-share-save-slots
8591 Disable sharing of stack slots used for saving call-used hard
8592 registers living through a call.  Each hard register gets a
8593 separate stack slot, and as a result function stack frames are
8594 larger.
8596 @item -fno-ira-share-spill-slots
8597 @opindex fno-ira-share-spill-slots
8598 Disable sharing of stack slots allocated for pseudo-registers.  Each
8599 pseudo-register that does not get a hard register gets a separate
8600 stack slot, and as a result function stack frames are larger.
8602 @item -flra-remat
8603 @opindex flra-remat
8604 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8605 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8606 values if it is profitable.
8608 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8610 @item -fdelayed-branch
8611 @opindex fdelayed-branch
8612 If supported for the target machine, attempt to reorder instructions
8613 to exploit instruction slots available after delayed branch
8614 instructions.
8616 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os},
8617 but not at @option{-Og}.
8619 @item -fschedule-insns
8620 @opindex fschedule-insns
8621 If supported for the target machine, attempt to reorder instructions to
8622 eliminate execution stalls due to required data being unavailable.  This
8623 helps machines that have slow floating point or memory load instructions
8624 by allowing other instructions to be issued until the result of the load
8625 or floating-point instruction is required.
8627 Enabled at levels @option{-O2}, @option{-O3}.
8629 @item -fschedule-insns2
8630 @opindex fschedule-insns2
8631 Similar to @option{-fschedule-insns}, but requests an additional pass of
8632 instruction scheduling after register allocation has been done.  This is
8633 especially useful on machines with a relatively small number of
8634 registers and where memory load instructions take more than one cycle.
8636 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8638 @item -fno-sched-interblock
8639 @opindex fno-sched-interblock
8640 Disable instruction scheduling across basic blocks, which
8641 is normally enabled when scheduling before register allocation, i.e.@:
8642 with @option{-fschedule-insns} or at @option{-O2} or higher.
8644 @item -fno-sched-spec
8645 @opindex fno-sched-spec
8646 Disable speculative motion of non-load instructions, which
8647 is normally enabled when scheduling before register allocation, i.e.@:
8648 with @option{-fschedule-insns} or at @option{-O2} or higher.
8650 @item -fsched-pressure
8651 @opindex fsched-pressure
8652 Enable register pressure sensitive insn scheduling before register
8653 allocation.  This only makes sense when scheduling before register
8654 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8655 @option{-O2} or higher.  Usage of this option can improve the
8656 generated code and decrease its size by preventing register pressure
8657 increase above the number of available hard registers and subsequent
8658 spills in register allocation.
8660 @item -fsched-spec-load
8661 @opindex fsched-spec-load
8662 Allow speculative motion of some load instructions.  This only makes
8663 sense when scheduling before register allocation, i.e.@: with
8664 @option{-fschedule-insns} or at @option{-O2} or higher.
8666 @item -fsched-spec-load-dangerous
8667 @opindex fsched-spec-load-dangerous
8668 Allow speculative motion of more load instructions.  This only makes
8669 sense when scheduling before register allocation, i.e.@: with
8670 @option{-fschedule-insns} or at @option{-O2} or higher.
8672 @item -fsched-stalled-insns
8673 @itemx -fsched-stalled-insns=@var{n}
8674 @opindex fsched-stalled-insns
8675 Define how many insns (if any) can be moved prematurely from the queue
8676 of stalled insns into the ready list during the second scheduling pass.
8677 @option{-fno-sched-stalled-insns} means that no insns are moved
8678 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8679 on how many queued insns can be moved prematurely.
8680 @option{-fsched-stalled-insns} without a value is equivalent to
8681 @option{-fsched-stalled-insns=1}.
8683 @item -fsched-stalled-insns-dep
8684 @itemx -fsched-stalled-insns-dep=@var{n}
8685 @opindex fsched-stalled-insns-dep
8686 Define how many insn groups (cycles) are examined for a dependency
8687 on a stalled insn that is a candidate for premature removal from the queue
8688 of stalled insns.  This has an effect only during the second scheduling pass,
8689 and only if @option{-fsched-stalled-insns} is used.
8690 @option{-fno-sched-stalled-insns-dep} is equivalent to
8691 @option{-fsched-stalled-insns-dep=0}.
8692 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8693 @option{-fsched-stalled-insns-dep=1}.
8695 @item -fsched2-use-superblocks
8696 @opindex fsched2-use-superblocks
8697 When scheduling after register allocation, use superblock scheduling.
8698 This allows motion across basic block boundaries,
8699 resulting in faster schedules.  This option is experimental, as not all machine
8700 descriptions used by GCC model the CPU closely enough to avoid unreliable
8701 results from the algorithm.
8703 This only makes sense when scheduling after register allocation, i.e.@: with
8704 @option{-fschedule-insns2} or at @option{-O2} or higher.
8706 @item -fsched-group-heuristic
8707 @opindex fsched-group-heuristic
8708 Enable the group heuristic in the scheduler.  This heuristic favors
8709 the instruction that belongs to a schedule group.  This is enabled
8710 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8711 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8713 @item -fsched-critical-path-heuristic
8714 @opindex fsched-critical-path-heuristic
8715 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8716 instructions on the critical path.  This is enabled by default when
8717 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8718 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8720 @item -fsched-spec-insn-heuristic
8721 @opindex fsched-spec-insn-heuristic
8722 Enable the speculative instruction heuristic in the scheduler.  This
8723 heuristic favors speculative instructions with greater dependency weakness.
8724 This is enabled by default when scheduling is enabled, i.e.@:
8725 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8726 or at @option{-O2} or higher.
8728 @item -fsched-rank-heuristic
8729 @opindex fsched-rank-heuristic
8730 Enable the rank heuristic in the scheduler.  This heuristic favors
8731 the instruction belonging to a basic block with greater size or frequency.
8732 This is enabled by default when scheduling is enabled, i.e.@:
8733 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8734 at @option{-O2} or higher.
8736 @item -fsched-last-insn-heuristic
8737 @opindex fsched-last-insn-heuristic
8738 Enable the last-instruction heuristic in the scheduler.  This heuristic
8739 favors the instruction that is less dependent on the last instruction
8740 scheduled.  This is enabled by default when scheduling is enabled,
8741 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8742 at @option{-O2} or higher.
8744 @item -fsched-dep-count-heuristic
8745 @opindex fsched-dep-count-heuristic
8746 Enable the dependent-count heuristic in the scheduler.  This heuristic
8747 favors the instruction that has more instructions depending on it.
8748 This is enabled by default when scheduling is enabled, i.e.@:
8749 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8750 at @option{-O2} or higher.
8752 @item -freschedule-modulo-scheduled-loops
8753 @opindex freschedule-modulo-scheduled-loops
8754 Modulo scheduling is performed before traditional scheduling.  If a loop
8755 is modulo scheduled, later scheduling passes may change its schedule.  
8756 Use this option to control that behavior.
8758 @item -fselective-scheduling
8759 @opindex fselective-scheduling
8760 Schedule instructions using selective scheduling algorithm.  Selective
8761 scheduling runs instead of the first scheduler pass.
8763 @item -fselective-scheduling2
8764 @opindex fselective-scheduling2
8765 Schedule instructions using selective scheduling algorithm.  Selective
8766 scheduling runs instead of the second scheduler pass.
8768 @item -fsel-sched-pipelining
8769 @opindex fsel-sched-pipelining
8770 Enable software pipelining of innermost loops during selective scheduling.
8771 This option has no effect unless one of @option{-fselective-scheduling} or
8772 @option{-fselective-scheduling2} is turned on.
8774 @item -fsel-sched-pipelining-outer-loops
8775 @opindex fsel-sched-pipelining-outer-loops
8776 When pipelining loops during selective scheduling, also pipeline outer loops.
8777 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8779 @item -fsemantic-interposition
8780 @opindex fsemantic-interposition
8781 Some object formats, like ELF, allow interposing of symbols by the 
8782 dynamic linker.
8783 This means that for symbols exported from the DSO, the compiler cannot perform
8784 interprocedural propagation, inlining and other optimizations in anticipation
8785 that the function or variable in question may change. While this feature is
8786 useful, for example, to rewrite memory allocation functions by a debugging
8787 implementation, it is expensive in the terms of code quality.
8788 With @option{-fno-semantic-interposition} the compiler assumes that 
8789 if interposition happens for functions the overwriting function will have 
8790 precisely the same semantics (and side effects). 
8791 Similarly if interposition happens
8792 for variables, the constructor of the variable will be the same. The flag
8793 has no effect for functions explicitly declared inline 
8794 (where it is never allowed for interposition to change semantics) 
8795 and for symbols explicitly declared weak.
8797 @item -fshrink-wrap
8798 @opindex fshrink-wrap
8799 Emit function prologues only before parts of the function that need it,
8800 rather than at the top of the function.  This flag is enabled by default at
8801 @option{-O} and higher.
8803 @item -fshrink-wrap-separate
8804 @opindex fshrink-wrap-separate
8805 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8806 those parts are only executed when needed.
8807 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8808 is also turned on and the target supports this.
8810 @item -fcaller-saves
8811 @opindex fcaller-saves
8812 Enable allocation of values to registers that are clobbered by
8813 function calls, by emitting extra instructions to save and restore the
8814 registers around such calls.  Such allocation is done only when it
8815 seems to result in better code.
8817 This option is always enabled by default on certain machines, usually
8818 those which have no call-preserved registers to use instead.
8820 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8822 @item -fcombine-stack-adjustments
8823 @opindex fcombine-stack-adjustments
8824 Tracks stack adjustments (pushes and pops) and stack memory references
8825 and then tries to find ways to combine them.
8827 Enabled by default at @option{-O1} and higher.
8829 @item -fipa-ra
8830 @opindex fipa-ra
8831 Use caller save registers for allocation if those registers are not used by
8832 any called function.  In that case it is not necessary to save and restore
8833 them around calls.  This is only possible if called functions are part of
8834 same compilation unit as current function and they are compiled before it.
8836 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8837 is disabled if generated code will be instrumented for profiling
8838 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8839 exactly (this happens on targets that do not expose prologues
8840 and epilogues in RTL).
8842 @item -fconserve-stack
8843 @opindex fconserve-stack
8844 Attempt to minimize stack usage.  The compiler attempts to use less
8845 stack space, even if that makes the program slower.  This option
8846 implies setting the @option{large-stack-frame} parameter to 100
8847 and the @option{large-stack-frame-growth} parameter to 400.
8849 @item -ftree-reassoc
8850 @opindex ftree-reassoc
8851 Perform reassociation on trees.  This flag is enabled by default
8852 at @option{-O} and higher.
8854 @item -fcode-hoisting
8855 @opindex fcode-hoisting
8856 Perform code hoisting.  Code hoisting tries to move the
8857 evaluation of expressions executed on all paths to the function exit
8858 as early as possible.  This is especially useful as a code size
8859 optimization, but it often helps for code speed as well.
8860 This flag is enabled by default at @option{-O2} and higher.
8862 @item -ftree-pre
8863 @opindex ftree-pre
8864 Perform partial redundancy elimination (PRE) on trees.  This flag is
8865 enabled by default at @option{-O2} and @option{-O3}.
8867 @item -ftree-partial-pre
8868 @opindex ftree-partial-pre
8869 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8870 enabled by default at @option{-O3}.
8872 @item -ftree-forwprop
8873 @opindex ftree-forwprop
8874 Perform forward propagation on trees.  This flag is enabled by default
8875 at @option{-O} and higher.
8877 @item -ftree-fre
8878 @opindex ftree-fre
8879 Perform full redundancy elimination (FRE) on trees.  The difference
8880 between FRE and PRE is that FRE only considers expressions
8881 that are computed on all paths leading to the redundant computation.
8882 This analysis is faster than PRE, though it exposes fewer redundancies.
8883 This flag is enabled by default at @option{-O} and higher.
8885 @item -ftree-phiprop
8886 @opindex ftree-phiprop
8887 Perform hoisting of loads from conditional pointers on trees.  This
8888 pass is enabled by default at @option{-O} and higher.
8890 @item -fhoist-adjacent-loads
8891 @opindex fhoist-adjacent-loads
8892 Speculatively hoist loads from both branches of an if-then-else if the
8893 loads are from adjacent locations in the same structure and the target
8894 architecture has a conditional move instruction.  This flag is enabled
8895 by default at @option{-O2} and higher.
8897 @item -ftree-copy-prop
8898 @opindex ftree-copy-prop
8899 Perform copy propagation on trees.  This pass eliminates unnecessary
8900 copy operations.  This flag is enabled by default at @option{-O} and
8901 higher.
8903 @item -fipa-pure-const
8904 @opindex fipa-pure-const
8905 Discover which functions are pure or constant.
8906 Enabled by default at @option{-O} and higher.
8908 @item -fipa-reference
8909 @opindex fipa-reference
8910 Discover which static variables do not escape the
8911 compilation unit.
8912 Enabled by default at @option{-O} and higher.
8914 @item -fipa-pta
8915 @opindex fipa-pta
8916 Perform interprocedural pointer analysis and interprocedural modification
8917 and reference analysis.  This option can cause excessive memory and
8918 compile-time usage on large compilation units.  It is not enabled by
8919 default at any optimization level.
8921 @item -fipa-profile
8922 @opindex fipa-profile
8923 Perform interprocedural profile propagation.  The functions called only from
8924 cold functions are marked as cold. Also functions executed once (such as
8925 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8926 functions and loop less parts of functions executed once are then optimized for
8927 size.
8928 Enabled by default at @option{-O} and higher.
8930 @item -fipa-cp
8931 @opindex fipa-cp
8932 Perform interprocedural constant propagation.
8933 This optimization analyzes the program to determine when values passed
8934 to functions are constants and then optimizes accordingly.
8935 This optimization can substantially increase performance
8936 if the application has constants passed to functions.
8937 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8939 @item -fipa-cp-clone
8940 @opindex fipa-cp-clone
8941 Perform function cloning to make interprocedural constant propagation stronger.
8942 When enabled, interprocedural constant propagation performs function cloning
8943 when externally visible function can be called with constant arguments.
8944 Because this optimization can create multiple copies of functions,
8945 it may significantly increase code size
8946 (see @option{--param ipcp-unit-growth=@var{value}}).
8947 This flag is enabled by default at @option{-O3}.
8949 @item -fipa-bit-cp
8950 @opindex fipa-bit-cp
8951 When enabled, perform interprocedural bitwise constant
8952 propagation. This flag is enabled by default at @option{-O2}. It
8953 requires that @option{-fipa-cp} is enabled.
8955 @item -fipa-vrp
8956 @opindex fipa-vrp
8957 When enabled, perform interprocedural propagation of value
8958 ranges. This flag is enabled by default at @option{-O2}. It requires
8959 that @option{-fipa-cp} is enabled.
8961 @item -fipa-icf
8962 @opindex fipa-icf
8963 Perform Identical Code Folding for functions and read-only variables.
8964 The optimization reduces code size and may disturb unwind stacks by replacing
8965 a function by equivalent one with a different name. The optimization works
8966 more effectively with link-time optimization enabled.
8968 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8969 works on different levels and thus the optimizations are not same - there are
8970 equivalences that are found only by GCC and equivalences found only by Gold.
8972 This flag is enabled by default at @option{-O2} and @option{-Os}.
8974 @item -fisolate-erroneous-paths-dereference
8975 @opindex fisolate-erroneous-paths-dereference
8976 Detect paths that trigger erroneous or undefined behavior due to
8977 dereferencing a null pointer.  Isolate those paths from the main control
8978 flow and turn the statement with erroneous or undefined behavior into a trap.
8979 This flag is enabled by default at @option{-O2} and higher and depends on
8980 @option{-fdelete-null-pointer-checks} also being enabled.
8982 @item -fisolate-erroneous-paths-attribute
8983 @opindex fisolate-erroneous-paths-attribute
8984 Detect paths that trigger erroneous or undefined behavior due to a null value
8985 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8986 attribute.  Isolate those paths from the main control flow and turn the
8987 statement with erroneous or undefined behavior into a trap.  This is not
8988 currently enabled, but may be enabled by @option{-O2} in the future.
8990 @item -ftree-sink
8991 @opindex ftree-sink
8992 Perform forward store motion on trees.  This flag is
8993 enabled by default at @option{-O} and higher.
8995 @item -ftree-bit-ccp
8996 @opindex ftree-bit-ccp
8997 Perform sparse conditional bit constant propagation on trees and propagate
8998 pointer alignment information.
8999 This pass only operates on local scalar variables and is enabled by default
9000 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
9002 @item -ftree-ccp
9003 @opindex ftree-ccp
9004 Perform sparse conditional constant propagation (CCP) on trees.  This
9005 pass only operates on local scalar variables and is enabled by default
9006 at @option{-O} and higher.
9008 @item -fssa-backprop
9009 @opindex fssa-backprop
9010 Propagate information about uses of a value up the definition chain
9011 in order to simplify the definitions.  For example, this pass strips
9012 sign operations if the sign of a value never matters.  The flag is
9013 enabled by default at @option{-O} and higher.
9015 @item -fssa-phiopt
9016 @opindex fssa-phiopt
9017 Perform pattern matching on SSA PHI nodes to optimize conditional
9018 code.  This pass is enabled by default at @option{-O} and higher.
9020 @item -ftree-switch-conversion
9021 @opindex ftree-switch-conversion
9022 Perform conversion of simple initializations in a switch to
9023 initializations from a scalar array.  This flag is enabled by default
9024 at @option{-O2} and higher.
9026 @item -ftree-tail-merge
9027 @opindex ftree-tail-merge
9028 Look for identical code sequences.  When found, replace one with a jump to the
9029 other.  This optimization is known as tail merging or cross jumping.  This flag
9030 is enabled by default at @option{-O2} and higher.  The compilation time
9031 in this pass can
9032 be limited using @option{max-tail-merge-comparisons} parameter and
9033 @option{max-tail-merge-iterations} parameter.
9035 @item -ftree-dce
9036 @opindex ftree-dce
9037 Perform dead code elimination (DCE) on trees.  This flag is enabled by
9038 default at @option{-O} and higher.
9040 @item -ftree-builtin-call-dce
9041 @opindex ftree-builtin-call-dce
9042 Perform conditional dead code elimination (DCE) for calls to built-in functions
9043 that may set @code{errno} but are otherwise free of side effects.  This flag is
9044 enabled by default at @option{-O2} and higher if @option{-Os} is not also
9045 specified.
9047 @item -ftree-dominator-opts
9048 @opindex ftree-dominator-opts
9049 Perform a variety of simple scalar cleanups (constant/copy
9050 propagation, redundancy elimination, range propagation and expression
9051 simplification) based on a dominator tree traversal.  This also
9052 performs jump threading (to reduce jumps to jumps). This flag is
9053 enabled by default at @option{-O} and higher.
9055 @item -ftree-dse
9056 @opindex ftree-dse
9057 Perform dead store elimination (DSE) on trees.  A dead store is a store into
9058 a memory location that is later overwritten by another store without
9059 any intervening loads.  In this case the earlier store can be deleted.  This
9060 flag is enabled by default at @option{-O} and higher.
9062 @item -ftree-ch
9063 @opindex ftree-ch
9064 Perform loop header copying on trees.  This is beneficial since it increases
9065 effectiveness of code motion optimizations.  It also saves one jump.  This flag
9066 is enabled by default at @option{-O} and higher.  It is not enabled
9067 for @option{-Os}, since it usually increases code size.
9069 @item -ftree-loop-optimize
9070 @opindex ftree-loop-optimize
9071 Perform loop optimizations on trees.  This flag is enabled by default
9072 at @option{-O} and higher.
9074 @item -ftree-loop-linear
9075 @itemx -floop-strip-mine
9076 @itemx -floop-block
9077 @opindex ftree-loop-linear
9078 @opindex floop-strip-mine
9079 @opindex floop-block
9080 Perform loop nest optimizations.  Same as
9081 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
9082 to be configured with @option{--with-isl} to enable the Graphite loop
9083 transformation infrastructure.
9085 @item -fgraphite-identity
9086 @opindex fgraphite-identity
9087 Enable the identity transformation for graphite.  For every SCoP we generate
9088 the polyhedral representation and transform it back to gimple.  Using
9089 @option{-fgraphite-identity} we can check the costs or benefits of the
9090 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
9091 are also performed by the code generator isl, like index splitting and
9092 dead code elimination in loops.
9094 @item -floop-nest-optimize
9095 @opindex floop-nest-optimize
9096 Enable the isl based loop nest optimizer.  This is a generic loop nest
9097 optimizer based on the Pluto optimization algorithms.  It calculates a loop
9098 structure optimized for data-locality and parallelism.  This option
9099 is experimental.
9101 @item -floop-parallelize-all
9102 @opindex floop-parallelize-all
9103 Use the Graphite data dependence analysis to identify loops that can
9104 be parallelized.  Parallelize all the loops that can be analyzed to
9105 not contain loop carried dependences without checking that it is
9106 profitable to parallelize the loops.
9108 @item -ftree-coalesce-vars
9109 @opindex ftree-coalesce-vars
9110 While transforming the program out of the SSA representation, attempt to
9111 reduce copying by coalescing versions of different user-defined
9112 variables, instead of just compiler temporaries.  This may severely
9113 limit the ability to debug an optimized program compiled with
9114 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
9115 prevents SSA coalescing of user variables.  This option is enabled by
9116 default if optimization is enabled, and it does very little otherwise.
9118 @item -ftree-loop-if-convert
9119 @opindex ftree-loop-if-convert
9120 Attempt to transform conditional jumps in the innermost loops to
9121 branch-less equivalents.  The intent is to remove control-flow from
9122 the innermost loops in order to improve the ability of the
9123 vectorization pass to handle these loops.  This is enabled by default
9124 if vectorization is enabled.
9126 @item -ftree-loop-distribution
9127 @opindex ftree-loop-distribution
9128 Perform loop distribution.  This flag can improve cache performance on
9129 big loop bodies and allow further loop optimizations, like
9130 parallelization or vectorization, to take place.  For example, the loop
9131 @smallexample
9132 DO I = 1, N
9133   A(I) = B(I) + C
9134   D(I) = E(I) * F
9135 ENDDO
9136 @end smallexample
9137 is transformed to
9138 @smallexample
9139 DO I = 1, N
9140    A(I) = B(I) + C
9141 ENDDO
9142 DO I = 1, N
9143    D(I) = E(I) * F
9144 ENDDO
9145 @end smallexample
9147 @item -ftree-loop-distribute-patterns
9148 @opindex ftree-loop-distribute-patterns
9149 Perform loop distribution of patterns that can be code generated with
9150 calls to a library.  This flag is enabled by default at @option{-O3}.
9152 This pass distributes the initialization loops and generates a call to
9153 memset zero.  For example, the loop
9154 @smallexample
9155 DO I = 1, N
9156   A(I) = 0
9157   B(I) = A(I) + I
9158 ENDDO
9159 @end smallexample
9160 is transformed to
9161 @smallexample
9162 DO I = 1, N
9163    A(I) = 0
9164 ENDDO
9165 DO I = 1, N
9166    B(I) = A(I) + I
9167 ENDDO
9168 @end smallexample
9169 and the initialization loop is transformed into a call to memset zero.
9171 @item -floop-interchange
9172 @opindex floop-interchange
9173 Perform loop interchange outside of graphite.  This flag can improve cache
9174 performance on loop nest and allow further loop optimizations, like
9175 vectorization, to take place.  For example, the loop
9176 @smallexample
9177 for (int i = 0; i < N; i++)
9178   for (int j = 0; j < N; j++)
9179     for (int k = 0; k < N; k++)
9180       c[i][j] = c[i][j] + a[i][k]*b[k][j];
9181 @end smallexample
9182 is transformed to
9183 @smallexample
9184 for (int i = 0; i < N; i++)
9185   for (int k = 0; k < N; k++)
9186     for (int j = 0; j < N; j++)
9187       c[i][j] = c[i][j] + a[i][k]*b[k][j];
9188 @end smallexample
9189 This flag is enabled by default at @option{-O3}.
9191 @item -floop-unroll-and-jam
9192 @opindex floop-unroll-and-jam
9193 Apply unroll and jam transformations on feasible loops.  In a loop
9194 nest this unrolls the outer loop by some factor and fuses the resulting
9195 multiple inner loops.  This flag is enabled by default at @option{-O3}.
9197 @item -ftree-loop-im
9198 @opindex ftree-loop-im
9199 Perform loop invariant motion on trees.  This pass moves only invariants that
9200 are hard to handle at RTL level (function calls, operations that expand to
9201 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
9202 operands of conditions that are invariant out of the loop, so that we can use
9203 just trivial invariantness analysis in loop unswitching.  The pass also includes
9204 store motion.
9206 @item -ftree-loop-ivcanon
9207 @opindex ftree-loop-ivcanon
9208 Create a canonical counter for number of iterations in loops for which
9209 determining number of iterations requires complicated analysis.  Later
9210 optimizations then may determine the number easily.  Useful especially
9211 in connection with unrolling.
9213 @item -ftree-scev-cprop
9214 @opindex ftree-scev-cprop
9215 Perform final value replacement.  If a variable is modified in a loop
9216 in such a way that its value when exiting the loop can be determined using
9217 only its initial value and the number of loop iterations, replace uses of
9218 the final value by such a computation, provided it is sufficiently cheap.
9219 This reduces data dependencies and may allow further simplifications.
9220 Enabled by default at @option{-O} and higher.
9222 @item -fivopts
9223 @opindex fivopts
9224 Perform induction variable optimizations (strength reduction, induction
9225 variable merging and induction variable elimination) on trees.
9227 @item -ftree-parallelize-loops=n
9228 @opindex ftree-parallelize-loops
9229 Parallelize loops, i.e., split their iteration space to run in n threads.
9230 This is only possible for loops whose iterations are independent
9231 and can be arbitrarily reordered.  The optimization is only
9232 profitable on multiprocessor machines, for loops that are CPU-intensive,
9233 rather than constrained e.g.@: by memory bandwidth.  This option
9234 implies @option{-pthread}, and thus is only supported on targets
9235 that have support for @option{-pthread}.
9237 @item -ftree-pta
9238 @opindex ftree-pta
9239 Perform function-local points-to analysis on trees.  This flag is
9240 enabled by default at @option{-O} and higher.
9242 @item -ftree-sra
9243 @opindex ftree-sra
9244 Perform scalar replacement of aggregates.  This pass replaces structure
9245 references with scalars to prevent committing structures to memory too
9246 early.  This flag is enabled by default at @option{-O} and higher.
9248 @item -fstore-merging
9249 @opindex fstore-merging
9250 Perform merging of narrow stores to consecutive memory addresses.  This pass
9251 merges contiguous stores of immediate values narrower than a word into fewer
9252 wider stores to reduce the number of instructions.  This is enabled by default
9253 at @option{-O2} and higher as well as @option{-Os}.
9255 @item -ftree-ter
9256 @opindex ftree-ter
9257 Perform temporary expression replacement during the SSA->normal phase.  Single
9258 use/single def temporaries are replaced at their use location with their
9259 defining expression.  This results in non-GIMPLE code, but gives the expanders
9260 much more complex trees to work on resulting in better RTL generation.  This is
9261 enabled by default at @option{-O} and higher.
9263 @item -ftree-slsr
9264 @opindex ftree-slsr
9265 Perform straight-line strength reduction on trees.  This recognizes related
9266 expressions involving multiplications and replaces them by less expensive
9267 calculations when possible.  This is enabled by default at @option{-O} and
9268 higher.
9270 @item -ftree-vectorize
9271 @opindex ftree-vectorize
9272 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
9273 and @option{-ftree-slp-vectorize} if not explicitly specified.
9275 @item -ftree-loop-vectorize
9276 @opindex ftree-loop-vectorize
9277 Perform loop vectorization on trees. This flag is enabled by default at
9278 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9280 @item -ftree-slp-vectorize
9281 @opindex ftree-slp-vectorize
9282 Perform basic block vectorization on trees. This flag is enabled by default at
9283 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9285 @item -fvect-cost-model=@var{model}
9286 @opindex fvect-cost-model
9287 Alter the cost model used for vectorization.  The @var{model} argument
9288 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
9289 With the @samp{unlimited} model the vectorized code-path is assumed
9290 to be profitable while with the @samp{dynamic} model a runtime check
9291 guards the vectorized code-path to enable it only for iteration
9292 counts that will likely execute faster than when executing the original
9293 scalar loop.  The @samp{cheap} model disables vectorization of
9294 loops where doing so would be cost prohibitive for example due to
9295 required runtime checks for data dependence or alignment but otherwise
9296 is equal to the @samp{dynamic} model.
9297 The default cost model depends on other optimization flags and is
9298 either @samp{dynamic} or @samp{cheap}.
9300 @item -fsimd-cost-model=@var{model}
9301 @opindex fsimd-cost-model
9302 Alter the cost model used for vectorization of loops marked with the OpenMP
9303 simd directive.  The @var{model} argument should be one of
9304 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9305 have the same meaning as described in @option{-fvect-cost-model} and by
9306 default a cost model defined with @option{-fvect-cost-model} is used.
9308 @item -ftree-vrp
9309 @opindex ftree-vrp
9310 Perform Value Range Propagation on trees.  This is similar to the
9311 constant propagation pass, but instead of values, ranges of values are
9312 propagated.  This allows the optimizers to remove unnecessary range
9313 checks like array bound checks and null pointer checks.  This is
9314 enabled by default at @option{-O2} and higher.  Null pointer check
9315 elimination is only done if @option{-fdelete-null-pointer-checks} is
9316 enabled.
9318 @item -fsplit-paths
9319 @opindex fsplit-paths
9320 Split paths leading to loop backedges.  This can improve dead code
9321 elimination and common subexpression elimination.  This is enabled by
9322 default at @option{-O2} and above.
9324 @item -fsplit-ivs-in-unroller
9325 @opindex fsplit-ivs-in-unroller
9326 Enables expression of values of induction variables in later iterations
9327 of the unrolled loop using the value in the first iteration.  This breaks
9328 long dependency chains, thus improving efficiency of the scheduling passes.
9330 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9331 same effect.  However, that is not reliable in cases where the loop body
9332 is more complicated than a single basic block.  It also does not work at all
9333 on some architectures due to restrictions in the CSE pass.
9335 This optimization is enabled by default.
9337 @item -fvariable-expansion-in-unroller
9338 @opindex fvariable-expansion-in-unroller
9339 With this option, the compiler creates multiple copies of some
9340 local variables when unrolling a loop, which can result in superior code.
9342 @item -fpartial-inlining
9343 @opindex fpartial-inlining
9344 Inline parts of functions.  This option has any effect only
9345 when inlining itself is turned on by the @option{-finline-functions}
9346 or @option{-finline-small-functions} options.
9348 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9350 @item -fpredictive-commoning
9351 @opindex fpredictive-commoning
9352 Perform predictive commoning optimization, i.e., reusing computations
9353 (especially memory loads and stores) performed in previous
9354 iterations of loops.
9356 This option is enabled at level @option{-O3}.
9358 @item -fprefetch-loop-arrays
9359 @opindex fprefetch-loop-arrays
9360 If supported by the target machine, generate instructions to prefetch
9361 memory to improve the performance of loops that access large arrays.
9363 This option may generate better or worse code; results are highly
9364 dependent on the structure of loops within the source code.
9366 Disabled at level @option{-Os}.
9368 @item -fno-printf-return-value
9369 @opindex fno-printf-return-value
9370 Do not substitute constants for known return value of formatted output
9371 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9372 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9373 transformation allows GCC to optimize or even eliminate branches based
9374 on the known return value of these functions called with arguments that
9375 are either constant, or whose values are known to be in a range that
9376 makes determining the exact return value possible.  For example, when
9377 @option{-fprintf-return-value} is in effect, both the branch and the
9378 body of the @code{if} statement (but not the call to @code{snprint})
9379 can be optimized away when @code{i} is a 32-bit or smaller integer
9380 because the return value is guaranteed to be at most 8.
9382 @smallexample
9383 char buf[9];
9384 if (snprintf (buf, "%08x", i) >= sizeof buf)
9385   @dots{}
9386 @end smallexample
9388 The @option{-fprintf-return-value} option relies on other optimizations
9389 and yields best results with @option{-O2} and above.  It works in tandem
9390 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9391 options.  The @option{-fprintf-return-value} option is enabled by default.
9393 @item -fno-peephole
9394 @itemx -fno-peephole2
9395 @opindex fno-peephole
9396 @opindex fno-peephole2
9397 Disable any machine-specific peephole optimizations.  The difference
9398 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9399 are implemented in the compiler; some targets use one, some use the
9400 other, a few use both.
9402 @option{-fpeephole} is enabled by default.
9403 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9405 @item -fno-guess-branch-probability
9406 @opindex fno-guess-branch-probability
9407 Do not guess branch probabilities using heuristics.
9409 GCC uses heuristics to guess branch probabilities if they are
9410 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9411 heuristics are based on the control flow graph.  If some branch probabilities
9412 are specified by @code{__builtin_expect}, then the heuristics are
9413 used to guess branch probabilities for the rest of the control flow graph,
9414 taking the @code{__builtin_expect} info into account.  The interactions
9415 between the heuristics and @code{__builtin_expect} can be complex, and in
9416 some cases, it may be useful to disable the heuristics so that the effects
9417 of @code{__builtin_expect} are easier to understand.
9419 It is also possible to specify expected probability of the expression
9420 with @code{__builtin_expect_with_probability} built-in function.
9422 The default is @option{-fguess-branch-probability} at levels
9423 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9425 @item -freorder-blocks
9426 @opindex freorder-blocks
9427 Reorder basic blocks in the compiled function in order to reduce number of
9428 taken branches and improve code locality.
9430 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9432 @item -freorder-blocks-algorithm=@var{algorithm}
9433 @opindex freorder-blocks-algorithm
9434 Use the specified algorithm for basic block reordering.  The
9435 @var{algorithm} argument can be @samp{simple}, which does not increase
9436 code size (except sometimes due to secondary effects like alignment),
9437 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9438 put all often executed code together, minimizing the number of branches
9439 executed by making extra copies of code.
9441 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9442 @samp{stc} at levels @option{-O2}, @option{-O3}.
9444 @item -freorder-blocks-and-partition
9445 @opindex freorder-blocks-and-partition
9446 In addition to reordering basic blocks in the compiled function, in order
9447 to reduce number of taken branches, partitions hot and cold basic blocks
9448 into separate sections of the assembly and @file{.o} files, to improve
9449 paging and cache locality performance.
9451 This optimization is automatically turned off in the presence of
9452 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9453 section attribute and on any architecture that does not support named
9454 sections.  When @option{-fsplit-stack} is used this option is not
9455 enabled by default (to avoid linker errors), but may be enabled
9456 explicitly (if using a working linker).
9458 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9460 @item -freorder-functions
9461 @opindex freorder-functions
9462 Reorder functions in the object file in order to
9463 improve code locality.  This is implemented by using special
9464 subsections @code{.text.hot} for most frequently executed functions and
9465 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9466 the linker so object file format must support named sections and linker must
9467 place them in a reasonable way.
9469 Also profile feedback must be available to make this option effective.  See
9470 @option{-fprofile-arcs} for details.
9472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9474 @item -fstrict-aliasing
9475 @opindex fstrict-aliasing
9476 Allow the compiler to assume the strictest aliasing rules applicable to
9477 the language being compiled.  For C (and C++), this activates
9478 optimizations based on the type of expressions.  In particular, an
9479 object of one type is assumed never to reside at the same address as an
9480 object of a different type, unless the types are almost the same.  For
9481 example, an @code{unsigned int} can alias an @code{int}, but not a
9482 @code{void*} or a @code{double}.  A character type may alias any other
9483 type.
9485 @anchor{Type-punning}Pay special attention to code like this:
9486 @smallexample
9487 union a_union @{
9488   int i;
9489   double d;
9492 int f() @{
9493   union a_union t;
9494   t.d = 3.0;
9495   return t.i;
9497 @end smallexample
9498 The practice of reading from a different union member than the one most
9499 recently written to (called ``type-punning'') is common.  Even with
9500 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9501 is accessed through the union type.  So, the code above works as
9502 expected.  @xref{Structures unions enumerations and bit-fields
9503 implementation}.  However, this code might not:
9504 @smallexample
9505 int f() @{
9506   union a_union t;
9507   int* ip;
9508   t.d = 3.0;
9509   ip = &t.i;
9510   return *ip;
9512 @end smallexample
9514 Similarly, access by taking the address, casting the resulting pointer
9515 and dereferencing the result has undefined behavior, even if the cast
9516 uses a union type, e.g.:
9517 @smallexample
9518 int f() @{
9519   double d = 3.0;
9520   return ((union a_union *) &d)->i;
9522 @end smallexample
9524 The @option{-fstrict-aliasing} option is enabled at levels
9525 @option{-O2}, @option{-O3}, @option{-Os}.
9527 @item -falign-functions
9528 @itemx -falign-functions=@var{n}
9529 @itemx -falign-functions=@var{n}:@var{m}
9530 @itemx -falign-functions=@var{n}:@var{m}:@var{n2}
9531 @itemx -falign-functions=@var{n}:@var{m}:@var{n2}:@var{m2}
9532 @opindex falign-functions
9533 Align the start of functions to the next power-of-two greater than
9534 @var{n}, skipping up to @var{m}-1 bytes.  This ensures that at least
9535 the first @var{m} bytes of the function can be fetched by the CPU
9536 without crossing an @var{n}-byte alignment boundary.
9538 If @var{m} is not specified, it defaults to @var{n}.
9540 Examples: @option{-falign-functions=32} aligns functions to the next
9541 32-byte boundary, @option{-falign-functions=24} aligns to the next
9542 32-byte boundary only if this can be done by skipping 23 bytes or less,
9543 @option{-falign-functions=32:7} aligns to the next
9544 32-byte boundary only if this can be done by skipping 6 bytes or less.
9546 The second pair of @var{n2}:@var{m2} values allows you to specify
9547 a secondary alignment: @option{-falign-functions=64:7:32:3} aligns to
9548 the next 64-byte boundary if this can be done by skipping 6 bytes or less,
9549 otherwise aligns to the next 32-byte boundary if this can be done
9550 by skipping 2 bytes or less.
9551 If @var{m2} is not specified, it defaults to @var{n2}.
9553 Some assemblers only support this flag when @var{n} is a power of two;
9554 in that case, it is rounded up.
9556 @option{-fno-align-functions} and @option{-falign-functions=1} are
9557 equivalent and mean that functions are not aligned.
9559 If @var{n} is not specified or is zero, use a machine-dependent default.
9560 The maximum allowed @var{n} option value is 65536.
9562 Enabled at levels @option{-O2}, @option{-O3}.
9564 @item -flimit-function-alignment
9565 If this option is enabled, the compiler tries to avoid unnecessarily
9566 overaligning functions. It attempts to instruct the assembler to align
9567 by the amount specified by @option{-falign-functions}, but not to
9568 skip more bytes than the size of the function.
9570 @item -falign-labels
9571 @itemx -falign-labels=@var{n}
9572 @itemx -falign-labels=@var{n}:@var{m}
9573 @itemx -falign-labels=@var{n}:@var{m}:@var{n2}
9574 @itemx -falign-labels=@var{n}:@var{m}:@var{n2}:@var{m2}
9575 @opindex falign-labels
9576 Align all branch targets to a power-of-two boundary.
9578 Parameters of this option are analogous to the @option{-falign-functions} option.
9579 @option{-fno-align-labels} and @option{-falign-labels=1} are
9580 equivalent and mean that labels are not aligned.
9582 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9583 are greater than this value, then their values are used instead.
9585 If @var{n} is not specified or is zero, use a machine-dependent default
9586 which is very likely to be @samp{1}, meaning no alignment.
9587 The maximum allowed @var{n} option value is 65536.
9589 Enabled at levels @option{-O2}, @option{-O3}.
9591 @item -falign-loops
9592 @itemx -falign-loops=@var{n}
9593 @itemx -falign-loops=@var{n}:@var{m}
9594 @itemx -falign-loops=@var{n}:@var{m}:@var{n2}
9595 @itemx -falign-loops=@var{n}:@var{m}:@var{n2}:@var{m2}
9596 @opindex falign-loops
9597 Align loops to a power-of-two boundary.  If the loops are executed
9598 many times, this makes up for any execution of the dummy padding
9599 instructions.
9601 Parameters of this option are analogous to the @option{-falign-functions} option.
9602 @option{-fno-align-loops} and @option{-falign-loops=1} are
9603 equivalent and mean that loops are not aligned.
9604 The maximum allowed @var{n} option value is 65536.
9606 If @var{n} is not specified or is zero, use a machine-dependent default.
9608 Enabled at levels @option{-O2}, @option{-O3}.
9610 @item -falign-jumps
9611 @itemx -falign-jumps=@var{n}
9612 @itemx -falign-jumps=@var{n}:@var{m}
9613 @itemx -falign-jumps=@var{n}:@var{m}:@var{n2}
9614 @itemx -falign-jumps=@var{n}:@var{m}:@var{n2}:@var{m2}
9615 @opindex falign-jumps
9616 Align branch targets to a power-of-two boundary, for branch targets
9617 where the targets can only be reached by jumping.  In this case,
9618 no dummy operations need be executed.
9620 Parameters of this option are analogous to the @option{-falign-functions} option.
9621 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9622 equivalent and mean that loops are not aligned.
9624 If @var{n} is not specified or is zero, use a machine-dependent default.
9625 The maximum allowed @var{n} option value is 65536.
9627 Enabled at levels @option{-O2}, @option{-O3}.
9629 @item -funit-at-a-time
9630 @opindex funit-at-a-time
9631 This option is left for compatibility reasons. @option{-funit-at-a-time}
9632 has no effect, while @option{-fno-unit-at-a-time} implies
9633 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9635 Enabled by default.
9637 @item -fno-toplevel-reorder
9638 @opindex fno-toplevel-reorder
9639 Do not reorder top-level functions, variables, and @code{asm}
9640 statements.  Output them in the same order that they appear in the
9641 input file.  When this option is used, unreferenced static variables
9642 are not removed.  This option is intended to support existing code
9643 that relies on a particular ordering.  For new code, it is better to
9644 use attributes when possible.
9646 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9647 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9648 targets.
9650 @item -fweb
9651 @opindex fweb
9652 Constructs webs as commonly used for register allocation purposes and assign
9653 each web individual pseudo register.  This allows the register allocation pass
9654 to operate on pseudos directly, but also strengthens several other optimization
9655 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9656 however, make debugging impossible, since variables no longer stay in a
9657 ``home register''.
9659 Enabled by default with @option{-funroll-loops}.
9661 @item -fwhole-program
9662 @opindex fwhole-program
9663 Assume that the current compilation unit represents the whole program being
9664 compiled.  All public functions and variables with the exception of @code{main}
9665 and those merged by attribute @code{externally_visible} become static functions
9666 and in effect are optimized more aggressively by interprocedural optimizers.
9668 This option should not be used in combination with @option{-flto}.
9669 Instead relying on a linker plugin should provide safer and more precise
9670 information.
9672 @item -flto[=@var{n}]
9673 @opindex flto
9674 This option runs the standard link-time optimizer.  When invoked
9675 with source code, it generates GIMPLE (one of GCC's internal
9676 representations) and writes it to special ELF sections in the object
9677 file.  When the object files are linked together, all the function
9678 bodies are read from these ELF sections and instantiated as if they
9679 had been part of the same translation unit.
9681 To use the link-time optimizer, @option{-flto} and optimization
9682 options should be specified at compile time and during the final link.
9683 It is recommended that you compile all the files participating in the
9684 same link with the same options and also specify those options at
9685 link time.  
9686 For example:
9688 @smallexample
9689 gcc -c -O2 -flto foo.c
9690 gcc -c -O2 -flto bar.c
9691 gcc -o myprog -flto -O2 foo.o bar.o
9692 @end smallexample
9694 The first two invocations to GCC save a bytecode representation
9695 of GIMPLE into special ELF sections inside @file{foo.o} and
9696 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9697 @file{foo.o} and @file{bar.o}, merges the two files into a single
9698 internal image, and compiles the result as usual.  Since both
9699 @file{foo.o} and @file{bar.o} are merged into a single image, this
9700 causes all the interprocedural analyses and optimizations in GCC to
9701 work across the two files as if they were a single one.  This means,
9702 for example, that the inliner is able to inline functions in
9703 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9705 Another (simpler) way to enable link-time optimization is:
9707 @smallexample
9708 gcc -o myprog -flto -O2 foo.c bar.c
9709 @end smallexample
9711 The above generates bytecode for @file{foo.c} and @file{bar.c},
9712 merges them together into a single GIMPLE representation and optimizes
9713 them as usual to produce @file{myprog}.
9715 The only important thing to keep in mind is that to enable link-time
9716 optimizations you need to use the GCC driver to perform the link step.
9717 GCC then automatically performs link-time optimization if any of the
9718 objects involved were compiled with the @option{-flto} command-line option.  
9719 You generally
9720 should specify the optimization options to be used for link-time
9721 optimization though GCC tries to be clever at guessing an
9722 optimization level to use from the options used at compile time
9723 if you fail to specify one at link time.  You can always override
9724 the automatic decision to do link-time optimization
9725 by passing @option{-fno-lto} to the link command.
9727 To make whole program optimization effective, it is necessary to make
9728 certain whole program assumptions.  The compiler needs to know
9729 what functions and variables can be accessed by libraries and runtime
9730 outside of the link-time optimized unit.  When supported by the linker,
9731 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9732 to the compiler about used and externally visible symbols.  When
9733 the linker plugin is not available, @option{-fwhole-program} should be
9734 used to allow the compiler to make these assumptions, which leads
9735 to more aggressive optimization decisions.
9737 When @option{-fuse-linker-plugin} is not enabled, when a file is
9738 compiled with @option{-flto}, the generated object file is larger than
9739 a regular object file because it contains GIMPLE bytecodes and the usual
9740 final code (see @option{-ffat-lto-objects}.  This means that
9741 object files with LTO information can be linked as normal object
9742 files; if @option{-fno-lto} is passed to the linker, no
9743 interprocedural optimizations are applied.  Note that when
9744 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9745 but you cannot perform a regular, non-LTO link on them.
9747 Additionally, the optimization flags used to compile individual files
9748 are not necessarily related to those used at link time.  For instance,
9750 @smallexample
9751 gcc -c -O0 -ffat-lto-objects -flto foo.c
9752 gcc -c -O0 -ffat-lto-objects -flto bar.c
9753 gcc -o myprog -O3 foo.o bar.o
9754 @end smallexample
9756 This produces individual object files with unoptimized assembler
9757 code, but the resulting binary @file{myprog} is optimized at
9758 @option{-O3}.  If, instead, the final binary is generated with
9759 @option{-fno-lto}, then @file{myprog} is not optimized.
9761 When producing the final binary, GCC only
9762 applies link-time optimizations to those files that contain bytecode.
9763 Therefore, you can mix and match object files and libraries with
9764 GIMPLE bytecodes and final object code.  GCC automatically selects
9765 which files to optimize in LTO mode and which files to link without
9766 further processing.
9768 There are some code generation flags preserved by GCC when
9769 generating bytecodes, as they need to be used during the final link
9770 stage.  Generally options specified at link time override those
9771 specified at compile time.
9773 If you do not specify an optimization level option @option{-O} at
9774 link time, then GCC uses the highest optimization level 
9775 used when compiling the object files.
9777 Currently, the following options and their settings are taken from
9778 the first object file that explicitly specifies them: 
9779 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9780 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9781 and all the @option{-m} target flags.
9783 Certain ABI-changing flags are required to match in all compilation units,
9784 and trying to override this at link time with a conflicting value
9785 is ignored.  This includes options such as @option{-freg-struct-return}
9786 and @option{-fpcc-struct-return}. 
9788 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9789 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9790 are passed through to the link stage and merged conservatively for
9791 conflicting translation units.  Specifically
9792 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9793 precedence; and for example @option{-ffp-contract=off} takes precedence
9794 over @option{-ffp-contract=fast}.  You can override them at link time.
9796 If LTO encounters objects with C linkage declared with incompatible
9797 types in separate translation units to be linked together (undefined
9798 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9799 issued.  The behavior is still undefined at run time.  Similar
9800 diagnostics may be raised for other languages.
9802 Another feature of LTO is that it is possible to apply interprocedural
9803 optimizations on files written in different languages:
9805 @smallexample
9806 gcc -c -flto foo.c
9807 g++ -c -flto bar.cc
9808 gfortran -c -flto baz.f90
9809 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9810 @end smallexample
9812 Notice that the final link is done with @command{g++} to get the C++
9813 runtime libraries and @option{-lgfortran} is added to get the Fortran
9814 runtime libraries.  In general, when mixing languages in LTO mode, you
9815 should use the same link command options as when mixing languages in a
9816 regular (non-LTO) compilation.
9818 If object files containing GIMPLE bytecode are stored in a library archive, say
9819 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9820 are using a linker with plugin support.  To create static libraries suitable
9821 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9822 and @command{ranlib}; 
9823 to show the symbols of object files with GIMPLE bytecode, use
9824 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9825 and @command{nm} have been compiled with plugin support.  At link time, use the
9826 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9827 the LTO optimization process:
9829 @smallexample
9830 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9831 @end smallexample
9833 With the linker plugin enabled, the linker extracts the needed
9834 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9835 to make them part of the aggregated GIMPLE image to be optimized.
9837 If you are not using a linker with plugin support and/or do not
9838 enable the linker plugin, then the objects inside @file{libfoo.a}
9839 are extracted and linked as usual, but they do not participate
9840 in the LTO optimization process.  In order to make a static library suitable
9841 for both LTO optimization and usual linkage, compile its object files with
9842 @option{-flto} @option{-ffat-lto-objects}.
9844 Link-time optimizations do not require the presence of the whole program to
9845 operate.  If the program does not require any symbols to be exported, it is
9846 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9847 the interprocedural optimizers to use more aggressive assumptions which may
9848 lead to improved optimization opportunities.
9849 Use of @option{-fwhole-program} is not needed when linker plugin is
9850 active (see @option{-fuse-linker-plugin}).
9852 The current implementation of LTO makes no
9853 attempt to generate bytecode that is portable between different
9854 types of hosts.  The bytecode files are versioned and there is a
9855 strict version check, so bytecode files generated in one version of
9856 GCC do not work with an older or newer version of GCC.
9858 Link-time optimization does not work well with generation of debugging
9859 information on systems other than those using a combination of ELF and
9860 DWARF.
9862 If you specify the optional @var{n}, the optimization and code
9863 generation done at link time is executed in parallel using @var{n}
9864 parallel jobs by utilizing an installed @command{make} program.  The
9865 environment variable @env{MAKE} may be used to override the program
9866 used.  The default value for @var{n} is 1.
9868 You can also specify @option{-flto=jobserver} to use GNU make's
9869 job server mode to determine the number of parallel jobs. This
9870 is useful when the Makefile calling GCC is already executing in parallel.
9871 You must prepend a @samp{+} to the command recipe in the parent Makefile
9872 for this to work.  This option likely only works if @env{MAKE} is
9873 GNU make.
9875 @item -flto-partition=@var{alg}
9876 @opindex flto-partition
9877 Specify the partitioning algorithm used by the link-time optimizer.
9878 The value is either @samp{1to1} to specify a partitioning mirroring
9879 the original source files or @samp{balanced} to specify partitioning
9880 into equally sized chunks (whenever possible) or @samp{max} to create
9881 new partition for every symbol where possible.  Specifying @samp{none}
9882 as an algorithm disables partitioning and streaming completely. 
9883 The default value is @samp{balanced}. While @samp{1to1} can be used
9884 as an workaround for various code ordering issues, the @samp{max}
9885 partitioning is intended for internal testing only.
9886 The value @samp{one} specifies that exactly one partition should be
9887 used while the value @samp{none} bypasses partitioning and executes
9888 the link-time optimization step directly from the WPA phase.
9890 @item -flto-odr-type-merging
9891 @opindex flto-odr-type-merging
9892 Enable streaming of mangled types names of C++ types and their unification
9893 at link time.  This increases size of LTO object files, but enables
9894 diagnostics about One Definition Rule violations.
9896 @item -flto-compression-level=@var{n}
9897 @opindex flto-compression-level
9898 This option specifies the level of compression used for intermediate
9899 language written to LTO object files, and is only meaningful in
9900 conjunction with LTO mode (@option{-flto}).  Valid
9901 values are 0 (no compression) to 9 (maximum compression).  Values
9902 outside this range are clamped to either 0 or 9.  If the option is not
9903 given, a default balanced compression setting is used.
9905 @item -fuse-linker-plugin
9906 @opindex fuse-linker-plugin
9907 Enables the use of a linker plugin during link-time optimization.  This
9908 option relies on plugin support in the linker, which is available in gold
9909 or in GNU ld 2.21 or newer.
9911 This option enables the extraction of object files with GIMPLE bytecode out
9912 of library archives. This improves the quality of optimization by exposing
9913 more code to the link-time optimizer.  This information specifies what
9914 symbols can be accessed externally (by non-LTO object or during dynamic
9915 linking).  Resulting code quality improvements on binaries (and shared
9916 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9917 See @option{-flto} for a description of the effect of this flag and how to
9918 use it.
9920 This option is enabled by default when LTO support in GCC is enabled
9921 and GCC was configured for use with
9922 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9924 @item -ffat-lto-objects
9925 @opindex ffat-lto-objects
9926 Fat LTO objects are object files that contain both the intermediate language
9927 and the object code. This makes them usable for both LTO linking and normal
9928 linking. This option is effective only when compiling with @option{-flto}
9929 and is ignored at link time.
9931 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9932 requires the complete toolchain to be aware of LTO. It requires a linker with
9933 linker plugin support for basic functionality.  Additionally,
9934 @command{nm}, @command{ar} and @command{ranlib}
9935 need to support linker plugins to allow a full-featured build environment
9936 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9937 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9938 to these tools. With non fat LTO makefiles need to be modified to use them.
9940 Note that modern binutils provide plugin auto-load mechanism.
9941 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9942 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9943 @command{gcc-ranlib}).
9945 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9946 support.
9948 @item -fcompare-elim
9949 @opindex fcompare-elim
9950 After register allocation and post-register allocation instruction splitting,
9951 identify arithmetic instructions that compute processor flags similar to a
9952 comparison operation based on that arithmetic.  If possible, eliminate the
9953 explicit comparison operation.
9955 This pass only applies to certain targets that cannot explicitly represent
9956 the comparison operation before register allocation is complete.
9958 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9960 @item -fcprop-registers
9961 @opindex fcprop-registers
9962 After register allocation and post-register allocation instruction splitting,
9963 perform a copy-propagation pass to try to reduce scheduling dependencies
9964 and occasionally eliminate the copy.
9966 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9968 @item -fprofile-correction
9969 @opindex fprofile-correction
9970 Profiles collected using an instrumented binary for multi-threaded programs may
9971 be inconsistent due to missed counter updates. When this option is specified,
9972 GCC uses heuristics to correct or smooth out such inconsistencies. By
9973 default, GCC emits an error message when an inconsistent profile is detected.
9975 @item -fprofile-use
9976 @itemx -fprofile-use=@var{path}
9977 @opindex fprofile-use
9978 Enable profile feedback-directed optimizations, 
9979 and the following optimizations
9980 which are generally profitable only with profile feedback available:
9981 @option{-fbranch-probabilities}, @option{-fvpt},
9982 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9983 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9985 Before you can use this option, you must first generate profiling information.
9986 @xref{Instrumentation Options}, for information about the
9987 @option{-fprofile-generate} option.
9989 By default, GCC emits an error message if the feedback profiles do not
9990 match the source code.  This error can be turned into a warning by using
9991 @option{-Wno-error=coverage-mismatch}.  Note this may result in poorly
9992 optimized code.  Additionally, by default, GCC also emits a warning message if
9993 the feedback profiles do not exist (See @option{-Wmissing-profile}).
9995 If @var{path} is specified, GCC looks at the @var{path} to find
9996 the profile feedback data files. See @option{-fprofile-dir}.
9998 @item -fauto-profile
9999 @itemx -fauto-profile=@var{path}
10000 @opindex fauto-profile
10001 Enable sampling-based feedback-directed optimizations, 
10002 and the following optimizations
10003 which are generally profitable only with profile feedback available:
10004 @option{-fbranch-probabilities}, @option{-fvpt},
10005 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
10006 @option{-ftree-vectorize},
10007 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
10008 @option{-fpredictive-commoning}, @option{-funswitch-loops},
10009 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
10011 @var{path} is the name of a file containing AutoFDO profile information.
10012 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
10014 Producing an AutoFDO profile data file requires running your program
10015 with the @command{perf} utility on a supported GNU/Linux target system.
10016 For more information, see @uref{https://perf.wiki.kernel.org/}.
10018 E.g.
10019 @smallexample
10020 perf record -e br_inst_retired:near_taken -b -o perf.data \
10021     -- your_program
10022 @end smallexample
10024 Then use the @command{create_gcov} tool to convert the raw profile data
10025 to a format that can be used by GCC.@  You must also supply the 
10026 unstripped binary for your program to this tool.  
10027 See @uref{https://github.com/google/autofdo}.
10029 E.g.
10030 @smallexample
10031 create_gcov --binary=your_program.unstripped --profile=perf.data \
10032     --gcov=profile.afdo
10033 @end smallexample
10034 @end table
10036 The following options control compiler behavior regarding floating-point 
10037 arithmetic.  These options trade off between speed and
10038 correctness.  All must be specifically enabled.
10040 @table @gcctabopt
10041 @item -ffloat-store
10042 @opindex ffloat-store
10043 Do not store floating-point variables in registers, and inhibit other
10044 options that might change whether a floating-point value is taken from a
10045 register or memory.
10047 @cindex floating-point precision
10048 This option prevents undesirable excess precision on machines such as
10049 the 68000 where the floating registers (of the 68881) keep more
10050 precision than a @code{double} is supposed to have.  Similarly for the
10051 x86 architecture.  For most programs, the excess precision does only
10052 good, but a few programs rely on the precise definition of IEEE floating
10053 point.  Use @option{-ffloat-store} for such programs, after modifying
10054 them to store all pertinent intermediate computations into variables.
10056 @item -fexcess-precision=@var{style}
10057 @opindex fexcess-precision
10058 This option allows further control over excess precision on machines
10059 where floating-point operations occur in a format with more precision or
10060 range than the IEEE standard and interchange floating-point types.  By
10061 default, @option{-fexcess-precision=fast} is in effect; this means that
10062 operations may be carried out in a wider precision than the types specified
10063 in the source if that would result in faster code, and it is unpredictable
10064 when rounding to the types specified in the source code takes place.
10065 When compiling C, if @option{-fexcess-precision=standard} is specified then
10066 excess precision follows the rules specified in ISO C99; in particular,
10067 both casts and assignments cause values to be rounded to their
10068 semantic types (whereas @option{-ffloat-store} only affects
10069 assignments).  This option is enabled by default for C if a strict
10070 conformance option such as @option{-std=c99} is used.
10071 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
10072 regardless of whether a strict conformance option is used.
10074 @opindex mfpmath
10075 @option{-fexcess-precision=standard} is not implemented for languages
10076 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
10077 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
10078 semantics apply without excess precision, and in the latter, rounding
10079 is unpredictable.
10081 @item -ffast-math
10082 @opindex ffast-math
10083 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
10084 @option{-ffinite-math-only}, @option{-fno-rounding-math},
10085 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
10086 @option{-fexcess-precision=fast}.
10088 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
10090 This option is not turned on by any @option{-O} option besides
10091 @option{-Ofast} since it can result in incorrect output for programs
10092 that depend on an exact implementation of IEEE or ISO rules/specifications
10093 for math functions. It may, however, yield faster code for programs
10094 that do not require the guarantees of these specifications.
10096 @item -fno-math-errno
10097 @opindex fno-math-errno
10098 Do not set @code{errno} after calling math functions that are executed
10099 with a single instruction, e.g., @code{sqrt}.  A program that relies on
10100 IEEE exceptions for math error handling may want to use this flag
10101 for speed while maintaining IEEE arithmetic compatibility.
10103 This option is not turned on by any @option{-O} option since
10104 it can result in incorrect output for programs that depend on
10105 an exact implementation of IEEE or ISO rules/specifications for
10106 math functions. It may, however, yield faster code for programs
10107 that do not require the guarantees of these specifications.
10109 The default is @option{-fmath-errno}.
10111 On Darwin systems, the math library never sets @code{errno}.  There is
10112 therefore no reason for the compiler to consider the possibility that
10113 it might, and @option{-fno-math-errno} is the default.
10115 @item -funsafe-math-optimizations
10116 @opindex funsafe-math-optimizations
10118 Allow optimizations for floating-point arithmetic that (a) assume
10119 that arguments and results are valid and (b) may violate IEEE or
10120 ANSI standards.  When used at link time, it may include libraries
10121 or startup files that change the default FPU control word or other
10122 similar optimizations.
10124 This option is not turned on by any @option{-O} option since
10125 it can result in incorrect output for programs that depend on
10126 an exact implementation of IEEE or ISO rules/specifications for
10127 math functions. It may, however, yield faster code for programs
10128 that do not require the guarantees of these specifications.
10129 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
10130 @option{-fassociative-math} and @option{-freciprocal-math}.
10132 The default is @option{-fno-unsafe-math-optimizations}.
10134 @item -fassociative-math
10135 @opindex fassociative-math
10137 Allow re-association of operands in series of floating-point operations.
10138 This violates the ISO C and C++ language standard by possibly changing
10139 computation result.  NOTE: re-ordering may change the sign of zero as
10140 well as ignore NaNs and inhibit or create underflow or overflow (and
10141 thus cannot be used on code that relies on rounding behavior like
10142 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
10143 and thus may not be used when ordered comparisons are required.
10144 This option requires that both @option{-fno-signed-zeros} and
10145 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
10146 much sense with @option{-frounding-math}. For Fortran the option
10147 is automatically enabled when both @option{-fno-signed-zeros} and
10148 @option{-fno-trapping-math} are in effect.
10150 The default is @option{-fno-associative-math}.
10152 @item -freciprocal-math
10153 @opindex freciprocal-math
10155 Allow the reciprocal of a value to be used instead of dividing by
10156 the value if this enables optimizations.  For example @code{x / y}
10157 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
10158 is subject to common subexpression elimination.  Note that this loses
10159 precision and increases the number of flops operating on the value.
10161 The default is @option{-fno-reciprocal-math}.
10163 @item -ffinite-math-only
10164 @opindex ffinite-math-only
10165 Allow optimizations for floating-point arithmetic that assume
10166 that arguments and results are not NaNs or +-Infs.
10168 This option is not turned on by any @option{-O} option since
10169 it can result in incorrect output for programs that depend on
10170 an exact implementation of IEEE or ISO rules/specifications for
10171 math functions. It may, however, yield faster code for programs
10172 that do not require the guarantees of these specifications.
10174 The default is @option{-fno-finite-math-only}.
10176 @item -fno-signed-zeros
10177 @opindex fno-signed-zeros
10178 Allow optimizations for floating-point arithmetic that ignore the
10179 signedness of zero.  IEEE arithmetic specifies the behavior of
10180 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
10181 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
10182 This option implies that the sign of a zero result isn't significant.
10184 The default is @option{-fsigned-zeros}.
10186 @item -fno-trapping-math
10187 @opindex fno-trapping-math
10188 Compile code assuming that floating-point operations cannot generate
10189 user-visible traps.  These traps include division by zero, overflow,
10190 underflow, inexact result and invalid operation.  This option requires
10191 that @option{-fno-signaling-nans} be in effect.  Setting this option may
10192 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
10194 This option should never be turned on by any @option{-O} option since
10195 it can result in incorrect output for programs that depend on
10196 an exact implementation of IEEE or ISO rules/specifications for
10197 math functions.
10199 The default is @option{-ftrapping-math}.
10201 @item -frounding-math
10202 @opindex frounding-math
10203 Disable transformations and optimizations that assume default floating-point
10204 rounding behavior.  This is round-to-zero for all floating point
10205 to integer conversions, and round-to-nearest for all other arithmetic
10206 truncations.  This option should be specified for programs that change
10207 the FP rounding mode dynamically, or that may be executed with a
10208 non-default rounding mode.  This option disables constant folding of
10209 floating-point expressions at compile time (which may be affected by
10210 rounding mode) and arithmetic transformations that are unsafe in the
10211 presence of sign-dependent rounding modes.
10213 The default is @option{-fno-rounding-math}.
10215 This option is experimental and does not currently guarantee to
10216 disable all GCC optimizations that are affected by rounding mode.
10217 Future versions of GCC may provide finer control of this setting
10218 using C99's @code{FENV_ACCESS} pragma.  This command-line option
10219 will be used to specify the default state for @code{FENV_ACCESS}.
10221 @item -fsignaling-nans
10222 @opindex fsignaling-nans
10223 Compile code assuming that IEEE signaling NaNs may generate user-visible
10224 traps during floating-point operations.  Setting this option disables
10225 optimizations that may change the number of exceptions visible with
10226 signaling NaNs.  This option implies @option{-ftrapping-math}.
10228 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
10229 be defined.
10231 The default is @option{-fno-signaling-nans}.
10233 This option is experimental and does not currently guarantee to
10234 disable all GCC optimizations that affect signaling NaN behavior.
10236 @item -fno-fp-int-builtin-inexact
10237 @opindex fno-fp-int-builtin-inexact
10238 Do not allow the built-in functions @code{ceil}, @code{floor},
10239 @code{round} and @code{trunc}, and their @code{float} and @code{long
10240 double} variants, to generate code that raises the ``inexact''
10241 floating-point exception for noninteger arguments.  ISO C99 and C11
10242 allow these functions to raise the ``inexact'' exception, but ISO/IEC
10243 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
10244 functions to do so.
10246 The default is @option{-ffp-int-builtin-inexact}, allowing the
10247 exception to be raised.  This option does nothing unless
10248 @option{-ftrapping-math} is in effect.
10250 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
10251 generate a call to a library function then the ``inexact'' exception
10252 may be raised if the library implementation does not follow TS 18661.
10254 @item -fsingle-precision-constant
10255 @opindex fsingle-precision-constant
10256 Treat floating-point constants as single precision instead of
10257 implicitly converting them to double-precision constants.
10259 @item -fcx-limited-range
10260 @opindex fcx-limited-range
10261 When enabled, this option states that a range reduction step is not
10262 needed when performing complex division.  Also, there is no checking
10263 whether the result of a complex multiplication or division is @code{NaN
10264 + I*NaN}, with an attempt to rescue the situation in that case.  The
10265 default is @option{-fno-cx-limited-range}, but is enabled by
10266 @option{-ffast-math}.
10268 This option controls the default setting of the ISO C99
10269 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
10270 all languages.
10272 @item -fcx-fortran-rules
10273 @opindex fcx-fortran-rules
10274 Complex multiplication and division follow Fortran rules.  Range
10275 reduction is done as part of complex division, but there is no checking
10276 whether the result of a complex multiplication or division is @code{NaN
10277 + I*NaN}, with an attempt to rescue the situation in that case.
10279 The default is @option{-fno-cx-fortran-rules}.
10281 @end table
10283 The following options control optimizations that may improve
10284 performance, but are not enabled by any @option{-O} options.  This
10285 section includes experimental options that may produce broken code.
10287 @table @gcctabopt
10288 @item -fbranch-probabilities
10289 @opindex fbranch-probabilities
10290 After running a program compiled with @option{-fprofile-arcs}
10291 (@pxref{Instrumentation Options}),
10292 you can compile it a second time using
10293 @option{-fbranch-probabilities}, to improve optimizations based on
10294 the number of times each branch was taken.  When a program
10295 compiled with @option{-fprofile-arcs} exits, it saves arc execution
10296 counts to a file called @file{@var{sourcename}.gcda} for each source
10297 file.  The information in this data file is very dependent on the
10298 structure of the generated code, so you must use the same source code
10299 and the same optimization options for both compilations.
10301 With @option{-fbranch-probabilities}, GCC puts a
10302 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
10303 These can be used to improve optimization.  Currently, they are only
10304 used in one place: in @file{reorg.c}, instead of guessing which path a
10305 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
10306 exactly determine which path is taken more often.
10308 @item -fprofile-values
10309 @opindex fprofile-values
10310 If combined with @option{-fprofile-arcs}, it adds code so that some
10311 data about values of expressions in the program is gathered.
10313 With @option{-fbranch-probabilities}, it reads back the data gathered
10314 from profiling values of expressions for usage in optimizations.
10316 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
10318 @item -fprofile-reorder-functions
10319 @opindex fprofile-reorder-functions
10320 Function reordering based on profile instrumentation collects
10321 first time of execution of a function and orders these functions
10322 in ascending order.
10324 Enabled with @option{-fprofile-use}.
10326 @item -fvpt
10327 @opindex fvpt
10328 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10329 to add code to gather information about values of expressions.
10331 With @option{-fbranch-probabilities}, it reads back the data gathered
10332 and actually performs the optimizations based on them.
10333 Currently the optimizations include specialization of division operations
10334 using the knowledge about the value of the denominator.
10336 @item -frename-registers
10337 @opindex frename-registers
10338 Attempt to avoid false dependencies in scheduled code by making use
10339 of registers left over after register allocation.  This optimization
10340 most benefits processors with lots of registers.  Depending on the
10341 debug information format adopted by the target, however, it can
10342 make debugging impossible, since variables no longer stay in
10343 a ``home register''.
10345 Enabled by default with @option{-funroll-loops}.
10347 @item -fschedule-fusion
10348 @opindex fschedule-fusion
10349 Performs a target dependent pass over the instruction stream to schedule
10350 instructions of same type together because target machine can execute them
10351 more efficiently if they are adjacent to each other in the instruction flow.
10353 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10355 @item -ftracer
10356 @opindex ftracer
10357 Perform tail duplication to enlarge superblock size.  This transformation
10358 simplifies the control flow of the function allowing other optimizations to do
10359 a better job.
10361 Enabled with @option{-fprofile-use}.
10363 @item -funroll-loops
10364 @opindex funroll-loops
10365 Unroll loops whose number of iterations can be determined at compile time or
10366 upon entry to the loop.  @option{-funroll-loops} implies
10367 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10368 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10369 a small constant number of iterations).  This option makes code larger, and may
10370 or may not make it run faster.
10372 Enabled with @option{-fprofile-use}.
10374 @item -funroll-all-loops
10375 @opindex funroll-all-loops
10376 Unroll all loops, even if their number of iterations is uncertain when
10377 the loop is entered.  This usually makes programs run more slowly.
10378 @option{-funroll-all-loops} implies the same options as
10379 @option{-funroll-loops}.
10381 @item -fpeel-loops
10382 @opindex fpeel-loops
10383 Peels loops for which there is enough information that they do not
10384 roll much (from profile feedback or static analysis).  It also turns on
10385 complete loop peeling (i.e.@: complete removal of loops with small constant
10386 number of iterations).
10388 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10390 @item -fmove-loop-invariants
10391 @opindex fmove-loop-invariants
10392 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10393 at level @option{-O1}
10395 @item -fsplit-loops
10396 @opindex fsplit-loops
10397 Split a loop into two if it contains a condition that's always true
10398 for one side of the iteration space and false for the other.
10400 @item -funswitch-loops
10401 @opindex funswitch-loops
10402 Move branches with loop invariant conditions out of the loop, with duplicates
10403 of the loop on both branches (modified according to result of the condition).
10405 @item -ffunction-sections
10406 @itemx -fdata-sections
10407 @opindex ffunction-sections
10408 @opindex fdata-sections
10409 Place each function or data item into its own section in the output
10410 file if the target supports arbitrary sections.  The name of the
10411 function or the name of the data item determines the section's name
10412 in the output file.
10414 Use these options on systems where the linker can perform optimizations to
10415 improve locality of reference in the instruction space.  Most systems using the
10416 ELF object format have linkers with such optimizations.  On AIX, the linker
10417 rearranges sections (CSECTs) based on the call graph.  The performance impact
10418 varies.
10420 Together with a linker garbage collection (linker @option{--gc-sections}
10421 option) these options may lead to smaller statically-linked executables (after
10422 stripping).
10424 On ELF/DWARF systems these options do not degenerate the quality of the debug
10425 information.  There could be issues with other object files/debug info formats.
10427 Only use these options when there are significant benefits from doing so.  When
10428 you specify these options, the assembler and linker create larger object and
10429 executable files and are also slower.  These options affect code generation.
10430 They prevent optimizations by the compiler and assembler using relative
10431 locations inside a translation unit since the locations are unknown until
10432 link time.  An example of such an optimization is relaxing calls to short call
10433 instructions.
10435 @item -fbranch-target-load-optimize
10436 @opindex fbranch-target-load-optimize
10437 Perform branch target register load optimization before prologue / epilogue
10438 threading.
10439 The use of target registers can typically be exposed only during reload,
10440 thus hoisting loads out of loops and doing inter-block scheduling needs
10441 a separate optimization pass.
10443 @item -fbranch-target-load-optimize2
10444 @opindex fbranch-target-load-optimize2
10445 Perform branch target register load optimization after prologue / epilogue
10446 threading.
10448 @item -fbtr-bb-exclusive
10449 @opindex fbtr-bb-exclusive
10450 When performing branch target register load optimization, don't reuse
10451 branch target registers within any basic block.
10453 @item -fstdarg-opt
10454 @opindex fstdarg-opt
10455 Optimize the prologue of variadic argument functions with respect to usage of
10456 those arguments.
10458 @item -fsection-anchors
10459 @opindex fsection-anchors
10460 Try to reduce the number of symbolic address calculations by using
10461 shared ``anchor'' symbols to address nearby objects.  This transformation
10462 can help to reduce the number of GOT entries and GOT accesses on some
10463 targets.
10465 For example, the implementation of the following function @code{foo}:
10467 @smallexample
10468 static int a, b, c;
10469 int foo (void) @{ return a + b + c; @}
10470 @end smallexample
10472 @noindent
10473 usually calculates the addresses of all three variables, but if you
10474 compile it with @option{-fsection-anchors}, it accesses the variables
10475 from a common anchor point instead.  The effect is similar to the
10476 following pseudocode (which isn't valid C):
10478 @smallexample
10479 int foo (void)
10481   register int *xr = &x;
10482   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10484 @end smallexample
10486 Not all targets support this option.
10488 @item --param @var{name}=@var{value}
10489 @opindex param
10490 In some places, GCC uses various constants to control the amount of
10491 optimization that is done.  For example, GCC does not inline functions
10492 that contain more than a certain number of instructions.  You can
10493 control some of these constants on the command line using the
10494 @option{--param} option.
10496 The names of specific parameters, and the meaning of the values, are
10497 tied to the internals of the compiler, and are subject to change
10498 without notice in future releases.
10500 In order to get minimal, maximal and default value of a parameter,
10501 one can use @option{--help=param -Q} options.
10503 In each case, the @var{value} is an integer.  The allowable choices for
10504 @var{name} are:
10506 @table @gcctabopt
10507 @item predictable-branch-outcome
10508 When branch is predicted to be taken with probability lower than this threshold
10509 (in percent), then it is considered well predictable.
10511 @item max-rtl-if-conversion-insns
10512 RTL if-conversion tries to remove conditional branches around a block and
10513 replace them with conditionally executed instructions.  This parameter
10514 gives the maximum number of instructions in a block which should be
10515 considered for if-conversion.  The compiler will
10516 also use other heuristics to decide whether if-conversion is likely to be
10517 profitable.
10519 @item max-rtl-if-conversion-predictable-cost
10520 @itemx max-rtl-if-conversion-unpredictable-cost
10521 RTL if-conversion will try to remove conditional branches around a block
10522 and replace them with conditionally executed instructions.  These parameters
10523 give the maximum permissible cost for the sequence that would be generated
10524 by if-conversion depending on whether the branch is statically determined
10525 to be predictable or not.  The units for this parameter are the same as
10526 those for the GCC internal seq_cost metric.  The compiler will try to
10527 provide a reasonable default for this parameter using the BRANCH_COST
10528 target macro.
10530 @item max-crossjump-edges
10531 The maximum number of incoming edges to consider for cross-jumping.
10532 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10533 the number of edges incoming to each block.  Increasing values mean
10534 more aggressive optimization, making the compilation time increase with
10535 probably small improvement in executable size.
10537 @item min-crossjump-insns
10538 The minimum number of instructions that must be matched at the end
10539 of two blocks before cross-jumping is performed on them.  This
10540 value is ignored in the case where all instructions in the block being
10541 cross-jumped from are matched.
10543 @item max-grow-copy-bb-insns
10544 The maximum code size expansion factor when copying basic blocks
10545 instead of jumping.  The expansion is relative to a jump instruction.
10547 @item max-goto-duplication-insns
10548 The maximum number of instructions to duplicate to a block that jumps
10549 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10550 passes, GCC factors computed gotos early in the compilation process,
10551 and unfactors them as late as possible.  Only computed jumps at the
10552 end of a basic blocks with no more than max-goto-duplication-insns are
10553 unfactored.
10555 @item max-delay-slot-insn-search
10556 The maximum number of instructions to consider when looking for an
10557 instruction to fill a delay slot.  If more than this arbitrary number of
10558 instructions are searched, the time savings from filling the delay slot
10559 are minimal, so stop searching.  Increasing values mean more
10560 aggressive optimization, making the compilation time increase with probably
10561 small improvement in execution time.
10563 @item max-delay-slot-live-search
10564 When trying to fill delay slots, the maximum number of instructions to
10565 consider when searching for a block with valid live register
10566 information.  Increasing this arbitrarily chosen value means more
10567 aggressive optimization, increasing the compilation time.  This parameter
10568 should be removed when the delay slot code is rewritten to maintain the
10569 control-flow graph.
10571 @item max-gcse-memory
10572 The approximate maximum amount of memory that can be allocated in
10573 order to perform the global common subexpression elimination
10574 optimization.  If more memory than specified is required, the
10575 optimization is not done.
10577 @item max-gcse-insertion-ratio
10578 If the ratio of expression insertions to deletions is larger than this value
10579 for any expression, then RTL PRE inserts or removes the expression and thus
10580 leaves partially redundant computations in the instruction stream.
10582 @item max-pending-list-length
10583 The maximum number of pending dependencies scheduling allows
10584 before flushing the current state and starting over.  Large functions
10585 with few branches or calls can create excessively large lists which
10586 needlessly consume memory and resources.
10588 @item max-modulo-backtrack-attempts
10589 The maximum number of backtrack attempts the scheduler should make
10590 when modulo scheduling a loop.  Larger values can exponentially increase
10591 compilation time.
10593 @item max-inline-insns-single
10594 Several parameters control the tree inliner used in GCC@.
10595 This number sets the maximum number of instructions (counted in GCC's
10596 internal representation) in a single function that the tree inliner
10597 considers for inlining.  This only affects functions declared
10598 inline and methods implemented in a class declaration (C++).
10600 @item max-inline-insns-auto
10601 When you use @option{-finline-functions} (included in @option{-O3}),
10602 a lot of functions that would otherwise not be considered for inlining
10603 by the compiler are investigated.  To those functions, a different
10604 (more restrictive) limit compared to functions declared inline can
10605 be applied.
10607 @item inline-min-speedup
10608 When estimated performance improvement of caller + callee runtime exceeds this
10609 threshold (in percent), the function can be inlined regardless of the limit on
10610 @option{--param max-inline-insns-single} and @option{--param
10611 max-inline-insns-auto}.
10613 @item large-function-insns
10614 The limit specifying really large functions.  For functions larger than this
10615 limit after inlining, inlining is constrained by
10616 @option{--param large-function-growth}.  This parameter is useful primarily
10617 to avoid extreme compilation time caused by non-linear algorithms used by the
10618 back end.
10620 @item large-function-growth
10621 Specifies maximal growth of large function caused by inlining in percents.
10622 For example, parameter value 100 limits large function growth to 2.0 times
10623 the original size.
10625 @item large-unit-insns
10626 The limit specifying large translation unit.  Growth caused by inlining of
10627 units larger than this limit is limited by @option{--param inline-unit-growth}.
10628 For small units this might be too tight.
10629 For example, consider a unit consisting of function A
10630 that is inline and B that just calls A three times.  If B is small relative to
10631 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10632 large units consisting of small inlineable functions, however, the overall unit
10633 growth limit is needed to avoid exponential explosion of code size.  Thus for
10634 smaller units, the size is increased to @option{--param large-unit-insns}
10635 before applying @option{--param inline-unit-growth}.
10637 @item inline-unit-growth
10638 Specifies maximal overall growth of the compilation unit caused by inlining.
10639 For example, parameter value 20 limits unit growth to 1.2 times the original
10640 size. Cold functions (either marked cold via an attribute or by profile
10641 feedback) are not accounted into the unit size.
10643 @item ipcp-unit-growth
10644 Specifies maximal overall growth of the compilation unit caused by
10645 interprocedural constant propagation.  For example, parameter value 10 limits
10646 unit growth to 1.1 times the original size.
10648 @item large-stack-frame
10649 The limit specifying large stack frames.  While inlining the algorithm is trying
10650 to not grow past this limit too much.
10652 @item large-stack-frame-growth
10653 Specifies maximal growth of large stack frames caused by inlining in percents.
10654 For example, parameter value 1000 limits large stack frame growth to 11 times
10655 the original size.
10657 @item max-inline-insns-recursive
10658 @itemx max-inline-insns-recursive-auto
10659 Specifies the maximum number of instructions an out-of-line copy of a
10660 self-recursive inline
10661 function can grow into by performing recursive inlining.
10663 @option{--param max-inline-insns-recursive} applies to functions
10664 declared inline.
10665 For functions not declared inline, recursive inlining
10666 happens only when @option{-finline-functions} (included in @option{-O3}) is
10667 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.
10669 @item max-inline-recursive-depth
10670 @itemx max-inline-recursive-depth-auto
10671 Specifies the maximum recursion depth used for recursive inlining.
10673 @option{--param max-inline-recursive-depth} applies to functions
10674 declared inline.  For functions not declared inline, recursive inlining
10675 happens only when @option{-finline-functions} (included in @option{-O3}) is
10676 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.
10678 @item min-inline-recursive-probability
10679 Recursive inlining is profitable only for function having deep recursion
10680 in average and can hurt for function having little recursion depth by
10681 increasing the prologue size or complexity of function body to other
10682 optimizers.
10684 When profile feedback is available (see @option{-fprofile-generate}) the actual
10685 recursion depth can be guessed from the probability that function recurses
10686 via a given call expression.  This parameter limits inlining only to call
10687 expressions whose probability exceeds the given threshold (in percents).
10689 @item early-inlining-insns
10690 Specify growth that the early inliner can make.  In effect it increases
10691 the amount of inlining for code having a large abstraction penalty.
10693 @item max-early-inliner-iterations
10694 Limit of iterations of the early inliner.  This basically bounds
10695 the number of nested indirect calls the early inliner can resolve.
10696 Deeper chains are still handled by late inlining.
10698 @item comdat-sharing-probability
10699 Probability (in percent) that C++ inline function with comdat visibility
10700 are shared across multiple compilation units.
10702 @item profile-func-internal-id
10703 A parameter to control whether to use function internal id in profile
10704 database lookup. If the value is 0, the compiler uses an id that
10705 is based on function assembler name and filename, which makes old profile
10706 data more tolerant to source changes such as function reordering etc.
10708 @item min-vect-loop-bound
10709 The minimum number of iterations under which loops are not vectorized
10710 when @option{-ftree-vectorize} is used.  The number of iterations after
10711 vectorization needs to be greater than the value specified by this option
10712 to allow vectorization.
10714 @item gcse-cost-distance-ratio
10715 Scaling factor in calculation of maximum distance an expression
10716 can be moved by GCSE optimizations.  This is currently supported only in the
10717 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10718 is with simple expressions, i.e., the expressions that have cost
10719 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10720 hoisting of simple expressions.
10722 @item gcse-unrestricted-cost
10723 Cost, roughly measured as the cost of a single typical machine
10724 instruction, at which GCSE optimizations do not constrain
10725 the distance an expression can travel.  This is currently
10726 supported only in the code hoisting pass.  The lesser the cost,
10727 the more aggressive code hoisting is.  Specifying 0 
10728 allows all expressions to travel unrestricted distances.
10730 @item max-hoist-depth
10731 The depth of search in the dominator tree for expressions to hoist.
10732 This is used to avoid quadratic behavior in hoisting algorithm.
10733 The value of 0 does not limit on the search, but may slow down compilation
10734 of huge functions.
10736 @item max-tail-merge-comparisons
10737 The maximum amount of similar bbs to compare a bb with.  This is used to
10738 avoid quadratic behavior in tree tail merging.
10740 @item max-tail-merge-iterations
10741 The maximum amount of iterations of the pass over the function.  This is used to
10742 limit compilation time in tree tail merging.
10744 @item store-merging-allow-unaligned
10745 Allow the store merging pass to introduce unaligned stores if it is legal to
10746 do so.
10748 @item max-stores-to-merge
10749 The maximum number of stores to attempt to merge into wider stores in the store
10750 merging pass.
10752 @item max-unrolled-insns
10753 The maximum number of instructions that a loop may have to be unrolled.
10754 If a loop is unrolled, this parameter also determines how many times
10755 the loop code is unrolled.
10757 @item max-average-unrolled-insns
10758 The maximum number of instructions biased by probabilities of their execution
10759 that a loop may have to be unrolled.  If a loop is unrolled,
10760 this parameter also determines how many times the loop code is unrolled.
10762 @item max-unroll-times
10763 The maximum number of unrollings of a single loop.
10765 @item max-peeled-insns
10766 The maximum number of instructions that a loop may have to be peeled.
10767 If a loop is peeled, this parameter also determines how many times
10768 the loop code is peeled.
10770 @item max-peel-times
10771 The maximum number of peelings of a single loop.
10773 @item max-peel-branches
10774 The maximum number of branches on the hot path through the peeled sequence.
10776 @item max-completely-peeled-insns
10777 The maximum number of insns of a completely peeled loop.
10779 @item max-completely-peel-times
10780 The maximum number of iterations of a loop to be suitable for complete peeling.
10782 @item max-completely-peel-loop-nest-depth
10783 The maximum depth of a loop nest suitable for complete peeling.
10785 @item max-unswitch-insns
10786 The maximum number of insns of an unswitched loop.
10788 @item max-unswitch-level
10789 The maximum number of branches unswitched in a single loop.
10791 @item lim-expensive
10792 The minimum cost of an expensive expression in the loop invariant motion.
10794 @item iv-consider-all-candidates-bound
10795 Bound on number of candidates for induction variables, below which
10796 all candidates are considered for each use in induction variable
10797 optimizations.  If there are more candidates than this,
10798 only the most relevant ones are considered to avoid quadratic time complexity.
10800 @item iv-max-considered-uses
10801 The induction variable optimizations give up on loops that contain more
10802 induction variable uses.
10804 @item iv-always-prune-cand-set-bound
10805 If the number of candidates in the set is smaller than this value,
10806 always try to remove unnecessary ivs from the set
10807 when adding a new one.
10809 @item avg-loop-niter
10810 Average number of iterations of a loop.
10812 @item dse-max-object-size
10813 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10814 Larger values may result in larger compilation times.
10816 @item dse-max-alias-queries-per-store
10817 Maximum number of queries into the alias oracle per store.
10818 Larger values result in larger compilation times and may result in more
10819 removed dead stores.
10821 @item scev-max-expr-size
10822 Bound on size of expressions used in the scalar evolutions analyzer.
10823 Large expressions slow the analyzer.
10825 @item scev-max-expr-complexity
10826 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10827 Complex expressions slow the analyzer.
10829 @item max-tree-if-conversion-phi-args
10830 Maximum number of arguments in a PHI supported by TREE if conversion
10831 unless the loop is marked with simd pragma.
10833 @item vect-max-version-for-alignment-checks
10834 The maximum number of run-time checks that can be performed when
10835 doing loop versioning for alignment in the vectorizer.
10837 @item vect-max-version-for-alias-checks
10838 The maximum number of run-time checks that can be performed when
10839 doing loop versioning for alias in the vectorizer.
10841 @item vect-max-peeling-for-alignment
10842 The maximum number of loop peels to enhance access alignment
10843 for vectorizer. Value -1 means no limit.
10845 @item max-iterations-to-track
10846 The maximum number of iterations of a loop the brute-force algorithm
10847 for analysis of the number of iterations of the loop tries to evaluate.
10849 @item hot-bb-count-ws-permille
10850 A basic block profile count is considered hot if it contributes to 
10851 the given permillage (i.e.@: 0...1000) of the entire profiled execution.
10853 @item hot-bb-frequency-fraction
10854 Select fraction of the entry block frequency of executions of basic block in
10855 function given basic block needs to have to be considered hot.
10857 @item max-predicted-iterations
10858 The maximum number of loop iterations we predict statically.  This is useful
10859 in cases where a function contains a single loop with known bound and
10860 another loop with unknown bound.
10861 The known number of iterations is predicted correctly, while
10862 the unknown number of iterations average to roughly 10.  This means that the
10863 loop without bounds appears artificially cold relative to the other one.
10865 @item builtin-expect-probability
10866 Control the probability of the expression having the specified value. This
10867 parameter takes a percentage (i.e.@: 0 ... 100) as input.
10869 @item builtin-string-cmp-inline-length
10870 The maximum length of a constant string for a builtin string cmp call 
10871 eligible for inlining.
10873 @item align-threshold
10875 Select fraction of the maximal frequency of executions of a basic block in
10876 a function to align the basic block.
10878 @item align-loop-iterations
10880 A loop expected to iterate at least the selected number of iterations is
10881 aligned.
10883 @item tracer-dynamic-coverage
10884 @itemx tracer-dynamic-coverage-feedback
10886 This value is used to limit superblock formation once the given percentage of
10887 executed instructions is covered.  This limits unnecessary code size
10888 expansion.
10890 The @option{tracer-dynamic-coverage-feedback} parameter
10891 is used only when profile
10892 feedback is available.  The real profiles (as opposed to statically estimated
10893 ones) are much less balanced allowing the threshold to be larger value.
10895 @item tracer-max-code-growth
10896 Stop tail duplication once code growth has reached given percentage.  This is
10897 a rather artificial limit, as most of the duplicates are eliminated later in
10898 cross jumping, so it may be set to much higher values than is the desired code
10899 growth.
10901 @item tracer-min-branch-ratio
10903 Stop reverse growth when the reverse probability of best edge is less than this
10904 threshold (in percent).
10906 @item tracer-min-branch-probability
10907 @itemx tracer-min-branch-probability-feedback
10909 Stop forward growth if the best edge has probability lower than this
10910 threshold.
10912 Similarly to @option{tracer-dynamic-coverage} two parameters are
10913 provided.  @option{tracer-min-branch-probability-feedback} is used for
10914 compilation with profile feedback and @option{tracer-min-branch-probability}
10915 compilation without.  The value for compilation with profile feedback
10916 needs to be more conservative (higher) in order to make tracer
10917 effective.
10919 @item stack-clash-protection-guard-size
10920 Specify the size of the operating system provided stack guard as
10921 2 raised to @var{num} bytes.  Higher values may reduce the
10922 number of explicit probes, but a value larger than the operating system
10923 provided guard will leave code vulnerable to stack clash style attacks.
10925 @item stack-clash-protection-probe-interval
10926 Stack clash protection involves probing stack space as it is allocated.  This
10927 param controls the maximum distance between probes into the stack as 2 raised
10928 to @var{num} bytes.  Higher values may reduce the number of explicit probes, but a value
10929 larger than the operating system provided guard will leave code vulnerable to
10930 stack clash style attacks.
10932 @item max-cse-path-length
10934 The maximum number of basic blocks on path that CSE considers.
10936 @item max-cse-insns
10937 The maximum number of instructions CSE processes before flushing.
10939 @item ggc-min-expand
10941 GCC uses a garbage collector to manage its own memory allocation.  This
10942 parameter specifies the minimum percentage by which the garbage
10943 collector's heap should be allowed to expand between collections.
10944 Tuning this may improve compilation speed; it has no effect on code
10945 generation.
10947 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10948 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10949 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10950 GCC is not able to calculate RAM on a particular platform, the lower
10951 bound of 30% is used.  Setting this parameter and
10952 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10953 every opportunity.  This is extremely slow, but can be useful for
10954 debugging.
10956 @item ggc-min-heapsize
10958 Minimum size of the garbage collector's heap before it begins bothering
10959 to collect garbage.  The first collection occurs after the heap expands
10960 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10961 tuning this may improve compilation speed, and has no effect on code
10962 generation.
10964 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10965 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10966 with a lower bound of 4096 (four megabytes) and an upper bound of
10967 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10968 particular platform, the lower bound is used.  Setting this parameter
10969 very large effectively disables garbage collection.  Setting this
10970 parameter and @option{ggc-min-expand} to zero causes a full collection
10971 to occur at every opportunity.
10973 @item max-reload-search-insns
10974 The maximum number of instruction reload should look backward for equivalent
10975 register.  Increasing values mean more aggressive optimization, making the
10976 compilation time increase with probably slightly better performance.
10978 @item max-cselib-memory-locations
10979 The maximum number of memory locations cselib should take into account.
10980 Increasing values mean more aggressive optimization, making the compilation time
10981 increase with probably slightly better performance.
10983 @item max-sched-ready-insns
10984 The maximum number of instructions ready to be issued the scheduler should
10985 consider at any given time during the first scheduling pass.  Increasing
10986 values mean more thorough searches, making the compilation time increase
10987 with probably little benefit.
10989 @item max-sched-region-blocks
10990 The maximum number of blocks in a region to be considered for
10991 interblock scheduling.
10993 @item max-pipeline-region-blocks
10994 The maximum number of blocks in a region to be considered for
10995 pipelining in the selective scheduler.
10997 @item max-sched-region-insns
10998 The maximum number of insns in a region to be considered for
10999 interblock scheduling.
11001 @item max-pipeline-region-insns
11002 The maximum number of insns in a region to be considered for
11003 pipelining in the selective scheduler.
11005 @item min-spec-prob
11006 The minimum probability (in percents) of reaching a source block
11007 for interblock speculative scheduling.
11009 @item max-sched-extend-regions-iters
11010 The maximum number of iterations through CFG to extend regions.
11011 A value of 0 disables region extensions.
11013 @item max-sched-insn-conflict-delay
11014 The maximum conflict delay for an insn to be considered for speculative motion.
11016 @item sched-spec-prob-cutoff
11017 The minimal probability of speculation success (in percents), so that
11018 speculative insns are scheduled.
11020 @item sched-state-edge-prob-cutoff
11021 The minimum probability an edge must have for the scheduler to save its
11022 state across it.
11024 @item sched-mem-true-dep-cost
11025 Minimal distance (in CPU cycles) between store and load targeting same
11026 memory locations.
11028 @item selsched-max-lookahead
11029 The maximum size of the lookahead window of selective scheduling.  It is a
11030 depth of search for available instructions.
11032 @item selsched-max-sched-times
11033 The maximum number of times that an instruction is scheduled during
11034 selective scheduling.  This is the limit on the number of iterations
11035 through which the instruction may be pipelined.
11037 @item selsched-insns-to-rename
11038 The maximum number of best instructions in the ready list that are considered
11039 for renaming in the selective scheduler.
11041 @item sms-min-sc
11042 The minimum value of stage count that swing modulo scheduler
11043 generates.
11045 @item max-last-value-rtl
11046 The maximum size measured as number of RTLs that can be recorded in an expression
11047 in combiner for a pseudo register as last known value of that register.
11049 @item max-combine-insns
11050 The maximum number of instructions the RTL combiner tries to combine.
11052 @item integer-share-limit
11053 Small integer constants can use a shared data structure, reducing the
11054 compiler's memory usage and increasing its speed.  This sets the maximum
11055 value of a shared integer constant.
11057 @item ssp-buffer-size
11058 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
11059 protection when @option{-fstack-protection} is used.
11061 @item min-size-for-stack-sharing
11062 The minimum size of variables taking part in stack slot sharing when not
11063 optimizing.
11065 @item max-jump-thread-duplication-stmts
11066 Maximum number of statements allowed in a block that needs to be
11067 duplicated when threading jumps.
11069 @item max-fields-for-field-sensitive
11070 Maximum number of fields in a structure treated in
11071 a field sensitive manner during pointer analysis.
11073 @item prefetch-latency
11074 Estimate on average number of instructions that are executed before
11075 prefetch finishes.  The distance prefetched ahead is proportional
11076 to this constant.  Increasing this number may also lead to less
11077 streams being prefetched (see @option{simultaneous-prefetches}).
11079 @item simultaneous-prefetches
11080 Maximum number of prefetches that can run at the same time.
11082 @item l1-cache-line-size
11083 The size of cache line in L1 cache, in bytes.
11085 @item l1-cache-size
11086 The size of L1 cache, in kilobytes.
11088 @item l2-cache-size
11089 The size of L2 cache, in kilobytes.
11091 @item prefetch-dynamic-strides
11092 Whether the loop array prefetch pass should issue software prefetch hints
11093 for strides that are non-constant.  In some cases this may be
11094 beneficial, though the fact the stride is non-constant may make it
11095 hard to predict when there is clear benefit to issuing these hints.
11097 Set to 1 if the prefetch hints should be issued for non-constant
11098 strides.  Set to 0 if prefetch hints should be issued only for strides that
11099 are known to be constant and below @option{prefetch-minimum-stride}.
11101 @item prefetch-minimum-stride
11102 Minimum constant stride, in bytes, to start using prefetch hints for.  If
11103 the stride is less than this threshold, prefetch hints will not be issued.
11105 This setting is useful for processors that have hardware prefetchers, in
11106 which case there may be conflicts between the hardware prefetchers and
11107 the software prefetchers.  If the hardware prefetchers have a maximum
11108 stride they can handle, it should be used here to improve the use of
11109 software prefetchers.
11111 A value of -1 means we don't have a threshold and therefore
11112 prefetch hints can be issued for any constant stride.
11114 This setting is only useful for strides that are known and constant.
11116 @item loop-interchange-max-num-stmts
11117 The maximum number of stmts in a loop to be interchanged.
11119 @item loop-interchange-stride-ratio
11120 The minimum ratio between stride of two loops for interchange to be profitable.
11122 @item min-insn-to-prefetch-ratio
11123 The minimum ratio between the number of instructions and the
11124 number of prefetches to enable prefetching in a loop.
11126 @item prefetch-min-insn-to-mem-ratio
11127 The minimum ratio between the number of instructions and the
11128 number of memory references to enable prefetching in a loop.
11130 @item use-canonical-types
11131 Whether the compiler should use the ``canonical'' type system.
11132 Should always be 1, which uses a more efficient internal
11133 mechanism for comparing types in C++ and Objective-C++.  However, if
11134 bugs in the canonical type system are causing compilation failures,
11135 set this value to 0 to disable canonical types.
11137 @item switch-conversion-max-branch-ratio
11138 Switch initialization conversion refuses to create arrays that are
11139 bigger than @option{switch-conversion-max-branch-ratio} times the number of
11140 branches in the switch.
11142 @item max-partial-antic-length
11143 Maximum length of the partial antic set computed during the tree
11144 partial redundancy elimination optimization (@option{-ftree-pre}) when
11145 optimizing at @option{-O3} and above.  For some sorts of source code
11146 the enhanced partial redundancy elimination optimization can run away,
11147 consuming all of the memory available on the host machine.  This
11148 parameter sets a limit on the length of the sets that are computed,
11149 which prevents the runaway behavior.  Setting a value of 0 for
11150 this parameter allows an unlimited set length.
11152 @item rpo-vn-max-loop-depth
11153 Maximum loop depth that is value-numbered optimistically.
11154 When the limit hits the innermost
11155 @var{rpo-vn-max-loop-depth} loops and the outermost loop in the
11156 loop nest are value-numbered optimistically and the remaining ones not.
11158 @item sccvn-max-alias-queries-per-access
11159 Maximum number of alias-oracle queries we perform when looking for
11160 redundancies for loads and stores.  If this limit is hit the search
11161 is aborted and the load or store is not considered redundant.  The
11162 number of queries is algorithmically limited to the number of
11163 stores on all paths from the load to the function entry.
11165 @item ira-max-loops-num
11166 IRA uses regional register allocation by default.  If a function
11167 contains more loops than the number given by this parameter, only at most
11168 the given number of the most frequently-executed loops form regions
11169 for regional register allocation.
11171 @item ira-max-conflict-table-size 
11172 Although IRA uses a sophisticated algorithm to compress the conflict
11173 table, the table can still require excessive amounts of memory for
11174 huge functions.  If the conflict table for a function could be more
11175 than the size in MB given by this parameter, the register allocator
11176 instead uses a faster, simpler, and lower-quality
11177 algorithm that does not require building a pseudo-register conflict table.  
11179 @item ira-loop-reserved-regs
11180 IRA can be used to evaluate more accurate register pressure in loops
11181 for decisions to move loop invariants (see @option{-O3}).  The number
11182 of available registers reserved for some other purposes is given
11183 by this parameter.  Default of the parameter
11184 is the best found from numerous experiments.
11186 @item lra-inheritance-ebb-probability-cutoff
11187 LRA tries to reuse values reloaded in registers in subsequent insns.
11188 This optimization is called inheritance.  EBB is used as a region to
11189 do this optimization.  The parameter defines a minimal fall-through
11190 edge probability in percentage used to add BB to inheritance EBB in
11191 LRA.  The default value was chosen
11192 from numerous runs of SPEC2000 on x86-64.
11194 @item loop-invariant-max-bbs-in-loop
11195 Loop invariant motion can be very expensive, both in compilation time and
11196 in amount of needed compile-time memory, with very large loops.  Loops
11197 with more basic blocks than this parameter won't have loop invariant
11198 motion optimization performed on them.
11200 @item loop-max-datarefs-for-datadeps
11201 Building data dependencies is expensive for very large loops.  This
11202 parameter limits the number of data references in loops that are
11203 considered for data dependence analysis.  These large loops are no
11204 handled by the optimizations using loop data dependencies.
11206 @item max-vartrack-size
11207 Sets a maximum number of hash table slots to use during variable
11208 tracking dataflow analysis of any function.  If this limit is exceeded
11209 with variable tracking at assignments enabled, analysis for that
11210 function is retried without it, after removing all debug insns from
11211 the function.  If the limit is exceeded even without debug insns, var
11212 tracking analysis is completely disabled for the function.  Setting
11213 the parameter to zero makes it unlimited.
11215 @item max-vartrack-expr-depth
11216 Sets a maximum number of recursion levels when attempting to map
11217 variable names or debug temporaries to value expressions.  This trades
11218 compilation time for more complete debug information.  If this is set too
11219 low, value expressions that are available and could be represented in
11220 debug information may end up not being used; setting this higher may
11221 enable the compiler to find more complex debug expressions, but compile
11222 time and memory use may grow.
11224 @item max-debug-marker-count
11225 Sets a threshold on the number of debug markers (e.g.@: begin stmt
11226 markers) to avoid complexity explosion at inlining or expanding to RTL.
11227 If a function has more such gimple stmts than the set limit, such stmts
11228 will be dropped from the inlined copy of a function, and from its RTL
11229 expansion.
11231 @item min-nondebug-insn-uid
11232 Use uids starting at this parameter for nondebug insns.  The range below
11233 the parameter is reserved exclusively for debug insns created by
11234 @option{-fvar-tracking-assignments}, but debug insns may get
11235 (non-overlapping) uids above it if the reserved range is exhausted.
11237 @item ipa-sra-ptr-growth-factor
11238 IPA-SRA replaces a pointer to an aggregate with one or more new
11239 parameters only when their cumulative size is less or equal to
11240 @option{ipa-sra-ptr-growth-factor} times the size of the original
11241 pointer parameter.
11243 @item sra-max-scalarization-size-Ospeed
11244 @itemx sra-max-scalarization-size-Osize
11245 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
11246 replace scalar parts of aggregates with uses of independent scalar
11247 variables.  These parameters control the maximum size, in storage units,
11248 of aggregate which is considered for replacement when compiling for
11249 speed
11250 (@option{sra-max-scalarization-size-Ospeed}) or size
11251 (@option{sra-max-scalarization-size-Osize}) respectively.
11253 @item tm-max-aggregate-size
11254 When making copies of thread-local variables in a transaction, this
11255 parameter specifies the size in bytes after which variables are
11256 saved with the logging functions as opposed to save/restore code
11257 sequence pairs.  This option only applies when using
11258 @option{-fgnu-tm}.
11260 @item graphite-max-nb-scop-params
11261 To avoid exponential effects in the Graphite loop transforms, the
11262 number of parameters in a Static Control Part (SCoP) is bounded.
11263 A value of zero can be used to lift
11264 the bound.  A variable whose value is unknown at compilation time and
11265 defined outside a SCoP is a parameter of the SCoP.
11267 @item loop-block-tile-size
11268 Loop blocking or strip mining transforms, enabled with
11269 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
11270 loop in the loop nest by a given number of iterations.  The strip
11271 length can be changed using the @option{loop-block-tile-size}
11272 parameter.
11274 @item ipa-cp-value-list-size
11275 IPA-CP attempts to track all possible values and types passed to a function's
11276 parameter in order to propagate them and perform devirtualization.
11277 @option{ipa-cp-value-list-size} is the maximum number of values and types it
11278 stores per one formal parameter of a function.
11280 @item ipa-cp-eval-threshold
11281 IPA-CP calculates its own score of cloning profitability heuristics
11282 and performs those cloning opportunities with scores that exceed
11283 @option{ipa-cp-eval-threshold}.
11285 @item ipa-cp-recursion-penalty
11286 Percentage penalty the recursive functions will receive when they
11287 are evaluated for cloning.
11289 @item ipa-cp-single-call-penalty
11290 Percentage penalty functions containing a single call to another
11291 function will receive when they are evaluated for cloning.
11293 @item ipa-max-agg-items
11294 IPA-CP is also capable to propagate a number of scalar values passed
11295 in an aggregate. @option{ipa-max-agg-items} controls the maximum
11296 number of such values per one parameter.
11298 @item ipa-cp-loop-hint-bonus
11299 When IPA-CP determines that a cloning candidate would make the number
11300 of iterations of a loop known, it adds a bonus of
11301 @option{ipa-cp-loop-hint-bonus} to the profitability score of
11302 the candidate.
11304 @item ipa-cp-array-index-hint-bonus
11305 When IPA-CP determines that a cloning candidate would make the index of
11306 an array access known, it adds a bonus of
11307 @option{ipa-cp-array-index-hint-bonus} to the profitability
11308 score of the candidate.
11310 @item ipa-max-aa-steps
11311 During its analysis of function bodies, IPA-CP employs alias analysis
11312 in order to track values pointed to by function parameters.  In order
11313 not spend too much time analyzing huge functions, it gives up and
11314 consider all memory clobbered after examining
11315 @option{ipa-max-aa-steps} statements modifying memory.
11317 @item lto-partitions
11318 Specify desired number of partitions produced during WHOPR compilation.
11319 The number of partitions should exceed the number of CPUs used for compilation.
11321 @item lto-min-partition
11322 Size of minimal partition for WHOPR (in estimated instructions).
11323 This prevents expenses of splitting very small programs into too many
11324 partitions.
11326 @item lto-max-partition
11327 Size of max partition for WHOPR (in estimated instructions).
11328 to provide an upper bound for individual size of partition.
11329 Meant to be used only with balanced partitioning.
11331 @item cxx-max-namespaces-for-diagnostic-help
11332 The maximum number of namespaces to consult for suggestions when C++
11333 name lookup fails for an identifier.
11335 @item sink-frequency-threshold
11336 The maximum relative execution frequency (in percents) of the target block
11337 relative to a statement's original block to allow statement sinking of a
11338 statement.  Larger numbers result in more aggressive statement sinking.
11339 A small positive adjustment is applied for
11340 statements with memory operands as those are even more profitable so sink.
11342 @item max-stores-to-sink
11343 The maximum number of conditional store pairs that can be sunk.  Set to 0
11344 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11345 (@option{-ftree-loop-if-convert}) is disabled.
11347 @item allow-store-data-races
11348 Allow optimizers to introduce new data races on stores.
11349 Set to 1 to allow, otherwise to 0.
11351 @item case-values-threshold
11352 The smallest number of different values for which it is best to use a
11353 jump-table instead of a tree of conditional branches.  If the value is
11354 0, use the default for the machine.
11356 @item tree-reassoc-width
11357 Set the maximum number of instructions executed in parallel in
11358 reassociated tree. This parameter overrides target dependent
11359 heuristics used by default if has non zero value.
11361 @item sched-pressure-algorithm
11362 Choose between the two available implementations of
11363 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11364 and is the more likely to prevent instructions from being reordered.
11365 Algorithm 2 was designed to be a compromise between the relatively
11366 conservative approach taken by algorithm 1 and the rather aggressive
11367 approach taken by the default scheduler.  It relies more heavily on
11368 having a regular register file and accurate register pressure classes.
11369 See @file{haifa-sched.c} in the GCC sources for more details.
11371 The default choice depends on the target.
11373 @item max-slsr-cand-scan
11374 Set the maximum number of existing candidates that are considered when
11375 seeking a basis for a new straight-line strength reduction candidate.
11377 @item asan-globals
11378 Enable buffer overflow detection for global objects.  This kind
11379 of protection is enabled by default if you are using
11380 @option{-fsanitize=address} option.
11381 To disable global objects protection use @option{--param asan-globals=0}.
11383 @item asan-stack
11384 Enable buffer overflow detection for stack objects.  This kind of
11385 protection is enabled by default when using @option{-fsanitize=address}.
11386 To disable stack protection use @option{--param asan-stack=0} option.
11388 @item asan-instrument-reads
11389 Enable buffer overflow detection for memory reads.  This kind of
11390 protection is enabled by default when using @option{-fsanitize=address}.
11391 To disable memory reads protection use
11392 @option{--param asan-instrument-reads=0}.
11394 @item asan-instrument-writes
11395 Enable buffer overflow detection for memory writes.  This kind of
11396 protection is enabled by default when using @option{-fsanitize=address}.
11397 To disable memory writes protection use
11398 @option{--param asan-instrument-writes=0} option.
11400 @item asan-memintrin
11401 Enable detection for built-in functions.  This kind of protection
11402 is enabled by default when using @option{-fsanitize=address}.
11403 To disable built-in functions protection use
11404 @option{--param asan-memintrin=0}.
11406 @item asan-use-after-return
11407 Enable detection of use-after-return.  This kind of protection
11408 is enabled by default when using the @option{-fsanitize=address} option.
11409 To disable it use @option{--param asan-use-after-return=0}.
11411 Note: By default the check is disabled at run time.  To enable it,
11412 add @code{detect_stack_use_after_return=1} to the environment variable
11413 @env{ASAN_OPTIONS}.
11415 @item asan-instrumentation-with-call-threshold
11416 If number of memory accesses in function being instrumented
11417 is greater or equal to this number, use callbacks instead of inline checks.
11418 E.g. to disable inline code use
11419 @option{--param asan-instrumentation-with-call-threshold=0}.
11421 @item use-after-scope-direct-emission-threshold
11422 If the size of a local variable in bytes is smaller or equal to this
11423 number, directly poison (or unpoison) shadow memory instead of using
11424 run-time callbacks.
11426 @item max-fsm-thread-path-insns
11427 Maximum number of instructions to copy when duplicating blocks on a
11428 finite state automaton jump thread path.
11430 @item max-fsm-thread-length
11431 Maximum number of basic blocks on a finite state automaton jump thread
11432 path.
11434 @item max-fsm-thread-paths
11435 Maximum number of new jump thread paths to create for a finite state
11436 automaton.
11438 @item parloops-chunk-size
11439 Chunk size of omp schedule for loops parallelized by parloops.
11441 @item parloops-schedule
11442 Schedule type of omp schedule for loops parallelized by parloops (static,
11443 dynamic, guided, auto, runtime).
11445 @item parloops-min-per-thread
11446 The minimum number of iterations per thread of an innermost parallelized
11447 loop for which the parallelized variant is preferred over the single threaded
11448 one.  Note that for a parallelized loop nest the
11449 minimum number of iterations of the outermost loop per thread is two.
11451 @item max-ssa-name-query-depth
11452 Maximum depth of recursion when querying properties of SSA names in things
11453 like fold routines.  One level of recursion corresponds to following a
11454 use-def chain.
11456 @item hsa-gen-debug-stores
11457 Enable emission of special debug stores within HSA kernels which are
11458 then read and reported by libgomp plugin.  Generation of these stores
11459 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11460 enable it.
11462 @item max-speculative-devirt-maydefs
11463 The maximum number of may-defs we analyze when looking for a must-def
11464 specifying the dynamic type of an object that invokes a virtual call
11465 we may be able to devirtualize speculatively.
11467 @item max-vrp-switch-assertions
11468 The maximum number of assertions to add along the default edge of a switch
11469 statement during VRP.
11471 @item unroll-jam-min-percent
11472 The minimum percentage of memory references that must be optimized
11473 away for the unroll-and-jam transformation to be considered profitable.
11475 @item unroll-jam-max-unroll
11476 The maximum number of times the outer loop should be unrolled by
11477 the unroll-and-jam transformation.
11479 @item max-rtl-if-conversion-unpredictable-cost
11480 Maximum permissible cost for the sequence that would be generated
11481 by the RTL if-conversion pass for a branch that is considered unpredictable.
11483 @item max-variable-expansions-in-unroller
11484 If @option{-fvariable-expansion-in-unroller} is used, the maximum number
11485 of times that an individual variable will be expanded during loop unrolling.
11487 @item tracer-min-branch-probability-feedback
11488 Stop forward growth if the probability of best edge is less than
11489 this threshold (in percent). Used when profile feedback is available.
11491 @item partial-inlining-entry-probability
11492 Maximum probability of the entry BB of split region
11493 (in percent relative to entry BB of the function)
11494 to make partial inlining happen.
11496 @item max-tracked-strlens
11497 Maximum number of strings for which strlen optimization pass will
11498 track string lengths.
11500 @item gcse-after-reload-partial-fraction
11501 The threshold ratio for performing partial redundancy
11502 elimination after reload.
11504 @item gcse-after-reload-critical-fraction
11505 The threshold ratio of critical edges execution count that
11506 permit performing redundancy elimination after reload.
11508 @item max-loop-header-insns
11509 The maximum number of insns in loop header duplicated
11510 by the copy loop headers pass.
11512 @item vect-epilogues-nomask
11513 Enable loop epilogue vectorization using smaller vector size.
11515 @item slp-max-insns-in-bb
11516 Maximum number of instructions in basic block to be
11517 considered for SLP vectorization.
11519 @item avoid-fma-max-bits
11520 Maximum number of bits for which we avoid creating FMAs.
11522 @item sms-loop-average-count-threshold
11523 A threshold on the average loop count considered by the swing modulo scheduler.
11525 @item sms-dfa-history
11526 The number of cycles the swing modulo scheduler considers when checking
11527 conflicts using DFA.
11529 @item hot-bb-count-fraction
11530 Select fraction of the maximal count of repetitions of basic block
11531 in program given basic block needs
11532 to have to be considered hot (used in non-LTO mode)
11534 @item max-inline-insns-recursive-auto
11535 The maximum number of instructions non-inline function
11536 can grow to via recursive inlining.
11538 @item graphite-allow-codegen-errors
11539 Whether codegen errors should be ICEs when @option{-fchecking}.
11541 @item sms-max-ii-factor
11542 A factor for tuning the upper bound that swing modulo scheduler
11543 uses for scheduling a loop.
11545 @item lra-max-considered-reload-pseudos
11546 The max number of reload pseudos which are considered during
11547 spilling a non-reload pseudo.
11549 @item max-pow-sqrt-depth
11550 Maximum depth of sqrt chains to use when synthesizing exponentiation
11551 by a real constant.
11553 @item max-dse-active-local-stores
11554 Maximum number of active local stores in RTL dead store elimination.
11556 @item asan-instrument-allocas
11557 Enable asan allocas/VLAs protection.
11559 @item max-iterations-computation-cost
11560 Bound on the cost of an expression to compute the number of iterations.
11562 @item max-isl-operations
11563 Maximum number of isl operations, 0 means unlimited.
11565 @item graphite-max-arrays-per-scop
11566 Maximum number of arrays per scop.
11568 @item max-vartrack-reverse-op-size
11569 Max. size of loc list for which reverse ops should be added.
11571 @item unlikely-bb-count-fraction
11572 The minimum fraction of profile runs a given basic block execution count
11573 must be not to be considered unlikely.
11575 @item tracer-dynamic-coverage-feedback
11576 The percentage of function, weighted by execution frequency,
11577 that must be covered by trace formation.
11578 Used when profile feedback is available.
11580 @item max-inline-recursive-depth-auto
11581 The maximum depth of recursive inlining for non-inline functions.
11583 @item fsm-scale-path-stmts
11584 Scale factor to apply to the number of statements in a threading path
11585 when comparing to the number of (scaled) blocks.
11587 @item fsm-maximum-phi-arguments
11588 Maximum number of arguments a PHI may have before the FSM threader
11589 will not try to thread through its block.
11591 @item uninit-control-dep-attempts
11592 Maximum number of nested calls to search for control dependencies
11593 during uninitialized variable analysis.
11595 @item indir-call-topn-profile
11596 Track top N target addresses in indirect-call profile.
11598 @item max-once-peeled-insns
11599 The maximum number of insns of a peeled loop that rolls only once.
11601 @item sra-max-scalarization-size-Osize
11602 Maximum size, in storage units, of an aggregate
11603 which should be considered for scalarization when compiling for size.
11605 @item fsm-scale-path-blocks
11606 Scale factor to apply to the number of blocks in a threading path
11607 when comparing to the number of (scaled) statements.
11609 @item sched-autopref-queue-depth
11610 Hardware autoprefetcher scheduler model control flag.
11611 Number of lookahead cycles the model looks into; at '
11612 ' only enable instruction sorting heuristic.
11615 @end table
11616 @end table
11618 @node Instrumentation Options
11619 @section Program Instrumentation Options
11620 @cindex instrumentation options
11621 @cindex program instrumentation options
11622 @cindex run-time error checking options
11623 @cindex profiling options
11624 @cindex options, program instrumentation
11625 @cindex options, run-time error checking
11626 @cindex options, profiling
11628 GCC supports a number of command-line options that control adding
11629 run-time instrumentation to the code it normally generates.  
11630 For example, one purpose of instrumentation is collect profiling
11631 statistics for use in finding program hot spots, code coverage
11632 analysis, or profile-guided optimizations.
11633 Another class of program instrumentation is adding run-time checking 
11634 to detect programming errors like invalid pointer
11635 dereferences or out-of-bounds array accesses, as well as deliberately
11636 hostile attacks such as stack smashing or C++ vtable hijacking.
11637 There is also a general hook which can be used to implement other
11638 forms of tracing or function-level instrumentation for debug or
11639 program analysis purposes.
11641 @table @gcctabopt
11642 @cindex @command{prof}
11643 @item -p
11644 @opindex p
11645 Generate extra code to write profile information suitable for the
11646 analysis program @command{prof}.  You must use this option when compiling
11647 the source files you want data about, and you must also use it when
11648 linking.
11650 @cindex @command{gprof}
11651 @item -pg
11652 @opindex pg
11653 Generate extra code to write profile information suitable for the
11654 analysis program @command{gprof}.  You must use this option when compiling
11655 the source files you want data about, and you must also use it when
11656 linking.
11658 @item -fprofile-arcs
11659 @opindex fprofile-arcs
11660 Add code so that program flow @dfn{arcs} are instrumented.  During
11661 execution the program records how many times each branch and call is
11662 executed and how many times it is taken or returns.  On targets that support
11663 constructors with priority support, profiling properly handles constructors,
11664 destructors and C++ constructors (and destructors) of classes which are used
11665 as a type of a global variable.
11667 When the compiled
11668 program exits it saves this data to a file called
11669 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11670 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11671 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11672 @var{auxname} is generated from the name of the output file, if
11673 explicitly specified and it is not the final executable, otherwise it is
11674 the basename of the source file.  In both cases any suffix is removed
11675 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11676 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11677 @xref{Cross-profiling}.
11679 @cindex @command{gcov}
11680 @item --coverage
11681 @opindex coverage
11683 This option is used to compile and link code instrumented for coverage
11684 analysis.  The option is a synonym for @option{-fprofile-arcs}
11685 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11686 linking).  See the documentation for those options for more details.
11688 @itemize
11690 @item
11691 Compile the source files with @option{-fprofile-arcs} plus optimization
11692 and code generation options.  For test coverage analysis, use the
11693 additional @option{-ftest-coverage} option.  You do not need to profile
11694 every source file in a program.
11696 @item
11697 Compile the source files additionally with @option{-fprofile-abs-path}
11698 to create absolute path names in the @file{.gcno} files.  This allows
11699 @command{gcov} to find the correct sources in projects where compilations
11700 occur with different working directories.
11702 @item
11703 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11704 (the latter implies the former).
11706 @item
11707 Run the program on a representative workload to generate the arc profile
11708 information.  This may be repeated any number of times.  You can run
11709 concurrent instances of your program, and provided that the file system
11710 supports locking, the data files will be correctly updated.  Unless
11711 a strict ISO C dialect option is in effect, @code{fork} calls are
11712 detected and correctly handled without double counting.
11714 @item
11715 For profile-directed optimizations, compile the source files again with
11716 the same optimization and code generation options plus
11717 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11718 Control Optimization}).
11720 @item
11721 For test coverage analysis, use @command{gcov} to produce human readable
11722 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11723 @command{gcov} documentation for further information.
11725 @end itemize
11727 With @option{-fprofile-arcs}, for each function of your program GCC
11728 creates a program flow graph, then finds a spanning tree for the graph.
11729 Only arcs that are not on the spanning tree have to be instrumented: the
11730 compiler adds code to count the number of times that these arcs are
11731 executed.  When an arc is the only exit or only entrance to a block, the
11732 instrumentation code can be added to the block; otherwise, a new basic
11733 block must be created to hold the instrumentation code.
11735 @need 2000
11736 @item -ftest-coverage
11737 @opindex ftest-coverage
11738 Produce a notes file that the @command{gcov} code-coverage utility
11739 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11740 show program coverage.  Each source file's note file is called
11741 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11742 above for a description of @var{auxname} and instructions on how to
11743 generate test coverage data.  Coverage data matches the source files
11744 more closely if you do not optimize.
11746 @item -fprofile-abs-path
11747 @opindex fprofile-abs-path
11748 Automatically convert relative source file names to absolute path names
11749 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11750 sources in projects where compilations occur with different working
11751 directories.
11753 @item -fprofile-dir=@var{path}
11754 @opindex fprofile-dir
11756 Set the directory to search for the profile data files in to @var{path}.
11757 This option affects only the profile data generated by
11758 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11759 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11760 and its related options.  Both absolute and relative paths can be used.
11761 By default, GCC uses the current directory as @var{path}, thus the
11762 profile data file appears in the same directory as the object file.
11763 In order to prevent the file name clashing, if the object file name is
11764 not an absolute path, we mangle the absolute path of the
11765 @file{@var{sourcename}.gcda} file and use it as the file name of a
11766 @file{.gcda} file.
11768 When an executable is run in a massive parallel environment, it is recommended
11769 to save profile to different folders.  That can be done with variables
11770 in @var{path} that are exported during run-time:
11772 @table @gcctabopt
11774 @item %p
11775 process ID.
11777 @item %q@{VAR@}
11778 value of environment variable @var{VAR}
11780 @end table
11782 @item -fprofile-generate
11783 @itemx -fprofile-generate=@var{path}
11784 @opindex fprofile-generate
11786 Enable options usually used for instrumenting application to produce
11787 profile useful for later recompilation with profile feedback based
11788 optimization.  You must use @option{-fprofile-generate} both when
11789 compiling and when linking your program.
11791 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11793 If @var{path} is specified, GCC looks at the @var{path} to find
11794 the profile feedback data files. See @option{-fprofile-dir}.
11796 To optimize the program based on the collected profile information, use
11797 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11799 @item -fprofile-update=@var{method}
11800 @opindex fprofile-update
11802 Alter the update method for an application instrumented for profile
11803 feedback based optimization.  The @var{method} argument should be one of
11804 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11805 The first one is useful for single-threaded applications,
11806 while the second one prevents profile corruption by emitting thread-safe code.
11808 @strong{Warning:} When an application does not properly join all threads
11809 (or creates an detached thread), a profile file can be still corrupted.
11811 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11812 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11813 automatically selects @samp{prefer-atomic} when @option{-pthread}
11814 is present in the command line.
11816 @item -fsanitize=address
11817 @opindex fsanitize=address
11818 Enable AddressSanitizer, a fast memory error detector.
11819 Memory access instructions are instrumented to detect
11820 out-of-bounds and use-after-free bugs.
11821 The option enables @option{-fsanitize-address-use-after-scope}.
11822 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11823 more details.  The run-time behavior can be influenced using the
11824 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11825 the available options are shown at startup of the instrumented program.  See
11826 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11827 for a list of supported options.
11828 The option cannot be combined with @option{-fsanitize=thread}.
11830 @item -fsanitize=kernel-address
11831 @opindex fsanitize=kernel-address
11832 Enable AddressSanitizer for Linux kernel.
11833 See @uref{https://github.com/google/kasan/wiki} for more details.
11835 @item -fsanitize=pointer-compare
11836 @opindex fsanitize=pointer-compare
11837 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11838 The option must be combined with either @option{-fsanitize=kernel-address} or
11839 @option{-fsanitize=address}
11840 The option cannot be combined with @option{-fsanitize=thread}.
11841 Note: By default the check is disabled at run time.  To enable it,
11842 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11843 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11844 invalid operation only when both pointers are non-null.
11846 @item -fsanitize=pointer-subtract
11847 @opindex fsanitize=pointer-subtract
11848 Instrument subtraction with pointer operands.
11849 The option must be combined with either @option{-fsanitize=kernel-address} or
11850 @option{-fsanitize=address}
11851 The option cannot be combined with @option{-fsanitize=thread}.
11852 Note: By default the check is disabled at run time.  To enable it,
11853 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11854 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11855 invalid operation only when both pointers are non-null.
11857 @item -fsanitize=thread
11858 @opindex fsanitize=thread
11859 Enable ThreadSanitizer, a fast data race detector.
11860 Memory access instructions are instrumented to detect
11861 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11862 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11863 environment variable; see
11864 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11865 supported options.
11866 The option cannot be combined with @option{-fsanitize=address},
11867 @option{-fsanitize=leak}.
11869 Note that sanitized atomic builtins cannot throw exceptions when
11870 operating on invalid memory addresses with non-call exceptions
11871 (@option{-fnon-call-exceptions}).
11873 @item -fsanitize=leak
11874 @opindex fsanitize=leak
11875 Enable LeakSanitizer, a memory leak detector.
11876 This option only matters for linking of executables and
11877 the executable is linked against a library that overrides @code{malloc}
11878 and other allocator functions.  See
11879 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11880 details.  The run-time behavior can be influenced using the
11881 @env{LSAN_OPTIONS} environment variable.
11882 The option cannot be combined with @option{-fsanitize=thread}.
11884 @item -fsanitize=undefined
11885 @opindex fsanitize=undefined
11886 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11887 Various computations are instrumented to detect undefined behavior
11888 at runtime.  Current suboptions are:
11890 @table @gcctabopt
11892 @item -fsanitize=shift
11893 @opindex fsanitize=shift
11894 This option enables checking that the result of a shift operation is
11895 not undefined.  Note that what exactly is considered undefined differs
11896 slightly between C and C++, as well as between ISO C90 and C99, etc.
11897 This option has two suboptions, @option{-fsanitize=shift-base} and
11898 @option{-fsanitize=shift-exponent}.
11900 @item -fsanitize=shift-exponent
11901 @opindex fsanitize=shift-exponent
11902 This option enables checking that the second argument of a shift operation
11903 is not negative and is smaller than the precision of the promoted first
11904 argument.
11906 @item -fsanitize=shift-base
11907 @opindex fsanitize=shift-base
11908 If the second argument of a shift operation is within range, check that the
11909 result of a shift operation is not undefined.  Note that what exactly is
11910 considered undefined differs slightly between C and C++, as well as between
11911 ISO C90 and C99, etc.
11913 @item -fsanitize=integer-divide-by-zero
11914 @opindex fsanitize=integer-divide-by-zero
11915 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11917 @item -fsanitize=unreachable
11918 @opindex fsanitize=unreachable
11919 With this option, the compiler turns the @code{__builtin_unreachable}
11920 call into a diagnostics message call instead.  When reaching the
11921 @code{__builtin_unreachable} call, the behavior is undefined.
11923 @item -fsanitize=vla-bound
11924 @opindex fsanitize=vla-bound
11925 This option instructs the compiler to check that the size of a variable
11926 length array is positive.
11928 @item -fsanitize=null
11929 @opindex fsanitize=null
11930 This option enables pointer checking.  Particularly, the application
11931 built with this option turned on will issue an error message when it
11932 tries to dereference a NULL pointer, or if a reference (possibly an
11933 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11934 on an object pointed by a NULL pointer.
11936 @item -fsanitize=return
11937 @opindex fsanitize=return
11938 This option enables return statement checking.  Programs
11939 built with this option turned on will issue an error message
11940 when the end of a non-void function is reached without actually
11941 returning a value.  This option works in C++ only.
11943 @item -fsanitize=signed-integer-overflow
11944 @opindex fsanitize=signed-integer-overflow
11945 This option enables signed integer overflow checking.  We check that
11946 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11947 does not overflow in the signed arithmetics.  Note, integer promotion
11948 rules must be taken into account.  That is, the following is not an
11949 overflow:
11950 @smallexample
11951 signed char a = SCHAR_MAX;
11952 a++;
11953 @end smallexample
11955 @item -fsanitize=bounds
11956 @opindex fsanitize=bounds
11957 This option enables instrumentation of array bounds.  Various out of bounds
11958 accesses are detected.  Flexible array members, flexible array member-like
11959 arrays, and initializers of variables with static storage are not instrumented.
11961 @item -fsanitize=bounds-strict
11962 @opindex fsanitize=bounds-strict
11963 This option enables strict instrumentation of array bounds.  Most out of bounds
11964 accesses are detected, including flexible array members and flexible array
11965 member-like arrays.  Initializers of variables with static storage are not
11966 instrumented.
11968 @item -fsanitize=alignment
11969 @opindex fsanitize=alignment
11971 This option enables checking of alignment of pointers when they are
11972 dereferenced, or when a reference is bound to insufficiently aligned target,
11973 or when a method or constructor is invoked on insufficiently aligned object.
11975 @item -fsanitize=object-size
11976 @opindex fsanitize=object-size
11977 This option enables instrumentation of memory references using the
11978 @code{__builtin_object_size} function.  Various out of bounds pointer
11979 accesses are detected.
11981 @item -fsanitize=float-divide-by-zero
11982 @opindex fsanitize=float-divide-by-zero
11983 Detect floating-point division by zero.  Unlike other similar options,
11984 @option{-fsanitize=float-divide-by-zero} is not enabled by
11985 @option{-fsanitize=undefined}, since floating-point division by zero can
11986 be a legitimate way of obtaining infinities and NaNs.
11988 @item -fsanitize=float-cast-overflow
11989 @opindex fsanitize=float-cast-overflow
11990 This option enables floating-point type to integer conversion checking.
11991 We check that the result of the conversion does not overflow.
11992 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11993 not enabled by @option{-fsanitize=undefined}.
11994 This option does not work well with @code{FE_INVALID} exceptions enabled.
11996 @item -fsanitize=nonnull-attribute
11997 @opindex fsanitize=nonnull-attribute
11999 This option enables instrumentation of calls, checking whether null values
12000 are not passed to arguments marked as requiring a non-null value by the
12001 @code{nonnull} function attribute.
12003 @item -fsanitize=returns-nonnull-attribute
12004 @opindex fsanitize=returns-nonnull-attribute
12006 This option enables instrumentation of return statements in functions
12007 marked with @code{returns_nonnull} function attribute, to detect returning
12008 of null values from such functions.
12010 @item -fsanitize=bool
12011 @opindex fsanitize=bool
12013 This option enables instrumentation of loads from bool.  If a value other
12014 than 0/1 is loaded, a run-time error is issued.
12016 @item -fsanitize=enum
12017 @opindex fsanitize=enum
12019 This option enables instrumentation of loads from an enum type.  If
12020 a value outside the range of values for the enum type is loaded,
12021 a run-time error is issued.
12023 @item -fsanitize=vptr
12024 @opindex fsanitize=vptr
12026 This option enables instrumentation of C++ member function calls, member
12027 accesses and some conversions between pointers to base and derived classes,
12028 to verify the referenced object has the correct dynamic type.
12030 @item -fsanitize=pointer-overflow
12031 @opindex fsanitize=pointer-overflow
12033 This option enables instrumentation of pointer arithmetics.  If the pointer
12034 arithmetics overflows, a run-time error is issued.
12036 @item -fsanitize=builtin
12037 @opindex fsanitize=builtin
12039 This option enables instrumentation of arguments to selected builtin
12040 functions.  If an invalid value is passed to such arguments, a run-time
12041 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
12042 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
12043 by this option.
12045 @end table
12047 While @option{-ftrapv} causes traps for signed overflows to be emitted,
12048 @option{-fsanitize=undefined} gives a diagnostic message.
12049 This currently works only for the C family of languages.
12051 @item -fno-sanitize=all
12052 @opindex fno-sanitize=all
12054 This option disables all previously enabled sanitizers.
12055 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
12056 together.
12058 @item -fasan-shadow-offset=@var{number}
12059 @opindex fasan-shadow-offset
12060 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
12061 It is useful for experimenting with different shadow memory layouts in
12062 Kernel AddressSanitizer.
12064 @item -fsanitize-sections=@var{s1},@var{s2},...
12065 @opindex fsanitize-sections
12066 Sanitize global variables in selected user-defined sections.  @var{si} may
12067 contain wildcards.
12069 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
12070 @opindex fsanitize-recover
12071 @opindex fno-sanitize-recover
12072 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
12073 mentioned in comma-separated list of @var{opts}.  Enabling this option
12074 for a sanitizer component causes it to attempt to continue
12075 running the program as if no error happened.  This means multiple
12076 runtime errors can be reported in a single program run, and the exit
12077 code of the program may indicate success even when errors
12078 have been reported.  The @option{-fno-sanitize-recover=} option
12079 can be used to alter
12080 this behavior: only the first detected error is reported
12081 and program then exits with a non-zero exit code.
12083 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
12084 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
12085 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
12086 @option{-fsanitize=bounds-strict},
12087 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
12088 For these sanitizers error recovery is turned on by default,
12089 except @option{-fsanitize=address}, for which this feature is experimental.
12090 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
12091 accepted, the former enables recovery for all sanitizers that support it,
12092 the latter disables recovery for all sanitizers that support it.
12094 Even if a recovery mode is turned on the compiler side, it needs to be also
12095 enabled on the runtime library side, otherwise the failures are still fatal.
12096 The runtime library defaults to @code{halt_on_error=0} for
12097 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
12098 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
12099 setting the @code{halt_on_error} flag in the corresponding environment variable.
12101 Syntax without an explicit @var{opts} parameter is deprecated.  It is
12102 equivalent to specifying an @var{opts} list of:
12104 @smallexample
12105 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
12106 @end smallexample
12108 @item -fsanitize-address-use-after-scope
12109 @opindex fsanitize-address-use-after-scope
12110 Enable sanitization of local variables to detect use-after-scope bugs.
12111 The option sets @option{-fstack-reuse} to @samp{none}.
12113 @item -fsanitize-undefined-trap-on-error
12114 @opindex fsanitize-undefined-trap-on-error
12115 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
12116 report undefined behavior using @code{__builtin_trap} rather than
12117 a @code{libubsan} library routine.  The advantage of this is that the
12118 @code{libubsan} library is not needed and is not linked in, so this
12119 is usable even in freestanding environments.
12121 @item -fsanitize-coverage=trace-pc
12122 @opindex fsanitize-coverage=trace-pc
12123 Enable coverage-guided fuzzing code instrumentation.
12124 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
12126 @item -fsanitize-coverage=trace-cmp
12127 @opindex fsanitize-coverage=trace-cmp
12128 Enable dataflow guided fuzzing code instrumentation.
12129 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
12130 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
12131 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
12132 variable or @code{__sanitizer_cov_trace_const_cmp1},
12133 @code{__sanitizer_cov_trace_const_cmp2},
12134 @code{__sanitizer_cov_trace_const_cmp4} or
12135 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
12136 operand constant, @code{__sanitizer_cov_trace_cmpf} or
12137 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
12138 @code{__sanitizer_cov_trace_switch} for switch statements.
12140 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
12141 @opindex fcf-protection
12142 Enable code instrumentation of control-flow transfers to increase
12143 program security by checking that target addresses of control-flow
12144 transfer instructions (such as indirect function call, function return,
12145 indirect jump) are valid.  This prevents diverting the flow of control
12146 to an unexpected target.  This is intended to protect against such
12147 threats as Return-oriented Programming (ROP), and similarly
12148 call/jmp-oriented programming (COP/JOP).
12150 The value @code{branch} tells the compiler to implement checking of
12151 validity of control-flow transfer at the point of indirect branch
12152 instructions, i.e.@: call/jmp instructions.  The value @code{return}
12153 implements checking of validity at the point of returning from a
12154 function.  The value @code{full} is an alias for specifying both
12155 @code{branch} and @code{return}. The value @code{none} turns off
12156 instrumentation.
12158 The macro @code{__CET__} is defined when @option{-fcf-protection} is
12159 used.  The first bit of @code{__CET__} is set to 1 for the value
12160 @code{branch} and the second bit of @code{__CET__} is set to 1 for
12161 the @code{return}.
12163 You can also use the @code{nocf_check} attribute to identify
12164 which functions and calls should be skipped from instrumentation
12165 (@pxref{Function Attributes}).
12167 Currently the x86 GNU/Linux target provides an implementation based
12168 on Intel Control-flow Enforcement Technology (CET).
12170 @item -fstack-protector
12171 @opindex fstack-protector
12172 Emit extra code to check for buffer overflows, such as stack smashing
12173 attacks.  This is done by adding a guard variable to functions with
12174 vulnerable objects.  This includes functions that call @code{alloca}, and
12175 functions with buffers larger than 8 bytes.  The guards are initialized
12176 when a function is entered and then checked when the function exits.
12177 If a guard check fails, an error message is printed and the program exits.
12179 @item -fstack-protector-all
12180 @opindex fstack-protector-all
12181 Like @option{-fstack-protector} except that all functions are protected.
12183 @item -fstack-protector-strong
12184 @opindex fstack-protector-strong
12185 Like @option{-fstack-protector} but includes additional functions to
12186 be protected --- those that have local array definitions, or have
12187 references to local frame addresses.
12189 @item -fstack-protector-explicit
12190 @opindex fstack-protector-explicit
12191 Like @option{-fstack-protector} but only protects those functions which
12192 have the @code{stack_protect} attribute.
12194 @item -fstack-check
12195 @opindex fstack-check
12196 Generate code to verify that you do not go beyond the boundary of the
12197 stack.  You should specify this flag if you are running in an
12198 environment with multiple threads, but you only rarely need to specify it in
12199 a single-threaded environment since stack overflow is automatically
12200 detected on nearly all systems if there is only one stack.
12202 Note that this switch does not actually cause checking to be done; the
12203 operating system or the language runtime must do that.  The switch causes
12204 generation of code to ensure that they see the stack being extended.
12206 You can additionally specify a string parameter: @samp{no} means no
12207 checking, @samp{generic} means force the use of old-style checking,
12208 @samp{specific} means use the best checking method and is equivalent
12209 to bare @option{-fstack-check}.
12211 Old-style checking is a generic mechanism that requires no specific
12212 target support in the compiler but comes with the following drawbacks:
12214 @enumerate
12215 @item
12216 Modified allocation strategy for large objects: they are always
12217 allocated dynamically if their size exceeds a fixed threshold.  Note this
12218 may change the semantics of some code.
12220 @item
12221 Fixed limit on the size of the static frame of functions: when it is
12222 topped by a particular function, stack checking is not reliable and
12223 a warning is issued by the compiler.
12225 @item
12226 Inefficiency: because of both the modified allocation strategy and the
12227 generic implementation, code performance is hampered.
12228 @end enumerate
12230 Note that old-style stack checking is also the fallback method for
12231 @samp{specific} if no target support has been added in the compiler.
12233 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
12234 and stack overflows.  @samp{specific} is an excellent choice when compiling
12235 Ada code.  It is not generally sufficient to protect against stack-clash
12236 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
12238 @item -fstack-clash-protection
12239 @opindex fstack-clash-protection
12240 Generate code to prevent stack clash style attacks.  When this option is
12241 enabled, the compiler will only allocate one page of stack space at a time
12242 and each page is accessed immediately after allocation.  Thus, it prevents
12243 allocations from jumping over any stack guard page provided by the
12244 operating system.
12246 Most targets do not fully support stack clash protection.  However, on
12247 those targets @option{-fstack-clash-protection} will protect dynamic stack
12248 allocations.  @option{-fstack-clash-protection} may also provide limited
12249 protection for static stack allocations if the target supports
12250 @option{-fstack-check=specific}.
12252 @item -fstack-limit-register=@var{reg}
12253 @itemx -fstack-limit-symbol=@var{sym}
12254 @itemx -fno-stack-limit
12255 @opindex fstack-limit-register
12256 @opindex fstack-limit-symbol
12257 @opindex fno-stack-limit
12258 Generate code to ensure that the stack does not grow beyond a certain value,
12259 either the value of a register or the address of a symbol.  If a larger
12260 stack is required, a signal is raised at run time.  For most targets,
12261 the signal is raised before the stack overruns the boundary, so
12262 it is possible to catch the signal without taking special precautions.
12264 For instance, if the stack starts at absolute address @samp{0x80000000}
12265 and grows downwards, you can use the flags
12266 @option{-fstack-limit-symbol=__stack_limit} and
12267 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12268 of 128KB@.  Note that this may only work with the GNU linker.
12270 You can locally override stack limit checking by using the
12271 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
12273 @item -fsplit-stack
12274 @opindex fsplit-stack
12275 Generate code to automatically split the stack before it overflows.
12276 The resulting program has a discontiguous stack which can only
12277 overflow if the program is unable to allocate any more memory.  This
12278 is most useful when running threaded programs, as it is no longer
12279 necessary to calculate a good stack size to use for each thread.  This
12280 is currently only implemented for the x86 targets running
12281 GNU/Linux.
12283 When code compiled with @option{-fsplit-stack} calls code compiled
12284 without @option{-fsplit-stack}, there may not be much stack space
12285 available for the latter code to run.  If compiling all code,
12286 including library code, with @option{-fsplit-stack} is not an option,
12287 then the linker can fix up these calls so that the code compiled
12288 without @option{-fsplit-stack} always has a large stack.  Support for
12289 this is implemented in the gold linker in GNU binutils release 2.21
12290 and later.
12292 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
12293 @opindex fvtable-verify
12294 This option is only available when compiling C++ code.
12295 It turns on (or off, if using @option{-fvtable-verify=none}) the security
12296 feature that verifies at run time, for every virtual call, that
12297 the vtable pointer through which the call is made is valid for the type of
12298 the object, and has not been corrupted or overwritten.  If an invalid vtable
12299 pointer is detected at run time, an error is reported and execution of the
12300 program is immediately halted.
12302 This option causes run-time data structures to be built at program startup,
12303 which are used for verifying the vtable pointers.  
12304 The options @samp{std} and @samp{preinit}
12305 control the timing of when these data structures are built.  In both cases the
12306 data structures are built before execution reaches @code{main}.  Using
12307 @option{-fvtable-verify=std} causes the data structures to be built after
12308 shared libraries have been loaded and initialized.
12309 @option{-fvtable-verify=preinit} causes them to be built before shared
12310 libraries have been loaded and initialized.
12312 If this option appears multiple times in the command line with different
12313 values specified, @samp{none} takes highest priority over both @samp{std} and
12314 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
12316 @item -fvtv-debug
12317 @opindex fvtv-debug
12318 When used in conjunction with @option{-fvtable-verify=std} or 
12319 @option{-fvtable-verify=preinit}, causes debug versions of the 
12320 runtime functions for the vtable verification feature to be called.  
12321 This flag also causes the compiler to log information about which 
12322 vtable pointers it finds for each class.
12323 This information is written to a file named @file{vtv_set_ptr_data.log} 
12324 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
12325 if that is defined or the current working directory otherwise.
12327 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
12328 file, be sure to delete any existing one.
12330 @item -fvtv-counts
12331 @opindex fvtv-counts
12332 This is a debugging flag.  When used in conjunction with
12333 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
12334 causes the compiler to keep track of the total number of virtual calls
12335 it encounters and the number of verifications it inserts.  It also
12336 counts the number of calls to certain run-time library functions
12337 that it inserts and logs this information for each compilation unit.
12338 The compiler writes this information to a file named
12339 @file{vtv_count_data.log} in the directory named by the environment
12340 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12341 directory otherwise.  It also counts the size of the vtable pointer sets
12342 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12343 in the same directory.
12345 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12346 files, be sure to delete any existing ones.
12348 @item -finstrument-functions
12349 @opindex finstrument-functions
12350 Generate instrumentation calls for entry and exit to functions.  Just
12351 after function entry and just before function exit, the following
12352 profiling functions are called with the address of the current
12353 function and its call site.  (On some platforms,
12354 @code{__builtin_return_address} does not work beyond the current
12355 function, so the call site information may not be available to the
12356 profiling functions otherwise.)
12358 @smallexample
12359 void __cyg_profile_func_enter (void *this_fn,
12360                                void *call_site);
12361 void __cyg_profile_func_exit  (void *this_fn,
12362                                void *call_site);
12363 @end smallexample
12365 The first argument is the address of the start of the current function,
12366 which may be looked up exactly in the symbol table.
12368 This instrumentation is also done for functions expanded inline in other
12369 functions.  The profiling calls indicate where, conceptually, the
12370 inline function is entered and exited.  This means that addressable
12371 versions of such functions must be available.  If all your uses of a
12372 function are expanded inline, this may mean an additional expansion of
12373 code size.  If you use @code{extern inline} in your C code, an
12374 addressable version of such functions must be provided.  (This is
12375 normally the case anyway, but if you get lucky and the optimizer always
12376 expands the functions inline, you might have gotten away without
12377 providing static copies.)
12379 A function may be given the attribute @code{no_instrument_function}, in
12380 which case this instrumentation is not done.  This can be used, for
12381 example, for the profiling functions listed above, high-priority
12382 interrupt routines, and any functions from which the profiling functions
12383 cannot safely be called (perhaps signal handlers, if the profiling
12384 routines generate output or allocate memory).
12386 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12387 @opindex finstrument-functions-exclude-file-list
12389 Set the list of functions that are excluded from instrumentation (see
12390 the description of @option{-finstrument-functions}).  If the file that
12391 contains a function definition matches with one of @var{file}, then
12392 that function is not instrumented.  The match is done on substrings:
12393 if the @var{file} parameter is a substring of the file name, it is
12394 considered to be a match.
12396 For example:
12398 @smallexample
12399 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12400 @end smallexample
12402 @noindent
12403 excludes any inline function defined in files whose pathnames
12404 contain @file{/bits/stl} or @file{include/sys}.
12406 If, for some reason, you want to include letter @samp{,} in one of
12407 @var{sym}, write @samp{\,}. For example,
12408 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12409 (note the single quote surrounding the option).
12411 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12412 @opindex finstrument-functions-exclude-function-list
12414 This is similar to @option{-finstrument-functions-exclude-file-list},
12415 but this option sets the list of function names to be excluded from
12416 instrumentation.  The function name to be matched is its user-visible
12417 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12418 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12419 match is done on substrings: if the @var{sym} parameter is a substring
12420 of the function name, it is considered to be a match.  For C99 and C++
12421 extended identifiers, the function name must be given in UTF-8, not
12422 using universal character names.
12424 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12425 @opindex fpatchable-function-entry
12426 Generate @var{N} NOPs right at the beginning
12427 of each function, with the function entry point before the @var{M}th NOP.
12428 If @var{M} is omitted, it defaults to @code{0} so the
12429 function entry points to the address just at the first NOP.
12430 The NOP instructions reserve extra space which can be used to patch in
12431 any desired instrumentation at run time, provided that the code segment
12432 is writable.  The amount of space is controllable indirectly via
12433 the number of NOPs; the NOP instruction used corresponds to the instruction
12434 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12435 is target-specific and may also depend on the architecture variant and/or
12436 other compilation options.
12438 For run-time identification, the starting addresses of these areas,
12439 which correspond to their respective function entries minus @var{M},
12440 are additionally collected in the @code{__patchable_function_entries}
12441 section of the resulting binary.
12443 Note that the value of @code{__attribute__ ((patchable_function_entry
12444 (N,M)))} takes precedence over command-line option
12445 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12446 the area size or to remove it completely on a single function.
12447 If @code{N=0}, no pad location is recorded.
12449 The NOP instructions are inserted at---and maybe before, depending on
12450 @var{M}---the function entry address, even before the prologue.
12452 @end table
12455 @node Preprocessor Options
12456 @section Options Controlling the Preprocessor
12457 @cindex preprocessor options
12458 @cindex options, preprocessor
12460 These options control the C preprocessor, which is run on each C source
12461 file before actual compilation.
12463 If you use the @option{-E} option, nothing is done except preprocessing.
12464 Some of these options make sense only together with @option{-E} because
12465 they cause the preprocessor output to be unsuitable for actual
12466 compilation.
12468 In addition to the options listed here, there are a number of options 
12469 to control search paths for include files documented in 
12470 @ref{Directory Options}.  
12471 Options to control preprocessor diagnostics are listed in 
12472 @ref{Warning Options}.
12474 @table @gcctabopt
12475 @include cppopts.texi
12477 @item -Wp,@var{option}
12478 @opindex Wp
12479 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12480 and pass @var{option} directly through to the preprocessor.  If
12481 @var{option} contains commas, it is split into multiple options at the
12482 commas.  However, many options are modified, translated or interpreted
12483 by the compiler driver before being passed to the preprocessor, and
12484 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12485 interface is undocumented and subject to change, so whenever possible
12486 you should avoid using @option{-Wp} and let the driver handle the
12487 options instead.
12489 @item -Xpreprocessor @var{option}
12490 @opindex Xpreprocessor
12491 Pass @var{option} as an option to the preprocessor.  You can use this to
12492 supply system-specific preprocessor options that GCC does not 
12493 recognize.
12495 If you want to pass an option that takes an argument, you must use
12496 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12498 @item -no-integrated-cpp
12499 @opindex no-integrated-cpp
12500 Perform preprocessing as a separate pass before compilation.
12501 By default, GCC performs preprocessing as an integrated part of
12502 input tokenization and parsing.
12503 If this option is provided, the appropriate language front end
12504 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12505 and Objective-C, respectively) is instead invoked twice,
12506 once for preprocessing only and once for actual compilation
12507 of the preprocessed input.
12508 This option may be useful in conjunction with the @option{-B} or
12509 @option{-wrapper} options to specify an alternate preprocessor or
12510 perform additional processing of the program source between
12511 normal preprocessing and compilation.
12513 @end table
12515 @node Assembler Options
12516 @section Passing Options to the Assembler
12518 @c prevent bad page break with this line
12519 You can pass options to the assembler.
12521 @table @gcctabopt
12522 @item -Wa,@var{option}
12523 @opindex Wa
12524 Pass @var{option} as an option to the assembler.  If @var{option}
12525 contains commas, it is split into multiple options at the commas.
12527 @item -Xassembler @var{option}
12528 @opindex Xassembler
12529 Pass @var{option} as an option to the assembler.  You can use this to
12530 supply system-specific assembler options that GCC does not
12531 recognize.
12533 If you want to pass an option that takes an argument, you must use
12534 @option{-Xassembler} twice, once for the option and once for the argument.
12536 @end table
12538 @node Link Options
12539 @section Options for Linking
12540 @cindex link options
12541 @cindex options, linking
12543 These options come into play when the compiler links object files into
12544 an executable output file.  They are meaningless if the compiler is
12545 not doing a link step.
12547 @table @gcctabopt
12548 @cindex file names
12549 @item @var{object-file-name}
12550 A file name that does not end in a special recognized suffix is
12551 considered to name an object file or library.  (Object files are
12552 distinguished from libraries by the linker according to the file
12553 contents.)  If linking is done, these object files are used as input
12554 to the linker.
12556 @item -c
12557 @itemx -S
12558 @itemx -E
12559 @opindex c
12560 @opindex S
12561 @opindex E
12562 If any of these options is used, then the linker is not run, and
12563 object file names should not be used as arguments.  @xref{Overall
12564 Options}.
12566 @item -flinker-output=@var{type}
12567 @opindex flinker-output
12568 This option controls the code generation of the link time optimizer.  By
12569 default the linker output is determined by the linker plugin automatically. For
12570 debugging the compiler and in the case of incremental linking to non-lto object
12571 file is desired, it may be useful to control the type manually.
12573 If @var{type} is @samp{exec} the code generation is configured to produce static
12574 binary. In this case @option{-fpic} and @option{-fpie} are both disabled.
12576 If @var{type} is @samp{dyn} the code generation is configured to produce shared
12577 library. In this case @option{-fpic} or @option{-fPIC} is preserved, but not
12578 enabled automatically.  This makes it possible to build shared libraries without
12579 position independent code on architectures this is possible, i.e.@: on x86.
12581 If @var{type} is @samp{pie} the code generation is configured to produce
12582 @option{-fpie} executable. This result in similar optimizations as @samp{exec}
12583 except that @option{-fpie} is not disabled if specified at compilation time.
12585 If @var{type} is @samp{rel} the compiler assumes that incremental linking is
12586 done.  The sections containing intermediate code for link-time optimization are
12587 merged, pre-optimized, and output to the resulting object file. In addition, if
12588 @option{-ffat-lto-objects} is specified the binary code is produced for future
12589 non-lto linking. The object file produced by incremental linking will be smaller
12590 than a static library produced from the same object files.  At link-time the
12591 result of incremental linking will also load faster to compiler than a static
12592 library assuming that majority of objects in the library are used.
12594 Finally @samp{nolto-rel} configure compiler to for incremental linking where
12595 code generation is forced, final binary is produced and the intermediate code
12596 for later link-time optimization is stripped. When multiple object files are
12597 linked together the resulting code will be optimized better than with link time
12598 optimizations disabled (for example, the cross-module inlining will happen),
12599 most of benefits of whole program optimizations are however lost. 
12601 During the incremental link (by @option{-r}) the linker plugin will default to
12602 @option{rel}. With current interfaces to GNU Binutils it is however not
12603 possible to link incrementally LTO objects and non-LTO objects into a single
12604 mixed object file.  In the case any of object files in incremental link can not
12605 be used for link-time optimization the linker plugin will output warning and
12606 use @samp{nolto-rel}. To maintain the whole program optimization it is
12607 recommended to link such objects into static library instead. Alternatively it
12608 is possible to use H.J. Lu's binutils with support for mixed objects.
12610 @item -fuse-ld=bfd
12611 @opindex fuse-ld=bfd
12612 Use the @command{bfd} linker instead of the default linker.
12614 @item -fuse-ld=gold
12615 @opindex fuse-ld=gold
12616 Use the @command{gold} linker instead of the default linker.
12618 @item -fuse-ld=lld
12619 @opindex fuse-ld=lld
12620 Use the LLVM @command{lld} linker instead of the default linker.
12622 @cindex Libraries
12623 @item -l@var{library}
12624 @itemx -l @var{library}
12625 @opindex l
12626 Search the library named @var{library} when linking.  (The second
12627 alternative with the library as a separate argument is only for
12628 POSIX compliance and is not recommended.)
12630 It makes a difference where in the command you write this option; the
12631 linker searches and processes libraries and object files in the order they
12632 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12633 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12634 to functions in @samp{z}, those functions may not be loaded.
12636 The linker searches a standard list of directories for the library,
12637 which is actually a file named @file{lib@var{library}.a}.  The linker
12638 then uses this file as if it had been specified precisely by name.
12640 The directories searched include several standard system directories
12641 plus any that you specify with @option{-L}.
12643 Normally the files found this way are library files---archive files
12644 whose members are object files.  The linker handles an archive file by
12645 scanning through it for members which define symbols that have so far
12646 been referenced but not defined.  But if the file that is found is an
12647 ordinary object file, it is linked in the usual fashion.  The only
12648 difference between using an @option{-l} option and specifying a file name
12649 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12650 and searches several directories.
12652 @item -lobjc
12653 @opindex lobjc
12654 You need this special case of the @option{-l} option in order to
12655 link an Objective-C or Objective-C++ program.
12657 @item -nostartfiles
12658 @opindex nostartfiles
12659 Do not use the standard system startup files when linking.
12660 The standard system libraries are used normally, unless @option{-nostdlib},
12661 @option{-nolibc}, or @option{-nodefaultlibs} is used.
12663 @item -nodefaultlibs
12664 @opindex nodefaultlibs
12665 Do not use the standard system libraries when linking.
12666 Only the libraries you specify are passed to the linker, and options
12667 specifying linkage of the system libraries, such as @option{-static-libgcc}
12668 or @option{-shared-libgcc}, are ignored.  
12669 The standard startup files are used normally, unless @option{-nostartfiles}
12670 is used.  
12672 The compiler may generate calls to @code{memcmp},
12673 @code{memset}, @code{memcpy} and @code{memmove}.
12674 These entries are usually resolved by entries in
12675 libc.  These entry points should be supplied through some other
12676 mechanism when this option is specified.
12678 @item -nolibc
12679 @opindex nolibc
12680 Do not use the C library or system libraries tightly coupled with it when
12681 linking.  Still link with the startup files, @file{libgcc} or toolchain
12682 provided language support libraries such as @file{libgnat}, @file{libgfortran}
12683 or @file{libstdc++} unless options preventing their inclusion are used as
12684 well.  This typically removes @option{-lc} from the link command line, as well
12685 as system libraries that normally go with it and become meaningless when
12686 absence of a C library is assumed, for example @option{-lpthread} or
12687 @option{-lm} in some configurations.  This is intended for bare-board
12688 targets when there is indeed no C library available.
12690 @item -nostdlib
12691 @opindex nostdlib
12692 Do not use the standard system startup files or libraries when linking.
12693 No startup files and only the libraries you specify are passed to
12694 the linker, and options specifying linkage of the system libraries, such as
12695 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12697 The compiler may generate calls to @code{memcmp}, @code{memset},
12698 @code{memcpy} and @code{memmove}.
12699 These entries are usually resolved by entries in
12700 libc.  These entry points should be supplied through some other
12701 mechanism when this option is specified.
12703 @cindex @option{-lgcc}, use with @option{-nostdlib}
12704 @cindex @option{-nostdlib} and unresolved references
12705 @cindex unresolved references and @option{-nostdlib}
12706 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12707 @cindex @option{-nodefaultlibs} and unresolved references
12708 @cindex unresolved references and @option{-nodefaultlibs}
12709 One of the standard libraries bypassed by @option{-nostdlib} and
12710 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12711 which GCC uses to overcome shortcomings of particular machines, or special
12712 needs for some languages.
12713 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12714 Collection (GCC) Internals},
12715 for more discussion of @file{libgcc.a}.)
12716 In most cases, you need @file{libgcc.a} even when you want to avoid
12717 other standard libraries.  In other words, when you specify @option{-nostdlib}
12718 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12719 This ensures that you have no unresolved references to internal GCC
12720 library subroutines.
12721 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12722 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12723 GNU Compiler Collection (GCC) Internals}.)
12725 @item -e @var{entry}
12726 @itemx --entry=@var{entry}
12727 @opindex e
12728 @opindex entry
12730 Specify that the program entry point is @var{entry}.  The argument is
12731 interpreted by the linker; the GNU linker accepts either a symbol name
12732 or an address.
12734 @item -pie
12735 @opindex pie
12736 Produce a dynamically linked position independent executable on targets
12737 that support it.  For predictable results, you must also specify the same
12738 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12739 or model suboptions) when you specify this linker option.
12741 @item -no-pie
12742 @opindex no-pie
12743 Don't produce a dynamically linked position independent executable.
12745 @item -static-pie
12746 @opindex static-pie
12747 Produce a static position independent executable on targets that support
12748 it.  A static position independent executable is similar to a static
12749 executable, but can be loaded at any address without a dynamic linker.
12750 For predictable results, you must also specify the same set of options
12751 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12752 suboptions) when you specify this linker option.
12754 @item -pthread
12755 @opindex pthread
12756 Link with the POSIX threads library.  This option is supported on 
12757 GNU/Linux targets, most other Unix derivatives, and also on 
12758 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12759 flags for the preprocessor, so it should be used consistently for both
12760 compilation and linking.
12762 @item -r
12763 @opindex r
12764 Produce a relocatable object as output.  This is also known as partial
12765 linking.
12767 @item -rdynamic
12768 @opindex rdynamic
12769 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12770 that support it. This instructs the linker to add all symbols, not
12771 only used ones, to the dynamic symbol table. This option is needed
12772 for some uses of @code{dlopen} or to allow obtaining backtraces
12773 from within a program.
12775 @item -s
12776 @opindex s
12777 Remove all symbol table and relocation information from the executable.
12779 @item -static
12780 @opindex static
12781 On systems that support dynamic linking, this overrides @option{-pie}
12782 and prevents linking with the shared libraries.  On other systems, this
12783 option has no effect.
12785 @item -shared
12786 @opindex shared
12787 Produce a shared object which can then be linked with other objects to
12788 form an executable.  Not all systems support this option.  For predictable
12789 results, you must also specify the same set of options used for compilation
12790 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12791 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12792 needs to build supplementary stub code for constructors to work.  On
12793 multi-libbed systems, @samp{gcc -shared} must select the correct support
12794 libraries to link against.  Failing to supply the correct flags may lead
12795 to subtle defects.  Supplying them in cases where they are not necessary
12796 is innocuous.}
12798 @item -shared-libgcc
12799 @itemx -static-libgcc
12800 @opindex shared-libgcc
12801 @opindex static-libgcc
12802 On systems that provide @file{libgcc} as a shared library, these options
12803 force the use of either the shared or static version, respectively.
12804 If no shared version of @file{libgcc} was built when the compiler was
12805 configured, these options have no effect.
12807 There are several situations in which an application should use the
12808 shared @file{libgcc} instead of the static version.  The most common
12809 of these is when the application wishes to throw and catch exceptions
12810 across different shared libraries.  In that case, each of the libraries
12811 as well as the application itself should use the shared @file{libgcc}.
12813 Therefore, the G++ driver automatically adds @option{-shared-libgcc}
12814 whenever you build a shared library or a main executable, because C++
12815 programs typically use exceptions, so this is the right thing to do.
12817 If, instead, you use the GCC driver to create shared libraries, you may
12818 find that they are not always linked with the shared @file{libgcc}.
12819 If GCC finds, at its configuration time, that you have a non-GNU linker
12820 or a GNU linker that does not support option @option{--eh-frame-hdr},
12821 it links the shared version of @file{libgcc} into shared libraries
12822 by default.  Otherwise, it takes advantage of the linker and optimizes
12823 away the linking with the shared version of @file{libgcc}, linking with
12824 the static version of libgcc by default.  This allows exceptions to
12825 propagate through such shared libraries, without incurring relocation
12826 costs at library load time.
12828 However, if a library or main executable is supposed to throw or catch
12829 exceptions, you must link it using the G++ driver, or using the option
12830 @option{-shared-libgcc}, such that it is linked with the shared
12831 @file{libgcc}.
12833 @item -static-libasan
12834 @opindex static-libasan
12835 When the @option{-fsanitize=address} option is used to link a program,
12836 the GCC driver automatically links against @option{libasan}.  If
12837 @file{libasan} is available as a shared library, and the @option{-static}
12838 option is not used, then this links against the shared version of
12839 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12840 driver to link @file{libasan} statically, without necessarily linking
12841 other libraries statically.
12843 @item -static-libtsan
12844 @opindex static-libtsan
12845 When the @option{-fsanitize=thread} option is used to link a program,
12846 the GCC driver automatically links against @option{libtsan}.  If
12847 @file{libtsan} is available as a shared library, and the @option{-static}
12848 option is not used, then this links against the shared version of
12849 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12850 driver to link @file{libtsan} statically, without necessarily linking
12851 other libraries statically.
12853 @item -static-liblsan
12854 @opindex static-liblsan
12855 When the @option{-fsanitize=leak} option is used to link a program,
12856 the GCC driver automatically links against @option{liblsan}.  If
12857 @file{liblsan} is available as a shared library, and the @option{-static}
12858 option is not used, then this links against the shared version of
12859 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12860 driver to link @file{liblsan} statically, without necessarily linking
12861 other libraries statically.
12863 @item -static-libubsan
12864 @opindex static-libubsan
12865 When the @option{-fsanitize=undefined} option is used to link a program,
12866 the GCC driver automatically links against @option{libubsan}.  If
12867 @file{libubsan} is available as a shared library, and the @option{-static}
12868 option is not used, then this links against the shared version of
12869 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12870 driver to link @file{libubsan} statically, without necessarily linking
12871 other libraries statically.
12873 @item -static-libstdc++
12874 @opindex static-libstdc++
12875 When the @command{g++} program is used to link a C++ program, it
12876 normally automatically links against @option{libstdc++}.  If
12877 @file{libstdc++} is available as a shared library, and the
12878 @option{-static} option is not used, then this links against the
12879 shared version of @file{libstdc++}.  That is normally fine.  However, it
12880 is sometimes useful to freeze the version of @file{libstdc++} used by
12881 the program without going all the way to a fully static link.  The
12882 @option{-static-libstdc++} option directs the @command{g++} driver to
12883 link @file{libstdc++} statically, without necessarily linking other
12884 libraries statically.
12886 @item -symbolic
12887 @opindex symbolic
12888 Bind references to global symbols when building a shared object.  Warn
12889 about any unresolved references (unless overridden by the link editor
12890 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12891 this option.
12893 @item -T @var{script}
12894 @opindex T
12895 @cindex linker script
12896 Use @var{script} as the linker script.  This option is supported by most
12897 systems using the GNU linker.  On some targets, such as bare-board
12898 targets without an operating system, the @option{-T} option may be required
12899 when linking to avoid references to undefined symbols.
12901 @item -Xlinker @var{option}
12902 @opindex Xlinker
12903 Pass @var{option} as an option to the linker.  You can use this to
12904 supply system-specific linker options that GCC does not recognize.
12906 If you want to pass an option that takes a separate argument, you must use
12907 @option{-Xlinker} twice, once for the option and once for the argument.
12908 For example, to pass @option{-assert definitions}, you must write
12909 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12910 @option{-Xlinker "-assert definitions"}, because this passes the entire
12911 string as a single argument, which is not what the linker expects.
12913 When using the GNU linker, it is usually more convenient to pass
12914 arguments to linker options using the @option{@var{option}=@var{value}}
12915 syntax than as separate arguments.  For example, you can specify
12916 @option{-Xlinker -Map=output.map} rather than
12917 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12918 this syntax for command-line options.
12920 @item -Wl,@var{option}
12921 @opindex Wl
12922 Pass @var{option} as an option to the linker.  If @var{option} contains
12923 commas, it is split into multiple options at the commas.  You can use this
12924 syntax to pass an argument to the option.
12925 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12926 linker.  When using the GNU linker, you can also get the same effect with
12927 @option{-Wl,-Map=output.map}.
12929 @item -u @var{symbol}
12930 @opindex u
12931 Pretend the symbol @var{symbol} is undefined, to force linking of
12932 library modules to define it.  You can use @option{-u} multiple times with
12933 different symbols to force loading of additional library modules.
12935 @item -z @var{keyword}
12936 @opindex z
12937 @option{-z} is passed directly on to the linker along with the keyword
12938 @var{keyword}. See the section in the documentation of your linker for
12939 permitted values and their meanings.
12940 @end table
12942 @node Directory Options
12943 @section Options for Directory Search
12944 @cindex directory options
12945 @cindex options, directory search
12946 @cindex search path
12948 These options specify directories to search for header files, for
12949 libraries and for parts of the compiler:
12951 @table @gcctabopt
12952 @include cppdiropts.texi
12954 @item -iplugindir=@var{dir}
12955 @opindex iplugindir=
12956 Set the directory to search for plugins that are passed
12957 by @option{-fplugin=@var{name}} instead of
12958 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12959 to be used by the user, but only passed by the driver.
12961 @item -L@var{dir}
12962 @opindex L
12963 Add directory @var{dir} to the list of directories to be searched
12964 for @option{-l}.
12966 @item -B@var{prefix}
12967 @opindex B
12968 This option specifies where to find the executables, libraries,
12969 include files, and data files of the compiler itself.
12971 The compiler driver program runs one or more of the subprograms
12972 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12973 @var{prefix} as a prefix for each program it tries to run, both with and
12974 without @samp{@var{machine}/@var{version}/} for the corresponding target
12975 machine and compiler version.
12977 For each subprogram to be run, the compiler driver first tries the
12978 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12979 is not specified, the driver tries two standard prefixes, 
12980 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12981 those results in a file name that is found, the unmodified program
12982 name is searched for using the directories specified in your
12983 @env{PATH} environment variable.
12985 The compiler checks to see if the path provided by @option{-B}
12986 refers to a directory, and if necessary it adds a directory
12987 separator character at the end of the path.
12989 @option{-B} prefixes that effectively specify directory names also apply
12990 to libraries in the linker, because the compiler translates these
12991 options into @option{-L} options for the linker.  They also apply to
12992 include files in the preprocessor, because the compiler translates these
12993 options into @option{-isystem} options for the preprocessor.  In this case,
12994 the compiler appends @samp{include} to the prefix.
12996 The runtime support file @file{libgcc.a} can also be searched for using
12997 the @option{-B} prefix, if needed.  If it is not found there, the two
12998 standard prefixes above are tried, and that is all.  The file is left
12999 out of the link if it is not found by those means.
13001 Another way to specify a prefix much like the @option{-B} prefix is to use
13002 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
13003 Variables}.
13005 As a special kludge, if the path provided by @option{-B} is
13006 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
13007 9, then it is replaced by @file{[dir/]include}.  This is to help
13008 with boot-strapping the compiler.
13010 @item -no-canonical-prefixes
13011 @opindex no-canonical-prefixes
13012 Do not expand any symbolic links, resolve references to @samp{/../}
13013 or @samp{/./}, or make the path absolute when generating a relative
13014 prefix.
13016 @item --sysroot=@var{dir}
13017 @opindex sysroot
13018 Use @var{dir} as the logical root directory for headers and libraries.
13019 For example, if the compiler normally searches for headers in
13020 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
13021 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
13023 If you use both this option and the @option{-isysroot} option, then
13024 the @option{--sysroot} option applies to libraries, but the
13025 @option{-isysroot} option applies to header files.
13027 The GNU linker (beginning with version 2.16) has the necessary support
13028 for this option.  If your linker does not support this option, the
13029 header file aspect of @option{--sysroot} still works, but the
13030 library aspect does not.
13032 @item --no-sysroot-suffix
13033 @opindex no-sysroot-suffix
13034 For some targets, a suffix is added to the root directory specified
13035 with @option{--sysroot}, depending on the other options used, so that
13036 headers may for example be found in
13037 @file{@var{dir}/@var{suffix}/usr/include} instead of
13038 @file{@var{dir}/usr/include}.  This option disables the addition of
13039 such a suffix.
13041 @end table
13043 @node Code Gen Options
13044 @section Options for Code Generation Conventions
13045 @cindex code generation conventions
13046 @cindex options, code generation
13047 @cindex run-time options
13049 These machine-independent options control the interface conventions
13050 used in code generation.
13052 Most of them have both positive and negative forms; the negative form
13053 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
13054 one of the forms is listed---the one that is not the default.  You
13055 can figure out the other form by either removing @samp{no-} or adding
13058 @table @gcctabopt
13059 @item -fstack-reuse=@var{reuse-level}
13060 @opindex fstack_reuse
13061 This option controls stack space reuse for user declared local/auto variables
13062 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
13063 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
13064 local variables and temporaries, @samp{named_vars} enables the reuse only for
13065 user defined local variables with names, and @samp{none} disables stack reuse
13066 completely. The default value is @samp{all}. The option is needed when the
13067 program extends the lifetime of a scoped local variable or a compiler generated
13068 temporary beyond the end point defined by the language.  When a lifetime of
13069 a variable ends, and if the variable lives in memory, the optimizing compiler
13070 has the freedom to reuse its stack space with other temporaries or scoped
13071 local variables whose live range does not overlap with it. Legacy code extending
13072 local lifetime is likely to break with the stack reuse optimization.
13074 For example,
13076 @smallexample
13077    int *p;
13078    @{
13079      int local1;
13081      p = &local1;
13082      local1 = 10;
13083      ....
13084    @}
13085    @{
13086       int local2;
13087       local2 = 20;
13088       ...
13089    @}
13091    if (*p == 10)  // out of scope use of local1
13092      @{
13094      @}
13095 @end smallexample
13097 Another example:
13098 @smallexample
13100    struct A
13101    @{
13102        A(int k) : i(k), j(k) @{ @}
13103        int i;
13104        int j;
13105    @};
13107    A *ap;
13109    void foo(const A& ar)
13110    @{
13111       ap = &ar;
13112    @}
13114    void bar()
13115    @{
13116       foo(A(10)); // temp object's lifetime ends when foo returns
13118       @{
13119         A a(20);
13120         ....
13121       @}
13122       ap->i+= 10;  // ap references out of scope temp whose space
13123                    // is reused with a. What is the value of ap->i?
13124    @}
13126 @end smallexample
13128 The lifetime of a compiler generated temporary is well defined by the C++
13129 standard. When a lifetime of a temporary ends, and if the temporary lives
13130 in memory, the optimizing compiler has the freedom to reuse its stack
13131 space with other temporaries or scoped local variables whose live range
13132 does not overlap with it. However some of the legacy code relies on
13133 the behavior of older compilers in which temporaries' stack space is
13134 not reused, the aggressive stack reuse can lead to runtime errors. This
13135 option is used to control the temporary stack reuse optimization.
13137 @item -ftrapv
13138 @opindex ftrapv
13139 This option generates traps for signed overflow on addition, subtraction,
13140 multiplication operations.
13141 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
13142 @option{-ftrapv} @option{-fwrapv} on the command-line results in
13143 @option{-fwrapv} being effective.  Note that only active options override, so
13144 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
13145 results in @option{-ftrapv} being effective.
13147 @item -fwrapv
13148 @opindex fwrapv
13149 This option instructs the compiler to assume that signed arithmetic
13150 overflow of addition, subtraction and multiplication wraps around
13151 using twos-complement representation.  This flag enables some optimizations
13152 and disables others.
13153 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
13154 @option{-ftrapv} @option{-fwrapv} on the command-line results in
13155 @option{-fwrapv} being effective.  Note that only active options override, so
13156 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
13157 results in @option{-ftrapv} being effective.
13159 @item -fwrapv-pointer
13160 @opindex fwrapv-pointer
13161 This option instructs the compiler to assume that pointer arithmetic
13162 overflow on addition and subtraction wraps around using twos-complement
13163 representation.  This flag disables some optimizations which assume
13164 pointer overflow is invalid.
13166 @item -fstrict-overflow
13167 @opindex fstrict-overflow
13168 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
13169 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
13171 @item -fexceptions
13172 @opindex fexceptions
13173 Enable exception handling.  Generates extra code needed to propagate
13174 exceptions.  For some targets, this implies GCC generates frame
13175 unwind information for all functions, which can produce significant data
13176 size overhead, although it does not affect execution.  If you do not
13177 specify this option, GCC enables it by default for languages like
13178 C++ that normally require exception handling, and disables it for
13179 languages like C that do not normally require it.  However, you may need
13180 to enable this option when compiling C code that needs to interoperate
13181 properly with exception handlers written in C++.  You may also wish to
13182 disable this option if you are compiling older C++ programs that don't
13183 use exception handling.
13185 @item -fnon-call-exceptions
13186 @opindex fnon-call-exceptions
13187 Generate code that allows trapping instructions to throw exceptions.
13188 Note that this requires platform-specific runtime support that does
13189 not exist everywhere.  Moreover, it only allows @emph{trapping}
13190 instructions to throw exceptions, i.e.@: memory references or floating-point
13191 instructions.  It does not allow exceptions to be thrown from
13192 arbitrary signal handlers such as @code{SIGALRM}.
13194 @item -fdelete-dead-exceptions
13195 @opindex fdelete-dead-exceptions
13196 Consider that instructions that may throw exceptions but don't otherwise
13197 contribute to the execution of the program can be optimized away.
13198 This option is enabled by default for the Ada front end, as permitted by
13199 the Ada language specification.
13200 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
13202 @item -funwind-tables
13203 @opindex funwind-tables
13204 Similar to @option{-fexceptions}, except that it just generates any needed
13205 static data, but does not affect the generated code in any other way.
13206 You normally do not need to enable this option; instead, a language processor
13207 that needs this handling enables it on your behalf.
13209 @item -fasynchronous-unwind-tables
13210 @opindex fasynchronous-unwind-tables
13211 Generate unwind table in DWARF format, if supported by target machine.  The
13212 table is exact at each instruction boundary, so it can be used for stack
13213 unwinding from asynchronous events (such as debugger or garbage collector).
13215 @item -fno-gnu-unique
13216 @opindex fno-gnu-unique
13217 On systems with recent GNU assembler and C library, the C++ compiler
13218 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
13219 of template static data members and static local variables in inline
13220 functions are unique even in the presence of @code{RTLD_LOCAL}; this
13221 is necessary to avoid problems with a library used by two different
13222 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
13223 therefore disagreeing with the other one about the binding of the
13224 symbol.  But this causes @code{dlclose} to be ignored for affected
13225 DSOs; if your program relies on reinitialization of a DSO via
13226 @code{dlclose} and @code{dlopen}, you can use
13227 @option{-fno-gnu-unique}.
13229 @item -fpcc-struct-return
13230 @opindex fpcc-struct-return
13231 Return ``short'' @code{struct} and @code{union} values in memory like
13232 longer ones, rather than in registers.  This convention is less
13233 efficient, but it has the advantage of allowing intercallability between
13234 GCC-compiled files and files compiled with other compilers, particularly
13235 the Portable C Compiler (pcc).
13237 The precise convention for returning structures in memory depends
13238 on the target configuration macros.
13240 Short structures and unions are those whose size and alignment match
13241 that of some integer type.
13243 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13244 switch is not binary compatible with code compiled with the
13245 @option{-freg-struct-return} switch.
13246 Use it to conform to a non-default application binary interface.
13248 @item -freg-struct-return
13249 @opindex freg-struct-return
13250 Return @code{struct} and @code{union} values in registers when possible.
13251 This is more efficient for small structures than
13252 @option{-fpcc-struct-return}.
13254 If you specify neither @option{-fpcc-struct-return} nor
13255 @option{-freg-struct-return}, GCC defaults to whichever convention is
13256 standard for the target.  If there is no standard convention, GCC
13257 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13258 the principal compiler.  In those cases, we can choose the standard, and
13259 we chose the more efficient register return alternative.
13261 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13262 switch is not binary compatible with code compiled with the
13263 @option{-fpcc-struct-return} switch.
13264 Use it to conform to a non-default application binary interface.
13266 @item -fshort-enums
13267 @opindex fshort-enums
13268 Allocate to an @code{enum} type only as many bytes as it needs for the
13269 declared range of possible values.  Specifically, the @code{enum} type
13270 is equivalent to the smallest integer type that has enough room.
13272 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13273 code that is not binary compatible with code generated without that switch.
13274 Use it to conform to a non-default application binary interface.
13276 @item -fshort-wchar
13277 @opindex fshort-wchar
13278 Override the underlying type for @code{wchar_t} to be @code{short
13279 unsigned int} instead of the default for the target.  This option is
13280 useful for building programs to run under WINE@.
13282 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13283 code that is not binary compatible with code generated without that switch.
13284 Use it to conform to a non-default application binary interface.
13286 @item -fno-common
13287 @opindex fno-common
13288 @cindex tentative definitions
13289 In C code, this option controls the placement of global variables 
13290 defined without an initializer, known as @dfn{tentative definitions} 
13291 in the C standard.  Tentative definitions are distinct from declarations 
13292 of a variable with the @code{extern} keyword, which do not allocate storage.
13294 Unix C compilers have traditionally allocated storage for
13295 uninitialized global variables in a common block.  This allows the
13296 linker to resolve all tentative definitions of the same variable
13297 in different compilation units to the same object, or to a non-tentative
13298 definition.  
13299 This is the behavior specified by @option{-fcommon}, and is the default for 
13300 GCC on most targets.  
13301 On the other hand, this behavior is not required by ISO
13302 C, and on some targets may carry a speed or code size penalty on
13303 variable references.
13305 The @option{-fno-common} option specifies that the compiler should instead
13306 place uninitialized global variables in the BSS section of the object file.
13307 This inhibits the merging of tentative definitions by the linker so
13308 you get a multiple-definition error if the same 
13309 variable is defined in more than one compilation unit.
13310 Compiling with @option{-fno-common} is useful on targets for which
13311 it provides better performance, or if you wish to verify that the
13312 program will work on other systems that always treat uninitialized
13313 variable definitions this way.
13315 @item -fno-ident
13316 @opindex fno-ident
13317 Ignore the @code{#ident} directive.
13319 @item -finhibit-size-directive
13320 @opindex finhibit-size-directive
13321 Don't output a @code{.size} assembler directive, or anything else that
13322 would cause trouble if the function is split in the middle, and the
13323 two halves are placed at locations far apart in memory.  This option is
13324 used when compiling @file{crtstuff.c}; you should not need to use it
13325 for anything else.
13327 @item -fverbose-asm
13328 @opindex fverbose-asm
13329 Put extra commentary information in the generated assembly code to
13330 make it more readable.  This option is generally only of use to those
13331 who actually need to read the generated assembly code (perhaps while
13332 debugging the compiler itself).
13334 @option{-fno-verbose-asm}, the default, causes the
13335 extra information to be omitted and is useful when comparing two assembler
13336 files.
13338 The added comments include:
13340 @itemize @bullet
13342 @item
13343 information on the compiler version and command-line options,
13345 @item
13346 the source code lines associated with the assembly instructions,
13347 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
13349 @item
13350 hints on which high-level expressions correspond to
13351 the various assembly instruction operands.
13353 @end itemize
13355 For example, given this C source file:
13357 @smallexample
13358 int test (int n)
13360   int i;
13361   int total = 0;
13363   for (i = 0; i < n; i++)
13364     total += i * i;
13366   return total;
13368 @end smallexample
13370 compiling to (x86_64) assembly via @option{-S} and emitting the result
13371 direct to stdout via @option{-o} @option{-}
13373 @smallexample
13374 gcc -S test.c -fverbose-asm -Os -o -
13375 @end smallexample
13377 gives output similar to this:
13379 @smallexample
13380         .file   "test.c"
13381 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
13382   [...snip...]
13383 # options passed:
13384   [...snip...]
13386         .text
13387         .globl  test
13388         .type   test, @@function
13389 test:
13390 .LFB0:
13391         .cfi_startproc
13392 # test.c:4:   int total = 0;
13393         xorl    %eax, %eax      # <retval>
13394 # test.c:6:   for (i = 0; i < n; i++)
13395         xorl    %edx, %edx      # i
13396 .L2:
13397 # test.c:6:   for (i = 0; i < n; i++)
13398         cmpl    %edi, %edx      # n, i
13399         jge     .L5     #,
13400 # test.c:7:     total += i * i;
13401         movl    %edx, %ecx      # i, tmp92
13402         imull   %edx, %ecx      # i, tmp92
13403 # test.c:6:   for (i = 0; i < n; i++)
13404         incl    %edx    # i
13405 # test.c:7:     total += i * i;
13406         addl    %ecx, %eax      # tmp92, <retval>
13407         jmp     .L2     #
13408 .L5:
13409 # test.c:10: @}
13410         ret
13411         .cfi_endproc
13412 .LFE0:
13413         .size   test, .-test
13414         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13415         .section        .note.GNU-stack,"",@@progbits
13416 @end smallexample
13418 The comments are intended for humans rather than machines and hence the
13419 precise format of the comments is subject to change.
13421 @item -frecord-gcc-switches
13422 @opindex frecord-gcc-switches
13423 This switch causes the command line used to invoke the
13424 compiler to be recorded into the object file that is being created.
13425 This switch is only implemented on some targets and the exact format
13426 of the recording is target and binary file format dependent, but it
13427 usually takes the form of a section containing ASCII text.  This
13428 switch is related to the @option{-fverbose-asm} switch, but that
13429 switch only records information in the assembler output file as
13430 comments, so it never reaches the object file.
13431 See also @option{-grecord-gcc-switches} for another
13432 way of storing compiler options into the object file.
13434 @item -fpic
13435 @opindex fpic
13436 @cindex global offset table
13437 @cindex PIC
13438 Generate position-independent code (PIC) suitable for use in a shared
13439 library, if supported for the target machine.  Such code accesses all
13440 constant addresses through a global offset table (GOT)@.  The dynamic
13441 loader resolves the GOT entries when the program starts (the dynamic
13442 loader is not part of GCC; it is part of the operating system).  If
13443 the GOT size for the linked executable exceeds a machine-specific
13444 maximum size, you get an error message from the linker indicating that
13445 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13446 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13447 on the m68k and RS/6000.  The x86 has no such limit.)
13449 Position-independent code requires special support, and therefore works
13450 only on certain machines.  For the x86, GCC supports PIC for System V
13451 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13452 position-independent.
13454 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13455 are defined to 1.
13457 @item -fPIC
13458 @opindex fPIC
13459 If supported for the target machine, emit position-independent code,
13460 suitable for dynamic linking and avoiding any limit on the size of the
13461 global offset table.  This option makes a difference on AArch64, m68k,
13462 PowerPC and SPARC@.
13464 Position-independent code requires special support, and therefore works
13465 only on certain machines.
13467 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13468 are defined to 2.
13470 @item -fpie
13471 @itemx -fPIE
13472 @opindex fpie
13473 @opindex fPIE
13474 These options are similar to @option{-fpic} and @option{-fPIC}, but the
13475 generated position-independent code can be only linked into executables.
13476 Usually these options are used to compile code that will be linked using
13477 the @option{-pie} GCC option.
13479 @option{-fpie} and @option{-fPIE} both define the macros
13480 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13481 for @option{-fpie} and 2 for @option{-fPIE}.
13483 @item -fno-plt
13484 @opindex fno-plt
13485 Do not use the PLT for external function calls in position-independent code.
13486 Instead, load the callee address at call sites from the GOT and branch to it.
13487 This leads to more efficient code by eliminating PLT stubs and exposing
13488 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13489 PLT stubs expect the GOT pointer in a specific register, this gives more
13490 register allocation freedom to the compiler.
13491 Lazy binding requires use of the PLT; 
13492 with @option{-fno-plt} all external symbols are resolved at load time.
13494 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13495 through the PLT for specific external functions.
13497 In position-dependent code, a few targets also convert calls to
13498 functions that are marked to not use the PLT to use the GOT instead.
13500 @item -fno-jump-tables
13501 @opindex fno-jump-tables
13502 Do not use jump tables for switch statements even where it would be
13503 more efficient than other code generation strategies.  This option is
13504 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13505 building code that forms part of a dynamic linker and cannot
13506 reference the address of a jump table.  On some targets, jump tables
13507 do not require a GOT and this option is not needed.
13509 @item -ffixed-@var{reg}
13510 @opindex ffixed
13511 Treat the register named @var{reg} as a fixed register; generated code
13512 should never refer to it (except perhaps as a stack pointer, frame
13513 pointer or in some other fixed role).
13515 @var{reg} must be the name of a register.  The register names accepted
13516 are machine-specific and are defined in the @code{REGISTER_NAMES}
13517 macro in the machine description macro file.
13519 This flag does not have a negative form, because it specifies a
13520 three-way choice.
13522 @item -fcall-used-@var{reg}
13523 @opindex fcall-used
13524 Treat the register named @var{reg} as an allocable register that is
13525 clobbered by function calls.  It may be allocated for temporaries or
13526 variables that do not live across a call.  Functions compiled this way
13527 do not save and restore the register @var{reg}.
13529 It is an error to use this flag with the frame pointer or stack pointer.
13530 Use of this flag for other registers that have fixed pervasive roles in
13531 the machine's execution model produces disastrous results.
13533 This flag does not have a negative form, because it specifies a
13534 three-way choice.
13536 @item -fcall-saved-@var{reg}
13537 @opindex fcall-saved
13538 Treat the register named @var{reg} as an allocable register saved by
13539 functions.  It may be allocated even for temporaries or variables that
13540 live across a call.  Functions compiled this way save and restore
13541 the register @var{reg} if they use it.
13543 It is an error to use this flag with the frame pointer or stack pointer.
13544 Use of this flag for other registers that have fixed pervasive roles in
13545 the machine's execution model produces disastrous results.
13547 A different sort of disaster results from the use of this flag for
13548 a register in which function values may be returned.
13550 This flag does not have a negative form, because it specifies a
13551 three-way choice.
13553 @item -fpack-struct[=@var{n}]
13554 @opindex fpack-struct
13555 Without a value specified, pack all structure members together without
13556 holes.  When a value is specified (which must be a small power of two), pack
13557 structure members according to this value, representing the maximum
13558 alignment (that is, objects with default alignment requirements larger than
13559 this are output potentially unaligned at the next fitting location.
13561 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13562 code that is not binary compatible with code generated without that switch.
13563 Additionally, it makes the code suboptimal.
13564 Use it to conform to a non-default application binary interface.
13566 @item -fleading-underscore
13567 @opindex fleading-underscore
13568 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13569 change the way C symbols are represented in the object file.  One use
13570 is to help link with legacy assembly code.
13572 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13573 generate code that is not binary compatible with code generated without that
13574 switch.  Use it to conform to a non-default application binary interface.
13575 Not all targets provide complete support for this switch.
13577 @item -ftls-model=@var{model}
13578 @opindex ftls-model
13579 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13580 The @var{model} argument should be one of @samp{global-dynamic},
13581 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13582 Note that the choice is subject to optimization: the compiler may use
13583 a more efficient model for symbols not visible outside of the translation
13584 unit, or if @option{-fpic} is not given on the command line.
13586 The default without @option{-fpic} is @samp{initial-exec}; with
13587 @option{-fpic} the default is @samp{global-dynamic}.
13589 @item -ftrampolines
13590 @opindex ftrampolines
13591 For targets that normally need trampolines for nested functions, always
13592 generate them instead of using descriptors.  Otherwise, for targets that
13593 do not need them, like for example HP-PA or IA-64, do nothing.
13595 A trampoline is a small piece of code that is created at run time on the
13596 stack when the address of a nested function is taken, and is used to call
13597 the nested function indirectly.  Therefore, it requires the stack to be
13598 made executable in order for the program to work properly.
13600 @option{-fno-trampolines} is enabled by default on a language by language
13601 basis to let the compiler avoid generating them, if it computes that this
13602 is safe, and replace them with descriptors.  Descriptors are made up of data
13603 only, but the generated code must be prepared to deal with them.  As of this
13604 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13606 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13607 @option{-fno-trampolines} are not binary compatible if nested functions are
13608 present.  This option must therefore be used on a program-wide basis and be
13609 manipulated with extreme care.
13611 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13612 @opindex fvisibility
13613 Set the default ELF image symbol visibility to the specified option---all
13614 symbols are marked with this unless overridden within the code.
13615 Using this feature can very substantially improve linking and
13616 load times of shared object libraries, produce more optimized
13617 code, provide near-perfect API export and prevent symbol clashes.
13618 It is @strong{strongly} recommended that you use this in any shared objects
13619 you distribute.
13621 Despite the nomenclature, @samp{default} always means public; i.e.,
13622 available to be linked against from outside the shared object.
13623 @samp{protected} and @samp{internal} are pretty useless in real-world
13624 usage so the only other commonly used option is @samp{hidden}.
13625 The default if @option{-fvisibility} isn't specified is
13626 @samp{default}, i.e., make every symbol public.
13628 A good explanation of the benefits offered by ensuring ELF
13629 symbols have the correct visibility is given by ``How To Write
13630 Shared Libraries'' by Ulrich Drepper (which can be found at
13631 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13632 solution made possible by this option to marking things hidden when
13633 the default is public is to make the default hidden and mark things
13634 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13635 and @code{__attribute__ ((visibility("default")))} instead of
13636 @code{__declspec(dllexport)} you get almost identical semantics with
13637 identical syntax.  This is a great boon to those working with
13638 cross-platform projects.
13640 For those adding visibility support to existing code, you may find
13641 @code{#pragma GCC visibility} of use.  This works by you enclosing
13642 the declarations you wish to set visibility for with (for example)
13643 @code{#pragma GCC visibility push(hidden)} and
13644 @code{#pragma GCC visibility pop}.
13645 Bear in mind that symbol visibility should be viewed @strong{as
13646 part of the API interface contract} and thus all new code should
13647 always specify visibility when it is not the default; i.e., declarations
13648 only for use within the local DSO should @strong{always} be marked explicitly
13649 as hidden as so to avoid PLT indirection overheads---making this
13650 abundantly clear also aids readability and self-documentation of the code.
13651 Note that due to ISO C++ specification requirements, @code{operator new} and
13652 @code{operator delete} must always be of default visibility.
13654 Be aware that headers from outside your project, in particular system
13655 headers and headers from any other library you use, may not be
13656 expecting to be compiled with visibility other than the default.  You
13657 may need to explicitly say @code{#pragma GCC visibility push(default)}
13658 before including any such headers.
13660 @code{extern} declarations are not affected by @option{-fvisibility}, so
13661 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13662 no modifications.  However, this means that calls to @code{extern}
13663 functions with no explicit visibility use the PLT, so it is more
13664 effective to use @code{__attribute ((visibility))} and/or
13665 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13666 declarations should be treated as hidden.
13668 Note that @option{-fvisibility} does affect C++ vague linkage
13669 entities. This means that, for instance, an exception class that is
13670 be thrown between DSOs must be explicitly marked with default
13671 visibility so that the @samp{type_info} nodes are unified between
13672 the DSOs.
13674 An overview of these techniques, their benefits and how to use them
13675 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13677 @item -fstrict-volatile-bitfields
13678 @opindex fstrict-volatile-bitfields
13679 This option should be used if accesses to volatile bit-fields (or other
13680 structure fields, although the compiler usually honors those types
13681 anyway) should use a single access of the width of the
13682 field's type, aligned to a natural alignment if possible.  For
13683 example, targets with memory-mapped peripheral registers might require
13684 all such accesses to be 16 bits wide; with this flag you can
13685 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13686 is 16 bits on these targets) to force GCC to use 16-bit accesses
13687 instead of, perhaps, a more efficient 32-bit access.
13689 If this option is disabled, the compiler uses the most efficient
13690 instruction.  In the previous example, that might be a 32-bit load
13691 instruction, even though that accesses bytes that do not contain
13692 any portion of the bit-field, or memory-mapped registers unrelated to
13693 the one being updated.
13695 In some cases, such as when the @code{packed} attribute is applied to a 
13696 structure field, it may not be possible to access the field with a single
13697 read or write that is correctly aligned for the target machine.  In this
13698 case GCC falls back to generating multiple accesses rather than code that 
13699 will fault or truncate the result at run time.
13701 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13702 not allowed to touch non bit-field members.  It is therefore recommended
13703 to define all bits of the field's type as bit-field members.
13705 The default value of this option is determined by the application binary
13706 interface for the target processor.
13708 @item -fsync-libcalls
13709 @opindex fsync-libcalls
13710 This option controls whether any out-of-line instance of the @code{__sync}
13711 family of functions may be used to implement the C++11 @code{__atomic}
13712 family of functions.
13714 The default value of this option is enabled, thus the only useful form
13715 of the option is @option{-fno-sync-libcalls}.  This option is used in
13716 the implementation of the @file{libatomic} runtime library.
13718 @end table
13720 @node Developer Options
13721 @section GCC Developer Options
13722 @cindex developer options
13723 @cindex debugging GCC
13724 @cindex debug dump options
13725 @cindex dump options
13726 @cindex compilation statistics
13728 This section describes command-line options that are primarily of
13729 interest to GCC developers, including options to support compiler
13730 testing and investigation of compiler bugs and compile-time
13731 performance problems.  This includes options that produce debug dumps
13732 at various points in the compilation; that print statistics such as
13733 memory use and execution time; and that print information about GCC's
13734 configuration, such as where it searches for libraries.  You should
13735 rarely need to use any of these options for ordinary compilation and
13736 linking tasks.
13738 Many developer options that cause GCC to dump output to a file take an
13739 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
13740 or @samp{-} to dump to standard output, and @samp{stderr} for standard
13741 error.
13743 If @samp{=@var{filename}} is omitted, a default dump file name is
13744 constructed by concatenating the base dump file name, a pass number,
13745 phase letter, and pass name.  The base dump file name is the name of
13746 output file produced by the compiler if explicitly specified and not
13747 an executable; otherwise it is the source file name.
13748 The pass number is determined by the order passes are registered with
13749 the compiler's pass manager. 
13750 This is generally the same as the order of execution, but passes
13751 registered by plugins, target-specific passes, or passes that are
13752 otherwise registered late are numbered higher than the pass named
13753 @samp{final}, even if they are executed earlier.  The phase letter is
13754 one of @samp{i} (inter-procedural analysis), @samp{l}
13755 (language-specific), @samp{r} (RTL), or @samp{t} (tree). 
13756 The files are created in the directory of the output file. 
13758 @table @gcctabopt
13760 @item -d@var{letters}
13761 @itemx -fdump-rtl-@var{pass}
13762 @itemx -fdump-rtl-@var{pass}=@var{filename}
13763 @opindex d
13764 @opindex fdump-rtl-@var{pass}
13765 Says to make debugging dumps during compilation at times specified by
13766 @var{letters}.  This is used for debugging the RTL-based passes of the
13767 compiler.
13769 Some @option{-d@var{letters}} switches have different meaning when
13770 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13771 for information about preprocessor-specific dump options.
13773 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13774 @option{-d} option @var{letters}.  Here are the possible
13775 letters for use in @var{pass} and @var{letters}, and their meanings:
13777 @table @gcctabopt
13779 @item -fdump-rtl-alignments
13780 @opindex fdump-rtl-alignments
13781 Dump after branch alignments have been computed.
13783 @item -fdump-rtl-asmcons
13784 @opindex fdump-rtl-asmcons
13785 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13787 @item -fdump-rtl-auto_inc_dec
13788 @opindex fdump-rtl-auto_inc_dec
13789 Dump after auto-inc-dec discovery.  This pass is only run on
13790 architectures that have auto inc or auto dec instructions.
13792 @item -fdump-rtl-barriers
13793 @opindex fdump-rtl-barriers
13794 Dump after cleaning up the barrier instructions.
13796 @item -fdump-rtl-bbpart
13797 @opindex fdump-rtl-bbpart
13798 Dump after partitioning hot and cold basic blocks.
13800 @item -fdump-rtl-bbro
13801 @opindex fdump-rtl-bbro
13802 Dump after block reordering.
13804 @item -fdump-rtl-btl1
13805 @itemx -fdump-rtl-btl2
13806 @opindex fdump-rtl-btl2
13807 @opindex fdump-rtl-btl2
13808 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13809 after the two branch
13810 target load optimization passes.
13812 @item -fdump-rtl-bypass
13813 @opindex fdump-rtl-bypass
13814 Dump after jump bypassing and control flow optimizations.
13816 @item -fdump-rtl-combine
13817 @opindex fdump-rtl-combine
13818 Dump after the RTL instruction combination pass.
13820 @item -fdump-rtl-compgotos
13821 @opindex fdump-rtl-compgotos
13822 Dump after duplicating the computed gotos.
13824 @item -fdump-rtl-ce1
13825 @itemx -fdump-rtl-ce2
13826 @itemx -fdump-rtl-ce3
13827 @opindex fdump-rtl-ce1
13828 @opindex fdump-rtl-ce2
13829 @opindex fdump-rtl-ce3
13830 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13831 @option{-fdump-rtl-ce3} enable dumping after the three
13832 if conversion passes.
13834 @item -fdump-rtl-cprop_hardreg
13835 @opindex fdump-rtl-cprop_hardreg
13836 Dump after hard register copy propagation.
13838 @item -fdump-rtl-csa
13839 @opindex fdump-rtl-csa
13840 Dump after combining stack adjustments.
13842 @item -fdump-rtl-cse1
13843 @itemx -fdump-rtl-cse2
13844 @opindex fdump-rtl-cse1
13845 @opindex fdump-rtl-cse2
13846 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13847 the two common subexpression elimination passes.
13849 @item -fdump-rtl-dce
13850 @opindex fdump-rtl-dce
13851 Dump after the standalone dead code elimination passes.
13853 @item -fdump-rtl-dbr
13854 @opindex fdump-rtl-dbr
13855 Dump after delayed branch scheduling.
13857 @item -fdump-rtl-dce1
13858 @itemx -fdump-rtl-dce2
13859 @opindex fdump-rtl-dce1
13860 @opindex fdump-rtl-dce2
13861 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13862 the two dead store elimination passes.
13864 @item -fdump-rtl-eh
13865 @opindex fdump-rtl-eh
13866 Dump after finalization of EH handling code.
13868 @item -fdump-rtl-eh_ranges
13869 @opindex fdump-rtl-eh_ranges
13870 Dump after conversion of EH handling range regions.
13872 @item -fdump-rtl-expand
13873 @opindex fdump-rtl-expand
13874 Dump after RTL generation.
13876 @item -fdump-rtl-fwprop1
13877 @itemx -fdump-rtl-fwprop2
13878 @opindex fdump-rtl-fwprop1
13879 @opindex fdump-rtl-fwprop2
13880 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13881 dumping after the two forward propagation passes.
13883 @item -fdump-rtl-gcse1
13884 @itemx -fdump-rtl-gcse2
13885 @opindex fdump-rtl-gcse1
13886 @opindex fdump-rtl-gcse2
13887 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13888 after global common subexpression elimination.
13890 @item -fdump-rtl-init-regs
13891 @opindex fdump-rtl-init-regs
13892 Dump after the initialization of the registers.
13894 @item -fdump-rtl-initvals
13895 @opindex fdump-rtl-initvals
13896 Dump after the computation of the initial value sets.
13898 @item -fdump-rtl-into_cfglayout
13899 @opindex fdump-rtl-into_cfglayout
13900 Dump after converting to cfglayout mode.
13902 @item -fdump-rtl-ira
13903 @opindex fdump-rtl-ira
13904 Dump after iterated register allocation.
13906 @item -fdump-rtl-jump
13907 @opindex fdump-rtl-jump
13908 Dump after the second jump optimization.
13910 @item -fdump-rtl-loop2
13911 @opindex fdump-rtl-loop2
13912 @option{-fdump-rtl-loop2} enables dumping after the rtl
13913 loop optimization passes.
13915 @item -fdump-rtl-mach
13916 @opindex fdump-rtl-mach
13917 Dump after performing the machine dependent reorganization pass, if that
13918 pass exists.
13920 @item -fdump-rtl-mode_sw
13921 @opindex fdump-rtl-mode_sw
13922 Dump after removing redundant mode switches.
13924 @item -fdump-rtl-rnreg
13925 @opindex fdump-rtl-rnreg
13926 Dump after register renumbering.
13928 @item -fdump-rtl-outof_cfglayout
13929 @opindex fdump-rtl-outof_cfglayout
13930 Dump after converting from cfglayout mode.
13932 @item -fdump-rtl-peephole2
13933 @opindex fdump-rtl-peephole2
13934 Dump after the peephole pass.
13936 @item -fdump-rtl-postreload
13937 @opindex fdump-rtl-postreload
13938 Dump after post-reload optimizations.
13940 @item -fdump-rtl-pro_and_epilogue
13941 @opindex fdump-rtl-pro_and_epilogue
13942 Dump after generating the function prologues and epilogues.
13944 @item -fdump-rtl-sched1
13945 @itemx -fdump-rtl-sched2
13946 @opindex fdump-rtl-sched1
13947 @opindex fdump-rtl-sched2
13948 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13949 after the basic block scheduling passes.
13951 @item -fdump-rtl-ree
13952 @opindex fdump-rtl-ree
13953 Dump after sign/zero extension elimination.
13955 @item -fdump-rtl-seqabstr
13956 @opindex fdump-rtl-seqabstr
13957 Dump after common sequence discovery.
13959 @item -fdump-rtl-shorten
13960 @opindex fdump-rtl-shorten
13961 Dump after shortening branches.
13963 @item -fdump-rtl-sibling
13964 @opindex fdump-rtl-sibling
13965 Dump after sibling call optimizations.
13967 @item -fdump-rtl-split1
13968 @itemx -fdump-rtl-split2
13969 @itemx -fdump-rtl-split3
13970 @itemx -fdump-rtl-split4
13971 @itemx -fdump-rtl-split5
13972 @opindex fdump-rtl-split1
13973 @opindex fdump-rtl-split2
13974 @opindex fdump-rtl-split3
13975 @opindex fdump-rtl-split4
13976 @opindex fdump-rtl-split5
13977 These options enable dumping after five rounds of
13978 instruction splitting.
13980 @item -fdump-rtl-sms
13981 @opindex fdump-rtl-sms
13982 Dump after modulo scheduling.  This pass is only run on some
13983 architectures.
13985 @item -fdump-rtl-stack
13986 @opindex fdump-rtl-stack
13987 Dump after conversion from GCC's ``flat register file'' registers to the
13988 x87's stack-like registers.  This pass is only run on x86 variants.
13990 @item -fdump-rtl-subreg1
13991 @itemx -fdump-rtl-subreg2
13992 @opindex fdump-rtl-subreg1
13993 @opindex fdump-rtl-subreg2
13994 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13995 the two subreg expansion passes.
13997 @item -fdump-rtl-unshare
13998 @opindex fdump-rtl-unshare
13999 Dump after all rtl has been unshared.
14001 @item -fdump-rtl-vartrack
14002 @opindex fdump-rtl-vartrack
14003 Dump after variable tracking.
14005 @item -fdump-rtl-vregs
14006 @opindex fdump-rtl-vregs
14007 Dump after converting virtual registers to hard registers.
14009 @item -fdump-rtl-web
14010 @opindex fdump-rtl-web
14011 Dump after live range splitting.
14013 @item -fdump-rtl-regclass
14014 @itemx -fdump-rtl-subregs_of_mode_init
14015 @itemx -fdump-rtl-subregs_of_mode_finish
14016 @itemx -fdump-rtl-dfinit
14017 @itemx -fdump-rtl-dfinish
14018 @opindex fdump-rtl-regclass
14019 @opindex fdump-rtl-subregs_of_mode_init
14020 @opindex fdump-rtl-subregs_of_mode_finish
14021 @opindex fdump-rtl-dfinit
14022 @opindex fdump-rtl-dfinish
14023 These dumps are defined but always produce empty files.
14025 @item -da
14026 @itemx -fdump-rtl-all
14027 @opindex da
14028 @opindex fdump-rtl-all
14029 Produce all the dumps listed above.
14031 @item -dA
14032 @opindex dA
14033 Annotate the assembler output with miscellaneous debugging information.
14035 @item -dD
14036 @opindex dD
14037 Dump all macro definitions, at the end of preprocessing, in addition to
14038 normal output.
14040 @item -dH
14041 @opindex dH
14042 Produce a core dump whenever an error occurs.
14044 @item -dp
14045 @opindex dp
14046 Annotate the assembler output with a comment indicating which
14047 pattern and alternative is used.  The length and cost of each instruction are
14048 also printed.
14050 @item -dP
14051 @opindex dP
14052 Dump the RTL in the assembler output as a comment before each instruction.
14053 Also turns on @option{-dp} annotation.
14055 @item -dx
14056 @opindex dx
14057 Just generate RTL for a function instead of compiling it.  Usually used
14058 with @option{-fdump-rtl-expand}.
14059 @end table
14061 @item -fdump-debug
14062 @opindex fdump-debug
14063 Dump debugging information generated during the debug
14064 generation phase.
14066 @item -fdump-earlydebug
14067 @opindex fdump-earlydebug
14068 Dump debugging information generated during the early debug
14069 generation phase.
14071 @item -fdump-noaddr
14072 @opindex fdump-noaddr
14073 When doing debugging dumps, suppress address output.  This makes it more
14074 feasible to use diff on debugging dumps for compiler invocations with
14075 different compiler binaries and/or different
14076 text / bss / data / heap / stack / dso start locations.
14078 @item -freport-bug
14079 @opindex freport-bug
14080 Collect and dump debug information into a temporary file if an
14081 internal compiler error (ICE) occurs.
14083 @item -fdump-unnumbered
14084 @opindex fdump-unnumbered
14085 When doing debugging dumps, suppress instruction numbers and address output.
14086 This makes it more feasible to use diff on debugging dumps for compiler
14087 invocations with different options, in particular with and without
14088 @option{-g}.
14090 @item -fdump-unnumbered-links
14091 @opindex fdump-unnumbered-links
14092 When doing debugging dumps (see @option{-d} option above), suppress
14093 instruction numbers for the links to the previous and next instructions
14094 in a sequence.
14096 @item -fdump-ipa-@var{switch}
14097 @itemx -fdump-ipa-@var{switch}-@var{options}
14098 @opindex fdump-ipa
14099 Control the dumping at various stages of inter-procedural analysis
14100 language tree to a file.  The file name is generated by appending a
14101 switch specific suffix to the source file name, and the file is created
14102 in the same directory as the output file.  The following dumps are
14103 possible:
14105 @table @samp
14106 @item all
14107 Enables all inter-procedural analysis dumps.
14109 @item cgraph
14110 Dumps information about call-graph optimization, unused function removal,
14111 and inlining decisions.
14113 @item inline
14114 Dump after function inlining.
14116 @end table
14118 Additionally, the options @option{-optimized}, @option{-missed},
14119 @option{-note}, and @option{-all} can be provided, with the same meaning
14120 as for @option{-fopt-info}, defaulting to @option{-optimized}.
14122 For example, @option{-fdump-ipa-inline-optimized-missed} will emit
14123 information on callsites that were inlined, along with callsites
14124 that were not inlined.
14126 By default, the dump will contain messages about successful
14127 optimizations (equivalent to @option{-optimized}) together with
14128 low-level details about the analysis.
14130 @item -fdump-lang-all
14131 @itemx -fdump-lang-@var{switch}
14132 @itemx -fdump-lang-@var{switch}-@var{options}
14133 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
14134 @opindex fdump-lang-all
14135 @opindex fdump-lang
14136 Control the dumping of language-specific information.  The @var{options}
14137 and @var{filename} portions behave as described in the
14138 @option{-fdump-tree} option.  The following @var{switch} values are
14139 accepted:
14141 @table @samp
14142 @item all
14144 Enable all language-specific dumps.
14146 @item class
14147 Dump class hierarchy information.  Virtual table information is emitted
14148 unless '@option{slim}' is specified.  This option is applicable to C++ only.
14150 @item raw
14151 Dump the raw internal tree data.  This option is applicable to C++ only.
14153 @end table
14155 @item -fdump-passes
14156 @opindex fdump-passes
14157 Print on @file{stderr} the list of optimization passes that are turned
14158 on and off by the current command-line options.
14160 @item -fdump-statistics-@var{option}
14161 @opindex fdump-statistics
14162 Enable and control dumping of pass statistics in a separate file.  The
14163 file name is generated by appending a suffix ending in
14164 @samp{.statistics} to the source file name, and the file is created in
14165 the same directory as the output file.  If the @samp{-@var{option}}
14166 form is used, @samp{-stats} causes counters to be summed over the
14167 whole compilation unit while @samp{-details} dumps every event as
14168 the passes generate them.  The default with no option is to sum
14169 counters for each function compiled.
14171 @item -fdump-tree-all
14172 @itemx -fdump-tree-@var{switch}
14173 @itemx -fdump-tree-@var{switch}-@var{options}
14174 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
14175 @opindex fdump-tree-all
14176 @opindex fdump-tree
14177 Control the dumping at various stages of processing the intermediate
14178 language tree to a file.  If the @samp{-@var{options}}
14179 form is used, @var{options} is a list of @samp{-} separated options
14180 which control the details of the dump.  Not all options are applicable
14181 to all dumps; those that are not meaningful are ignored.  The
14182 following options are available
14184 @table @samp
14185 @item address
14186 Print the address of each node.  Usually this is not meaningful as it
14187 changes according to the environment and source file.  Its primary use
14188 is for tying up a dump file with a debug environment.
14189 @item asmname
14190 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
14191 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
14192 use working backward from mangled names in the assembly file.
14193 @item slim
14194 When dumping front-end intermediate representations, inhibit dumping
14195 of members of a scope or body of a function merely because that scope
14196 has been reached.  Only dump such items when they are directly reachable
14197 by some other path.
14199 When dumping pretty-printed trees, this option inhibits dumping the
14200 bodies of control structures.
14202 When dumping RTL, print the RTL in slim (condensed) form instead of
14203 the default LISP-like representation.
14204 @item raw
14205 Print a raw representation of the tree.  By default, trees are
14206 pretty-printed into a C-like representation.
14207 @item details
14208 Enable more detailed dumps (not honored by every dump option). Also
14209 include information from the optimization passes.
14210 @item stats
14211 Enable dumping various statistics about the pass (not honored by every dump
14212 option).
14213 @item blocks
14214 Enable showing basic block boundaries (disabled in raw dumps).
14215 @item graph
14216 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
14217 dump a representation of the control flow graph suitable for viewing with
14218 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
14219 the file is pretty-printed as a subgraph, so that GraphViz can render them
14220 all in a single plot.
14222 This option currently only works for RTL dumps, and the RTL is always
14223 dumped in slim form.
14224 @item vops
14225 Enable showing virtual operands for every statement.
14226 @item lineno
14227 Enable showing line numbers for statements.
14228 @item uid
14229 Enable showing the unique ID (@code{DECL_UID}) for each variable.
14230 @item verbose
14231 Enable showing the tree dump for each statement.
14232 @item eh
14233 Enable showing the EH region number holding each statement.
14234 @item scev
14235 Enable showing scalar evolution analysis details.
14236 @item optimized
14237 Enable showing optimization information (only available in certain
14238 passes).
14239 @item missed
14240 Enable showing missed optimization information (only available in certain
14241 passes).
14242 @item note
14243 Enable other detailed optimization information (only available in
14244 certain passes).
14245 @item all
14246 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
14247 and @option{lineno}.
14248 @item optall
14249 Turn on all optimization options, i.e., @option{optimized},
14250 @option{missed}, and @option{note}.
14251 @end table
14253 To determine what tree dumps are available or find the dump for a pass
14254 of interest follow the steps below.
14256 @enumerate
14257 @item
14258 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
14259 look for a code that corresponds to the pass you are interested in.
14260 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
14261 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
14262 The number at the end distinguishes distinct invocations of the same pass.
14263 @item
14264 To enable the creation of the dump file, append the pass code to
14265 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
14266 to enable the dump from the Early Value Range Propagation pass, invoke
14267 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
14268 specify the name of the dump file.  If you don't specify one, GCC
14269 creates as described below.
14270 @item
14271 Find the pass dump in a file whose name is composed of three components
14272 separated by a period: the name of the source file GCC was invoked to
14273 compile, a numeric suffix indicating the pass number followed by the
14274 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
14275 and finally the pass code.  For example, the Early VRP pass dump might
14276 be in a file named @file{myfile.c.038t.evrp} in the current working
14277 directory.  Note that the numeric codes are not stable and may change
14278 from one version of GCC to another.
14279 @end enumerate
14281 @item -fopt-info
14282 @itemx -fopt-info-@var{options}
14283 @itemx -fopt-info-@var{options}=@var{filename}
14284 @opindex fopt-info
14285 Controls optimization dumps from various optimization passes. If the
14286 @samp{-@var{options}} form is used, @var{options} is a list of
14287 @samp{-} separated option keywords to select the dump details and
14288 optimizations.  
14290 The @var{options} can be divided into three groups:
14291 @enumerate
14292 @item
14293 options describing what kinds of messages should be emitted,
14294 @item
14295 options describing the verbosity of the dump, and
14296 @item
14297 options describing which optimizations should be included.
14298 @end enumerate
14299 The options from each group can be freely mixed as they are
14300 non-overlapping. However, in case of any conflicts,
14301 the later options override the earlier options on the command
14302 line. 
14304 The following options control which kinds of messages should be emitted:
14306 @table @samp
14307 @item optimized
14308 Print information when an optimization is successfully applied. It is
14309 up to a pass to decide which information is relevant. For example, the
14310 vectorizer passes print the source location of loops which are
14311 successfully vectorized.
14312 @item missed
14313 Print information about missed optimizations. Individual passes
14314 control which information to include in the output. 
14315 @item note
14316 Print verbose information about optimizations, such as certain
14317 transformations, more detailed messages about decisions etc.
14318 @item all
14319 Print detailed optimization information. This includes
14320 @samp{optimized}, @samp{missed}, and @samp{note}.
14321 @end table
14323 The following option controls the dump verbosity:
14325 @table @samp
14326 @item internals
14327 By default, only ``high-level'' messages are emitted. This option enables
14328 additional, more detailed, messages, which are likely to only be of interest
14329 to GCC developers.
14330 @end table
14332 One or more of the following option keywords can be used to describe a
14333 group of optimizations:
14335 @table @samp
14336 @item ipa
14337 Enable dumps from all interprocedural optimizations.
14338 @item loop
14339 Enable dumps from all loop optimizations.
14340 @item inline
14341 Enable dumps from all inlining optimizations.
14342 @item omp
14343 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
14344 @item vec
14345 Enable dumps from all vectorization optimizations.
14346 @item optall
14347 Enable dumps from all optimizations. This is a superset of
14348 the optimization groups listed above.
14349 @end table
14351 If @var{options} is
14352 omitted, it defaults to @samp{optimized-optall}, which means to dump messages
14353 about successful optimizations from all the passes, omitting messages
14354 that are treated as ``internals''.
14356 If the @var{filename} is provided, then the dumps from all the
14357 applicable optimizations are concatenated into the @var{filename}.
14358 Otherwise the dump is output onto @file{stderr}. Though multiple
14359 @option{-fopt-info} options are accepted, only one of them can include
14360 a @var{filename}. If other filenames are provided then all but the
14361 first such option are ignored.
14363 Note that the output @var{filename} is overwritten
14364 in case of multiple translation units. If a combined output from
14365 multiple translation units is desired, @file{stderr} should be used
14366 instead.
14368 In the following example, the optimization info is output to
14369 @file{stderr}:
14371 @smallexample
14372 gcc -O3 -fopt-info
14373 @end smallexample
14375 This example:
14376 @smallexample
14377 gcc -O3 -fopt-info-missed=missed.all
14378 @end smallexample
14380 @noindent
14381 outputs missed optimization report from all the passes into
14382 @file{missed.all}, and this one:
14384 @smallexample
14385 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
14386 @end smallexample
14388 @noindent
14389 prints information about missed optimization opportunities from
14390 vectorization passes on @file{stderr}.  
14391 Note that @option{-fopt-info-vec-missed} is equivalent to 
14392 @option{-fopt-info-missed-vec}.  The order of the optimization group
14393 names and message types listed after @option{-fopt-info} does not matter.
14395 As another example,
14396 @smallexample
14397 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
14398 @end smallexample
14400 @noindent
14401 outputs information about missed optimizations as well as
14402 optimized locations from all the inlining passes into
14403 @file{inline.txt}.
14405 Finally, consider:
14407 @smallexample
14408 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
14409 @end smallexample
14411 @noindent
14412 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
14413 in conflict since only one output file is allowed. In this case, only
14414 the first option takes effect and the subsequent options are
14415 ignored. Thus only @file{vec.miss} is produced which contains
14416 dumps from the vectorizer about missed opportunities.
14418 @item -fsave-optimization-record
14419 @opindex fsave-optimization-record
14420 Write a SRCFILE.opt-record.json file detailing what optimizations
14421 were performed, for those optimizations that support @option{-fopt-info}.
14423 This option is experimental and the format of the data within the JSON
14424 file is subject to change.
14426 It is roughly equivalent to a machine-readable version of
14427 @option{-fopt-info-all}, as a collection of messages with source file,
14428 line number and column number, with the following additional data for
14429 each message:
14431 @itemize @bullet
14433 @item
14434 the execution count of the code being optimized, along with metadata about
14435 whether this was from actual profile data, or just an estimate, allowing
14436 consumers to prioritize messages by code hotness,
14438 @item
14439 the function name of the code being optimized, where applicable,
14441 @item
14442 the ``inlining chain'' for the code being optimized, so that when
14443 a function is inlined into several different places (which might
14444 themselves be inlined), the reader can distinguish between the copies,
14446 @item
14447 objects identifying those parts of the message that refer to expressions,
14448 statements or symbol-table nodes, which of these categories they are, and,
14449 when available, their source code location,
14451 @item
14452 the GCC pass that emitted the message, and
14454 @item
14455 the location in GCC's own code from which the message was emitted
14457 @end itemize
14459 Additionally, some messages are logically nested within other
14460 messages, reflecting implementation details of the optimization
14461 passes.
14463 @item -fsched-verbose=@var{n}
14464 @opindex fsched-verbose
14465 On targets that use instruction scheduling, this option controls the
14466 amount of debugging output the scheduler prints to the dump files.
14468 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14469 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14470 For @var{n} greater than one, it also output basic block probabilities,
14471 detailed ready list information and unit/insn info.  For @var{n} greater
14472 than two, it includes RTL at abort point, control-flow and regions info.
14473 And for @var{n} over four, @option{-fsched-verbose} also includes
14474 dependence info.
14478 @item -fenable-@var{kind}-@var{pass}
14479 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14480 @opindex fdisable-
14481 @opindex fenable-
14483 This is a set of options that are used to explicitly disable/enable
14484 optimization passes.  These options are intended for use for debugging GCC.
14485 Compiler users should use regular options for enabling/disabling
14486 passes instead.
14488 @table @gcctabopt
14490 @item -fdisable-ipa-@var{pass}
14491 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14492 statically invoked in the compiler multiple times, the pass name should be
14493 appended with a sequential number starting from 1.
14495 @item -fdisable-rtl-@var{pass}
14496 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14497 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14498 statically invoked in the compiler multiple times, the pass name should be
14499 appended with a sequential number starting from 1.  @var{range-list} is a 
14500 comma-separated list of function ranges or assembler names.  Each range is a number
14501 pair separated by a colon.  The range is inclusive in both ends.  If the range
14502 is trivial, the number pair can be simplified as a single number.  If the
14503 function's call graph node's @var{uid} falls within one of the specified ranges,
14504 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14505 function header of a dump file, and the pass names can be dumped by using
14506 option @option{-fdump-passes}.
14508 @item -fdisable-tree-@var{pass}
14509 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14510 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14511 option arguments.
14513 @item -fenable-ipa-@var{pass}
14514 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14515 statically invoked in the compiler multiple times, the pass name should be
14516 appended with a sequential number starting from 1.
14518 @item -fenable-rtl-@var{pass}
14519 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14520 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14521 description and examples.
14523 @item -fenable-tree-@var{pass}
14524 @itemx -fenable-tree-@var{pass}=@var{range-list}
14525 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14526 of option arguments.
14528 @end table
14530 Here are some examples showing uses of these options.
14532 @smallexample
14534 # disable ccp1 for all functions
14535    -fdisable-tree-ccp1
14536 # disable complete unroll for function whose cgraph node uid is 1
14537    -fenable-tree-cunroll=1
14538 # disable gcse2 for functions at the following ranges [1,1],
14539 # [300,400], and [400,1000]
14540 # disable gcse2 for functions foo and foo2
14541    -fdisable-rtl-gcse2=foo,foo2
14542 # disable early inlining
14543    -fdisable-tree-einline
14544 # disable ipa inlining
14545    -fdisable-ipa-inline
14546 # enable tree full unroll
14547    -fenable-tree-unroll
14549 @end smallexample
14551 @item -fchecking
14552 @itemx -fchecking=@var{n}
14553 @opindex fchecking
14554 @opindex fno-checking
14555 Enable internal consistency checking.  The default depends on
14556 the compiler configuration.  @option{-fchecking=2} enables further
14557 internal consistency checking that might affect code generation.
14559 @item -frandom-seed=@var{string}
14560 @opindex frandom-seed
14561 This option provides a seed that GCC uses in place of
14562 random numbers in generating certain symbol names
14563 that have to be different in every compiled file.  It is also used to
14564 place unique stamps in coverage data files and the object files that
14565 produce them.  You can use the @option{-frandom-seed} option to produce
14566 reproducibly identical object files.
14568 The @var{string} can either be a number (decimal, octal or hex) or an
14569 arbitrary string (in which case it's converted to a number by
14570 computing CRC32).
14572 The @var{string} should be different for every file you compile.
14574 @item -save-temps
14575 @itemx -save-temps=cwd
14576 @opindex save-temps
14577 Store the usual ``temporary'' intermediate files permanently; place them
14578 in the current directory and name them based on the source file.  Thus,
14579 compiling @file{foo.c} with @option{-c -save-temps} produces files
14580 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14581 preprocessed @file{foo.i} output file even though the compiler now
14582 normally uses an integrated preprocessor.
14584 When used in combination with the @option{-x} command-line option,
14585 @option{-save-temps} is sensible enough to avoid over writing an
14586 input source file with the same extension as an intermediate file.
14587 The corresponding intermediate file may be obtained by renaming the
14588 source file before using @option{-save-temps}.
14590 If you invoke GCC in parallel, compiling several different source
14591 files that share a common base name in different subdirectories or the
14592 same source file compiled for multiple output destinations, it is
14593 likely that the different parallel compilers will interfere with each
14594 other, and overwrite the temporary files.  For instance:
14596 @smallexample
14597 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14598 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14599 @end smallexample
14601 may result in @file{foo.i} and @file{foo.o} being written to
14602 simultaneously by both compilers.
14604 @item -save-temps=obj
14605 @opindex save-temps=obj
14606 Store the usual ``temporary'' intermediate files permanently.  If the
14607 @option{-o} option is used, the temporary files are based on the
14608 object file.  If the @option{-o} option is not used, the
14609 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14611 For example:
14613 @smallexample
14614 gcc -save-temps=obj -c foo.c
14615 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14616 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14617 @end smallexample
14619 @noindent
14620 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14621 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14622 @file{dir2/yfoobar.o}.
14624 @item -time@r{[}=@var{file}@r{]}
14625 @opindex time
14626 Report the CPU time taken by each subprocess in the compilation
14627 sequence.  For C source files, this is the compiler proper and assembler
14628 (plus the linker if linking is done).
14630 Without the specification of an output file, the output looks like this:
14632 @smallexample
14633 # cc1 0.12 0.01
14634 # as 0.00 0.01
14635 @end smallexample
14637 The first number on each line is the ``user time'', that is time spent
14638 executing the program itself.  The second number is ``system time'',
14639 time spent executing operating system routines on behalf of the program.
14640 Both numbers are in seconds.
14642 With the specification of an output file, the output is appended to the
14643 named file, and it looks like this:
14645 @smallexample
14646 0.12 0.01 cc1 @var{options}
14647 0.00 0.01 as @var{options}
14648 @end smallexample
14650 The ``user time'' and the ``system time'' are moved before the program
14651 name, and the options passed to the program are displayed, so that one
14652 can later tell what file was being compiled, and with which options.
14654 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14655 @opindex fdump-final-insns
14656 Dump the final internal representation (RTL) to @var{file}.  If the
14657 optional argument is omitted (or if @var{file} is @code{.}), the name
14658 of the dump file is determined by appending @code{.gkd} to the
14659 compilation output file name.
14661 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14662 @opindex fcompare-debug
14663 @opindex fno-compare-debug
14664 If no error occurs during compilation, run the compiler a second time,
14665 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14666 passed to the second compilation.  Dump the final internal
14667 representation in both compilations, and print an error if they differ.
14669 If the equal sign is omitted, the default @option{-gtoggle} is used.
14671 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14672 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14673 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14674 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14675 is used.
14677 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14678 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14679 of the final representation and the second compilation, preventing even
14680 @env{GCC_COMPARE_DEBUG} from taking effect.
14682 To verify full coverage during @option{-fcompare-debug} testing, set
14683 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14684 which GCC rejects as an invalid option in any actual compilation
14685 (rather than preprocessing, assembly or linking).  To get just a
14686 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14687 not overridden} will do.
14689 @item -fcompare-debug-second
14690 @opindex fcompare-debug-second
14691 This option is implicitly passed to the compiler for the second
14692 compilation requested by @option{-fcompare-debug}, along with options to
14693 silence warnings, and omitting other options that would cause the compiler
14694 to produce output to files or to standard output as a side effect.  Dump
14695 files and preserved temporary files are renamed so as to contain the
14696 @code{.gk} additional extension during the second compilation, to avoid
14697 overwriting those generated by the first.
14699 When this option is passed to the compiler driver, it causes the
14700 @emph{first} compilation to be skipped, which makes it useful for little
14701 other than debugging the compiler proper.
14703 @item -gtoggle
14704 @opindex gtoggle
14705 Turn off generation of debug info, if leaving out this option
14706 generates it, or turn it on at level 2 otherwise.  The position of this
14707 argument in the command line does not matter; it takes effect after all
14708 other options are processed, and it does so only once, no matter how
14709 many times it is given.  This is mainly intended to be used with
14710 @option{-fcompare-debug}.
14712 @item -fvar-tracking-assignments-toggle
14713 @opindex fvar-tracking-assignments-toggle
14714 @opindex fno-var-tracking-assignments-toggle
14715 Toggle @option{-fvar-tracking-assignments}, in the same way that
14716 @option{-gtoggle} toggles @option{-g}.
14718 @item -Q
14719 @opindex Q
14720 Makes the compiler print out each function name as it is compiled, and
14721 print some statistics about each pass when it finishes.
14723 @item -ftime-report
14724 @opindex ftime-report
14725 Makes the compiler print some statistics about the time consumed by each
14726 pass when it finishes.
14728 @item -ftime-report-details
14729 @opindex ftime-report-details
14730 Record the time consumed by infrastructure parts separately for each pass.
14732 @item -fira-verbose=@var{n}
14733 @opindex fira-verbose
14734 Control the verbosity of the dump file for the integrated register allocator.
14735 The default value is 5.  If the value @var{n} is greater or equal to 10,
14736 the dump output is sent to stderr using the same format as @var{n} minus 10.
14738 @item -flto-report
14739 @opindex flto-report
14740 Prints a report with internal details on the workings of the link-time
14741 optimizer.  The contents of this report vary from version to version.
14742 It is meant to be useful to GCC developers when processing object
14743 files in LTO mode (via @option{-flto}).
14745 Disabled by default.
14747 @item -flto-report-wpa
14748 @opindex flto-report-wpa
14749 Like @option{-flto-report}, but only print for the WPA phase of Link
14750 Time Optimization.
14752 @item -fmem-report
14753 @opindex fmem-report
14754 Makes the compiler print some statistics about permanent memory
14755 allocation when it finishes.
14757 @item -fmem-report-wpa
14758 @opindex fmem-report-wpa
14759 Makes the compiler print some statistics about permanent memory
14760 allocation for the WPA phase only.
14762 @item -fpre-ipa-mem-report
14763 @opindex fpre-ipa-mem-report
14764 @item -fpost-ipa-mem-report
14765 @opindex fpost-ipa-mem-report
14766 Makes the compiler print some statistics about permanent memory
14767 allocation before or after interprocedural optimization.
14769 @item -fprofile-report
14770 @opindex fprofile-report
14771 Makes the compiler print some statistics about consistency of the
14772 (estimated) profile and effect of individual passes.
14774 @item -fstack-usage
14775 @opindex fstack-usage
14776 Makes the compiler output stack usage information for the program, on a
14777 per-function basis.  The filename for the dump is made by appending
14778 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14779 the output file, if explicitly specified and it is not an executable,
14780 otherwise it is the basename of the source file.  An entry is made up
14781 of three fields:
14783 @itemize
14784 @item
14785 The name of the function.
14786 @item
14787 A number of bytes.
14788 @item
14789 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14790 @end itemize
14792 The qualifier @code{static} means that the function manipulates the stack
14793 statically: a fixed number of bytes are allocated for the frame on function
14794 entry and released on function exit; no stack adjustments are otherwise made
14795 in the function.  The second field is this fixed number of bytes.
14797 The qualifier @code{dynamic} means that the function manipulates the stack
14798 dynamically: in addition to the static allocation described above, stack
14799 adjustments are made in the body of the function, for example to push/pop
14800 arguments around function calls.  If the qualifier @code{bounded} is also
14801 present, the amount of these adjustments is bounded at compile time and
14802 the second field is an upper bound of the total amount of stack used by
14803 the function.  If it is not present, the amount of these adjustments is
14804 not bounded at compile time and the second field only represents the
14805 bounded part.
14807 @item -fstats
14808 @opindex fstats
14809 Emit statistics about front-end processing at the end of the compilation.
14810 This option is supported only by the C++ front end, and
14811 the information is generally only useful to the G++ development team.
14813 @item -fdbg-cnt-list
14814 @opindex fdbg-cnt-list
14815 Print the name and the counter upper bound for all debug counters.
14818 @item -fdbg-cnt=@var{counter-value-list}
14819 @opindex fdbg-cnt
14820 Set the internal debug counter lower and upper bound.  @var{counter-value-list}
14821 is a comma-separated list of @var{name}:@var{lower_bound}:@var{upper_bound}
14822 tuples which sets the lower and the upper bound of each debug
14823 counter @var{name}.  The @var{lower_bound} is optional and is zero
14824 initialized if not set.
14825 All debug counters have the initial upper bound of @code{UINT_MAX};
14826 thus @code{dbg_cnt} returns true always unless the upper bound
14827 is set by this option.
14828 For example, with @option{-fdbg-cnt=dce:2:4,tail_call:10},
14829 @code{dbg_cnt(dce)} returns true only for third and fourth invocation.
14830 For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
14832 @item -print-file-name=@var{library}
14833 @opindex print-file-name
14834 Print the full absolute name of the library file @var{library} that
14835 would be used when linking---and don't do anything else.  With this
14836 option, GCC does not compile or link anything; it just prints the
14837 file name.
14839 @item -print-multi-directory
14840 @opindex print-multi-directory
14841 Print the directory name corresponding to the multilib selected by any
14842 other switches present in the command line.  This directory is supposed
14843 to exist in @env{GCC_EXEC_PREFIX}.
14845 @item -print-multi-lib
14846 @opindex print-multi-lib
14847 Print the mapping from multilib directory names to compiler switches
14848 that enable them.  The directory name is separated from the switches by
14849 @samp{;}, and each switch starts with an @samp{@@} instead of the
14850 @samp{-}, without spaces between multiple switches.  This is supposed to
14851 ease shell processing.
14853 @item -print-multi-os-directory
14854 @opindex print-multi-os-directory
14855 Print the path to OS libraries for the selected
14856 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14857 present in the @file{lib} subdirectory and no multilibs are used, this is
14858 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14859 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14860 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14861 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14863 @item -print-multiarch
14864 @opindex print-multiarch
14865 Print the path to OS libraries for the selected multiarch,
14866 relative to some @file{lib} subdirectory.
14868 @item -print-prog-name=@var{program}
14869 @opindex print-prog-name
14870 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14872 @item -print-libgcc-file-name
14873 @opindex print-libgcc-file-name
14874 Same as @option{-print-file-name=libgcc.a}.
14876 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14877 but you do want to link with @file{libgcc.a}.  You can do:
14879 @smallexample
14880 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14881 @end smallexample
14883 @item -print-search-dirs
14884 @opindex print-search-dirs
14885 Print the name of the configured installation directory and a list of
14886 program and library directories @command{gcc} searches---and don't do anything else.
14888 This is useful when @command{gcc} prints the error message
14889 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14890 To resolve this you either need to put @file{cpp0} and the other compiler
14891 components where @command{gcc} expects to find them, or you can set the environment
14892 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14893 Don't forget the trailing @samp{/}.
14894 @xref{Environment Variables}.
14896 @item -print-sysroot
14897 @opindex print-sysroot
14898 Print the target sysroot directory that is used during
14899 compilation.  This is the target sysroot specified either at configure
14900 time or using the @option{--sysroot} option, possibly with an extra
14901 suffix that depends on compilation options.  If no target sysroot is
14902 specified, the option prints nothing.
14904 @item -print-sysroot-headers-suffix
14905 @opindex print-sysroot-headers-suffix
14906 Print the suffix added to the target sysroot when searching for
14907 headers, or give an error if the compiler is not configured with such
14908 a suffix---and don't do anything else.
14910 @item -dumpmachine
14911 @opindex dumpmachine
14912 Print the compiler's target machine (for example,
14913 @samp{i686-pc-linux-gnu})---and don't do anything else.
14915 @item -dumpversion
14916 @opindex dumpversion
14917 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14918 anything else.  This is the compiler version used in filesystem paths and
14919 specs. Depending on how the compiler has been configured it can be just
14920 a single number (major version), two numbers separated by a dot (major and
14921 minor version) or three numbers separated by dots (major, minor and patchlevel
14922 version).
14924 @item -dumpfullversion
14925 @opindex dumpfullversion
14926 Print the full compiler version---and don't do anything else. The output is
14927 always three numbers separated by dots, major, minor and patchlevel version.
14929 @item -dumpspecs
14930 @opindex dumpspecs
14931 Print the compiler's built-in specs---and don't do anything else.  (This
14932 is used when GCC itself is being built.)  @xref{Spec Files}.
14933 @end table
14935 @node Submodel Options
14936 @section Machine-Dependent Options
14937 @cindex submodel options
14938 @cindex specifying hardware config
14939 @cindex hardware models and configurations, specifying
14940 @cindex target-dependent options
14941 @cindex machine-dependent options
14943 Each target machine supported by GCC can have its own options---for
14944 example, to allow you to compile for a particular processor variant or
14945 ABI, or to control optimizations specific to that machine.  By
14946 convention, the names of machine-specific options start with
14947 @samp{-m}.
14949 Some configurations of the compiler also support additional target-specific
14950 options, usually for compatibility with other compilers on the same
14951 platform.
14953 @c This list is ordered alphanumerically by subsection name.
14954 @c It should be the same order and spelling as these options are listed
14955 @c in Machine Dependent Options
14957 @menu
14958 * AArch64 Options::
14959 * Adapteva Epiphany Options::
14960 * ARC Options::
14961 * ARM Options::
14962 * AVR Options::
14963 * Blackfin Options::
14964 * C6X Options::
14965 * CRIS Options::
14966 * CR16 Options::
14967 * C-SKY Options::
14968 * Darwin Options::
14969 * DEC Alpha Options::
14970 * FR30 Options::
14971 * FT32 Options::
14972 * FRV Options::
14973 * GNU/Linux Options::
14974 * H8/300 Options::
14975 * HPPA Options::
14976 * IA-64 Options::
14977 * LM32 Options::
14978 * M32C Options::
14979 * M32R/D Options::
14980 * M680x0 Options::
14981 * MCore Options::
14982 * MeP Options::
14983 * MicroBlaze Options::
14984 * MIPS Options::
14985 * MMIX Options::
14986 * MN10300 Options::
14987 * Moxie Options::
14988 * MSP430 Options::
14989 * NDS32 Options::
14990 * Nios II Options::
14991 * Nvidia PTX Options::
14992 * OpenRISC Options::
14993 * PDP-11 Options::
14994 * picoChip Options::
14995 * PowerPC Options::
14996 * PowerPC SPE Options::
14997 * RISC-V Options::
14998 * RL78 Options::
14999 * RS/6000 and PowerPC Options::
15000 * RX Options::
15001 * S/390 and zSeries Options::
15002 * Score Options::
15003 * SH Options::
15004 * Solaris 2 Options::
15005 * SPARC Options::
15006 * SPU Options::
15007 * System V Options::
15008 * TILE-Gx Options::
15009 * TILEPro Options::
15010 * V850 Options::
15011 * VAX Options::
15012 * Visium Options::
15013 * VMS Options::
15014 * VxWorks Options::
15015 * x86 Options::
15016 * x86 Windows Options::
15017 * Xstormy16 Options::
15018 * Xtensa Options::
15019 * zSeries Options::
15020 @end menu
15022 @node AArch64 Options
15023 @subsection AArch64 Options
15024 @cindex AArch64 Options
15026 These options are defined for AArch64 implementations:
15028 @table @gcctabopt
15030 @item -mabi=@var{name}
15031 @opindex mabi
15032 Generate code for the specified data model.  Permissible values
15033 are @samp{ilp32} for SysV-like data model where int, long int and pointers
15034 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
15035 but long int and pointers are 64 bits.
15037 The default depends on the specific target configuration.  Note that
15038 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
15039 entire program with the same ABI, and link with a compatible set of libraries.
15041 @item -mbig-endian
15042 @opindex mbig-endian
15043 Generate big-endian code.  This is the default when GCC is configured for an
15044 @samp{aarch64_be-*-*} target.
15046 @item -mgeneral-regs-only
15047 @opindex mgeneral-regs-only
15048 Generate code which uses only the general-purpose registers.  This will prevent
15049 the compiler from using floating-point and Advanced SIMD registers but will not
15050 impose any restrictions on the assembler.
15052 @item -mlittle-endian
15053 @opindex mlittle-endian
15054 Generate little-endian code.  This is the default when GCC is configured for an
15055 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
15057 @item -mcmodel=tiny
15058 @opindex mcmodel=tiny
15059 Generate code for the tiny code model.  The program and its statically defined
15060 symbols must be within 1MB of each other.  Programs can be statically or
15061 dynamically linked.
15063 @item -mcmodel=small
15064 @opindex mcmodel=small
15065 Generate code for the small code model.  The program and its statically defined
15066 symbols must be within 4GB of each other.  Programs can be statically or
15067 dynamically linked.  This is the default code model.
15069 @item -mcmodel=large
15070 @opindex mcmodel=large
15071 Generate code for the large code model.  This makes no assumptions about
15072 addresses and sizes of sections.  Programs can be statically linked only.
15074 @item -mstrict-align
15075 @itemx -mno-strict-align
15076 @opindex mstrict-align
15077 @opindex mno-strict-align
15078 Avoid or allow generating memory accesses that may not be aligned on a natural
15079 object boundary as described in the architecture specification.
15081 @item -momit-leaf-frame-pointer
15082 @itemx -mno-omit-leaf-frame-pointer
15083 @opindex momit-leaf-frame-pointer
15084 @opindex mno-omit-leaf-frame-pointer
15085 Omit or keep the frame pointer in leaf functions.  The former behavior is the
15086 default.
15088 @item -mtls-dialect=desc
15089 @opindex mtls-dialect=desc
15090 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
15091 of TLS variables.  This is the default.
15093 @item -mtls-dialect=traditional
15094 @opindex mtls-dialect=traditional
15095 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
15096 of TLS variables.
15098 @item -mtls-size=@var{size}
15099 @opindex mtls-size
15100 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
15101 This option requires binutils 2.26 or newer.
15103 @item -mfix-cortex-a53-835769
15104 @itemx -mno-fix-cortex-a53-835769
15105 @opindex mfix-cortex-a53-835769
15106 @opindex mno-fix-cortex-a53-835769
15107 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
15108 This involves inserting a NOP instruction between memory instructions and
15109 64-bit integer multiply-accumulate instructions.
15111 @item -mfix-cortex-a53-843419
15112 @itemx -mno-fix-cortex-a53-843419
15113 @opindex mfix-cortex-a53-843419
15114 @opindex mno-fix-cortex-a53-843419
15115 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
15116 This erratum workaround is made at link time and this will only pass the
15117 corresponding flag to the linker.
15119 @item -mlow-precision-recip-sqrt
15120 @itemx -mno-low-precision-recip-sqrt
15121 @opindex mlow-precision-recip-sqrt
15122 @opindex mno-low-precision-recip-sqrt
15123 Enable or disable the reciprocal square root approximation.
15124 This option only has an effect if @option{-ffast-math} or
15125 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
15126 precision of reciprocal square root results to about 16 bits for
15127 single precision and to 32 bits for double precision.
15129 @item -mlow-precision-sqrt
15130 @itemx -mno-low-precision-sqrt
15131 @opindex mlow-precision-sqrt
15132 @opindex mno-low-precision-sqrt
15133 Enable or disable the square root approximation.
15134 This option only has an effect if @option{-ffast-math} or
15135 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
15136 precision of square root results to about 16 bits for
15137 single precision and to 32 bits for double precision.
15138 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
15140 @item -mlow-precision-div
15141 @itemx -mno-low-precision-div
15142 @opindex mlow-precision-div
15143 @opindex mno-low-precision-div
15144 Enable or disable the division approximation.
15145 This option only has an effect if @option{-ffast-math} or
15146 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
15147 precision of division results to about 16 bits for
15148 single precision and to 32 bits for double precision.
15150 @item -mtrack-speculation
15151 @itemx -mno-track-speculation
15152 Enable or disable generation of additional code to track speculative
15153 execution through conditional branches.  The tracking state can then
15154 be used by the compiler when expanding calls to
15155 @code{__builtin_speculation_safe_copy} to permit a more efficient code
15156 sequence to be generated.
15158 @item -march=@var{name}
15159 @opindex march
15160 Specify the name of the target architecture and, optionally, one or
15161 more feature modifiers.  This option has the form
15162 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
15164 The permissible values for @var{arch} are @samp{armv8-a},
15165 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
15166 or @var{native}.
15168 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
15169 support for the ARMv8.4-A architecture extensions.
15171 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
15172 support for the ARMv8.3-A architecture extensions.
15174 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
15175 support for the ARMv8.2-A architecture extensions.
15177 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
15178 support for the ARMv8.1-A architecture extension.  In particular, it
15179 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
15181 The value @samp{native} is available on native AArch64 GNU/Linux and
15182 causes the compiler to pick the architecture of the host system.  This
15183 option has no effect if the compiler is unable to recognize the
15184 architecture of the host system,
15186 The permissible values for @var{feature} are listed in the sub-section
15187 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
15188 Feature Modifiers}.  Where conflicting feature modifiers are
15189 specified, the right-most feature is used.
15191 GCC uses @var{name} to determine what kind of instructions it can emit
15192 when generating assembly code.  If @option{-march} is specified
15193 without either of @option{-mtune} or @option{-mcpu} also being
15194 specified, the code is tuned to perform well across a range of target
15195 processors implementing the target architecture.
15197 @item -mtune=@var{name}
15198 @opindex mtune
15199 Specify the name of the target processor for which GCC should tune the
15200 performance of the code.  Permissible values for this option are:
15201 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15202 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15203 @samp{cortex-a76}, @samp{ares}, @samp{exynos-m1}, @samp{falkor},
15204 @samp{qdf24xx}, @samp{saphira}, @samp{phecda}, @samp{xgene1}, @samp{vulcan},
15205 @samp{thunderx}, @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
15206 @samp{tsv110}, @samp{thunderxt83}, @samp{thunderx2t99},
15207 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15208 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
15209 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}
15210 @samp{native}.
15212 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15213 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
15214 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55} specify that GCC
15215 should tune for a big.LITTLE system.
15217 Additionally on native AArch64 GNU/Linux systems the value
15218 @samp{native} tunes performance to the host system.  This option has no effect
15219 if the compiler is unable to recognize the processor of the host system.
15221 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
15222 are specified, the code is tuned to perform well across a range
15223 of target processors.
15225 This option cannot be suffixed by feature modifiers.
15227 @item -mcpu=@var{name}
15228 @opindex mcpu
15229 Specify the name of the target processor, optionally suffixed by one
15230 or more feature modifiers.  This option has the form
15231 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
15232 the permissible values for @var{cpu} are the same as those available
15233 for @option{-mtune}.  The permissible values for @var{feature} are
15234 documented in the sub-section on
15235 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
15236 Feature Modifiers}.  Where conflicting feature modifiers are
15237 specified, the right-most feature is used.
15239 GCC uses @var{name} to determine what kind of instructions it can emit when
15240 generating assembly code (as if by @option{-march}) and to determine
15241 the target processor for which to tune for performance (as if
15242 by @option{-mtune}).  Where this option is used in conjunction
15243 with @option{-march} or @option{-mtune}, those options take precedence
15244 over the appropriate part of this option.
15246 @item -moverride=@var{string}
15247 @opindex moverride
15248 Override tuning decisions made by the back-end in response to a
15249 @option{-mtune=} switch.  The syntax, semantics, and accepted values
15250 for @var{string} in this option are not guaranteed to be consistent
15251 across releases.
15253 This option is only intended to be useful when developing GCC.
15255 @item -mverbose-cost-dump
15256 @opindex mverbose-cost-dump
15257 Enable verbose cost model dumping in the debug dump files.  This option is
15258 provided for use in debugging the compiler.
15260 @item -mpc-relative-literal-loads
15261 @itemx -mno-pc-relative-literal-loads
15262 @opindex mpc-relative-literal-loads
15263 @opindex mno-pc-relative-literal-loads
15264 Enable or disable PC-relative literal loads.  With this option literal pools are
15265 accessed using a single instruction and emitted after each function.  This
15266 limits the maximum size of functions to 1MB.  This is enabled by default for
15267 @option{-mcmodel=tiny}.
15269 @item -msign-return-address=@var{scope}
15270 @opindex msign-return-address
15271 Select the function scope on which return address signing will be applied.
15272 Permissible values are @samp{none}, which disables return address signing,
15273 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
15274 functions, and @samp{all}, which enables pointer signing for all functions.  The
15275 default value is @samp{none}.
15277 @item -msve-vector-bits=@var{bits}
15278 @opindex msve-vector-bits
15279 Specify the number of bits in an SVE vector register.  This option only has
15280 an effect when SVE is enabled.
15282 GCC supports two forms of SVE code generation: ``vector-length
15283 agnostic'' output that works with any size of vector register and
15284 ``vector-length specific'' output that only works when the vector
15285 registers are a particular size.  Replacing @var{bits} with
15286 @samp{scalable} selects vector-length agnostic output while
15287 replacing it with a number selects vector-length specific output.
15288 The possible lengths in the latter case are: 128, 256, 512, 1024
15289 and 2048.  @samp{scalable} is the default.
15291 At present, @samp{-msve-vector-bits=128} produces the same output
15292 as @samp{-msve-vector-bits=scalable}.
15294 @end table
15296 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
15297 @anchor{aarch64-feature-modifiers}
15298 @cindex @option{-march} feature modifiers
15299 @cindex @option{-mcpu} feature modifiers
15300 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
15301 the following and their inverses @option{no@var{feature}}:
15303 @table @samp
15304 @item crc
15305 Enable CRC extension.  This is on by default for
15306 @option{-march=armv8.1-a}.
15307 @item crypto
15308 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
15309 instructions.
15310 @item fp
15311 Enable floating-point instructions.  This is on by default for all possible
15312 values for options @option{-march} and @option{-mcpu}.
15313 @item simd
15314 Enable Advanced SIMD instructions.  This also enables floating-point
15315 instructions.  This is on by default for all possible values for options
15316 @option{-march} and @option{-mcpu}.
15317 @item sve
15318 Enable Scalable Vector Extension instructions.  This also enables Advanced
15319 SIMD and floating-point instructions.
15320 @item lse
15321 Enable Large System Extension instructions.  This is on by default for
15322 @option{-march=armv8.1-a}.
15323 @item rdma
15324 Enable Round Double Multiply Accumulate instructions.  This is on by default
15325 for @option{-march=armv8.1-a}.
15326 @item fp16
15327 Enable FP16 extension.  This also enables floating-point instructions.
15328 @item fp16fml
15329 Enable FP16 fmla extension.  This also enables FP16 extensions and
15330 floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported.
15332 @item rcpc
15333 Enable the RcPc extension.  This does not change code generation from GCC,
15334 but is passed on to the assembler, enabling inline asm statements to use
15335 instructions from the RcPc extension.
15336 @item dotprod
15337 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15338 @item aes
15339 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
15340 SIMD instructions.
15341 @item sha2
15342 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
15343 @item sha3
15344 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
15345 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
15346 @item sm4
15347 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
15348 Use of this option with architectures prior to Armv8.2-A is not supported.
15349 @item profile
15350 Enable the Statistical Profiling extension.  This option is only to enable the
15351 extension at the assembler level and does not affect code generation.
15353 @end table
15355 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
15356 which implies @option{fp}.
15357 Conversely, @option{nofp} implies @option{nosimd}, which implies
15358 @option{nocrypto}, @option{noaes} and @option{nosha2}.
15360 @node Adapteva Epiphany Options
15361 @subsection Adapteva Epiphany Options
15363 These @samp{-m} options are defined for Adapteva Epiphany:
15365 @table @gcctabopt
15366 @item -mhalf-reg-file
15367 @opindex mhalf-reg-file
15368 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
15369 That allows code to run on hardware variants that lack these registers.
15371 @item -mprefer-short-insn-regs
15372 @opindex mprefer-short-insn-regs
15373 Preferentially allocate registers that allow short instruction generation.
15374 This can result in increased instruction count, so this may either reduce or
15375 increase overall code size.
15377 @item -mbranch-cost=@var{num}
15378 @opindex mbranch-cost
15379 Set the cost of branches to roughly @var{num} ``simple'' instructions.
15380 This cost is only a heuristic and is not guaranteed to produce
15381 consistent results across releases.
15383 @item -mcmove
15384 @opindex mcmove
15385 Enable the generation of conditional moves.
15387 @item -mnops=@var{num}
15388 @opindex mnops
15389 Emit @var{num} NOPs before every other generated instruction.
15391 @item -mno-soft-cmpsf
15392 @opindex mno-soft-cmpsf
15393 For single-precision floating-point comparisons, emit an @code{fsub} instruction
15394 and test the flags.  This is faster than a software comparison, but can
15395 get incorrect results in the presence of NaNs, or when two different small
15396 numbers are compared such that their difference is calculated as zero.
15397 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
15398 software comparisons.
15400 @item -mstack-offset=@var{num}
15401 @opindex mstack-offset
15402 Set the offset between the top of the stack and the stack pointer.
15403 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
15404 can be used by leaf functions without stack allocation.
15405 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
15406 Note also that this option changes the ABI; compiling a program with a
15407 different stack offset than the libraries have been compiled with
15408 generally does not work.
15409 This option can be useful if you want to evaluate if a different stack
15410 offset would give you better code, but to actually use a different stack
15411 offset to build working programs, it is recommended to configure the
15412 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
15414 @item -mno-round-nearest
15415 @opindex mno-round-nearest
15416 Make the scheduler assume that the rounding mode has been set to
15417 truncating.  The default is @option{-mround-nearest}.
15419 @item -mlong-calls
15420 @opindex mlong-calls
15421 If not otherwise specified by an attribute, assume all calls might be beyond
15422 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
15423 function address into a register before performing a (otherwise direct) call.
15424 This is the default.
15426 @item -mshort-calls
15427 @opindex short-calls
15428 If not otherwise specified by an attribute, assume all direct calls are
15429 in the range of the @code{b} / @code{bl} instructions, so use these instructions
15430 for direct calls.  The default is @option{-mlong-calls}.
15432 @item -msmall16
15433 @opindex msmall16
15434 Assume addresses can be loaded as 16-bit unsigned values.  This does not
15435 apply to function addresses for which @option{-mlong-calls} semantics
15436 are in effect.
15438 @item -mfp-mode=@var{mode}
15439 @opindex mfp-mode
15440 Set the prevailing mode of the floating-point unit.
15441 This determines the floating-point mode that is provided and expected
15442 at function call and return time.  Making this mode match the mode you
15443 predominantly need at function start can make your programs smaller and
15444 faster by avoiding unnecessary mode switches.
15446 @var{mode} can be set to one the following values:
15448 @table @samp
15449 @item caller
15450 Any mode at function entry is valid, and retained or restored when
15451 the function returns, and when it calls other functions.
15452 This mode is useful for compiling libraries or other compilation units
15453 you might want to incorporate into different programs with different
15454 prevailing FPU modes, and the convenience of being able to use a single
15455 object file outweighs the size and speed overhead for any extra
15456 mode switching that might be needed, compared with what would be needed
15457 with a more specific choice of prevailing FPU mode.
15459 @item truncate
15460 This is the mode used for floating-point calculations with
15461 truncating (i.e.@: round towards zero) rounding mode.  That includes
15462 conversion from floating point to integer.
15464 @item round-nearest
15465 This is the mode used for floating-point calculations with
15466 round-to-nearest-or-even rounding mode.
15468 @item int
15469 This is the mode used to perform integer calculations in the FPU, e.g.@:
15470 integer multiply, or integer multiply-and-accumulate.
15471 @end table
15473 The default is @option{-mfp-mode=caller}
15475 @item -mnosplit-lohi
15476 @itemx -mno-postinc
15477 @itemx -mno-postmodify
15478 @opindex mnosplit-lohi
15479 @opindex mno-postinc
15480 @opindex mno-postmodify
15481 Code generation tweaks that disable, respectively, splitting of 32-bit
15482 loads, generation of post-increment addresses, and generation of
15483 post-modify addresses.  The defaults are @option{msplit-lohi},
15484 @option{-mpost-inc}, and @option{-mpost-modify}.
15486 @item -mnovect-double
15487 @opindex mno-vect-double
15488 Change the preferred SIMD mode to SImode.  The default is
15489 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15491 @item -max-vect-align=@var{num}
15492 @opindex max-vect-align
15493 The maximum alignment for SIMD vector mode types.
15494 @var{num} may be 4 or 8.  The default is 8.
15495 Note that this is an ABI change, even though many library function
15496 interfaces are unaffected if they don't use SIMD vector modes
15497 in places that affect size and/or alignment of relevant types.
15499 @item -msplit-vecmove-early
15500 @opindex msplit-vecmove-early
15501 Split vector moves into single word moves before reload.  In theory this
15502 can give better register allocation, but so far the reverse seems to be
15503 generally the case.
15505 @item -m1reg-@var{reg}
15506 @opindex m1reg-
15507 Specify a register to hold the constant @minus{}1, which makes loading small negative
15508 constants and certain bitmasks faster.
15509 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15510 which specify use of that register as a fixed register,
15511 and @samp{none}, which means that no register is used for this
15512 purpose.  The default is @option{-m1reg-none}.
15514 @end table
15516 @node ARC Options
15517 @subsection ARC Options
15518 @cindex ARC options
15520 The following options control the architecture variant for which code
15521 is being compiled:
15523 @c architecture variants
15524 @table @gcctabopt
15526 @item -mbarrel-shifter
15527 @opindex mbarrel-shifter
15528 Generate instructions supported by barrel shifter.  This is the default
15529 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15531 @item -mjli-always
15532 @opindex mjli-alawys
15533 Force to call a function using jli_s instruction.  This option is
15534 valid only for ARCv2 architecture.
15536 @item -mcpu=@var{cpu}
15537 @opindex mcpu
15538 Set architecture type, register usage, and instruction scheduling
15539 parameters for @var{cpu}.  There are also shortcut alias options
15540 available for backward compatibility and convenience.  Supported
15541 values for @var{cpu} are
15543 @table @samp
15544 @opindex mA6
15545 @opindex mARC600
15546 @item arc600
15547 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15549 @item arc601
15550 @opindex mARC601
15551 Compile for ARC601.  Alias: @option{-mARC601}.
15553 @item arc700
15554 @opindex mA7
15555 @opindex mARC700
15556 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15557 This is the default when configured with @option{--with-cpu=arc700}@.
15559 @item arcem
15560 Compile for ARC EM.
15562 @item archs
15563 Compile for ARC HS.
15565 @item em
15566 Compile for ARC EM CPU with no hardware extensions.
15568 @item em4
15569 Compile for ARC EM4 CPU.
15571 @item em4_dmips
15572 Compile for ARC EM4 DMIPS CPU.
15574 @item em4_fpus
15575 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15576 extension.
15578 @item em4_fpuda
15579 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15580 double assist instructions.
15582 @item hs
15583 Compile for ARC HS CPU with no hardware extensions except the atomic
15584 instructions.
15586 @item hs34
15587 Compile for ARC HS34 CPU.
15589 @item hs38
15590 Compile for ARC HS38 CPU.
15592 @item hs38_linux
15593 Compile for ARC HS38 CPU with all hardware extensions on.
15595 @item arc600_norm
15596 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15598 @item arc600_mul32x16
15599 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15600 instructions enabled.
15602 @item arc600_mul64
15603 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15604 instructions enabled.
15606 @item arc601_norm
15607 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15609 @item arc601_mul32x16
15610 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15611 instructions enabled.
15613 @item arc601_mul64
15614 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15615 instructions enabled.
15617 @item nps400
15618 Compile for ARC 700 on NPS400 chip.
15620 @item em_mini
15621 Compile for ARC EM minimalist configuration featuring reduced register
15622 set.
15624 @end table
15626 @item -mdpfp
15627 @opindex mdpfp
15628 @itemx -mdpfp-compact
15629 @opindex mdpfp-compact
15630 Generate double-precision FPX instructions, tuned for the compact
15631 implementation.
15633 @item -mdpfp-fast
15634 @opindex mdpfp-fast
15635 Generate double-precision FPX instructions, tuned for the fast
15636 implementation.
15638 @item -mno-dpfp-lrsr
15639 @opindex mno-dpfp-lrsr
15640 Disable @code{lr} and @code{sr} instructions from using FPX extension
15641 aux registers.
15643 @item -mea
15644 @opindex mea
15645 Generate extended arithmetic instructions.  Currently only
15646 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15647 supported.  This is always enabled for @option{-mcpu=ARC700}.
15649 @item -mno-mpy
15650 @opindex mno-mpy
15651 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15652 deprecated.
15654 @item -mmul32x16
15655 @opindex mmul32x16
15656 Generate 32x16-bit multiply and multiply-accumulate instructions.
15658 @item -mmul64
15659 @opindex mmul64
15660 Generate @code{mul64} and @code{mulu64} instructions.  
15661 Only valid for @option{-mcpu=ARC600}.
15663 @item -mnorm
15664 @opindex mnorm
15665 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15666 is in effect.
15668 @item -mspfp
15669 @opindex mspfp
15670 @itemx -mspfp-compact
15671 @opindex mspfp-compact
15672 Generate single-precision FPX instructions, tuned for the compact
15673 implementation.
15675 @item -mspfp-fast
15676 @opindex mspfp-fast
15677 Generate single-precision FPX instructions, tuned for the fast
15678 implementation.
15680 @item -msimd
15681 @opindex msimd
15682 Enable generation of ARC SIMD instructions via target-specific
15683 builtins.  Only valid for @option{-mcpu=ARC700}.
15685 @item -msoft-float
15686 @opindex msoft-float
15687 This option ignored; it is provided for compatibility purposes only.
15688 Software floating-point code is emitted by default, and this default
15689 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15690 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15691 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15693 @item -mswap
15694 @opindex mswap
15695 Generate @code{swap} instructions.
15697 @item -matomic
15698 @opindex matomic
15699 This enables use of the locked load/store conditional extension to implement
15700 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15701 EM cores.
15703 @item -mdiv-rem
15704 @opindex mdiv-rem
15705 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15707 @item -mcode-density
15708 @opindex mcode-density
15709 Enable code density instructions for ARC EM.  
15710 This option is on by default for ARC HS.
15712 @item -mll64
15713 @opindex mll64
15714 Enable double load/store operations for ARC HS cores.
15716 @item -mtp-regno=@var{regno}
15717 @opindex mtp-regno
15718 Specify thread pointer register number.
15720 @item -mmpy-option=@var{multo}
15721 @opindex mmpy-option
15722 Compile ARCv2 code with a multiplier design option.  You can specify 
15723 the option using either a string or numeric value for @var{multo}.  
15724 @samp{wlh1} is the default value.  The recognized values are:
15726 @table @samp
15727 @item 0
15728 @itemx none
15729 No multiplier available.
15731 @item 1
15732 @itemx w
15733 16x16 multiplier, fully pipelined.
15734 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15736 @item 2
15737 @itemx wlh1
15738 32x32 multiplier, fully
15739 pipelined (1 stage).  The following instructions are additionally
15740 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15742 @item 3
15743 @itemx wlh2
15744 32x32 multiplier, fully pipelined
15745 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15746 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15748 @item 4
15749 @itemx wlh3
15750 Two 16x16 multipliers, blocking,
15751 sequential.  The following instructions are additionally enabled: @code{mpy},
15752 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15754 @item 5
15755 @itemx wlh4
15756 One 16x16 multiplier, blocking,
15757 sequential.  The following instructions are additionally enabled: @code{mpy},
15758 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15760 @item 6
15761 @itemx wlh5
15762 One 32x4 multiplier, blocking,
15763 sequential.  The following instructions are additionally enabled: @code{mpy},
15764 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15766 @item 7
15767 @itemx plus_dmpy
15768 ARC HS SIMD support.
15770 @item 8
15771 @itemx plus_macd
15772 ARC HS SIMD support.
15774 @item 9
15775 @itemx plus_qmacw
15776 ARC HS SIMD support.
15778 @end table
15780 This option is only available for ARCv2 cores@.
15782 @item -mfpu=@var{fpu}
15783 @opindex mfpu
15784 Enables support for specific floating-point hardware extensions for ARCv2
15785 cores.  Supported values for @var{fpu} are:
15787 @table @samp
15789 @item fpus
15790 Enables support for single-precision floating-point hardware
15791 extensions@.
15793 @item fpud
15794 Enables support for double-precision floating-point hardware
15795 extensions.  The single-precision floating-point extension is also
15796 enabled.  Not available for ARC EM@.
15798 @item fpuda
15799 Enables support for double-precision floating-point hardware
15800 extensions using double-precision assist instructions.  The single-precision
15801 floating-point extension is also enabled.  This option is
15802 only available for ARC EM@.
15804 @item fpuda_div
15805 Enables support for double-precision floating-point hardware
15806 extensions using double-precision assist instructions.
15807 The single-precision floating-point, square-root, and divide 
15808 extensions are also enabled.  This option is
15809 only available for ARC EM@.
15811 @item fpuda_fma
15812 Enables support for double-precision floating-point hardware
15813 extensions using double-precision assist instructions.
15814 The single-precision floating-point and fused multiply and add 
15815 hardware extensions are also enabled.  This option is
15816 only available for ARC EM@.
15818 @item fpuda_all
15819 Enables support for double-precision floating-point hardware
15820 extensions using double-precision assist instructions.
15821 All single-precision floating-point hardware extensions are also
15822 enabled.  This option is only available for ARC EM@.
15824 @item fpus_div
15825 Enables support for single-precision floating-point, square-root and divide 
15826 hardware extensions@.
15828 @item fpud_div
15829 Enables support for double-precision floating-point, square-root and divide 
15830 hardware extensions.  This option
15831 includes option @samp{fpus_div}. Not available for ARC EM@.
15833 @item fpus_fma
15834 Enables support for single-precision floating-point and 
15835 fused multiply and add hardware extensions@.
15837 @item fpud_fma
15838 Enables support for double-precision floating-point and 
15839 fused multiply and add hardware extensions.  This option
15840 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15842 @item fpus_all
15843 Enables support for all single-precision floating-point hardware
15844 extensions@.
15846 @item fpud_all
15847 Enables support for all single- and double-precision floating-point
15848 hardware extensions.  Not available for ARC EM@.
15850 @end table
15852 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15853 @opindex mirq-ctrl-saved
15854 Specifies general-purposes registers that the processor automatically
15855 saves/restores on interrupt entry and exit.  @var{register-range} is
15856 specified as two registers separated by a dash.  The register range
15857 always starts with @code{r0}, the upper limit is @code{fp} register.
15858 @var{blink} and @var{lp_count} are optional.  This option is only
15859 valid for ARC EM and ARC HS cores.
15861 @item -mrgf-banked-regs=@var{number}
15862 @opindex mrgf-banked-regs
15863 Specifies the number of registers replicated in second register bank
15864 on entry to fast interrupt.  Fast interrupts are interrupts with the
15865 highest priority level P0.  These interrupts save only PC and STATUS32
15866 registers to avoid memory transactions during interrupt entry and exit
15867 sequences.  Use this option when you are using fast interrupts in an
15868 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15870 @item -mlpc-width=@var{width}
15871 @opindex mlpc-width
15872 Specify the width of the @code{lp_count} register.  Valid values for
15873 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15874 fixed to 32 bits.  If the width is less than 32, the compiler does not
15875 attempt to transform loops in your program to use the zero-delay loop
15876 mechanism unless it is known that the @code{lp_count} register can
15877 hold the required loop-counter value.  Depending on the width
15878 specified, the compiler and run-time library might continue to use the
15879 loop mechanism for various needs.  This option defines macro
15880 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15882 @item -mrf16
15883 @opindex mrf16
15884 This option instructs the compiler to generate code for a 16-entry
15885 register file.  This option defines the @code{__ARC_RF16__}
15886 preprocessor macro.
15888 @item -mbranch-index
15889 @opindex mbranch-index
15890 Enable use of @code{bi} or @code{bih} instructions to implement jump
15891 tables.
15893 @end table
15895 The following options are passed through to the assembler, and also
15896 define preprocessor macro symbols.
15898 @c Flags used by the assembler, but for which we define preprocessor
15899 @c macro symbols as well.
15900 @table @gcctabopt
15901 @item -mdsp-packa
15902 @opindex mdsp-packa
15903 Passed down to the assembler to enable the DSP Pack A extensions.
15904 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15905 deprecated.
15907 @item -mdvbf
15908 @opindex mdvbf
15909 Passed down to the assembler to enable the dual Viterbi butterfly
15910 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15911 option is deprecated.
15913 @c ARC700 4.10 extension instruction
15914 @item -mlock
15915 @opindex mlock
15916 Passed down to the assembler to enable the locked load/store
15917 conditional extension.  Also sets the preprocessor symbol
15918 @code{__Xlock}.
15920 @item -mmac-d16
15921 @opindex mmac-d16
15922 Passed down to the assembler.  Also sets the preprocessor symbol
15923 @code{__Xxmac_d16}.  This option is deprecated.
15925 @item -mmac-24
15926 @opindex mmac-24
15927 Passed down to the assembler.  Also sets the preprocessor symbol
15928 @code{__Xxmac_24}.  This option is deprecated.
15930 @c ARC700 4.10 extension instruction
15931 @item -mrtsc
15932 @opindex mrtsc
15933 Passed down to the assembler to enable the 64-bit time-stamp counter
15934 extension instruction.  Also sets the preprocessor symbol
15935 @code{__Xrtsc}.  This option is deprecated.
15937 @c ARC700 4.10 extension instruction
15938 @item -mswape
15939 @opindex mswape
15940 Passed down to the assembler to enable the swap byte ordering
15941 extension instruction.  Also sets the preprocessor symbol
15942 @code{__Xswape}.
15944 @item -mtelephony
15945 @opindex mtelephony
15946 Passed down to the assembler to enable dual- and single-operand
15947 instructions for telephony.  Also sets the preprocessor symbol
15948 @code{__Xtelephony}.  This option is deprecated.
15950 @item -mxy
15951 @opindex mxy
15952 Passed down to the assembler to enable the XY memory extension.  Also
15953 sets the preprocessor symbol @code{__Xxy}.
15955 @end table
15957 The following options control how the assembly code is annotated:
15959 @c Assembly annotation options
15960 @table @gcctabopt
15961 @item -misize
15962 @opindex misize
15963 Annotate assembler instructions with estimated addresses.
15965 @item -mannotate-align
15966 @opindex mannotate-align
15967 Explain what alignment considerations lead to the decision to make an
15968 instruction short or long.
15970 @end table
15972 The following options are passed through to the linker:
15974 @c options passed through to the linker
15975 @table @gcctabopt
15976 @item -marclinux
15977 @opindex marclinux
15978 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15979 This option is enabled by default in tool chains built for
15980 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15981 when profiling is not requested.
15983 @item -marclinux_prof
15984 @opindex marclinux_prof
15985 Passed through to the linker, to specify use of the
15986 @code{arclinux_prof} emulation.  This option is enabled by default in
15987 tool chains built for @w{@code{arc-linux-uclibc}} and
15988 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15990 @end table
15992 The following options control the semantics of generated code:
15994 @c semantically relevant code generation options
15995 @table @gcctabopt
15996 @item -mlong-calls
15997 @opindex mlong-calls
15998 Generate calls as register indirect calls, thus providing access
15999 to the full 32-bit address range.
16001 @item -mmedium-calls
16002 @opindex mmedium-calls
16003 Don't use less than 25-bit addressing range for calls, which is the
16004 offset available for an unconditional branch-and-link
16005 instruction.  Conditional execution of function calls is suppressed, to
16006 allow use of the 25-bit range, rather than the 21-bit range with
16007 conditional branch-and-link.  This is the default for tool chains built
16008 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
16010 @item -G @var{num}
16011 @opindex G
16012 Put definitions of externally-visible data in a small data section if
16013 that data is no bigger than @var{num} bytes.  The default value of
16014 @var{num} is 4 for any ARC configuration, or 8 when we have double
16015 load/store operations.
16017 @item -mno-sdata
16018 @opindex mno-sdata
16019 Do not generate sdata references.  This is the default for tool chains
16020 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
16021 targets.
16023 @item -mvolatile-cache
16024 @opindex mvolatile-cache
16025 Use ordinarily cached memory accesses for volatile references.  This is the
16026 default.
16028 @item -mno-volatile-cache
16029 @opindex mno-volatile-cache
16030 Enable cache bypass for volatile references.
16032 @end table
16034 The following options fine tune code generation:
16035 @c code generation tuning options
16036 @table @gcctabopt
16037 @item -malign-call
16038 @opindex malign-call
16039 Do alignment optimizations for call instructions.
16041 @item -mauto-modify-reg
16042 @opindex mauto-modify-reg
16043 Enable the use of pre/post modify with register displacement.
16045 @item -mbbit-peephole
16046 @opindex mbbit-peephole
16047 Enable bbit peephole2.
16049 @item -mno-brcc
16050 @opindex mno-brcc
16051 This option disables a target-specific pass in @file{arc_reorg} to
16052 generate compare-and-branch (@code{br@var{cc}}) instructions.  
16053 It has no effect on
16054 generation of these instructions driven by the combiner pass.
16056 @item -mcase-vector-pcrel
16057 @opindex mcase-vector-pcrel
16058 Use PC-relative switch case tables to enable case table shortening.
16059 This is the default for @option{-Os}.
16061 @item -mcompact-casesi
16062 @opindex mcompact-casesi
16063 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
16064 and only available for ARCv1 cores.  This option is deprecated.
16066 @item -mno-cond-exec
16067 @opindex mno-cond-exec
16068 Disable the ARCompact-specific pass to generate conditional 
16069 execution instructions.
16071 Due to delay slot scheduling and interactions between operand numbers,
16072 literal sizes, instruction lengths, and the support for conditional execution,
16073 the target-independent pass to generate conditional execution is often lacking,
16074 so the ARC port has kept a special pass around that tries to find more
16075 conditional execution generation opportunities after register allocation,
16076 branch shortening, and delay slot scheduling have been done.  This pass
16077 generally, but not always, improves performance and code size, at the cost of
16078 extra compilation time, which is why there is an option to switch it off.
16079 If you have a problem with call instructions exceeding their allowable
16080 offset range because they are conditionalized, you should consider using
16081 @option{-mmedium-calls} instead.
16083 @item -mearly-cbranchsi
16084 @opindex mearly-cbranchsi
16085 Enable pre-reload use of the @code{cbranchsi} pattern.
16087 @item -mexpand-adddi
16088 @opindex mexpand-adddi
16089 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
16090 @code{add.f}, @code{adc} etc.  This option is deprecated.
16092 @item -mindexed-loads
16093 @opindex mindexed-loads
16094 Enable the use of indexed loads.  This can be problematic because some
16095 optimizers then assume that indexed stores exist, which is not
16096 the case.
16098 @item -mlra
16099 @opindex mlra
16100 Enable Local Register Allocation.  This is still experimental for ARC,
16101 so by default the compiler uses standard reload
16102 (i.e.@: @option{-mno-lra}).
16104 @item -mlra-priority-none
16105 @opindex mlra-priority-none
16106 Don't indicate any priority for target registers.
16108 @item -mlra-priority-compact
16109 @opindex mlra-priority-compact
16110 Indicate target register priority for r0..r3 / r12..r15.
16112 @item -mlra-priority-noncompact
16113 @opindex mlra-priority-noncompact
16114 Reduce target register priority for r0..r3 / r12..r15.
16116 @item -mno-millicode
16117 @opindex mno-millicode
16118 When optimizing for size (using @option{-Os}), prologues and epilogues
16119 that have to save or restore a large number of registers are often
16120 shortened by using call to a special function in libgcc; this is
16121 referred to as a @emph{millicode} call.  As these calls can pose
16122 performance issues, and/or cause linking issues when linking in a
16123 nonstandard way, this option is provided to turn off millicode call
16124 generation.
16126 @item -mmixed-code
16127 @opindex mmixed-code
16128 Tweak register allocation to help 16-bit instruction generation.
16129 This generally has the effect of decreasing the average instruction size
16130 while increasing the instruction count.
16132 @item -mq-class
16133 @opindex mq-class
16134 Enable @samp{q} instruction alternatives.
16135 This is the default for @option{-Os}.
16137 @item -mRcq
16138 @opindex mRcq
16139 Enable @samp{Rcq} constraint handling.  
16140 Most short code generation depends on this.
16141 This is the default.
16143 @item -mRcw
16144 @opindex mRcw
16145 Enable @samp{Rcw} constraint handling.  
16146 Most ccfsm condexec mostly depends on this.
16147 This is the default.
16149 @item -msize-level=@var{level}
16150 @opindex msize-level
16151 Fine-tune size optimization with regards to instruction lengths and alignment.
16152 The recognized values for @var{level} are:
16153 @table @samp
16154 @item 0
16155 No size optimization.  This level is deprecated and treated like @samp{1}.
16157 @item 1
16158 Short instructions are used opportunistically.
16160 @item 2
16161 In addition, alignment of loops and of code after barriers are dropped.
16163 @item 3
16164 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
16166 @end table
16168 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
16169 the behavior when this is not set is equivalent to level @samp{1}.
16171 @item -mtune=@var{cpu}
16172 @opindex mtune
16173 Set instruction scheduling parameters for @var{cpu}, overriding any implied
16174 by @option{-mcpu=}.
16176 Supported values for @var{cpu} are
16178 @table @samp
16179 @item ARC600
16180 Tune for ARC600 CPU.
16182 @item ARC601
16183 Tune for ARC601 CPU.
16185 @item ARC700
16186 Tune for ARC700 CPU with standard multiplier block.
16188 @item ARC700-xmac
16189 Tune for ARC700 CPU with XMAC block.
16191 @item ARC725D
16192 Tune for ARC725D CPU.
16194 @item ARC750D
16195 Tune for ARC750D CPU.
16197 @end table
16199 @item -mmultcost=@var{num}
16200 @opindex mmultcost
16201 Cost to assume for a multiply instruction, with @samp{4} being equal to a
16202 normal instruction.
16204 @item -munalign-prob-threshold=@var{probability}
16205 @opindex munalign-prob-threshold
16206 Set probability threshold for unaligning branches.
16207 When tuning for @samp{ARC700} and optimizing for speed, branches without
16208 filled delay slot are preferably emitted unaligned and long, unless
16209 profiling indicates that the probability for the branch to be taken
16210 is below @var{probability}.  @xref{Cross-profiling}.
16211 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
16213 @end table
16215 The following options are maintained for backward compatibility, but
16216 are now deprecated and will be removed in a future release:
16218 @c Deprecated options
16219 @table @gcctabopt
16221 @item -margonaut
16222 @opindex margonaut
16223 Obsolete FPX.
16225 @item -mbig-endian
16226 @opindex mbig-endian
16227 @itemx -EB
16228 @opindex EB
16229 Compile code for big-endian targets.  Use of these options is now
16230 deprecated.  Big-endian code is supported by configuring GCC to build
16231 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
16232 for which big endian is the default.
16234 @item -mlittle-endian
16235 @opindex mlittle-endian
16236 @itemx -EL
16237 @opindex EL
16238 Compile code for little-endian targets.  Use of these options is now
16239 deprecated.  Little-endian code is supported by configuring GCC to build 
16240 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
16241 for which little endian is the default.
16243 @item -mbarrel_shifter
16244 @opindex mbarrel_shifter
16245 Replaced by @option{-mbarrel-shifter}.
16247 @item -mdpfp_compact
16248 @opindex mdpfp_compact
16249 Replaced by @option{-mdpfp-compact}.
16251 @item -mdpfp_fast
16252 @opindex mdpfp_fast
16253 Replaced by @option{-mdpfp-fast}.
16255 @item -mdsp_packa
16256 @opindex mdsp_packa
16257 Replaced by @option{-mdsp-packa}.
16259 @item -mEA
16260 @opindex mEA
16261 Replaced by @option{-mea}.
16263 @item -mmac_24
16264 @opindex mmac_24
16265 Replaced by @option{-mmac-24}.
16267 @item -mmac_d16
16268 @opindex mmac_d16
16269 Replaced by @option{-mmac-d16}.
16271 @item -mspfp_compact
16272 @opindex mspfp_compact
16273 Replaced by @option{-mspfp-compact}.
16275 @item -mspfp_fast
16276 @opindex mspfp_fast
16277 Replaced by @option{-mspfp-fast}.
16279 @item -mtune=@var{cpu}
16280 @opindex mtune
16281 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
16282 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
16283 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
16285 @item -multcost=@var{num}
16286 @opindex multcost
16287 Replaced by @option{-mmultcost}.
16289 @end table
16291 @node ARM Options
16292 @subsection ARM Options
16293 @cindex ARM options
16295 These @samp{-m} options are defined for the ARM port:
16297 @table @gcctabopt
16298 @item -mabi=@var{name}
16299 @opindex mabi
16300 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
16301 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
16303 @item -mapcs-frame
16304 @opindex mapcs-frame
16305 Generate a stack frame that is compliant with the ARM Procedure Call
16306 Standard for all functions, even if this is not strictly necessary for
16307 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
16308 with this option causes the stack frames not to be generated for
16309 leaf functions.  The default is @option{-mno-apcs-frame}.
16310 This option is deprecated.
16312 @item -mapcs
16313 @opindex mapcs
16314 This is a synonym for @option{-mapcs-frame} and is deprecated.
16316 @ignore
16317 @c not currently implemented
16318 @item -mapcs-stack-check
16319 @opindex mapcs-stack-check
16320 Generate code to check the amount of stack space available upon entry to
16321 every function (that actually uses some stack space).  If there is
16322 insufficient space available then either the function
16323 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
16324 called, depending upon the amount of stack space required.  The runtime
16325 system is required to provide these functions.  The default is
16326 @option{-mno-apcs-stack-check}, since this produces smaller code.
16328 @c not currently implemented
16329 @item -mapcs-reentrant
16330 @opindex mapcs-reentrant
16331 Generate reentrant, position-independent code.  The default is
16332 @option{-mno-apcs-reentrant}.
16333 @end ignore
16335 @item -mthumb-interwork
16336 @opindex mthumb-interwork
16337 Generate code that supports calling between the ARM and Thumb
16338 instruction sets.  Without this option, on pre-v5 architectures, the
16339 two instruction sets cannot be reliably used inside one program.  The
16340 default is @option{-mno-thumb-interwork}, since slightly larger code
16341 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
16342 configurations this option is meaningless.
16344 @item -mno-sched-prolog
16345 @opindex mno-sched-prolog
16346 Prevent the reordering of instructions in the function prologue, or the
16347 merging of those instruction with the instructions in the function's
16348 body.  This means that all functions start with a recognizable set
16349 of instructions (or in fact one of a choice from a small set of
16350 different function prologues), and this information can be used to
16351 locate the start of functions inside an executable piece of code.  The
16352 default is @option{-msched-prolog}.
16354 @item -mfloat-abi=@var{name}
16355 @opindex mfloat-abi
16356 Specifies which floating-point ABI to use.  Permissible values
16357 are: @samp{soft}, @samp{softfp} and @samp{hard}.
16359 Specifying @samp{soft} causes GCC to generate output containing
16360 library calls for floating-point operations.
16361 @samp{softfp} allows the generation of code using hardware floating-point
16362 instructions, but still uses the soft-float calling conventions.
16363 @samp{hard} allows generation of floating-point instructions
16364 and uses FPU-specific calling conventions.
16366 The default depends on the specific target configuration.  Note that
16367 the hard-float and soft-float ABIs are not link-compatible; you must
16368 compile your entire program with the same ABI, and link with a
16369 compatible set of libraries.
16371 @item -mlittle-endian
16372 @opindex mlittle-endian
16373 Generate code for a processor running in little-endian mode.  This is
16374 the default for all standard configurations.
16376 @item -mbig-endian
16377 @opindex mbig-endian
16378 Generate code for a processor running in big-endian mode; the default is
16379 to compile code for a little-endian processor.
16381 @item -mbe8
16382 @itemx -mbe32
16383 @opindex mbe8
16384 When linking a big-endian image select between BE8 and BE32 formats.
16385 The option has no effect for little-endian images and is ignored.  The
16386 default is dependent on the selected target architecture.  For ARMv6
16387 and later architectures the default is BE8, for older architectures
16388 the default is BE32.  BE32 format has been deprecated by ARM.
16390 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
16391 @opindex march
16392 This specifies the name of the target ARM architecture.  GCC uses this
16393 name to determine what kind of instructions it can emit when generating
16394 assembly code.  This option can be used in conjunction with or instead
16395 of the @option{-mcpu=} option.
16397 Permissible names are:
16398 @samp{armv4t},
16399 @samp{armv5t}, @samp{armv5te},
16400 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
16401 @samp{armv6z}, @samp{armv6zk},
16402 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
16403 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
16404 @samp{armv8.4-a},
16405 @samp{armv7-r},
16406 @samp{armv8-r},
16407 @samp{armv6-m}, @samp{armv6s-m},
16408 @samp{armv7-m}, @samp{armv7e-m},
16409 @samp{armv8-m.base}, @samp{armv8-m.main},
16410 @samp{iwmmxt} and @samp{iwmmxt2}.
16412 Additionally, the following architectures, which lack support for the
16413 Thumb execution state, are recognized but support is deprecated: @samp{armv4}.
16415 Many of the architectures support extensions.  These can be added by
16416 appending @samp{+@var{extension}} to the architecture name.  Extension
16417 options are processed in order and capabilities accumulate.  An extension
16418 will also enable any necessary base extensions
16419 upon which it depends.  For example, the @samp{+crypto} extension
16420 will always enable the @samp{+simd} extension.  The exception to the
16421 additive construction is for extensions that are prefixed with
16422 @samp{+no@dots{}}: these extensions disable the specified option and
16423 any other extensions that may depend on the presence of that
16424 extension.
16426 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
16427 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
16428 entirely disabled by the @samp{+nofp} option that follows it.
16430 Most extension names are generically named, but have an effect that is
16431 dependent upon the architecture to which it is applied.  For example,
16432 the @samp{+simd} option can be applied to both @samp{armv7-a} and
16433 @samp{armv8-a} architectures, but will enable the original ARMv7-A
16434 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
16435 variant for @samp{armv8-a}.
16437 The table below lists the supported extensions for each architecture.
16438 Architectures not mentioned do not support any extensions.
16440 @table @samp
16441 @item armv5te
16442 @itemx armv6
16443 @itemx armv6j
16444 @itemx armv6k
16445 @itemx armv6kz
16446 @itemx armv6t2
16447 @itemx armv6z
16448 @itemx armv6zk
16449 @table @samp
16450 @item +fp
16451 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
16452 used as an alias for this extension.
16454 @item +nofp
16455 Disable the floating-point instructions.
16456 @end table
16458 @item armv7
16459 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
16460 @table @samp
16461 @item +fp
16462 The VFPv3 floating-point instructions, with 16 double-precision
16463 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
16464 for this extension.  Note that floating-point is not supported by the
16465 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
16466 ARMv7-R architectures.
16468 @item +nofp
16469 Disable the floating-point instructions.
16470 @end table
16472 @item armv7-a
16473 @table @samp
16474 @item +fp
16475 The VFPv3 floating-point instructions, with 16 double-precision
16476 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
16477 for this extension.
16479 @item +simd
16480 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16481 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
16482 for this extension.
16484 @item +vfpv3
16485 The VFPv3 floating-point instructions, with 32 double-precision
16486 registers.
16488 @item +vfpv3-d16-fp16
16489 The VFPv3 floating-point instructions, with 16 double-precision
16490 registers and the half-precision floating-point conversion operations.
16492 @item +vfpv3-fp16
16493 The VFPv3 floating-point instructions, with 32 double-precision
16494 registers and the half-precision floating-point conversion operations.
16496 @item +vfpv4-d16
16497 The VFPv4 floating-point instructions, with 16 double-precision
16498 registers.
16500 @item +vfpv4
16501 The VFPv4 floating-point instructions, with 32 double-precision
16502 registers.
16504 @item +neon-fp16
16505 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16506 the half-precision floating-point conversion operations.
16508 @item +neon-vfpv4
16509 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16511 @item +nosimd
16512 Disable the Advanced SIMD instructions (does not disable floating point).
16514 @item +nofp
16515 Disable the floating-point and Advanced SIMD instructions.
16516 @end table
16518 @item armv7ve
16519 The extended version of the ARMv7-A architecture with support for
16520 virtualization.
16521 @table @samp
16522 @item +fp
16523 The VFPv4 floating-point instructions, with 16 double-precision registers.
16524 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16526 @item +simd
16527 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16528 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16530 @item +vfpv3-d16
16531 The VFPv3 floating-point instructions, with 16 double-precision
16532 registers.
16534 @item +vfpv3
16535 The VFPv3 floating-point instructions, with 32 double-precision
16536 registers.
16538 @item +vfpv3-d16-fp16
16539 The VFPv3 floating-point instructions, with 16 double-precision
16540 registers and the half-precision floating-point conversion operations.
16542 @item +vfpv3-fp16
16543 The VFPv3 floating-point instructions, with 32 double-precision
16544 registers and the half-precision floating-point conversion operations.
16546 @item +vfpv4-d16
16547 The VFPv4 floating-point instructions, with 16 double-precision
16548 registers.
16550 @item +vfpv4
16551 The VFPv4 floating-point instructions, with 32 double-precision
16552 registers.
16554 @item +neon
16555 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16556 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16558 @item +neon-fp16
16559 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16560 the half-precision floating-point conversion operations.
16562 @item +nosimd
16563 Disable the Advanced SIMD instructions (does not disable floating point).
16565 @item +nofp
16566 Disable the floating-point and Advanced SIMD instructions.
16567 @end table
16569 @item armv8-a
16570 @table @samp
16571 @item +crc
16572 The Cyclic Redundancy Check (CRC) instructions.
16573 @item +simd
16574 The ARMv8-A Advanced SIMD and floating-point instructions.
16575 @item +crypto
16576 The cryptographic instructions.
16577 @item +nocrypto
16578 Disable the cryptographic instructions.
16579 @item +nofp
16580 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16581 @end table
16583 @item armv8.1-a
16584 @table @samp
16585 @item +simd
16586 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16588 @item +crypto
16589 The cryptographic instructions.  This also enables the Advanced SIMD and
16590 floating-point instructions.
16592 @item +nocrypto
16593 Disable the cryptographic instructions.
16595 @item +nofp
16596 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16597 @end table
16599 @item armv8.2-a
16600 @itemx armv8.3-a
16601 @table @samp
16602 @item +fp16
16603 The half-precision floating-point data processing instructions.
16604 This also enables the Advanced SIMD and floating-point instructions.
16606 @item +fp16fml
16607 The half-precision floating-point fmla extension.  This also enables
16608 the half-precision floating-point extension and Advanced SIMD and
16609 floating-point instructions.
16611 @item +simd
16612 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16614 @item +crypto
16615 The cryptographic instructions.  This also enables the Advanced SIMD and
16616 floating-point instructions.
16618 @item +dotprod
16619 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16621 @item +nocrypto
16622 Disable the cryptographic extension.
16624 @item +nofp
16625 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16626 @end table
16628 @item armv8.4-a
16629 @table @samp
16630 @item +fp16
16631 The half-precision floating-point data processing instructions.
16632 This also enables the Advanced SIMD and floating-point instructions as well
16633 as the Dot Product extension and the half-precision floating-point fmla
16634 extension.
16636 @item +simd
16637 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16638 Dot Product extension.
16640 @item +crypto
16641 The cryptographic instructions.  This also enables the Advanced SIMD and
16642 floating-point instructions as well as the Dot Product extension.
16644 @item +nocrypto
16645 Disable the cryptographic extension.
16647 @item +nofp
16648 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16649 @end table
16651 @item armv7-r
16652 @table @samp
16653 @item +fp.sp
16654 The single-precision VFPv3 floating-point instructions.  The extension
16655 @samp{+vfpv3xd} can be used as an alias for this extension.
16657 @item +fp
16658 The VFPv3 floating-point instructions with 16 double-precision registers.
16659 The extension +vfpv3-d16 can be used as an alias for this extension.
16661 @item +nofp
16662 Disable the floating-point extension.
16664 @item +idiv
16665 The ARM-state integer division instructions.
16667 @item +noidiv
16668 Disable the ARM-state integer division extension.
16669 @end table
16671 @item armv7e-m
16672 @table @samp
16673 @item +fp
16674 The single-precision VFPv4 floating-point instructions.
16676 @item +fpv5
16677 The single-precision FPv5 floating-point instructions.
16679 @item +fp.dp
16680 The single- and double-precision FPv5 floating-point instructions.
16682 @item +nofp
16683 Disable the floating-point extensions.
16684 @end table
16686 @item  armv8-m.main
16687 @table @samp
16688 @item +dsp
16689 The DSP instructions.
16691 @item +nodsp
16692 Disable the DSP extension.
16694 @item +fp
16695 The single-precision floating-point instructions.
16697 @item +fp.dp
16698 The single- and double-precision floating-point instructions.
16700 @item +nofp
16701 Disable the floating-point extension.
16702 @end table
16704 @item armv8-r
16705 @table @samp
16706 @item +crc
16707 The Cyclic Redundancy Check (CRC) instructions.
16708 @item +fp.sp
16709 The single-precision FPv5 floating-point instructions.
16710 @item +simd
16711 The ARMv8-A Advanced SIMD and floating-point instructions.
16712 @item +crypto
16713 The cryptographic instructions.
16714 @item +nocrypto
16715 Disable the cryptographic instructions.
16716 @item +nofp
16717 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16718 @end table
16720 @end table
16722 @option{-march=native} causes the compiler to auto-detect the architecture
16723 of the build computer.  At present, this feature is only supported on
16724 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16725 is unsuccessful the option has no effect.
16727 @item -mtune=@var{name}
16728 @opindex mtune
16729 This option specifies the name of the target ARM processor for
16730 which GCC should tune the performance of the code.
16731 For some ARM implementations better performance can be obtained by using
16732 this option.
16733 Permissible names are: @samp{arm2}, @samp{arm250},
16734 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16735 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16736 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16737 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16738 @samp{arm720},
16739 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16740 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16741 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16742 @samp{strongarm1110},
16743 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16744 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16745 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16746 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16747 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16748 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16749 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16750 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16751 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16752 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16753 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16754 @samp{cortex-a76}, @samp{ares}, @samp{cortex-r4}, @samp{cortex-r4f},
16755 @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8}, @samp{cortex-r52},
16756 @samp{cortex-m33},
16757 @samp{cortex-m23},
16758 @samp{cortex-m7},
16759 @samp{cortex-m4},
16760 @samp{cortex-m3},
16761 @samp{cortex-m1},
16762 @samp{cortex-m0},
16763 @samp{cortex-m0plus},
16764 @samp{cortex-m1.small-multiply},
16765 @samp{cortex-m0.small-multiply},
16766 @samp{cortex-m0plus.small-multiply},
16767 @samp{exynos-m1},
16768 @samp{marvell-pj4},
16769 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16770 @samp{fa526}, @samp{fa626},
16771 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16772 @samp{xgene1}.
16774 Additionally, this option can specify that GCC should tune the performance
16775 of the code for a big.LITTLE system.  Permissible names are:
16776 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16777 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16778 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16779 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}.
16781 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16782 performance for a blend of processors within architecture @var{arch}.
16783 The aim is to generate code that run well on the current most popular
16784 processors, balancing between optimizations that benefit some CPUs in the
16785 range, and avoiding performance pitfalls of other CPUs.  The effects of
16786 this option may change in future GCC versions as CPU models come and go.
16788 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16789 the extension options do not affect the tuning of the generated code.
16791 @option{-mtune=native} causes the compiler to auto-detect the CPU
16792 of the build computer.  At present, this feature is only supported on
16793 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16794 unsuccessful the option has no effect.
16796 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16797 @opindex mcpu
16798 This specifies the name of the target ARM processor.  GCC uses this name
16799 to derive the name of the target ARM architecture (as if specified
16800 by @option{-march}) and the ARM processor type for which to tune for
16801 performance (as if specified by @option{-mtune}).  Where this option
16802 is used in conjunction with @option{-march} or @option{-mtune},
16803 those options take precedence over the appropriate part of this option.
16805 Many of the supported CPUs implement optional architectural
16806 extensions.  Where this is so the architectural extensions are
16807 normally enabled by default.  If implementations that lack the
16808 extension exist, then the extension syntax can be used to disable
16809 those extensions that have been omitted.  For floating-point and
16810 Advanced SIMD (Neon) instructions, the settings of the options
16811 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16812 floating-point and Advanced SIMD instructions will only be used if
16813 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16814 @option{-mfpu} other than @samp{auto} will override the available
16815 floating-point and SIMD extension instructions.
16817 For example, @samp{cortex-a9} can be found in three major
16818 configurations: integer only, with just a floating-point unit or with
16819 floating-point and Advanced SIMD.  The default is to enable all the
16820 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16821 be used to disable just the SIMD or both the SIMD and floating-point
16822 instructions respectively.
16824 Permissible names for this option are the same as those for
16825 @option{-mtune}.
16827 The following extension options are common to the listed CPUs:
16829 @table @samp
16830 @item +nodsp
16831 Disable the DSP instructions on @samp{cortex-m33}.
16833 @item  +nofp
16834 Disables the floating-point instructions on @samp{arm9e},
16835 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16836 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16837 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16838 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16839 Disables the floating-point and SIMD instructions on
16840 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16841 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16842 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16843 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16844 @samp{cortex-a53} and @samp{cortex-a55}.
16846 @item +nofp.dp
16847 Disables the double-precision component of the floating-point instructions
16848 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16850 @item +nosimd
16851 Disables the SIMD (but not floating-point) instructions on
16852 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16853 and @samp{cortex-a9}.
16855 @item +crypto
16856 Enables the cryptographic instructions on @samp{cortex-a32},
16857 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16858 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16859 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16860 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16861 @samp{cortex-a75.cortex-a55}.
16862 @end table
16864 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16865 VFPv3 with 16 double-precision registers.  It supports the following
16866 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16867 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16868 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16869 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16870 @option{-march=armv7-a}.
16872 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16873 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16874 See @option{-mtune} for more information.
16876 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16877 of the build computer.  At present, this feature is only supported on
16878 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16879 is unsuccessful the option has no effect.
16881 @item -mfpu=@var{name}
16882 @opindex mfpu
16883 This specifies what floating-point hardware (or hardware emulation) is
16884 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16885 @samp{vfpv3},
16886 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16887 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16888 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16889 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16890 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16891 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16892 is an alias for @samp{vfpv2}.
16894 The setting @samp{auto} is the default and is special.  It causes the
16895 compiler to select the floating-point and Advanced SIMD instructions
16896 based on the settings of @option{-mcpu} and @option{-march}.
16898 If the selected floating-point hardware includes the NEON extension
16899 (e.g.@: @option{-mfpu=neon}), note that floating-point
16900 operations are not generated by GCC's auto-vectorization pass unless
16901 @option{-funsafe-math-optimizations} is also specified.  This is
16902 because NEON hardware does not fully implement the IEEE 754 standard for
16903 floating-point arithmetic (in particular denormal values are treated as
16904 zero), so the use of NEON instructions may lead to a loss of precision.
16906 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}).
16908 @item -mfp16-format=@var{name}
16909 @opindex mfp16-format
16910 Specify the format of the @code{__fp16} half-precision floating-point type.
16911 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16912 the default is @samp{none}, in which case the @code{__fp16} type is not
16913 defined.  @xref{Half-Precision}, for more information.
16915 @item -mstructure-size-boundary=@var{n}
16916 @opindex mstructure-size-boundary
16917 The sizes of all structures and unions are rounded up to a multiple
16918 of the number of bits set by this option.  Permissible values are 8, 32
16919 and 64.  The default value varies for different toolchains.  For the COFF
16920 targeted toolchain the default value is 8.  A value of 64 is only allowed
16921 if the underlying ABI supports it.
16923 Specifying a larger number can produce faster, more efficient code, but
16924 can also increase the size of the program.  Different values are potentially
16925 incompatible.  Code compiled with one value cannot necessarily expect to
16926 work with code or libraries compiled with another value, if they exchange
16927 information using structures or unions.
16929 This option is deprecated.
16931 @item -mabort-on-noreturn
16932 @opindex mabort-on-noreturn
16933 Generate a call to the function @code{abort} at the end of a
16934 @code{noreturn} function.  It is executed if the function tries to
16935 return.
16937 @item -mlong-calls
16938 @itemx -mno-long-calls
16939 @opindex mlong-calls
16940 @opindex mno-long-calls
16941 Tells the compiler to perform function calls by first loading the
16942 address of the function into a register and then performing a subroutine
16943 call on this register.  This switch is needed if the target function
16944 lies outside of the 64-megabyte addressing range of the offset-based
16945 version of subroutine call instruction.
16947 Even if this switch is enabled, not all function calls are turned
16948 into long calls.  The heuristic is that static functions, functions
16949 that have the @code{short_call} attribute, functions that are inside
16950 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16951 definitions have already been compiled within the current compilation
16952 unit are not turned into long calls.  The exceptions to this rule are
16953 that weak function definitions, functions with the @code{long_call}
16954 attribute or the @code{section} attribute, and functions that are within
16955 the scope of a @code{#pragma long_calls} directive are always
16956 turned into long calls.
16958 This feature is not enabled by default.  Specifying
16959 @option{-mno-long-calls} restores the default behavior, as does
16960 placing the function calls within the scope of a @code{#pragma
16961 long_calls_off} directive.  Note these switches have no effect on how
16962 the compiler generates code to handle function calls via function
16963 pointers.
16965 @item -msingle-pic-base
16966 @opindex msingle-pic-base
16967 Treat the register used for PIC addressing as read-only, rather than
16968 loading it in the prologue for each function.  The runtime system is
16969 responsible for initializing this register with an appropriate value
16970 before execution begins.
16972 @item -mpic-register=@var{reg}
16973 @opindex mpic-register
16974 Specify the register to be used for PIC addressing.
16975 For standard PIC base case, the default is any suitable register
16976 determined by compiler.  For single PIC base case, the default is
16977 @samp{R9} if target is EABI based or stack-checking is enabled,
16978 otherwise the default is @samp{R10}.
16980 @item -mpic-data-is-text-relative
16981 @opindex mpic-data-is-text-relative
16982 Assume that the displacement between the text and data segments is fixed
16983 at static link time.  This permits using PC-relative addressing
16984 operations to access data known to be in the data segment.  For
16985 non-VxWorks RTP targets, this option is enabled by default.  When
16986 disabled on such targets, it will enable @option{-msingle-pic-base} by
16987 default.
16989 @item -mpoke-function-name
16990 @opindex mpoke-function-name
16991 Write the name of each function into the text section, directly
16992 preceding the function prologue.  The generated code is similar to this:
16994 @smallexample
16995      t0
16996          .ascii "arm_poke_function_name", 0
16997          .align
16998      t1
16999          .word 0xff000000 + (t1 - t0)
17000      arm_poke_function_name
17001          mov     ip, sp
17002          stmfd   sp!, @{fp, ip, lr, pc@}
17003          sub     fp, ip, #4
17004 @end smallexample
17006 When performing a stack backtrace, code can inspect the value of
17007 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
17008 location @code{pc - 12} and the top 8 bits are set, then we know that
17009 there is a function name embedded immediately preceding this location
17010 and has length @code{((pc[-3]) & 0xff000000)}.
17012 @item -mthumb
17013 @itemx -marm
17014 @opindex marm
17015 @opindex mthumb
17017 Select between generating code that executes in ARM and Thumb
17018 states.  The default for most configurations is to generate code
17019 that executes in ARM state, but the default can be changed by
17020 configuring GCC with the @option{--with-mode=}@var{state}
17021 configure option.
17023 You can also override the ARM and Thumb mode for each function
17024 by using the @code{target("thumb")} and @code{target("arm")} function attributes
17025 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
17027 @item -mflip-thumb 
17028 @opindex mflip-thumb
17029 Switch ARM/Thumb modes on alternating functions.
17030 This option is provided for regression testing of mixed Thumb/ARM code
17031 generation, and is not intended for ordinary use in compiling code.
17033 @item -mtpcs-frame
17034 @opindex mtpcs-frame
17035 Generate a stack frame that is compliant with the Thumb Procedure Call
17036 Standard for all non-leaf functions.  (A leaf function is one that does
17037 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
17039 @item -mtpcs-leaf-frame
17040 @opindex mtpcs-leaf-frame
17041 Generate a stack frame that is compliant with the Thumb Procedure Call
17042 Standard for all leaf functions.  (A leaf function is one that does
17043 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
17045 @item -mcallee-super-interworking
17046 @opindex mcallee-super-interworking
17047 Gives all externally visible functions in the file being compiled an ARM
17048 instruction set header which switches to Thumb mode before executing the
17049 rest of the function.  This allows these functions to be called from
17050 non-interworking code.  This option is not valid in AAPCS configurations
17051 because interworking is enabled by default.
17053 @item -mcaller-super-interworking
17054 @opindex mcaller-super-interworking
17055 Allows calls via function pointers (including virtual functions) to
17056 execute correctly regardless of whether the target code has been
17057 compiled for interworking or not.  There is a small overhead in the cost
17058 of executing a function pointer if this option is enabled.  This option
17059 is not valid in AAPCS configurations because interworking is enabled
17060 by default.
17062 @item -mtp=@var{name}
17063 @opindex mtp
17064 Specify the access model for the thread local storage pointer.  The valid
17065 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
17066 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
17067 (supported in the arm6k architecture), and @samp{auto}, which uses the
17068 best available method for the selected processor.  The default setting is
17069 @samp{auto}.
17071 @item -mtls-dialect=@var{dialect}
17072 @opindex mtls-dialect
17073 Specify the dialect to use for accessing thread local storage.  Two
17074 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
17075 @samp{gnu} dialect selects the original GNU scheme for supporting
17076 local and global dynamic TLS models.  The @samp{gnu2} dialect
17077 selects the GNU descriptor scheme, which provides better performance
17078 for shared libraries.  The GNU descriptor scheme is compatible with
17079 the original scheme, but does require new assembler, linker and
17080 library support.  Initial and local exec TLS models are unaffected by
17081 this option and always use the original scheme.
17083 @item -mword-relocations
17084 @opindex mword-relocations
17085 Only generate absolute relocations on word-sized values (i.e.@: R_ARM_ABS32).
17086 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
17087 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
17088 is specified. This option conflicts with @option{-mslow-flash-data}.
17090 @item -mfix-cortex-m3-ldrd
17091 @opindex mfix-cortex-m3-ldrd
17092 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
17093 with overlapping destination and base registers are used.  This option avoids
17094 generating these instructions.  This option is enabled by default when
17095 @option{-mcpu=cortex-m3} is specified.
17097 @item -munaligned-access
17098 @itemx -mno-unaligned-access
17099 @opindex munaligned-access
17100 @opindex mno-unaligned-access
17101 Enables (or disables) reading and writing of 16- and 32- bit values
17102 from addresses that are not 16- or 32- bit aligned.  By default
17103 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
17104 ARMv8-M Baseline architectures, and enabled for all other
17105 architectures.  If unaligned access is not enabled then words in packed
17106 data structures are accessed a byte at a time.
17108 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
17109 generated object file to either true or false, depending upon the
17110 setting of this option.  If unaligned access is enabled then the
17111 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
17112 defined.
17114 @item -mneon-for-64bits
17115 @opindex mneon-for-64bits
17116 Enables using Neon to handle scalar 64-bits operations. This is
17117 disabled by default since the cost of moving data from core registers
17118 to Neon is high.
17120 @item -mslow-flash-data
17121 @opindex mslow-flash-data
17122 Assume loading data from flash is slower than fetching instruction.
17123 Therefore literal load is minimized for better performance.
17124 This option is only supported when compiling for ARMv7 M-profile and
17125 off by default. It conflicts with @option{-mword-relocations}.
17127 @item -masm-syntax-unified
17128 @opindex masm-syntax-unified
17129 Assume inline assembler is using unified asm syntax.  The default is
17130 currently off which implies divided syntax.  This option has no impact
17131 on Thumb2. However, this may change in future releases of GCC.
17132 Divided syntax should be considered deprecated.
17134 @item -mrestrict-it
17135 @opindex mrestrict-it
17136 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
17137 IT blocks can only contain a single 16-bit instruction from a select
17138 set of instructions. This option is on by default for ARMv8-A Thumb mode.
17140 @item -mprint-tune-info
17141 @opindex mprint-tune-info
17142 Print CPU tuning information as comment in assembler file.  This is
17143 an option used only for regression testing of the compiler and not
17144 intended for ordinary use in compiling code.  This option is disabled
17145 by default.
17147 @item -mverbose-cost-dump
17148 @opindex mverbose-cost-dump
17149 Enable verbose cost model dumping in the debug dump files.  This option is
17150 provided for use in debugging the compiler.
17152 @item -mpure-code
17153 @opindex mpure-code
17154 Do not allow constant data to be placed in code sections.
17155 Additionally, when compiling for ELF object format give all text sections the
17156 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
17157 is only available when generating non-pic code for M-profile targets with the
17158 MOVT instruction.
17160 @item -mcmse
17161 @opindex mcmse
17162 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
17163 Development Tools Engineering Specification", which can be found on
17164 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
17165 @end table
17167 @node AVR Options
17168 @subsection AVR Options
17169 @cindex AVR Options
17171 These options are defined for AVR implementations:
17173 @table @gcctabopt
17174 @item -mmcu=@var{mcu}
17175 @opindex mmcu
17176 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
17178 The default for this option is@tie{}@samp{avr2}.
17180 GCC supports the following AVR devices and ISAs:
17182 @include avr-mmcu.texi
17184 @item -mabsdata
17185 @opindex mabsdata
17187 Assume that all data in static storage can be accessed by LDS / STS
17188 instructions.  This option has only an effect on reduced Tiny devices like
17189 ATtiny40.  See also the @code{absdata}
17190 @ref{AVR Variable Attributes,variable attribute}.
17192 @item -maccumulate-args
17193 @opindex maccumulate-args
17194 Accumulate outgoing function arguments and acquire/release the needed
17195 stack space for outgoing function arguments once in function
17196 prologue/epilogue.  Without this option, outgoing arguments are pushed
17197 before calling a function and popped afterwards.
17199 Popping the arguments after the function call can be expensive on
17200 AVR so that accumulating the stack space might lead to smaller
17201 executables because arguments need not be removed from the
17202 stack after such a function call.
17204 This option can lead to reduced code size for functions that perform
17205 several calls to functions that get their arguments on the stack like
17206 calls to printf-like functions.
17208 @item -mbranch-cost=@var{cost}
17209 @opindex mbranch-cost
17210 Set the branch costs for conditional branch instructions to
17211 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
17212 integers. The default branch cost is 0.
17214 @item -mcall-prologues
17215 @opindex mcall-prologues
17216 Functions prologues/epilogues are expanded as calls to appropriate
17217 subroutines.  Code size is smaller.
17219 @item -mgas-isr-prologues
17220 @opindex mgas-isr-prologues
17221 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
17222 instruction supported by GNU Binutils.
17223 If this option is on, the feature can still be disabled for individual
17224 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
17225 function attribute.  This feature is activated per default
17226 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
17227 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
17229 @item -mint8
17230 @opindex mint8
17231 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
17232 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
17233 and @code{long long} is 4 bytes.  Please note that this option does not
17234 conform to the C standards, but it results in smaller code
17235 size.
17237 @item -mmain-is-OS_task
17238 @opindex mmain-is-OS_task
17239 Do not save registers in @code{main}.  The effect is the same like
17240 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
17241 to @code{main}. It is activated per default if optimization is on.
17243 @item -mn-flash=@var{num}
17244 @opindex mn-flash
17245 Assume that the flash memory has a size of 
17246 @var{num} times 64@tie{}KiB.
17248 @item -mno-interrupts
17249 @opindex mno-interrupts
17250 Generated code is not compatible with hardware interrupts.
17251 Code size is smaller.
17253 @item -mrelax
17254 @opindex mrelax
17255 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
17256 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
17257 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
17258 the assembler's command line and the @option{--relax} option to the
17259 linker's command line.
17261 Jump relaxing is performed by the linker because jump offsets are not
17262 known before code is located. Therefore, the assembler code generated by the
17263 compiler is the same, but the instructions in the executable may
17264 differ from instructions in the assembler code.
17266 Relaxing must be turned on if linker stubs are needed, see the
17267 section on @code{EIND} and linker stubs below.
17269 @item -mrmw
17270 @opindex mrmw
17271 Assume that the device supports the Read-Modify-Write
17272 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
17274 @item -mshort-calls
17275 @opindex mshort-calls
17277 Assume that @code{RJMP} and @code{RCALL} can target the whole
17278 program memory.
17280 This option is used internally for multilib selection.  It is
17281 not an optimization option, and you don't need to set it by hand.
17283 @item -msp8
17284 @opindex msp8
17285 Treat the stack pointer register as an 8-bit register,
17286 i.e.@: assume the high byte of the stack pointer is zero.
17287 In general, you don't need to set this option by hand.
17289 This option is used internally by the compiler to select and
17290 build multilibs for architectures @code{avr2} and @code{avr25}.
17291 These architectures mix devices with and without @code{SPH}.
17292 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
17293 the compiler driver adds or removes this option from the compiler
17294 proper's command line, because the compiler then knows if the device
17295 or architecture has an 8-bit stack pointer and thus no @code{SPH}
17296 register or not.
17298 @item -mstrict-X
17299 @opindex mstrict-X
17300 Use address register @code{X} in a way proposed by the hardware.  This means
17301 that @code{X} is only used in indirect, post-increment or
17302 pre-decrement addressing.
17304 Without this option, the @code{X} register may be used in the same way
17305 as @code{Y} or @code{Z} which then is emulated by additional
17306 instructions.  
17307 For example, loading a value with @code{X+const} addressing with a
17308 small non-negative @code{const < 64} to a register @var{Rn} is
17309 performed as
17311 @example
17312 adiw r26, const   ; X += const
17313 ld   @var{Rn}, X        ; @var{Rn} = *X
17314 sbiw r26, const   ; X -= const
17315 @end example
17317 @item -mtiny-stack
17318 @opindex mtiny-stack
17319 Only change the lower 8@tie{}bits of the stack pointer.
17321 @item -mfract-convert-truncate
17322 @opindex mfract-convert-truncate
17323 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
17325 @item -nodevicelib
17326 @opindex nodevicelib
17327 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
17329 @item -Waddr-space-convert
17330 @opindex Waddr-space-convert
17331 @opindex Wno-addr-space-convert
17332 Warn about conversions between address spaces in the case where the
17333 resulting address space is not contained in the incoming address space.
17335 @item -Wmisspelled-isr
17336 @opindex Wmisspelled-isr
17337 @opindex Wno-misspelled-isr
17338 Warn if the ISR is misspelled, i.e.@: without __vector prefix.
17339 Enabled by default.
17340 @end table
17342 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
17343 @cindex @code{EIND}
17344 Pointers in the implementation are 16@tie{}bits wide.
17345 The address of a function or label is represented as word address so
17346 that indirect jumps and calls can target any code address in the
17347 range of 64@tie{}Ki words.
17349 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
17350 bytes of program memory space, there is a special function register called
17351 @code{EIND} that serves as most significant part of the target address
17352 when @code{EICALL} or @code{EIJMP} instructions are used.
17354 Indirect jumps and calls on these devices are handled as follows by
17355 the compiler and are subject to some limitations:
17357 @itemize @bullet
17359 @item
17360 The compiler never sets @code{EIND}.
17362 @item
17363 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
17364 instructions or might read @code{EIND} directly in order to emulate an
17365 indirect call/jump by means of a @code{RET} instruction.
17367 @item
17368 The compiler assumes that @code{EIND} never changes during the startup
17369 code or during the application. In particular, @code{EIND} is not
17370 saved/restored in function or interrupt service routine
17371 prologue/epilogue.
17373 @item
17374 For indirect calls to functions and computed goto, the linker
17375 generates @emph{stubs}. Stubs are jump pads sometimes also called
17376 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
17377 The stub contains a direct jump to the desired address.
17379 @item
17380 Linker relaxation must be turned on so that the linker generates
17381 the stubs correctly in all situations. See the compiler option
17382 @option{-mrelax} and the linker option @option{--relax}.
17383 There are corner cases where the linker is supposed to generate stubs
17384 but aborts without relaxation and without a helpful error message.
17386 @item
17387 The default linker script is arranged for code with @code{EIND = 0}.
17388 If code is supposed to work for a setup with @code{EIND != 0}, a custom
17389 linker script has to be used in order to place the sections whose
17390 name start with @code{.trampolines} into the segment where @code{EIND}
17391 points to.
17393 @item
17394 The startup code from libgcc never sets @code{EIND}.
17395 Notice that startup code is a blend of code from libgcc and AVR-LibC.
17396 For the impact of AVR-LibC on @code{EIND}, see the
17397 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
17399 @item
17400 It is legitimate for user-specific startup code to set up @code{EIND}
17401 early, for example by means of initialization code located in
17402 section @code{.init3}. Such code runs prior to general startup code
17403 that initializes RAM and calls constructors, but after the bit
17404 of startup code from AVR-LibC that sets @code{EIND} to the segment
17405 where the vector table is located.
17406 @example
17407 #include <avr/io.h>
17409 static void
17410 __attribute__((section(".init3"),naked,used,no_instrument_function))
17411 init3_set_eind (void)
17413   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
17414                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
17416 @end example
17418 @noindent
17419 The @code{__trampolines_start} symbol is defined in the linker script.
17421 @item
17422 Stubs are generated automatically by the linker if
17423 the following two conditions are met:
17424 @itemize @minus
17426 @item The address of a label is taken by means of the @code{gs} modifier
17427 (short for @emph{generate stubs}) like so:
17428 @example
17429 LDI r24, lo8(gs(@var{func}))
17430 LDI r25, hi8(gs(@var{func}))
17431 @end example
17432 @item The final location of that label is in a code segment
17433 @emph{outside} the segment where the stubs are located.
17434 @end itemize
17436 @item
17437 The compiler emits such @code{gs} modifiers for code labels in the
17438 following situations:
17439 @itemize @minus
17440 @item Taking address of a function or code label.
17441 @item Computed goto.
17442 @item If prologue-save function is used, see @option{-mcall-prologues}
17443 command-line option.
17444 @item Switch/case dispatch tables. If you do not want such dispatch
17445 tables you can specify the @option{-fno-jump-tables} command-line option.
17446 @item C and C++ constructors/destructors called during startup/shutdown.
17447 @item If the tools hit a @code{gs()} modifier explained above.
17448 @end itemize
17450 @item
17451 Jumping to non-symbolic addresses like so is @emph{not} supported:
17453 @example
17454 int main (void)
17456     /* Call function at word address 0x2 */
17457     return ((int(*)(void)) 0x2)();
17459 @end example
17461 Instead, a stub has to be set up, i.e.@: the function has to be called
17462 through a symbol (@code{func_4} in the example):
17464 @example
17465 int main (void)
17467     extern int func_4 (void);
17469     /* Call function at byte address 0x4 */
17470     return func_4();
17472 @end example
17474 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
17475 Alternatively, @code{func_4} can be defined in the linker script.
17476 @end itemize
17478 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
17479 @cindex @code{RAMPD}
17480 @cindex @code{RAMPX}
17481 @cindex @code{RAMPY}
17482 @cindex @code{RAMPZ}
17483 Some AVR devices support memories larger than the 64@tie{}KiB range
17484 that can be accessed with 16-bit pointers.  To access memory locations
17485 outside this 64@tie{}KiB range, the content of a @code{RAMP}
17486 register is used as high part of the address:
17487 The @code{X}, @code{Y}, @code{Z} address register is concatenated
17488 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
17489 register, respectively, to get a wide address. Similarly,
17490 @code{RAMPD} is used together with direct addressing.
17492 @itemize
17493 @item
17494 The startup code initializes the @code{RAMP} special function
17495 registers with zero.
17497 @item
17498 If a @ref{AVR Named Address Spaces,named address space} other than
17499 generic or @code{__flash} is used, then @code{RAMPZ} is set
17500 as needed before the operation.
17502 @item
17503 If the device supports RAM larger than 64@tie{}KiB and the compiler
17504 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17505 is reset to zero after the operation.
17507 @item
17508 If the device comes with a specific @code{RAMP} register, the ISR
17509 prologue/epilogue saves/restores that SFR and initializes it with
17510 zero in case the ISR code might (implicitly) use it.
17512 @item
17513 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17514 If you use inline assembler to read from locations outside the
17515 16-bit address range and change one of the @code{RAMP} registers,
17516 you must reset it to zero after the access.
17518 @end itemize
17520 @subsubsection AVR Built-in Macros
17522 GCC defines several built-in macros so that the user code can test
17523 for the presence or absence of features.  Almost any of the following
17524 built-in macros are deduced from device capabilities and thus
17525 triggered by the @option{-mmcu=} command-line option.
17527 For even more AVR-specific built-in macros see
17528 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17530 @table @code
17532 @item __AVR_ARCH__
17533 Build-in macro that resolves to a decimal number that identifies the
17534 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17535 Possible values are:
17537 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17538 @code{4}, @code{5}, @code{51}, @code{6}
17540 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17541 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17543 respectively and
17545 @code{100},
17546 @code{102}, @code{103}, @code{104},
17547 @code{105}, @code{106}, @code{107}
17549 for @var{mcu}=@code{avrtiny},
17550 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17551 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17552 If @var{mcu} specifies a device, this built-in macro is set
17553 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17554 defined to @code{4}.
17556 @item __AVR_@var{Device}__
17557 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17558 the device's name. For example, @option{-mmcu=atmega8} defines the
17559 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17560 @code{__AVR_ATtiny261A__}, etc.
17562 The built-in macros' names follow
17563 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17564 the device name as from the AVR user manual. The difference between
17565 @var{Device} in the built-in macro and @var{device} in
17566 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17568 If @var{device} is not a device but only a core architecture like
17569 @samp{avr51}, this macro is not defined.
17571 @item __AVR_DEVICE_NAME__
17572 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17573 the device's name. For example, with @option{-mmcu=atmega8} the macro
17574 is defined to @code{atmega8}.
17576 If @var{device} is not a device but only a core architecture like
17577 @samp{avr51}, this macro is not defined.
17579 @item __AVR_XMEGA__
17580 The device / architecture belongs to the XMEGA family of devices.
17582 @item __AVR_HAVE_ELPM__
17583 The device has the @code{ELPM} instruction.
17585 @item __AVR_HAVE_ELPMX__
17586 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17587 R@var{n},Z+} instructions.
17589 @item __AVR_HAVE_MOVW__
17590 The device has the @code{MOVW} instruction to perform 16-bit
17591 register-register moves.
17593 @item __AVR_HAVE_LPMX__
17594 The device has the @code{LPM R@var{n},Z} and
17595 @code{LPM R@var{n},Z+} instructions.
17597 @item __AVR_HAVE_MUL__
17598 The device has a hardware multiplier. 
17600 @item __AVR_HAVE_JMP_CALL__
17601 The device has the @code{JMP} and @code{CALL} instructions.
17602 This is the case for devices with more than 8@tie{}KiB of program
17603 memory.
17605 @item __AVR_HAVE_EIJMP_EICALL__
17606 @itemx __AVR_3_BYTE_PC__
17607 The device has the @code{EIJMP} and @code{EICALL} instructions.
17608 This is the case for devices with more than 128@tie{}KiB of program memory.
17609 This also means that the program counter
17610 (PC) is 3@tie{}bytes wide.
17612 @item __AVR_2_BYTE_PC__
17613 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17614 with up to 128@tie{}KiB of program memory.
17616 @item __AVR_HAVE_8BIT_SP__
17617 @itemx __AVR_HAVE_16BIT_SP__
17618 The stack pointer (SP) register is treated as 8-bit respectively
17619 16-bit register by the compiler.
17620 The definition of these macros is affected by @option{-mtiny-stack}.
17622 @item __AVR_HAVE_SPH__
17623 @itemx __AVR_SP8__
17624 The device has the SPH (high part of stack pointer) special function
17625 register or has an 8-bit stack pointer, respectively.
17626 The definition of these macros is affected by @option{-mmcu=} and
17627 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17628 by @option{-msp8}.
17630 @item __AVR_HAVE_RAMPD__
17631 @itemx __AVR_HAVE_RAMPX__
17632 @itemx __AVR_HAVE_RAMPY__
17633 @itemx __AVR_HAVE_RAMPZ__
17634 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17635 @code{RAMPZ} special function register, respectively.
17637 @item __NO_INTERRUPTS__
17638 This macro reflects the @option{-mno-interrupts} command-line option.
17640 @item __AVR_ERRATA_SKIP__
17641 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17642 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17643 instructions because of a hardware erratum.  Skip instructions are
17644 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17645 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17646 set.
17648 @item __AVR_ISA_RMW__
17649 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17651 @item __AVR_SFR_OFFSET__=@var{offset}
17652 Instructions that can address I/O special function registers directly
17653 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17654 address as if addressed by an instruction to access RAM like @code{LD}
17655 or @code{STS}. This offset depends on the device architecture and has
17656 to be subtracted from the RAM address in order to get the
17657 respective I/O@tie{}address.
17659 @item __AVR_SHORT_CALLS__
17660 The @option{-mshort-calls} command line option is set.
17662 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17663 Some devices support reading from flash memory by means of @code{LD*}
17664 instructions.  The flash memory is seen in the data address space
17665 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17666 is not defined, this feature is not available.  If defined,
17667 the address space is linear and there is no need to put
17668 @code{.rodata} into RAM.  This is handled by the default linker
17669 description file, and is currently available for
17670 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17671 there is no need to use address spaces like @code{__flash} or
17672 features like attribute @code{progmem} and @code{pgm_read_*}.
17674 @item __WITH_AVRLIBC__
17675 The compiler is configured to be used together with AVR-Libc.
17676 See the @option{--with-avrlibc} configure option.
17678 @end table
17680 @node Blackfin Options
17681 @subsection Blackfin Options
17682 @cindex Blackfin Options
17684 @table @gcctabopt
17685 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17686 @opindex mcpu=
17687 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17688 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17689 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17690 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17691 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17692 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17693 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17694 @samp{bf561}, @samp{bf592}.
17696 The optional @var{sirevision} specifies the silicon revision of the target
17697 Blackfin processor.  Any workarounds available for the targeted silicon revision
17698 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17699 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17700 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17701 hexadecimal digits representing the major and minor numbers in the silicon
17702 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17703 is not defined.  If @var{sirevision} is @samp{any}, the
17704 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17705 If this optional @var{sirevision} is not used, GCC assumes the latest known
17706 silicon revision of the targeted Blackfin processor.
17708 GCC defines a preprocessor macro for the specified @var{cpu}.
17709 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17710 provided by libgloss to be linked in if @option{-msim} is not given.
17712 Without this option, @samp{bf532} is used as the processor by default.
17714 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17715 only the preprocessor macro is defined.
17717 @item -msim
17718 @opindex msim
17719 Specifies that the program will be run on the simulator.  This causes
17720 the simulator BSP provided by libgloss to be linked in.  This option
17721 has effect only for @samp{bfin-elf} toolchain.
17722 Certain other options, such as @option{-mid-shared-library} and
17723 @option{-mfdpic}, imply @option{-msim}.
17725 @item -momit-leaf-frame-pointer
17726 @opindex momit-leaf-frame-pointer
17727 Don't keep the frame pointer in a register for leaf functions.  This
17728 avoids the instructions to save, set up and restore frame pointers and
17729 makes an extra register available in leaf functions.
17731 @item -mspecld-anomaly
17732 @opindex mspecld-anomaly
17733 When enabled, the compiler ensures that the generated code does not
17734 contain speculative loads after jump instructions. If this option is used,
17735 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17737 @item -mno-specld-anomaly
17738 @opindex mno-specld-anomaly
17739 Don't generate extra code to prevent speculative loads from occurring.
17741 @item -mcsync-anomaly
17742 @opindex mcsync-anomaly
17743 When enabled, the compiler ensures that the generated code does not
17744 contain CSYNC or SSYNC instructions too soon after conditional branches.
17745 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17747 @item -mno-csync-anomaly
17748 @opindex mno-csync-anomaly
17749 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17750 occurring too soon after a conditional branch.
17752 @item -mlow-64k
17753 @opindex mlow-64k
17754 When enabled, the compiler is free to take advantage of the knowledge that
17755 the entire program fits into the low 64k of memory.
17757 @item -mno-low-64k
17758 @opindex mno-low-64k
17759 Assume that the program is arbitrarily large.  This is the default.
17761 @item -mstack-check-l1
17762 @opindex mstack-check-l1
17763 Do stack checking using information placed into L1 scratchpad memory by the
17764 uClinux kernel.
17766 @item -mid-shared-library
17767 @opindex mid-shared-library
17768 Generate code that supports shared libraries via the library ID method.
17769 This allows for execute in place and shared libraries in an environment
17770 without virtual memory management.  This option implies @option{-fPIC}.
17771 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17773 @item -mno-id-shared-library
17774 @opindex mno-id-shared-library
17775 Generate code that doesn't assume ID-based shared libraries are being used.
17776 This is the default.
17778 @item -mleaf-id-shared-library
17779 @opindex mleaf-id-shared-library
17780 Generate code that supports shared libraries via the library ID method,
17781 but assumes that this library or executable won't link against any other
17782 ID shared libraries.  That allows the compiler to use faster code for jumps
17783 and calls.
17785 @item -mno-leaf-id-shared-library
17786 @opindex mno-leaf-id-shared-library
17787 Do not assume that the code being compiled won't link against any ID shared
17788 libraries.  Slower code is generated for jump and call insns.
17790 @item -mshared-library-id=n
17791 @opindex mshared-library-id
17792 Specifies the identification number of the ID-based shared library being
17793 compiled.  Specifying a value of 0 generates more compact code; specifying
17794 other values forces the allocation of that number to the current
17795 library but is no more space- or time-efficient than omitting this option.
17797 @item -msep-data
17798 @opindex msep-data
17799 Generate code that allows the data segment to be located in a different
17800 area of memory from the text segment.  This allows for execute in place in
17801 an environment without virtual memory management by eliminating relocations
17802 against the text section.
17804 @item -mno-sep-data
17805 @opindex mno-sep-data
17806 Generate code that assumes that the data segment follows the text segment.
17807 This is the default.
17809 @item -mlong-calls
17810 @itemx -mno-long-calls
17811 @opindex mlong-calls
17812 @opindex mno-long-calls
17813 Tells the compiler to perform function calls by first loading the
17814 address of the function into a register and then performing a subroutine
17815 call on this register.  This switch is needed if the target function
17816 lies outside of the 24-bit addressing range of the offset-based
17817 version of subroutine call instruction.
17819 This feature is not enabled by default.  Specifying
17820 @option{-mno-long-calls} restores the default behavior.  Note these
17821 switches have no effect on how the compiler generates code to handle
17822 function calls via function pointers.
17824 @item -mfast-fp
17825 @opindex mfast-fp
17826 Link with the fast floating-point library. This library relaxes some of
17827 the IEEE floating-point standard's rules for checking inputs against
17828 Not-a-Number (NAN), in the interest of performance.
17830 @item -minline-plt
17831 @opindex minline-plt
17832 Enable inlining of PLT entries in function calls to functions that are
17833 not known to bind locally.  It has no effect without @option{-mfdpic}.
17835 @item -mmulticore
17836 @opindex mmulticore
17837 Build a standalone application for multicore Blackfin processors. 
17838 This option causes proper start files and link scripts supporting 
17839 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17840 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17842 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17843 selects the one-application-per-core programming model.  Without
17844 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17845 programming model is used. In this model, the main function of Core B
17846 should be named as @code{coreb_main}.
17848 If this option is not used, the single-core application programming
17849 model is used.
17851 @item -mcorea
17852 @opindex mcorea
17853 Build a standalone application for Core A of BF561 when using
17854 the one-application-per-core programming model. Proper start files
17855 and link scripts are used to support Core A, and the macro
17856 @code{__BFIN_COREA} is defined.
17857 This option can only be used in conjunction with @option{-mmulticore}.
17859 @item -mcoreb
17860 @opindex mcoreb
17861 Build a standalone application for Core B of BF561 when using
17862 the one-application-per-core programming model. Proper start files
17863 and link scripts are used to support Core B, and the macro
17864 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17865 should be used instead of @code{main}. 
17866 This option can only be used in conjunction with @option{-mmulticore}.
17868 @item -msdram
17869 @opindex msdram
17870 Build a standalone application for SDRAM. Proper start files and
17871 link scripts are used to put the application into SDRAM, and the macro
17872 @code{__BFIN_SDRAM} is defined.
17873 The loader should initialize SDRAM before loading the application.
17875 @item -micplb
17876 @opindex micplb
17877 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17878 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17879 are enabled; for standalone applications the default is off.
17880 @end table
17882 @node C6X Options
17883 @subsection C6X Options
17884 @cindex C6X Options
17886 @table @gcctabopt
17887 @item -march=@var{name}
17888 @opindex march
17889 This specifies the name of the target architecture.  GCC uses this
17890 name to determine what kind of instructions it can emit when generating
17891 assembly code.  Permissible names are: @samp{c62x},
17892 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17894 @item -mbig-endian
17895 @opindex mbig-endian
17896 Generate code for a big-endian target.
17898 @item -mlittle-endian
17899 @opindex mlittle-endian
17900 Generate code for a little-endian target.  This is the default.
17902 @item -msim
17903 @opindex msim
17904 Choose startup files and linker script suitable for the simulator.
17906 @item -msdata=default
17907 @opindex msdata=default
17908 Put small global and static data in the @code{.neardata} section,
17909 which is pointed to by register @code{B14}.  Put small uninitialized
17910 global and static data in the @code{.bss} section, which is adjacent
17911 to the @code{.neardata} section.  Put small read-only data into the
17912 @code{.rodata} section.  The corresponding sections used for large
17913 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17915 @item -msdata=all
17916 @opindex msdata=all
17917 Put all data, not just small objects, into the sections reserved for
17918 small data, and use addressing relative to the @code{B14} register to
17919 access them.
17921 @item -msdata=none
17922 @opindex msdata=none
17923 Make no use of the sections reserved for small data, and use absolute
17924 addresses to access all data.  Put all initialized global and static
17925 data in the @code{.fardata} section, and all uninitialized data in the
17926 @code{.far} section.  Put all constant data into the @code{.const}
17927 section.
17928 @end table
17930 @node CRIS Options
17931 @subsection CRIS Options
17932 @cindex CRIS Options
17934 These options are defined specifically for the CRIS ports.
17936 @table @gcctabopt
17937 @item -march=@var{architecture-type}
17938 @itemx -mcpu=@var{architecture-type}
17939 @opindex march
17940 @opindex mcpu
17941 Generate code for the specified architecture.  The choices for
17942 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17943 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17944 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17945 @samp{v10}.
17947 @item -mtune=@var{architecture-type}
17948 @opindex mtune
17949 Tune to @var{architecture-type} everything applicable about the generated
17950 code, except for the ABI and the set of available instructions.  The
17951 choices for @var{architecture-type} are the same as for
17952 @option{-march=@var{architecture-type}}.
17954 @item -mmax-stack-frame=@var{n}
17955 @opindex mmax-stack-frame
17956 Warn when the stack frame of a function exceeds @var{n} bytes.
17958 @item -metrax4
17959 @itemx -metrax100
17960 @opindex metrax4
17961 @opindex metrax100
17962 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17963 @option{-march=v3} and @option{-march=v8} respectively.
17965 @item -mmul-bug-workaround
17966 @itemx -mno-mul-bug-workaround
17967 @opindex mmul-bug-workaround
17968 @opindex mno-mul-bug-workaround
17969 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17970 models where it applies.  This option is active by default.
17972 @item -mpdebug
17973 @opindex mpdebug
17974 Enable CRIS-specific verbose debug-related information in the assembly
17975 code.  This option also has the effect of turning off the @samp{#NO_APP}
17976 formatted-code indicator to the assembler at the beginning of the
17977 assembly file.
17979 @item -mcc-init
17980 @opindex mcc-init
17981 Do not use condition-code results from previous instruction; always emit
17982 compare and test instructions before use of condition codes.
17984 @item -mno-side-effects
17985 @opindex mno-side-effects
17986 Do not emit instructions with side effects in addressing modes other than
17987 post-increment.
17989 @item -mstack-align
17990 @itemx -mno-stack-align
17991 @itemx -mdata-align
17992 @itemx -mno-data-align
17993 @itemx -mconst-align
17994 @itemx -mno-const-align
17995 @opindex mstack-align
17996 @opindex mno-stack-align
17997 @opindex mdata-align
17998 @opindex mno-data-align
17999 @opindex mconst-align
18000 @opindex mno-const-align
18001 These options (@samp{no-} options) arrange (eliminate arrangements) for the
18002 stack frame, individual data and constants to be aligned for the maximum
18003 single data access size for the chosen CPU model.  The default is to
18004 arrange for 32-bit alignment.  ABI details such as structure layout are
18005 not affected by these options.
18007 @item -m32-bit
18008 @itemx -m16-bit
18009 @itemx -m8-bit
18010 @opindex m32-bit
18011 @opindex m16-bit
18012 @opindex m8-bit
18013 Similar to the stack- data- and const-align options above, these options
18014 arrange for stack frame, writable data and constants to all be 32-bit,
18015 16-bit or 8-bit aligned.  The default is 32-bit alignment.
18017 @item -mno-prologue-epilogue
18018 @itemx -mprologue-epilogue
18019 @opindex mno-prologue-epilogue
18020 @opindex mprologue-epilogue
18021 With @option{-mno-prologue-epilogue}, the normal function prologue and
18022 epilogue which set up the stack frame are omitted and no return
18023 instructions or return sequences are generated in the code.  Use this
18024 option only together with visual inspection of the compiled code: no
18025 warnings or errors are generated when call-saved registers must be saved,
18026 or storage for local variables needs to be allocated.
18028 @item -mno-gotplt
18029 @itemx -mgotplt
18030 @opindex mno-gotplt
18031 @opindex mgotplt
18032 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
18033 instruction sequences that load addresses for functions from the PLT part
18034 of the GOT rather than (traditional on other architectures) calls to the
18035 PLT@.  The default is @option{-mgotplt}.
18037 @item -melf
18038 @opindex melf
18039 Legacy no-op option only recognized with the cris-axis-elf and
18040 cris-axis-linux-gnu targets.
18042 @item -mlinux
18043 @opindex mlinux
18044 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
18046 @item -sim
18047 @opindex sim
18048 This option, recognized for the cris-axis-elf, arranges
18049 to link with input-output functions from a simulator library.  Code,
18050 initialized data and zero-initialized data are allocated consecutively.
18052 @item -sim2
18053 @opindex sim2
18054 Like @option{-sim}, but pass linker options to locate initialized data at
18055 0x40000000 and zero-initialized data at 0x80000000.
18056 @end table
18058 @node CR16 Options
18059 @subsection CR16 Options
18060 @cindex CR16 Options
18062 These options are defined specifically for the CR16 ports.
18064 @table @gcctabopt
18066 @item -mmac
18067 @opindex mmac
18068 Enable the use of multiply-accumulate instructions. Disabled by default.
18070 @item -mcr16cplus
18071 @itemx -mcr16c
18072 @opindex mcr16cplus
18073 @opindex mcr16c
18074 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
18075 is default.
18077 @item -msim
18078 @opindex msim
18079 Links the library libsim.a which is in compatible with simulator. Applicable
18080 to ELF compiler only.
18082 @item -mint32
18083 @opindex mint32
18084 Choose integer type as 32-bit wide.
18086 @item -mbit-ops
18087 @opindex mbit-ops
18088 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
18090 @item -mdata-model=@var{model}
18091 @opindex mdata-model
18092 Choose a data model. The choices for @var{model} are @samp{near},
18093 @samp{far} or @samp{medium}. @samp{medium} is default.
18094 However, @samp{far} is not valid with @option{-mcr16c}, as the
18095 CR16C architecture does not support the far data model.
18096 @end table
18098 @node C-SKY Options
18099 @subsection C-SKY Options
18100 @cindex C-SKY Options
18102 GCC supports these options when compiling for C-SKY V2 processors.
18104 @table @gcctabopt
18106 @item -march=@var{arch}
18107 @opindex march=
18108 Specify the C-SKY target architecture.  Valid values for @var{arch} are:
18109 @samp{ck801}, @samp{ck802}, @samp{ck803}, @samp{ck807}, and @samp{ck810}.
18110 The default is @samp{ck810}.
18112 @item -mcpu=@var{cpu}
18113 @opindex mcpu=
18114 Specify the C-SKY target processor.  Valid values for @var{cpu} are:
18115 @samp{ck801}, @samp{ck801t},
18116 @samp{ck802}, @samp{ck802t}, @samp{ck802j},
18117 @samp{ck803}, @samp{ck803h}, @samp{ck803t}, @samp{ck803ht},
18118 @samp{ck803f}, @samp{ck803fh}, @samp{ck803e}, @samp{ck803eh},
18119 @samp{ck803et}, @samp{ck803eht}, @samp{ck803ef}, @samp{ck803efh},
18120 @samp{ck803ft}, @samp{ck803eft}, @samp{ck803efht}, @samp{ck803r1},
18121 @samp{ck803hr1}, @samp{ck803tr1}, @samp{ck803htr1}, @samp{ck803fr1},
18122 @samp{ck803fhr1}, @samp{ck803er1}, @samp{ck803ehr1}, @samp{ck803etr1},
18123 @samp{ck803ehtr1}, @samp{ck803efr1}, @samp{ck803efhr1}, @samp{ck803ftr1},
18124 @samp{ck803eftr1}, @samp{ck803efhtr1},
18125 @samp{ck803s}, @samp{ck803st}, @samp{ck803se}, @samp{ck803sf},
18126 @samp{ck803sef}, @samp{ck803seft},
18127 @samp{ck807e}, @samp{ck807ef}, @samp{ck807}, @samp{ck807f},
18128 @samp{ck810e}, @samp{ck810et}, @samp{ck810ef}, @samp{ck810eft},
18129 @samp{ck810}, @samp{ck810v}, @samp{ck810f}, @samp{ck810t}, @samp{ck810fv},
18130 @samp{ck810tv}, @samp{ck810ft}, and @samp{ck810ftv}.
18132 @item -mbig-endian
18133 @opindex mbig-endian
18134 @itemx -EB
18135 @opindex EB
18136 @itemx -mlittle-endian
18137 @opindex mlittle-endian
18138 @itemx -EL
18139 @opindex EL
18141 Select big- or little-endian code.  The default is little-endian.
18143 @item -mhard-float
18144 @opindex mhard-float
18145 @itemx -msoft-float
18146 @opindex msoft-float
18148 Select hardware or software floating-point implementations.
18149 The default is soft float.
18151 @item -mdouble-float
18152 @itemx -mno-double-float
18153 @opindex mdouble-float
18154 When @option{-mhard-float} is in effect, enable generation of
18155 double-precision float instructions.  This is the default except
18156 when compiling for CK803.
18158 @item -mfdivdu
18159 @itemx -mno-fdivdu
18160 @opindex mfdivdu
18161 When @option{-mhard-float} is in effect, enable generation of
18162 @code{frecipd}, @code{fsqrtd}, and @code{fdivd} instructions.
18163 This is the default except when compiling for CK803.
18165 @item -mfpu=@var{fpu}
18166 @opindex mfpu=
18167 Select the floating-point processor.  This option can only be used with
18168 @option{-mhard-float}.
18169 Values for @var{fpu} are
18170 @samp{fpv2_sf} (equivalent to @samp{-mno-double-float -mno-fdivdu}),
18171 @samp{fpv2} (@samp{-mdouble-float -mno-divdu}), and
18172 @samp{fpv2_divd} (@samp{-mdouble-float -mdivdu}).
18174 @item -melrw
18175 @itemx -mno-elrw
18176 @opindex melrw
18177 Enable the extended @code{lrw} instruction.  This option defaults to on
18178 for CK801 and off otherwise.
18180 @item -mistack
18181 @itemx -mno-istack
18182 @opindex mistack
18183 Enable interrupt stack instructions; the default is off.
18185 The @option{-mistack} option is required to handle the
18186 @code{interrupt} and @code{isr} function attributes
18187 (@pxref{C-SKY Function Attributes}).
18189 @item -mmp
18190 @opindex mmp
18191 Enable multiprocessor instructions; the default is off.
18193 @item -mcp
18194 @opindex mcp
18195 Enable coprocessor instructions; the default is off.
18197 @item -mcache
18198 @opindex mcache
18199 Enable coprocessor instructions; the default is off.
18201 @item -msecurity
18202 @opindex msecurity
18203 Enable C-SKY security instructions; the default is off.
18205 @item -mtrust
18206 @opindex mtrust
18207 Enable C-SKY trust instructions; the default is off.
18209 @item -mdsp
18210 @opindex mdsp
18211 @itemx -medsp
18212 @opindex medsp
18213 @itemx -mvdsp
18214 @opindex mvdsp
18215 Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively.
18216 All of these options default to off.
18218 @item -mdiv
18219 @itemx -mno-div
18220 @opindex mdiv
18221 Generate divide instructions.  Default is off.
18223 @item -msmart
18224 @itemx -mno-smart
18225 @opindex msmart
18226 Generate code for Smart Mode, using only registers numbered 0-7 to allow
18227 use of 16-bit instructions.  This option is ignored for CK801 where this
18228 is the required behavior, and it defaults to on for CK802.
18229 For other targets, the default is off.
18231 @item -mhigh-registers
18232 @itemx -mno-high-registers
18233 @opindex mhigh-registers
18234 Generate code using the high registers numbered 16-31.  This option
18235 is not supported on CK801, CK802, or CK803, and is enabled by default
18236 for other processors.
18238 @item -manchor
18239 @itemx -mno-anchor
18240 @opindex manchor
18241 Generate code using global anchor symbol addresses.
18243 @item -mpushpop
18244 @itemx -mno-pushpop
18245 @opindex mpushpop
18246 Generate code using @code{push} and @code{pop} instructions.  This option
18247 defaults to on.
18249 @item -mmultiple-stld
18250 @itemx -mstm
18251 @itemx -mno-multiple-stld
18252 @itemx -mno-stm
18253 @opindex mmultiple-stld
18254 Generate code using @code{stm} and @code{ldm} instructions.  This option
18255 isn't supported on CK801 but is enabled by default on other processors.
18257 @item -mconstpool
18258 @itemx -mno-constpool
18259 @opindex mconstpool
18260 Create constant pools in the compiler instead of deferring it to the
18261 assembler.  This option is the default and required for correct code
18262 generation on CK801 and CK802, and is optional on other processors.
18264 @item -mstack-size
18265 @item -mno-stack-size
18266 @opindex mstack-size
18267 Emit @code{.stack_size} directives for each function in the assembly
18268 output.  This option defaults to off.
18270 @item -mccrt
18271 @itemx -mno-ccrt
18272 @opindex mccrt
18273 Generate code for the C-SKY compiler runtime instead of libgcc.  This
18274 option defaults to off.
18276 @item -mbranch-cost=@var{n}
18277 @opindex mbranch-cost=
18278 Set the branch costs to roughly @code{n} instructions.  The default is 1.
18280 @item -msched-prolog
18281 @itemx -mno-sched-prolog
18282 @opindex msched-prolog
18283 Permit scheduling of function prologue and epilogue sequences.  Using
18284 this option can result in code that is not compliant with the C-SKY V2 ABI
18285 prologue requirements and that cannot be debugged or backtraced.
18286 It is disabled by default.
18288 @end table
18290 @node Darwin Options
18291 @subsection Darwin Options
18292 @cindex Darwin options
18294 These options are defined for all architectures running the Darwin operating
18295 system.
18297 FSF GCC on Darwin does not create ``fat'' object files; it creates
18298 an object file for the single architecture that GCC was built to
18299 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
18300 @option{-arch} options are used; it does so by running the compiler or
18301 linker multiple times and joining the results together with
18302 @file{lipo}.
18304 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
18305 @samp{i686}) is determined by the flags that specify the ISA
18306 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
18307 @option{-force_cpusubtype_ALL} option can be used to override this.
18309 The Darwin tools vary in their behavior when presented with an ISA
18310 mismatch.  The assembler, @file{as}, only permits instructions to
18311 be used that are valid for the subtype of the file it is generating,
18312 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
18313 The linker for shared libraries, @file{/usr/bin/libtool}, fails
18314 and prints an error if asked to create a shared library with a less
18315 restrictive subtype than its input files (for instance, trying to put
18316 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
18317 for executables, @command{ld}, quietly gives the executable the most
18318 restrictive subtype of any of its input files.
18320 @table @gcctabopt
18321 @item -F@var{dir}
18322 @opindex F
18323 Add the framework directory @var{dir} to the head of the list of
18324 directories to be searched for header files.  These directories are
18325 interleaved with those specified by @option{-I} options and are
18326 scanned in a left-to-right order.
18328 A framework directory is a directory with frameworks in it.  A
18329 framework is a directory with a @file{Headers} and/or
18330 @file{PrivateHeaders} directory contained directly in it that ends
18331 in @file{.framework}.  The name of a framework is the name of this
18332 directory excluding the @file{.framework}.  Headers associated with
18333 the framework are found in one of those two directories, with
18334 @file{Headers} being searched first.  A subframework is a framework
18335 directory that is in a framework's @file{Frameworks} directory.
18336 Includes of subframework headers can only appear in a header of a
18337 framework that contains the subframework, or in a sibling subframework
18338 header.  Two subframeworks are siblings if they occur in the same
18339 framework.  A subframework should not have the same name as a
18340 framework; a warning is issued if this is violated.  Currently a
18341 subframework cannot have subframeworks; in the future, the mechanism
18342 may be extended to support this.  The standard frameworks can be found
18343 in @file{/System/Library/Frameworks} and
18344 @file{/Library/Frameworks}.  An example include looks like
18345 @code{#include <Framework/header.h>}, where @file{Framework} denotes
18346 the name of the framework and @file{header.h} is found in the
18347 @file{PrivateHeaders} or @file{Headers} directory.
18349 @item -iframework@var{dir}
18350 @opindex iframework
18351 Like @option{-F} except the directory is a treated as a system
18352 directory.  The main difference between this @option{-iframework} and
18353 @option{-F} is that with @option{-iframework} the compiler does not
18354 warn about constructs contained within header files found via
18355 @var{dir}.  This option is valid only for the C family of languages.
18357 @item -gused
18358 @opindex gused
18359 Emit debugging information for symbols that are used.  For stabs
18360 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
18361 This is by default ON@.
18363 @item -gfull
18364 @opindex gfull
18365 Emit debugging information for all symbols and types.
18367 @item -mmacosx-version-min=@var{version}
18368 The earliest version of MacOS X that this executable will run on
18369 is @var{version}.  Typical values of @var{version} include @code{10.1},
18370 @code{10.2}, and @code{10.3.9}.
18372 If the compiler was built to use the system's headers by default,
18373 then the default for this option is the system version on which the
18374 compiler is running, otherwise the default is to make choices that
18375 are compatible with as many systems and code bases as possible.
18377 @item -mkernel
18378 @opindex mkernel
18379 Enable kernel development mode.  The @option{-mkernel} option sets
18380 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
18381 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
18382 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
18383 applicable.  This mode also sets @option{-mno-altivec},
18384 @option{-msoft-float}, @option{-fno-builtin} and
18385 @option{-mlong-branch} for PowerPC targets.
18387 @item -mone-byte-bool
18388 @opindex mone-byte-bool
18389 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
18390 By default @code{sizeof(bool)} is @code{4} when compiling for
18391 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
18392 option has no effect on x86.
18394 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
18395 to generate code that is not binary compatible with code generated
18396 without that switch.  Using this switch may require recompiling all
18397 other modules in a program, including system libraries.  Use this
18398 switch to conform to a non-default data model.
18400 @item -mfix-and-continue
18401 @itemx -ffix-and-continue
18402 @itemx -findirect-data
18403 @opindex mfix-and-continue
18404 @opindex ffix-and-continue
18405 @opindex findirect-data
18406 Generate code suitable for fast turnaround development, such as to
18407 allow GDB to dynamically load @file{.o} files into already-running
18408 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
18409 are provided for backwards compatibility.
18411 @item -all_load
18412 @opindex all_load
18413 Loads all members of static archive libraries.
18414 See man ld(1) for more information.
18416 @item -arch_errors_fatal
18417 @opindex arch_errors_fatal
18418 Cause the errors having to do with files that have the wrong architecture
18419 to be fatal.
18421 @item -bind_at_load
18422 @opindex bind_at_load
18423 Causes the output file to be marked such that the dynamic linker will
18424 bind all undefined references when the file is loaded or launched.
18426 @item -bundle
18427 @opindex bundle
18428 Produce a Mach-o bundle format file.
18429 See man ld(1) for more information.
18431 @item -bundle_loader @var{executable}
18432 @opindex bundle_loader
18433 This option specifies the @var{executable} that will load the build
18434 output file being linked.  See man ld(1) for more information.
18436 @item -dynamiclib
18437 @opindex dynamiclib
18438 When passed this option, GCC produces a dynamic library instead of
18439 an executable when linking, using the Darwin @file{libtool} command.
18441 @item -force_cpusubtype_ALL
18442 @opindex force_cpusubtype_ALL
18443 This causes GCC's output file to have the @samp{ALL} subtype, instead of
18444 one controlled by the @option{-mcpu} or @option{-march} option.
18446 @item -allowable_client  @var{client_name}
18447 @itemx -client_name
18448 @itemx -compatibility_version
18449 @itemx -current_version
18450 @itemx -dead_strip
18451 @itemx -dependency-file
18452 @itemx -dylib_file
18453 @itemx -dylinker_install_name
18454 @itemx -dynamic
18455 @itemx -exported_symbols_list
18456 @itemx -filelist
18457 @need 800
18458 @itemx -flat_namespace
18459 @itemx -force_flat_namespace
18460 @itemx -headerpad_max_install_names
18461 @itemx -image_base
18462 @itemx -init
18463 @itemx -install_name
18464 @itemx -keep_private_externs
18465 @itemx -multi_module
18466 @itemx -multiply_defined
18467 @itemx -multiply_defined_unused
18468 @need 800
18469 @itemx -noall_load
18470 @itemx -no_dead_strip_inits_and_terms
18471 @itemx -nofixprebinding
18472 @itemx -nomultidefs
18473 @itemx -noprebind
18474 @itemx -noseglinkedit
18475 @itemx -pagezero_size
18476 @itemx -prebind
18477 @itemx -prebind_all_twolevel_modules
18478 @itemx -private_bundle
18479 @need 800
18480 @itemx -read_only_relocs
18481 @itemx -sectalign
18482 @itemx -sectobjectsymbols
18483 @itemx -whyload
18484 @itemx -seg1addr
18485 @itemx -sectcreate
18486 @itemx -sectobjectsymbols
18487 @itemx -sectorder
18488 @itemx -segaddr
18489 @itemx -segs_read_only_addr
18490 @need 800
18491 @itemx -segs_read_write_addr
18492 @itemx -seg_addr_table
18493 @itemx -seg_addr_table_filename
18494 @itemx -seglinkedit
18495 @itemx -segprot
18496 @itemx -segs_read_only_addr
18497 @itemx -segs_read_write_addr
18498 @itemx -single_module
18499 @itemx -static
18500 @itemx -sub_library
18501 @need 800
18502 @itemx -sub_umbrella
18503 @itemx -twolevel_namespace
18504 @itemx -umbrella
18505 @itemx -undefined
18506 @itemx -unexported_symbols_list
18507 @itemx -weak_reference_mismatches
18508 @itemx -whatsloaded
18509 @opindex allowable_client
18510 @opindex client_name
18511 @opindex compatibility_version
18512 @opindex current_version
18513 @opindex dead_strip
18514 @opindex dependency-file
18515 @opindex dylib_file
18516 @opindex dylinker_install_name
18517 @opindex dynamic
18518 @opindex exported_symbols_list
18519 @opindex filelist
18520 @opindex flat_namespace
18521 @opindex force_flat_namespace
18522 @opindex headerpad_max_install_names
18523 @opindex image_base
18524 @opindex init
18525 @opindex install_name
18526 @opindex keep_private_externs
18527 @opindex multi_module
18528 @opindex multiply_defined
18529 @opindex multiply_defined_unused
18530 @opindex noall_load
18531 @opindex no_dead_strip_inits_and_terms
18532 @opindex nofixprebinding
18533 @opindex nomultidefs
18534 @opindex noprebind
18535 @opindex noseglinkedit
18536 @opindex pagezero_size
18537 @opindex prebind
18538 @opindex prebind_all_twolevel_modules
18539 @opindex private_bundle
18540 @opindex read_only_relocs
18541 @opindex sectalign
18542 @opindex sectobjectsymbols
18543 @opindex whyload
18544 @opindex seg1addr
18545 @opindex sectcreate
18546 @opindex sectobjectsymbols
18547 @opindex sectorder
18548 @opindex segaddr
18549 @opindex segs_read_only_addr
18550 @opindex segs_read_write_addr
18551 @opindex seg_addr_table
18552 @opindex seg_addr_table_filename
18553 @opindex seglinkedit
18554 @opindex segprot
18555 @opindex segs_read_only_addr
18556 @opindex segs_read_write_addr
18557 @opindex single_module
18558 @opindex static
18559 @opindex sub_library
18560 @opindex sub_umbrella
18561 @opindex twolevel_namespace
18562 @opindex umbrella
18563 @opindex undefined
18564 @opindex unexported_symbols_list
18565 @opindex weak_reference_mismatches
18566 @opindex whatsloaded
18567 These options are passed to the Darwin linker.  The Darwin linker man page
18568 describes them in detail.
18569 @end table
18571 @node DEC Alpha Options
18572 @subsection DEC Alpha Options
18574 These @samp{-m} options are defined for the DEC Alpha implementations:
18576 @table @gcctabopt
18577 @item -mno-soft-float
18578 @itemx -msoft-float
18579 @opindex mno-soft-float
18580 @opindex msoft-float
18581 Use (do not use) the hardware floating-point instructions for
18582 floating-point operations.  When @option{-msoft-float} is specified,
18583 functions in @file{libgcc.a} are used to perform floating-point
18584 operations.  Unless they are replaced by routines that emulate the
18585 floating-point operations, or compiled in such a way as to call such
18586 emulations routines, these routines issue floating-point
18587 operations.   If you are compiling for an Alpha without floating-point
18588 operations, you must ensure that the library is built so as not to call
18589 them.
18591 Note that Alpha implementations without floating-point operations are
18592 required to have floating-point registers.
18594 @item -mfp-reg
18595 @itemx -mno-fp-regs
18596 @opindex mfp-reg
18597 @opindex mno-fp-regs
18598 Generate code that uses (does not use) the floating-point register set.
18599 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
18600 register set is not used, floating-point operands are passed in integer
18601 registers as if they were integers and floating-point results are passed
18602 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
18603 so any function with a floating-point argument or return value called by code
18604 compiled with @option{-mno-fp-regs} must also be compiled with that
18605 option.
18607 A typical use of this option is building a kernel that does not use,
18608 and hence need not save and restore, any floating-point registers.
18610 @item -mieee
18611 @opindex mieee
18612 The Alpha architecture implements floating-point hardware optimized for
18613 maximum performance.  It is mostly compliant with the IEEE floating-point
18614 standard.  However, for full compliance, software assistance is
18615 required.  This option generates code fully IEEE-compliant code
18616 @emph{except} that the @var{inexact-flag} is not maintained (see below).
18617 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
18618 defined during compilation.  The resulting code is less efficient but is
18619 able to correctly support denormalized numbers and exceptional IEEE
18620 values such as not-a-number and plus/minus infinity.  Other Alpha
18621 compilers call this option @option{-ieee_with_no_inexact}.
18623 @item -mieee-with-inexact
18624 @opindex mieee-with-inexact
18625 This is like @option{-mieee} except the generated code also maintains
18626 the IEEE @var{inexact-flag}.  Turning on this option causes the
18627 generated code to implement fully-compliant IEEE math.  In addition to
18628 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
18629 macro.  On some Alpha implementations the resulting code may execute
18630 significantly slower than the code generated by default.  Since there is
18631 very little code that depends on the @var{inexact-flag}, you should
18632 normally not specify this option.  Other Alpha compilers call this
18633 option @option{-ieee_with_inexact}.
18635 @item -mfp-trap-mode=@var{trap-mode}
18636 @opindex mfp-trap-mode
18637 This option controls what floating-point related traps are enabled.
18638 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
18639 The trap mode can be set to one of four values:
18641 @table @samp
18642 @item n
18643 This is the default (normal) setting.  The only traps that are enabled
18644 are the ones that cannot be disabled in software (e.g., division by zero
18645 trap).
18647 @item u
18648 In addition to the traps enabled by @samp{n}, underflow traps are enabled
18649 as well.
18651 @item su
18652 Like @samp{u}, but the instructions are marked to be safe for software
18653 completion (see Alpha architecture manual for details).
18655 @item sui
18656 Like @samp{su}, but inexact traps are enabled as well.
18657 @end table
18659 @item -mfp-rounding-mode=@var{rounding-mode}
18660 @opindex mfp-rounding-mode
18661 Selects the IEEE rounding mode.  Other Alpha compilers call this option
18662 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
18665 @table @samp
18666 @item n
18667 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
18668 the nearest machine number or towards the even machine number in case
18669 of a tie.
18671 @item m
18672 Round towards minus infinity.
18674 @item c
18675 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
18677 @item d
18678 Dynamic rounding mode.  A field in the floating-point control register
18679 (@var{fpcr}, see Alpha architecture reference manual) controls the
18680 rounding mode in effect.  The C library initializes this register for
18681 rounding towards plus infinity.  Thus, unless your program modifies the
18682 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18683 @end table
18685 @item -mtrap-precision=@var{trap-precision}
18686 @opindex mtrap-precision
18687 In the Alpha architecture, floating-point traps are imprecise.  This
18688 means without software assistance it is impossible to recover from a
18689 floating trap and program execution normally needs to be terminated.
18690 GCC can generate code that can assist operating system trap handlers
18691 in determining the exact location that caused a floating-point trap.
18692 Depending on the requirements of an application, different levels of
18693 precisions can be selected:
18695 @table @samp
18696 @item p
18697 Program precision.  This option is the default and means a trap handler
18698 can only identify which program caused a floating-point exception.
18700 @item f
18701 Function precision.  The trap handler can determine the function that
18702 caused a floating-point exception.
18704 @item i
18705 Instruction precision.  The trap handler can determine the exact
18706 instruction that caused a floating-point exception.
18707 @end table
18709 Other Alpha compilers provide the equivalent options called
18710 @option{-scope_safe} and @option{-resumption_safe}.
18712 @item -mieee-conformant
18713 @opindex mieee-conformant
18714 This option marks the generated code as IEEE conformant.  You must not
18715 use this option unless you also specify @option{-mtrap-precision=i} and either
18716 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18717 is to emit the line @samp{.eflag 48} in the function prologue of the
18718 generated assembly file.
18720 @item -mbuild-constants
18721 @opindex mbuild-constants
18722 Normally GCC examines a 32- or 64-bit integer constant to
18723 see if it can construct it from smaller constants in two or three
18724 instructions.  If it cannot, it outputs the constant as a literal and
18725 generates code to load it from the data segment at run time.
18727 Use this option to require GCC to construct @emph{all} integer constants
18728 using code, even if it takes more instructions (the maximum is six).
18730 You typically use this option to build a shared library dynamic
18731 loader.  Itself a shared library, it must relocate itself in memory
18732 before it can find the variables and constants in its own data segment.
18734 @item -mbwx
18735 @itemx -mno-bwx
18736 @itemx -mcix
18737 @itemx -mno-cix
18738 @itemx -mfix
18739 @itemx -mno-fix
18740 @itemx -mmax
18741 @itemx -mno-max
18742 @opindex mbwx
18743 @opindex mno-bwx
18744 @opindex mcix
18745 @opindex mno-cix
18746 @opindex mfix
18747 @opindex mno-fix
18748 @opindex mmax
18749 @opindex mno-max
18750 Indicate whether GCC should generate code to use the optional BWX,
18751 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18752 sets supported by the CPU type specified via @option{-mcpu=} option or that
18753 of the CPU on which GCC was built if none is specified.
18755 @item -mfloat-vax
18756 @itemx -mfloat-ieee
18757 @opindex mfloat-vax
18758 @opindex mfloat-ieee
18759 Generate code that uses (does not use) VAX F and G floating-point
18760 arithmetic instead of IEEE single and double precision.
18762 @item -mexplicit-relocs
18763 @itemx -mno-explicit-relocs
18764 @opindex mexplicit-relocs
18765 @opindex mno-explicit-relocs
18766 Older Alpha assemblers provided no way to generate symbol relocations
18767 except via assembler macros.  Use of these macros does not allow
18768 optimal instruction scheduling.  GNU binutils as of version 2.12
18769 supports a new syntax that allows the compiler to explicitly mark
18770 which relocations should apply to which instructions.  This option
18771 is mostly useful for debugging, as GCC detects the capabilities of
18772 the assembler when it is built and sets the default accordingly.
18774 @item -msmall-data
18775 @itemx -mlarge-data
18776 @opindex msmall-data
18777 @opindex mlarge-data
18778 When @option{-mexplicit-relocs} is in effect, static data is
18779 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18780 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18781 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18782 16-bit relocations off of the @code{$gp} register.  This limits the
18783 size of the small data area to 64KB, but allows the variables to be
18784 directly accessed via a single instruction.
18786 The default is @option{-mlarge-data}.  With this option the data area
18787 is limited to just below 2GB@.  Programs that require more than 2GB of
18788 data must use @code{malloc} or @code{mmap} to allocate the data in the
18789 heap instead of in the program's data segment.
18791 When generating code for shared libraries, @option{-fpic} implies
18792 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18794 @item -msmall-text
18795 @itemx -mlarge-text
18796 @opindex msmall-text
18797 @opindex mlarge-text
18798 When @option{-msmall-text} is used, the compiler assumes that the
18799 code of the entire program (or shared library) fits in 4MB, and is
18800 thus reachable with a branch instruction.  When @option{-msmall-data}
18801 is used, the compiler can assume that all local symbols share the
18802 same @code{$gp} value, and thus reduce the number of instructions
18803 required for a function call from 4 to 1.
18805 The default is @option{-mlarge-text}.
18807 @item -mcpu=@var{cpu_type}
18808 @opindex mcpu
18809 Set the instruction set and instruction scheduling parameters for
18810 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18811 style name or the corresponding chip number.  GCC supports scheduling
18812 parameters for the EV4, EV5 and EV6 family of processors and
18813 chooses the default values for the instruction set from the processor
18814 you specify.  If you do not specify a processor type, GCC defaults
18815 to the processor on which the compiler was built.
18817 Supported values for @var{cpu_type} are
18819 @table @samp
18820 @item ev4
18821 @itemx ev45
18822 @itemx 21064
18823 Schedules as an EV4 and has no instruction set extensions.
18825 @item ev5
18826 @itemx 21164
18827 Schedules as an EV5 and has no instruction set extensions.
18829 @item ev56
18830 @itemx 21164a
18831 Schedules as an EV5 and supports the BWX extension.
18833 @item pca56
18834 @itemx 21164pc
18835 @itemx 21164PC
18836 Schedules as an EV5 and supports the BWX and MAX extensions.
18838 @item ev6
18839 @itemx 21264
18840 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18842 @item ev67
18843 @itemx 21264a
18844 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18845 @end table
18847 Native toolchains also support the value @samp{native},
18848 which selects the best architecture option for the host processor.
18849 @option{-mcpu=native} has no effect if GCC does not recognize
18850 the processor.
18852 @item -mtune=@var{cpu_type}
18853 @opindex mtune
18854 Set only the instruction scheduling parameters for machine type
18855 @var{cpu_type}.  The instruction set is not changed.
18857 Native toolchains also support the value @samp{native},
18858 which selects the best architecture option for the host processor.
18859 @option{-mtune=native} has no effect if GCC does not recognize
18860 the processor.
18862 @item -mmemory-latency=@var{time}
18863 @opindex mmemory-latency
18864 Sets the latency the scheduler should assume for typical memory
18865 references as seen by the application.  This number is highly
18866 dependent on the memory access patterns used by the application
18867 and the size of the external cache on the machine.
18869 Valid options for @var{time} are
18871 @table @samp
18872 @item @var{number}
18873 A decimal number representing clock cycles.
18875 @item L1
18876 @itemx L2
18877 @itemx L3
18878 @itemx main
18879 The compiler contains estimates of the number of clock cycles for
18880 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18881 (also called Dcache, Scache, and Bcache), as well as to main memory.
18882 Note that L3 is only valid for EV5.
18884 @end table
18885 @end table
18887 @node FR30 Options
18888 @subsection FR30 Options
18889 @cindex FR30 Options
18891 These options are defined specifically for the FR30 port.
18893 @table @gcctabopt
18895 @item -msmall-model
18896 @opindex msmall-model
18897 Use the small address space model.  This can produce smaller code, but
18898 it does assume that all symbolic values and addresses fit into a
18899 20-bit range.
18901 @item -mno-lsim
18902 @opindex mno-lsim
18903 Assume that runtime support has been provided and so there is no need
18904 to include the simulator library (@file{libsim.a}) on the linker
18905 command line.
18907 @end table
18909 @node FT32 Options
18910 @subsection FT32 Options
18911 @cindex FT32 Options
18913 These options are defined specifically for the FT32 port.
18915 @table @gcctabopt
18917 @item -msim
18918 @opindex msim
18919 Specifies that the program will be run on the simulator.  This causes
18920 an alternate runtime startup and library to be linked.
18921 You must not use this option when generating programs that will run on
18922 real hardware; you must provide your own runtime library for whatever
18923 I/O functions are needed.
18925 @item -mlra
18926 @opindex mlra
18927 Enable Local Register Allocation.  This is still experimental for FT32,
18928 so by default the compiler uses standard reload.
18930 @item -mnodiv
18931 @opindex mnodiv
18932 Do not use div and mod instructions.
18934 @item -mft32b
18935 @opindex mft32b
18936 Enable use of the extended instructions of the FT32B processor.
18938 @item -mcompress
18939 @opindex mcompress
18940 Compress all code using the Ft32B code compression scheme.
18942 @item -mnopm
18943 @opindex  mnopm
18944 Do not generate code that reads program memory.
18946 @end table
18948 @node FRV Options
18949 @subsection FRV Options
18950 @cindex FRV Options
18952 @table @gcctabopt
18953 @item -mgpr-32
18954 @opindex mgpr-32
18956 Only use the first 32 general-purpose registers.
18958 @item -mgpr-64
18959 @opindex mgpr-64
18961 Use all 64 general-purpose registers.
18963 @item -mfpr-32
18964 @opindex mfpr-32
18966 Use only the first 32 floating-point registers.
18968 @item -mfpr-64
18969 @opindex mfpr-64
18971 Use all 64 floating-point registers.
18973 @item -mhard-float
18974 @opindex mhard-float
18976 Use hardware instructions for floating-point operations.
18978 @item -msoft-float
18979 @opindex msoft-float
18981 Use library routines for floating-point operations.
18983 @item -malloc-cc
18984 @opindex malloc-cc
18986 Dynamically allocate condition code registers.
18988 @item -mfixed-cc
18989 @opindex mfixed-cc
18991 Do not try to dynamically allocate condition code registers, only
18992 use @code{icc0} and @code{fcc0}.
18994 @item -mdword
18995 @opindex mdword
18997 Change ABI to use double word insns.
18999 @item -mno-dword
19000 @opindex mno-dword
19002 Do not use double word instructions.
19004 @item -mdouble
19005 @opindex mdouble
19007 Use floating-point double instructions.
19009 @item -mno-double
19010 @opindex mno-double
19012 Do not use floating-point double instructions.
19014 @item -mmedia
19015 @opindex mmedia
19017 Use media instructions.
19019 @item -mno-media
19020 @opindex mno-media
19022 Do not use media instructions.
19024 @item -mmuladd
19025 @opindex mmuladd
19027 Use multiply and add/subtract instructions.
19029 @item -mno-muladd
19030 @opindex mno-muladd
19032 Do not use multiply and add/subtract instructions.
19034 @item -mfdpic
19035 @opindex mfdpic
19037 Select the FDPIC ABI, which uses function descriptors to represent
19038 pointers to functions.  Without any PIC/PIE-related options, it
19039 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
19040 assumes GOT entries and small data are within a 12-bit range from the
19041 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
19042 are computed with 32 bits.
19043 With a @samp{bfin-elf} target, this option implies @option{-msim}.
19045 @item -minline-plt
19046 @opindex minline-plt
19048 Enable inlining of PLT entries in function calls to functions that are
19049 not known to bind locally.  It has no effect without @option{-mfdpic}.
19050 It's enabled by default if optimizing for speed and compiling for
19051 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
19052 optimization option such as @option{-O3} or above is present in the
19053 command line.
19055 @item -mTLS
19056 @opindex mTLS
19058 Assume a large TLS segment when generating thread-local code.
19060 @item -mtls
19061 @opindex mtls
19063 Do not assume a large TLS segment when generating thread-local code.
19065 @item -mgprel-ro
19066 @opindex mgprel-ro
19068 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
19069 that is known to be in read-only sections.  It's enabled by default,
19070 except for @option{-fpic} or @option{-fpie}: even though it may help
19071 make the global offset table smaller, it trades 1 instruction for 4.
19072 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
19073 one of which may be shared by multiple symbols, and it avoids the need
19074 for a GOT entry for the referenced symbol, so it's more likely to be a
19075 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
19077 @item -multilib-library-pic
19078 @opindex multilib-library-pic
19080 Link with the (library, not FD) pic libraries.  It's implied by
19081 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
19082 @option{-fpic} without @option{-mfdpic}.  You should never have to use
19083 it explicitly.
19085 @item -mlinked-fp
19086 @opindex mlinked-fp
19088 Follow the EABI requirement of always creating a frame pointer whenever
19089 a stack frame is allocated.  This option is enabled by default and can
19090 be disabled with @option{-mno-linked-fp}.
19092 @item -mlong-calls
19093 @opindex mlong-calls
19095 Use indirect addressing to call functions outside the current
19096 compilation unit.  This allows the functions to be placed anywhere
19097 within the 32-bit address space.
19099 @item -malign-labels
19100 @opindex malign-labels
19102 Try to align labels to an 8-byte boundary by inserting NOPs into the
19103 previous packet.  This option only has an effect when VLIW packing
19104 is enabled.  It doesn't create new packets; it merely adds NOPs to
19105 existing ones.
19107 @item -mlibrary-pic
19108 @opindex mlibrary-pic
19110 Generate position-independent EABI code.
19112 @item -macc-4
19113 @opindex macc-4
19115 Use only the first four media accumulator registers.
19117 @item -macc-8
19118 @opindex macc-8
19120 Use all eight media accumulator registers.
19122 @item -mpack
19123 @opindex mpack
19125 Pack VLIW instructions.
19127 @item -mno-pack
19128 @opindex mno-pack
19130 Do not pack VLIW instructions.
19132 @item -mno-eflags
19133 @opindex mno-eflags
19135 Do not mark ABI switches in e_flags.
19137 @item -mcond-move
19138 @opindex mcond-move
19140 Enable the use of conditional-move instructions (default).
19142 This switch is mainly for debugging the compiler and will likely be removed
19143 in a future version.
19145 @item -mno-cond-move
19146 @opindex mno-cond-move
19148 Disable the use of conditional-move instructions.
19150 This switch is mainly for debugging the compiler and will likely be removed
19151 in a future version.
19153 @item -mscc
19154 @opindex mscc
19156 Enable the use of conditional set instructions (default).
19158 This switch is mainly for debugging the compiler and will likely be removed
19159 in a future version.
19161 @item -mno-scc
19162 @opindex mno-scc
19164 Disable the use of conditional set instructions.
19166 This switch is mainly for debugging the compiler and will likely be removed
19167 in a future version.
19169 @item -mcond-exec
19170 @opindex mcond-exec
19172 Enable the use of conditional execution (default).
19174 This switch is mainly for debugging the compiler and will likely be removed
19175 in a future version.
19177 @item -mno-cond-exec
19178 @opindex mno-cond-exec
19180 Disable the use of conditional execution.
19182 This switch is mainly for debugging the compiler and will likely be removed
19183 in a future version.
19185 @item -mvliw-branch
19186 @opindex mvliw-branch
19188 Run a pass to pack branches into VLIW instructions (default).
19190 This switch is mainly for debugging the compiler and will likely be removed
19191 in a future version.
19193 @item -mno-vliw-branch
19194 @opindex mno-vliw-branch
19196 Do not run a pass to pack branches into VLIW instructions.
19198 This switch is mainly for debugging the compiler and will likely be removed
19199 in a future version.
19201 @item -mmulti-cond-exec
19202 @opindex mmulti-cond-exec
19204 Enable optimization of @code{&&} and @code{||} in conditional execution
19205 (default).
19207 This switch is mainly for debugging the compiler and will likely be removed
19208 in a future version.
19210 @item -mno-multi-cond-exec
19211 @opindex mno-multi-cond-exec
19213 Disable optimization of @code{&&} and @code{||} in conditional execution.
19215 This switch is mainly for debugging the compiler and will likely be removed
19216 in a future version.
19218 @item -mnested-cond-exec
19219 @opindex mnested-cond-exec
19221 Enable nested conditional execution optimizations (default).
19223 This switch is mainly for debugging the compiler and will likely be removed
19224 in a future version.
19226 @item -mno-nested-cond-exec
19227 @opindex mno-nested-cond-exec
19229 Disable nested conditional execution optimizations.
19231 This switch is mainly for debugging the compiler and will likely be removed
19232 in a future version.
19234 @item -moptimize-membar
19235 @opindex moptimize-membar
19237 This switch removes redundant @code{membar} instructions from the
19238 compiler-generated code.  It is enabled by default.
19240 @item -mno-optimize-membar
19241 @opindex mno-optimize-membar
19243 This switch disables the automatic removal of redundant @code{membar}
19244 instructions from the generated code.
19246 @item -mtomcat-stats
19247 @opindex mtomcat-stats
19249 Cause gas to print out tomcat statistics.
19251 @item -mcpu=@var{cpu}
19252 @opindex mcpu
19254 Select the processor type for which to generate code.  Possible values are
19255 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
19256 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
19258 @end table
19260 @node GNU/Linux Options
19261 @subsection GNU/Linux Options
19263 These @samp{-m} options are defined for GNU/Linux targets:
19265 @table @gcctabopt
19266 @item -mglibc
19267 @opindex mglibc
19268 Use the GNU C library.  This is the default except
19269 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
19270 @samp{*-*-linux-*android*} targets.
19272 @item -muclibc
19273 @opindex muclibc
19274 Use uClibc C library.  This is the default on
19275 @samp{*-*-linux-*uclibc*} targets.
19277 @item -mmusl
19278 @opindex mmusl
19279 Use the musl C library.  This is the default on
19280 @samp{*-*-linux-*musl*} targets.
19282 @item -mbionic
19283 @opindex mbionic
19284 Use Bionic C library.  This is the default on
19285 @samp{*-*-linux-*android*} targets.
19287 @item -mandroid
19288 @opindex mandroid
19289 Compile code compatible with Android platform.  This is the default on
19290 @samp{*-*-linux-*android*} targets.
19292 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
19293 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
19294 this option makes the GCC driver pass Android-specific options to the linker.
19295 Finally, this option causes the preprocessor macro @code{__ANDROID__}
19296 to be defined.
19298 @item -tno-android-cc
19299 @opindex tno-android-cc
19300 Disable compilation effects of @option{-mandroid}, i.e., do not enable
19301 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
19302 @option{-fno-rtti} by default.
19304 @item -tno-android-ld
19305 @opindex tno-android-ld
19306 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
19307 linking options to the linker.
19309 @end table
19311 @node H8/300 Options
19312 @subsection H8/300 Options
19314 These @samp{-m} options are defined for the H8/300 implementations:
19316 @table @gcctabopt
19317 @item -mrelax
19318 @opindex mrelax
19319 Shorten some address references at link time, when possible; uses the
19320 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
19321 ld, Using ld}, for a fuller description.
19323 @item -mh
19324 @opindex mh
19325 Generate code for the H8/300H@.
19327 @item -ms
19328 @opindex ms
19329 Generate code for the H8S@.
19331 @item -mn
19332 @opindex mn
19333 Generate code for the H8S and H8/300H in the normal mode.  This switch
19334 must be used either with @option{-mh} or @option{-ms}.
19336 @item -ms2600
19337 @opindex ms2600
19338 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
19340 @item -mexr
19341 @opindex mexr
19342 Extended registers are stored on stack before execution of function
19343 with monitor attribute. Default option is @option{-mexr}.
19344 This option is valid only for H8S targets.
19346 @item -mno-exr
19347 @opindex mno-exr
19348 Extended registers are not stored on stack before execution of function 
19349 with monitor attribute. Default option is @option{-mno-exr}. 
19350 This option is valid only for H8S targets.
19352 @item -mint32
19353 @opindex mint32
19354 Make @code{int} data 32 bits by default.
19356 @item -malign-300
19357 @opindex malign-300
19358 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
19359 The default for the H8/300H and H8S is to align longs and floats on
19360 4-byte boundaries.
19361 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
19362 This option has no effect on the H8/300.
19363 @end table
19365 @node HPPA Options
19366 @subsection HPPA Options
19367 @cindex HPPA Options
19369 These @samp{-m} options are defined for the HPPA family of computers:
19371 @table @gcctabopt
19372 @item -march=@var{architecture-type}
19373 @opindex march
19374 Generate code for the specified architecture.  The choices for
19375 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
19376 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
19377 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
19378 architecture option for your machine.  Code compiled for lower numbered
19379 architectures runs on higher numbered architectures, but not the
19380 other way around.
19382 @item -mpa-risc-1-0
19383 @itemx -mpa-risc-1-1
19384 @itemx -mpa-risc-2-0
19385 @opindex mpa-risc-1-0
19386 @opindex mpa-risc-1-1
19387 @opindex mpa-risc-2-0
19388 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
19390 @item -mcaller-copies
19391 @opindex mcaller-copies
19392 The caller copies function arguments passed by hidden reference.  This
19393 option should be used with care as it is not compatible with the default
19394 32-bit runtime.  However, only aggregates larger than eight bytes are
19395 passed by hidden reference and the option provides better compatibility
19396 with OpenMP.
19398 @item -mjump-in-delay
19399 @opindex mjump-in-delay
19400 This option is ignored and provided for compatibility purposes only.
19402 @item -mdisable-fpregs
19403 @opindex mdisable-fpregs
19404 Prevent floating-point registers from being used in any manner.  This is
19405 necessary for compiling kernels that perform lazy context switching of
19406 floating-point registers.  If you use this option and attempt to perform
19407 floating-point operations, the compiler aborts.
19409 @item -mdisable-indexing
19410 @opindex mdisable-indexing
19411 Prevent the compiler from using indexing address modes.  This avoids some
19412 rather obscure problems when compiling MIG generated code under MACH@.
19414 @item -mno-space-regs
19415 @opindex mno-space-regs
19416 Generate code that assumes the target has no space registers.  This allows
19417 GCC to generate faster indirect calls and use unscaled index address modes.
19419 Such code is suitable for level 0 PA systems and kernels.
19421 @item -mfast-indirect-calls
19422 @opindex mfast-indirect-calls
19423 Generate code that assumes calls never cross space boundaries.  This
19424 allows GCC to emit code that performs faster indirect calls.
19426 This option does not work in the presence of shared libraries or nested
19427 functions.
19429 @item -mfixed-range=@var{register-range}
19430 @opindex mfixed-range
19431 Generate code treating the given register range as fixed registers.
19432 A fixed register is one that the register allocator cannot use.  This is
19433 useful when compiling kernel code.  A register range is specified as
19434 two registers separated by a dash.  Multiple register ranges can be
19435 specified separated by a comma.
19437 @item -mlong-load-store
19438 @opindex mlong-load-store
19439 Generate 3-instruction load and store sequences as sometimes required by
19440 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
19441 the HP compilers.
19443 @item -mportable-runtime
19444 @opindex mportable-runtime
19445 Use the portable calling conventions proposed by HP for ELF systems.
19447 @item -mgas
19448 @opindex mgas
19449 Enable the use of assembler directives only GAS understands.
19451 @item -mschedule=@var{cpu-type}
19452 @opindex mschedule
19453 Schedule code according to the constraints for the machine type
19454 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
19455 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
19456 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
19457 proper scheduling option for your machine.  The default scheduling is
19458 @samp{8000}.
19460 @item -mlinker-opt
19461 @opindex mlinker-opt
19462 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
19463 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
19464 linkers in which they give bogus error messages when linking some programs.
19466 @item -msoft-float
19467 @opindex msoft-float
19468 Generate output containing library calls for floating point.
19469 @strong{Warning:} the requisite libraries are not available for all HPPA
19470 targets.  Normally the facilities of the machine's usual C compiler are
19471 used, but this cannot be done directly in cross-compilation.  You must make
19472 your own arrangements to provide suitable library functions for
19473 cross-compilation.
19475 @option{-msoft-float} changes the calling convention in the output file;
19476 therefore, it is only useful if you compile @emph{all} of a program with
19477 this option.  In particular, you need to compile @file{libgcc.a}, the
19478 library that comes with GCC, with @option{-msoft-float} in order for
19479 this to work.
19481 @item -msio
19482 @opindex msio
19483 Generate the predefine, @code{_SIO}, for server IO@.  The default is
19484 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
19485 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
19486 options are available under HP-UX and HI-UX@.
19488 @item -mgnu-ld
19489 @opindex mgnu-ld
19490 Use options specific to GNU @command{ld}.
19491 This passes @option{-shared} to @command{ld} when
19492 building a shared library.  It is the default when GCC is configured,
19493 explicitly or implicitly, with the GNU linker.  This option does not
19494 affect which @command{ld} is called; it only changes what parameters
19495 are passed to that @command{ld}.
19496 The @command{ld} that is called is determined by the
19497 @option{--with-ld} configure option, GCC's program search path, and
19498 finally by the user's @env{PATH}.  The linker used by GCC can be printed
19499 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
19500 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
19502 @item -mhp-ld
19503 @opindex mhp-ld
19504 Use options specific to HP @command{ld}.
19505 This passes @option{-b} to @command{ld} when building
19506 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
19507 links.  It is the default when GCC is configured, explicitly or
19508 implicitly, with the HP linker.  This option does not affect
19509 which @command{ld} is called; it only changes what parameters are passed to that
19510 @command{ld}.
19511 The @command{ld} that is called is determined by the @option{--with-ld}
19512 configure option, GCC's program search path, and finally by the user's
19513 @env{PATH}.  The linker used by GCC can be printed using @samp{which
19514 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
19515 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
19517 @item -mlong-calls
19518 @opindex mno-long-calls
19519 Generate code that uses long call sequences.  This ensures that a call
19520 is always able to reach linker generated stubs.  The default is to generate
19521 long calls only when the distance from the call site to the beginning
19522 of the function or translation unit, as the case may be, exceeds a
19523 predefined limit set by the branch type being used.  The limits for
19524 normal calls are 7,600,000 and 240,000 bytes, respectively for the
19525 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
19526 240,000 bytes.
19528 Distances are measured from the beginning of functions when using the
19529 @option{-ffunction-sections} option, or when using the @option{-mgas}
19530 and @option{-mno-portable-runtime} options together under HP-UX with
19531 the SOM linker.
19533 It is normally not desirable to use this option as it degrades
19534 performance.  However, it may be useful in large applications,
19535 particularly when partial linking is used to build the application.
19537 The types of long calls used depends on the capabilities of the
19538 assembler and linker, and the type of code being generated.  The
19539 impact on systems that support long absolute calls, and long pic
19540 symbol-difference or pc-relative calls should be relatively small.
19541 However, an indirect call is used on 32-bit ELF systems in pic code
19542 and it is quite long.
19544 @item -munix=@var{unix-std}
19545 @opindex march
19546 Generate compiler predefines and select a startfile for the specified
19547 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
19548 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
19549 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
19550 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
19551 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
19552 and later.
19554 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
19555 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
19556 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
19557 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
19558 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
19559 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
19561 It is @emph{important} to note that this option changes the interfaces
19562 for various library routines.  It also affects the operational behavior
19563 of the C library.  Thus, @emph{extreme} care is needed in using this
19564 option.
19566 Library code that is intended to operate with more than one UNIX
19567 standard must test, set and restore the variable @code{__xpg4_extended_mask}
19568 as appropriate.  Most GNU software doesn't provide this capability.
19570 @item -nolibdld
19571 @opindex nolibdld
19572 Suppress the generation of link options to search libdld.sl when the
19573 @option{-static} option is specified on HP-UX 10 and later.
19575 @item -static
19576 @opindex static
19577 The HP-UX implementation of setlocale in libc has a dependency on
19578 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
19579 when the @option{-static} option is specified, special link options
19580 are needed to resolve this dependency.
19582 On HP-UX 10 and later, the GCC driver adds the necessary options to
19583 link with libdld.sl when the @option{-static} option is specified.
19584 This causes the resulting binary to be dynamic.  On the 64-bit port,
19585 the linkers generate dynamic binaries by default in any case.  The
19586 @option{-nolibdld} option can be used to prevent the GCC driver from
19587 adding these link options.
19589 @item -threads
19590 @opindex threads
19591 Add support for multithreading with the @dfn{dce thread} library
19592 under HP-UX@.  This option sets flags for both the preprocessor and
19593 linker.
19594 @end table
19596 @node IA-64 Options
19597 @subsection IA-64 Options
19598 @cindex IA-64 Options
19600 These are the @samp{-m} options defined for the Intel IA-64 architecture.
19602 @table @gcctabopt
19603 @item -mbig-endian
19604 @opindex mbig-endian
19605 Generate code for a big-endian target.  This is the default for HP-UX@.
19607 @item -mlittle-endian
19608 @opindex mlittle-endian
19609 Generate code for a little-endian target.  This is the default for AIX5
19610 and GNU/Linux.
19612 @item -mgnu-as
19613 @itemx -mno-gnu-as
19614 @opindex mgnu-as
19615 @opindex mno-gnu-as
19616 Generate (or don't) code for the GNU assembler.  This is the default.
19617 @c Also, this is the default if the configure option @option{--with-gnu-as}
19618 @c is used.
19620 @item -mgnu-ld
19621 @itemx -mno-gnu-ld
19622 @opindex mgnu-ld
19623 @opindex mno-gnu-ld
19624 Generate (or don't) code for the GNU linker.  This is the default.
19625 @c Also, this is the default if the configure option @option{--with-gnu-ld}
19626 @c is used.
19628 @item -mno-pic
19629 @opindex mno-pic
19630 Generate code that does not use a global pointer register.  The result
19631 is not position independent code, and violates the IA-64 ABI@.
19633 @item -mvolatile-asm-stop
19634 @itemx -mno-volatile-asm-stop
19635 @opindex mvolatile-asm-stop
19636 @opindex mno-volatile-asm-stop
19637 Generate (or don't) a stop bit immediately before and after volatile asm
19638 statements.
19640 @item -mregister-names
19641 @itemx -mno-register-names
19642 @opindex mregister-names
19643 @opindex mno-register-names
19644 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
19645 the stacked registers.  This may make assembler output more readable.
19647 @item -mno-sdata
19648 @itemx -msdata
19649 @opindex mno-sdata
19650 @opindex msdata
19651 Disable (or enable) optimizations that use the small data section.  This may
19652 be useful for working around optimizer bugs.
19654 @item -mconstant-gp
19655 @opindex mconstant-gp
19656 Generate code that uses a single constant global pointer value.  This is
19657 useful when compiling kernel code.
19659 @item -mauto-pic
19660 @opindex mauto-pic
19661 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
19662 This is useful when compiling firmware code.
19664 @item -minline-float-divide-min-latency
19665 @opindex minline-float-divide-min-latency
19666 Generate code for inline divides of floating-point values
19667 using the minimum latency algorithm.
19669 @item -minline-float-divide-max-throughput
19670 @opindex minline-float-divide-max-throughput
19671 Generate code for inline divides of floating-point values
19672 using the maximum throughput algorithm.
19674 @item -mno-inline-float-divide
19675 @opindex mno-inline-float-divide
19676 Do not generate inline code for divides of floating-point values.
19678 @item -minline-int-divide-min-latency
19679 @opindex minline-int-divide-min-latency
19680 Generate code for inline divides of integer values
19681 using the minimum latency algorithm.
19683 @item -minline-int-divide-max-throughput
19684 @opindex minline-int-divide-max-throughput
19685 Generate code for inline divides of integer values
19686 using the maximum throughput algorithm.
19688 @item -mno-inline-int-divide
19689 @opindex mno-inline-int-divide
19690 Do not generate inline code for divides of integer values.
19692 @item -minline-sqrt-min-latency
19693 @opindex minline-sqrt-min-latency
19694 Generate code for inline square roots
19695 using the minimum latency algorithm.
19697 @item -minline-sqrt-max-throughput
19698 @opindex minline-sqrt-max-throughput
19699 Generate code for inline square roots
19700 using the maximum throughput algorithm.
19702 @item -mno-inline-sqrt
19703 @opindex mno-inline-sqrt
19704 Do not generate inline code for @code{sqrt}.
19706 @item -mfused-madd
19707 @itemx -mno-fused-madd
19708 @opindex mfused-madd
19709 @opindex mno-fused-madd
19710 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19711 instructions.  The default is to use these instructions.
19713 @item -mno-dwarf2-asm
19714 @itemx -mdwarf2-asm
19715 @opindex mno-dwarf2-asm
19716 @opindex mdwarf2-asm
19717 Don't (or do) generate assembler code for the DWARF line number debugging
19718 info.  This may be useful when not using the GNU assembler.
19720 @item -mearly-stop-bits
19721 @itemx -mno-early-stop-bits
19722 @opindex mearly-stop-bits
19723 @opindex mno-early-stop-bits
19724 Allow stop bits to be placed earlier than immediately preceding the
19725 instruction that triggered the stop bit.  This can improve instruction
19726 scheduling, but does not always do so.
19728 @item -mfixed-range=@var{register-range}
19729 @opindex mfixed-range
19730 Generate code treating the given register range as fixed registers.
19731 A fixed register is one that the register allocator cannot use.  This is
19732 useful when compiling kernel code.  A register range is specified as
19733 two registers separated by a dash.  Multiple register ranges can be
19734 specified separated by a comma.
19736 @item -mtls-size=@var{tls-size}
19737 @opindex mtls-size
19738 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19741 @item -mtune=@var{cpu-type}
19742 @opindex mtune
19743 Tune the instruction scheduling for a particular CPU, Valid values are
19744 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19745 and @samp{mckinley}.
19747 @item -milp32
19748 @itemx -mlp64
19749 @opindex milp32
19750 @opindex mlp64
19751 Generate code for a 32-bit or 64-bit environment.
19752 The 32-bit environment sets int, long and pointer to 32 bits.
19753 The 64-bit environment sets int to 32 bits and long and pointer
19754 to 64 bits.  These are HP-UX specific flags.
19756 @item -mno-sched-br-data-spec
19757 @itemx -msched-br-data-spec
19758 @opindex mno-sched-br-data-spec
19759 @opindex msched-br-data-spec
19760 (Dis/En)able data speculative scheduling before reload.
19761 This results in generation of @code{ld.a} instructions and
19762 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19763 The default setting is disabled.
19765 @item -msched-ar-data-spec
19766 @itemx -mno-sched-ar-data-spec
19767 @opindex msched-ar-data-spec
19768 @opindex mno-sched-ar-data-spec
19769 (En/Dis)able data speculative scheduling after reload.
19770 This results in generation of @code{ld.a} instructions and
19771 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19772 The default setting is enabled.
19774 @item -mno-sched-control-spec
19775 @itemx -msched-control-spec
19776 @opindex mno-sched-control-spec
19777 @opindex msched-control-spec
19778 (Dis/En)able control speculative scheduling.  This feature is
19779 available only during region scheduling (i.e.@: before reload).
19780 This results in generation of the @code{ld.s} instructions and
19781 the corresponding check instructions @code{chk.s}.
19782 The default setting is disabled.
19784 @item -msched-br-in-data-spec
19785 @itemx -mno-sched-br-in-data-spec
19786 @opindex msched-br-in-data-spec
19787 @opindex mno-sched-br-in-data-spec
19788 (En/Dis)able speculative scheduling of the instructions that
19789 are dependent on the data speculative loads before reload.
19790 This is effective only with @option{-msched-br-data-spec} enabled.
19791 The default setting is enabled.
19793 @item -msched-ar-in-data-spec
19794 @itemx -mno-sched-ar-in-data-spec
19795 @opindex msched-ar-in-data-spec
19796 @opindex mno-sched-ar-in-data-spec
19797 (En/Dis)able speculative scheduling of the instructions that
19798 are dependent on the data speculative loads after reload.
19799 This is effective only with @option{-msched-ar-data-spec} enabled.
19800 The default setting is enabled.
19802 @item -msched-in-control-spec
19803 @itemx -mno-sched-in-control-spec
19804 @opindex msched-in-control-spec
19805 @opindex mno-sched-in-control-spec
19806 (En/Dis)able speculative scheduling of the instructions that
19807 are dependent on the control speculative loads.
19808 This is effective only with @option{-msched-control-spec} enabled.
19809 The default setting is enabled.
19811 @item -mno-sched-prefer-non-data-spec-insns
19812 @itemx -msched-prefer-non-data-spec-insns
19813 @opindex mno-sched-prefer-non-data-spec-insns
19814 @opindex msched-prefer-non-data-spec-insns
19815 If enabled, data-speculative instructions are chosen for schedule
19816 only if there are no other choices at the moment.  This makes
19817 the use of the data speculation much more conservative.
19818 The default setting is disabled.
19820 @item -mno-sched-prefer-non-control-spec-insns
19821 @itemx -msched-prefer-non-control-spec-insns
19822 @opindex mno-sched-prefer-non-control-spec-insns
19823 @opindex msched-prefer-non-control-spec-insns
19824 If enabled, control-speculative instructions are chosen for schedule
19825 only if there are no other choices at the moment.  This makes
19826 the use of the control speculation much more conservative.
19827 The default setting is disabled.
19829 @item -mno-sched-count-spec-in-critical-path
19830 @itemx -msched-count-spec-in-critical-path
19831 @opindex mno-sched-count-spec-in-critical-path
19832 @opindex msched-count-spec-in-critical-path
19833 If enabled, speculative dependencies are considered during
19834 computation of the instructions priorities.  This makes the use of the
19835 speculation a bit more conservative.
19836 The default setting is disabled.
19838 @item -msched-spec-ldc
19839 @opindex msched-spec-ldc
19840 Use a simple data speculation check.  This option is on by default.
19842 @item -msched-control-spec-ldc
19843 @opindex msched-spec-ldc
19844 Use a simple check for control speculation.  This option is on by default.
19846 @item -msched-stop-bits-after-every-cycle
19847 @opindex msched-stop-bits-after-every-cycle
19848 Place a stop bit after every cycle when scheduling.  This option is on
19849 by default.
19851 @item -msched-fp-mem-deps-zero-cost
19852 @opindex msched-fp-mem-deps-zero-cost
19853 Assume that floating-point stores and loads are not likely to cause a conflict
19854 when placed into the same instruction group.  This option is disabled by
19855 default.
19857 @item -msel-sched-dont-check-control-spec
19858 @opindex msel-sched-dont-check-control-spec
19859 Generate checks for control speculation in selective scheduling.
19860 This flag is disabled by default.
19862 @item -msched-max-memory-insns=@var{max-insns}
19863 @opindex msched-max-memory-insns
19864 Limit on the number of memory insns per instruction group, giving lower
19865 priority to subsequent memory insns attempting to schedule in the same
19866 instruction group. Frequently useful to prevent cache bank conflicts.
19867 The default value is 1.
19869 @item -msched-max-memory-insns-hard-limit
19870 @opindex msched-max-memory-insns-hard-limit
19871 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19872 disallowing more than that number in an instruction group.
19873 Otherwise, the limit is ``soft'', meaning that non-memory operations
19874 are preferred when the limit is reached, but memory operations may still
19875 be scheduled.
19877 @end table
19879 @node LM32 Options
19880 @subsection LM32 Options
19881 @cindex LM32 options
19883 These @option{-m} options are defined for the LatticeMico32 architecture:
19885 @table @gcctabopt
19886 @item -mbarrel-shift-enabled
19887 @opindex mbarrel-shift-enabled
19888 Enable barrel-shift instructions.
19890 @item -mdivide-enabled
19891 @opindex mdivide-enabled
19892 Enable divide and modulus instructions.
19894 @item -mmultiply-enabled
19895 @opindex multiply-enabled
19896 Enable multiply instructions.
19898 @item -msign-extend-enabled
19899 @opindex msign-extend-enabled
19900 Enable sign extend instructions.
19902 @item -muser-enabled
19903 @opindex muser-enabled
19904 Enable user-defined instructions.
19906 @end table
19908 @node M32C Options
19909 @subsection M32C Options
19910 @cindex M32C options
19912 @table @gcctabopt
19913 @item -mcpu=@var{name}
19914 @opindex mcpu=
19915 Select the CPU for which code is generated.  @var{name} may be one of
19916 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19917 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19918 the M32C/80 series.
19920 @item -msim
19921 @opindex msim
19922 Specifies that the program will be run on the simulator.  This causes
19923 an alternate runtime library to be linked in which supports, for
19924 example, file I/O@.  You must not use this option when generating
19925 programs that will run on real hardware; you must provide your own
19926 runtime library for whatever I/O functions are needed.
19928 @item -memregs=@var{number}
19929 @opindex memregs=
19930 Specifies the number of memory-based pseudo-registers GCC uses
19931 during code generation.  These pseudo-registers are used like real
19932 registers, so there is a tradeoff between GCC's ability to fit the
19933 code into available registers, and the performance penalty of using
19934 memory instead of registers.  Note that all modules in a program must
19935 be compiled with the same value for this option.  Because of that, you
19936 must not use this option with GCC's default runtime libraries.
19938 @end table
19940 @node M32R/D Options
19941 @subsection M32R/D Options
19942 @cindex M32R/D options
19944 These @option{-m} options are defined for Renesas M32R/D architectures:
19946 @table @gcctabopt
19947 @item -m32r2
19948 @opindex m32r2
19949 Generate code for the M32R/2@.
19951 @item -m32rx
19952 @opindex m32rx
19953 Generate code for the M32R/X@.
19955 @item -m32r
19956 @opindex m32r
19957 Generate code for the M32R@.  This is the default.
19959 @item -mmodel=small
19960 @opindex mmodel=small
19961 Assume all objects live in the lower 16MB of memory (so that their addresses
19962 can be loaded with the @code{ld24} instruction), and assume all subroutines
19963 are reachable with the @code{bl} instruction.
19964 This is the default.
19966 The addressability of a particular object can be set with the
19967 @code{model} attribute.
19969 @item -mmodel=medium
19970 @opindex mmodel=medium
19971 Assume objects may be anywhere in the 32-bit address space (the compiler
19972 generates @code{seth/add3} instructions to load their addresses), and
19973 assume all subroutines are reachable with the @code{bl} instruction.
19975 @item -mmodel=large
19976 @opindex mmodel=large
19977 Assume objects may be anywhere in the 32-bit address space (the compiler
19978 generates @code{seth/add3} instructions to load their addresses), and
19979 assume subroutines may not be reachable with the @code{bl} instruction
19980 (the compiler generates the much slower @code{seth/add3/jl}
19981 instruction sequence).
19983 @item -msdata=none
19984 @opindex msdata=none
19985 Disable use of the small data area.  Variables are put into
19986 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19987 @code{section} attribute has been specified).
19988 This is the default.
19990 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19991 Objects may be explicitly put in the small data area with the
19992 @code{section} attribute using one of these sections.
19994 @item -msdata=sdata
19995 @opindex msdata=sdata
19996 Put small global and static data in the small data area, but do not
19997 generate special code to reference them.
19999 @item -msdata=use
20000 @opindex msdata=use
20001 Put small global and static data in the small data area, and generate
20002 special instructions to reference them.
20004 @item -G @var{num}
20005 @opindex G
20006 @cindex smaller data references
20007 Put global and static objects less than or equal to @var{num} bytes
20008 into the small data or BSS sections instead of the normal data or BSS
20009 sections.  The default value of @var{num} is 8.
20010 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
20011 for this option to have any effect.
20013 All modules should be compiled with the same @option{-G @var{num}} value.
20014 Compiling with different values of @var{num} may or may not work; if it
20015 doesn't the linker gives an error message---incorrect code is not
20016 generated.
20018 @item -mdebug
20019 @opindex mdebug
20020 Makes the M32R-specific code in the compiler display some statistics
20021 that might help in debugging programs.
20023 @item -malign-loops
20024 @opindex malign-loops
20025 Align all loops to a 32-byte boundary.
20027 @item -mno-align-loops
20028 @opindex mno-align-loops
20029 Do not enforce a 32-byte alignment for loops.  This is the default.
20031 @item -missue-rate=@var{number}
20032 @opindex missue-rate=@var{number}
20033 Issue @var{number} instructions per cycle.  @var{number} can only be 1
20034 or 2.
20036 @item -mbranch-cost=@var{number}
20037 @opindex mbranch-cost=@var{number}
20038 @var{number} can only be 1 or 2.  If it is 1 then branches are
20039 preferred over conditional code, if it is 2, then the opposite applies.
20041 @item -mflush-trap=@var{number}
20042 @opindex mflush-trap=@var{number}
20043 Specifies the trap number to use to flush the cache.  The default is
20044 12.  Valid numbers are between 0 and 15 inclusive.
20046 @item -mno-flush-trap
20047 @opindex mno-flush-trap
20048 Specifies that the cache cannot be flushed by using a trap.
20050 @item -mflush-func=@var{name}
20051 @opindex mflush-func=@var{name}
20052 Specifies the name of the operating system function to call to flush
20053 the cache.  The default is @samp{_flush_cache}, but a function call
20054 is only used if a trap is not available.
20056 @item -mno-flush-func
20057 @opindex mno-flush-func
20058 Indicates that there is no OS function for flushing the cache.
20060 @end table
20062 @node M680x0 Options
20063 @subsection M680x0 Options
20064 @cindex M680x0 options
20066 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
20067 The default settings depend on which architecture was selected when
20068 the compiler was configured; the defaults for the most common choices
20069 are given below.
20071 @table @gcctabopt
20072 @item -march=@var{arch}
20073 @opindex march
20074 Generate code for a specific M680x0 or ColdFire instruction set
20075 architecture.  Permissible values of @var{arch} for M680x0
20076 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
20077 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
20078 architectures are selected according to Freescale's ISA classification
20079 and the permissible values are: @samp{isaa}, @samp{isaaplus},
20080 @samp{isab} and @samp{isac}.
20082 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
20083 code for a ColdFire target.  The @var{arch} in this macro is one of the
20084 @option{-march} arguments given above.
20086 When used together, @option{-march} and @option{-mtune} select code
20087 that runs on a family of similar processors but that is optimized
20088 for a particular microarchitecture.
20090 @item -mcpu=@var{cpu}
20091 @opindex mcpu
20092 Generate code for a specific M680x0 or ColdFire processor.
20093 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
20094 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
20095 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
20096 below, which also classifies the CPUs into families:
20098 @multitable @columnfractions 0.20 0.80
20099 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
20100 @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}
20101 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
20102 @item @samp{5206e} @tab @samp{5206e}
20103 @item @samp{5208} @tab @samp{5207} @samp{5208}
20104 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
20105 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
20106 @item @samp{5216} @tab @samp{5214} @samp{5216}
20107 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
20108 @item @samp{5225} @tab @samp{5224} @samp{5225}
20109 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
20110 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
20111 @item @samp{5249} @tab @samp{5249}
20112 @item @samp{5250} @tab @samp{5250}
20113 @item @samp{5271} @tab @samp{5270} @samp{5271}
20114 @item @samp{5272} @tab @samp{5272}
20115 @item @samp{5275} @tab @samp{5274} @samp{5275}
20116 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
20117 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
20118 @item @samp{5307} @tab @samp{5307}
20119 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
20120 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
20121 @item @samp{5407} @tab @samp{5407}
20122 @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}
20123 @end multitable
20125 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
20126 @var{arch} is compatible with @var{cpu}.  Other combinations of
20127 @option{-mcpu} and @option{-march} are rejected.
20129 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
20130 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
20131 where the value of @var{family} is given by the table above.
20133 @item -mtune=@var{tune}
20134 @opindex mtune
20135 Tune the code for a particular microarchitecture within the
20136 constraints set by @option{-march} and @option{-mcpu}.
20137 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
20138 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
20139 and @samp{cpu32}.  The ColdFire microarchitectures
20140 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
20142 You can also use @option{-mtune=68020-40} for code that needs
20143 to run relatively well on 68020, 68030 and 68040 targets.
20144 @option{-mtune=68020-60} is similar but includes 68060 targets
20145 as well.  These two options select the same tuning decisions as
20146 @option{-m68020-40} and @option{-m68020-60} respectively.
20148 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
20149 when tuning for 680x0 architecture @var{arch}.  It also defines
20150 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
20151 option is used.  If GCC is tuning for a range of architectures,
20152 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
20153 it defines the macros for every architecture in the range.
20155 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
20156 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
20157 of the arguments given above.
20159 @item -m68000
20160 @itemx -mc68000
20161 @opindex m68000
20162 @opindex mc68000
20163 Generate output for a 68000.  This is the default
20164 when the compiler is configured for 68000-based systems.
20165 It is equivalent to @option{-march=68000}.
20167 Use this option for microcontrollers with a 68000 or EC000 core,
20168 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
20170 @item -m68010
20171 @opindex m68010
20172 Generate output for a 68010.  This is the default
20173 when the compiler is configured for 68010-based systems.
20174 It is equivalent to @option{-march=68010}.
20176 @item -m68020
20177 @itemx -mc68020
20178 @opindex m68020
20179 @opindex mc68020
20180 Generate output for a 68020.  This is the default
20181 when the compiler is configured for 68020-based systems.
20182 It is equivalent to @option{-march=68020}.
20184 @item -m68030
20185 @opindex m68030
20186 Generate output for a 68030.  This is the default when the compiler is
20187 configured for 68030-based systems.  It is equivalent to
20188 @option{-march=68030}.
20190 @item -m68040
20191 @opindex m68040
20192 Generate output for a 68040.  This is the default when the compiler is
20193 configured for 68040-based systems.  It is equivalent to
20194 @option{-march=68040}.
20196 This option inhibits the use of 68881/68882 instructions that have to be
20197 emulated by software on the 68040.  Use this option if your 68040 does not
20198 have code to emulate those instructions.
20200 @item -m68060
20201 @opindex m68060
20202 Generate output for a 68060.  This is the default when the compiler is
20203 configured for 68060-based systems.  It is equivalent to
20204 @option{-march=68060}.
20206 This option inhibits the use of 68020 and 68881/68882 instructions that
20207 have to be emulated by software on the 68060.  Use this option if your 68060
20208 does not have code to emulate those instructions.
20210 @item -mcpu32
20211 @opindex mcpu32
20212 Generate output for a CPU32.  This is the default
20213 when the compiler is configured for CPU32-based systems.
20214 It is equivalent to @option{-march=cpu32}.
20216 Use this option for microcontrollers with a
20217 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
20218 68336, 68340, 68341, 68349 and 68360.
20220 @item -m5200
20221 @opindex m5200
20222 Generate output for a 520X ColdFire CPU@.  This is the default
20223 when the compiler is configured for 520X-based systems.
20224 It is equivalent to @option{-mcpu=5206}, and is now deprecated
20225 in favor of that option.
20227 Use this option for microcontroller with a 5200 core, including
20228 the MCF5202, MCF5203, MCF5204 and MCF5206.
20230 @item -m5206e
20231 @opindex m5206e
20232 Generate output for a 5206e ColdFire CPU@.  The option is now
20233 deprecated in favor of the equivalent @option{-mcpu=5206e}.
20235 @item -m528x
20236 @opindex m528x
20237 Generate output for a member of the ColdFire 528X family.
20238 The option is now deprecated in favor of the equivalent
20239 @option{-mcpu=528x}.
20241 @item -m5307
20242 @opindex m5307
20243 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
20244 in favor of the equivalent @option{-mcpu=5307}.
20246 @item -m5407
20247 @opindex m5407
20248 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
20249 in favor of the equivalent @option{-mcpu=5407}.
20251 @item -mcfv4e
20252 @opindex mcfv4e
20253 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
20254 This includes use of hardware floating-point instructions.
20255 The option is equivalent to @option{-mcpu=547x}, and is now
20256 deprecated in favor of that option.
20258 @item -m68020-40
20259 @opindex m68020-40
20260 Generate output for a 68040, without using any of the new instructions.
20261 This results in code that can run relatively efficiently on either a
20262 68020/68881 or a 68030 or a 68040.  The generated code does use the
20263 68881 instructions that are emulated on the 68040.
20265 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
20267 @item -m68020-60
20268 @opindex m68020-60
20269 Generate output for a 68060, without using any of the new instructions.
20270 This results in code that can run relatively efficiently on either a
20271 68020/68881 or a 68030 or a 68040.  The generated code does use the
20272 68881 instructions that are emulated on the 68060.
20274 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
20276 @item -mhard-float
20277 @itemx -m68881
20278 @opindex mhard-float
20279 @opindex m68881
20280 Generate floating-point instructions.  This is the default for 68020
20281 and above, and for ColdFire devices that have an FPU@.  It defines the
20282 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
20283 on ColdFire targets.
20285 @item -msoft-float
20286 @opindex msoft-float
20287 Do not generate floating-point instructions; use library calls instead.
20288 This is the default for 68000, 68010, and 68832 targets.  It is also
20289 the default for ColdFire devices that have no FPU.
20291 @item -mdiv
20292 @itemx -mno-div
20293 @opindex mdiv
20294 @opindex mno-div
20295 Generate (do not generate) ColdFire hardware divide and remainder
20296 instructions.  If @option{-march} is used without @option{-mcpu},
20297 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
20298 architectures.  Otherwise, the default is taken from the target CPU
20299 (either the default CPU, or the one specified by @option{-mcpu}).  For
20300 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
20301 @option{-mcpu=5206e}.
20303 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
20305 @item -mshort
20306 @opindex mshort
20307 Consider type @code{int} to be 16 bits wide, like @code{short int}.
20308 Additionally, parameters passed on the stack are also aligned to a
20309 16-bit boundary even on targets whose API mandates promotion to 32-bit.
20311 @item -mno-short
20312 @opindex mno-short
20313 Do not consider type @code{int} to be 16 bits wide.  This is the default.
20315 @item -mnobitfield
20316 @itemx -mno-bitfield
20317 @opindex mnobitfield
20318 @opindex mno-bitfield
20319 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
20320 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
20322 @item -mbitfield
20323 @opindex mbitfield
20324 Do use the bit-field instructions.  The @option{-m68020} option implies
20325 @option{-mbitfield}.  This is the default if you use a configuration
20326 designed for a 68020.
20328 @item -mrtd
20329 @opindex mrtd
20330 Use a different function-calling convention, in which functions
20331 that take a fixed number of arguments return with the @code{rtd}
20332 instruction, which pops their arguments while returning.  This
20333 saves one instruction in the caller since there is no need to pop
20334 the arguments there.
20336 This calling convention is incompatible with the one normally
20337 used on Unix, so you cannot use it if you need to call libraries
20338 compiled with the Unix compiler.
20340 Also, you must provide function prototypes for all functions that
20341 take variable numbers of arguments (including @code{printf});
20342 otherwise incorrect code is generated for calls to those
20343 functions.
20345 In addition, seriously incorrect code results if you call a
20346 function with too many arguments.  (Normally, extra arguments are
20347 harmlessly ignored.)
20349 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
20350 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
20352 @item -mno-rtd
20353 @opindex mno-rtd
20354 Do not use the calling conventions selected by @option{-mrtd}.
20355 This is the default.
20357 @item -malign-int
20358 @itemx -mno-align-int
20359 @opindex malign-int
20360 @opindex mno-align-int
20361 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
20362 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
20363 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
20364 Aligning variables on 32-bit boundaries produces code that runs somewhat
20365 faster on processors with 32-bit busses at the expense of more memory.
20367 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
20368 aligns structures containing the above types differently than
20369 most published application binary interface specifications for the m68k.
20371 @item -mpcrel
20372 @opindex mpcrel
20373 Use the pc-relative addressing mode of the 68000 directly, instead of
20374 using a global offset table.  At present, this option implies @option{-fpic},
20375 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
20376 not presently supported with @option{-mpcrel}, though this could be supported for
20377 68020 and higher processors.
20379 @item -mno-strict-align
20380 @itemx -mstrict-align
20381 @opindex mno-strict-align
20382 @opindex mstrict-align
20383 Do not (do) assume that unaligned memory references are handled by
20384 the system.
20386 @item -msep-data
20387 Generate code that allows the data segment to be located in a different
20388 area of memory from the text segment.  This allows for execute-in-place in
20389 an environment without virtual memory management.  This option implies
20390 @option{-fPIC}.
20392 @item -mno-sep-data
20393 Generate code that assumes that the data segment follows the text segment.
20394 This is the default.
20396 @item -mid-shared-library
20397 Generate code that supports shared libraries via the library ID method.
20398 This allows for execute-in-place and shared libraries in an environment
20399 without virtual memory management.  This option implies @option{-fPIC}.
20401 @item -mno-id-shared-library
20402 Generate code that doesn't assume ID-based shared libraries are being used.
20403 This is the default.
20405 @item -mshared-library-id=n
20406 Specifies the identification number of the ID-based shared library being
20407 compiled.  Specifying a value of 0 generates more compact code; specifying
20408 other values forces the allocation of that number to the current
20409 library, but is no more space- or time-efficient than omitting this option.
20411 @item -mxgot
20412 @itemx -mno-xgot
20413 @opindex mxgot
20414 @opindex mno-xgot
20415 When generating position-independent code for ColdFire, generate code
20416 that works if the GOT has more than 8192 entries.  This code is
20417 larger and slower than code generated without this option.  On M680x0
20418 processors, this option is not needed; @option{-fPIC} suffices.
20420 GCC normally uses a single instruction to load values from the GOT@.
20421 While this is relatively efficient, it only works if the GOT
20422 is smaller than about 64k.  Anything larger causes the linker
20423 to report an error such as:
20425 @cindex relocation truncated to fit (ColdFire)
20426 @smallexample
20427 relocation truncated to fit: R_68K_GOT16O foobar
20428 @end smallexample
20430 If this happens, you should recompile your code with @option{-mxgot}.
20431 It should then work with very large GOTs.  However, code generated with
20432 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
20433 the value of a global symbol.
20435 Note that some linkers, including newer versions of the GNU linker,
20436 can create multiple GOTs and sort GOT entries.  If you have such a linker,
20437 you should only need to use @option{-mxgot} when compiling a single
20438 object file that accesses more than 8192 GOT entries.  Very few do.
20440 These options have no effect unless GCC is generating
20441 position-independent code.
20443 @item -mlong-jump-table-offsets
20444 @opindex mlong-jump-table-offsets
20445 Use 32-bit offsets in @code{switch} tables.  The default is to use
20446 16-bit offsets.
20448 @end table
20450 @node MCore Options
20451 @subsection MCore Options
20452 @cindex MCore options
20454 These are the @samp{-m} options defined for the Motorola M*Core
20455 processors.
20457 @table @gcctabopt
20459 @item -mhardlit
20460 @itemx -mno-hardlit
20461 @opindex mhardlit
20462 @opindex mno-hardlit
20463 Inline constants into the code stream if it can be done in two
20464 instructions or less.
20466 @item -mdiv
20467 @itemx -mno-div
20468 @opindex mdiv
20469 @opindex mno-div
20470 Use the divide instruction.  (Enabled by default).
20472 @item -mrelax-immediate
20473 @itemx -mno-relax-immediate
20474 @opindex mrelax-immediate
20475 @opindex mno-relax-immediate
20476 Allow arbitrary-sized immediates in bit operations.
20478 @item -mwide-bitfields
20479 @itemx -mno-wide-bitfields
20480 @opindex mwide-bitfields
20481 @opindex mno-wide-bitfields
20482 Always treat bit-fields as @code{int}-sized.
20484 @item -m4byte-functions
20485 @itemx -mno-4byte-functions
20486 @opindex m4byte-functions
20487 @opindex mno-4byte-functions
20488 Force all functions to be aligned to a 4-byte boundary.
20490 @item -mcallgraph-data
20491 @itemx -mno-callgraph-data
20492 @opindex mcallgraph-data
20493 @opindex mno-callgraph-data
20494 Emit callgraph information.
20496 @item -mslow-bytes
20497 @itemx -mno-slow-bytes
20498 @opindex mslow-bytes
20499 @opindex mno-slow-bytes
20500 Prefer word access when reading byte quantities.
20502 @item -mlittle-endian
20503 @itemx -mbig-endian
20504 @opindex mlittle-endian
20505 @opindex mbig-endian
20506 Generate code for a little-endian target.
20508 @item -m210
20509 @itemx -m340
20510 @opindex m210
20511 @opindex m340
20512 Generate code for the 210 processor.
20514 @item -mno-lsim
20515 @opindex mno-lsim
20516 Assume that runtime support has been provided and so omit the
20517 simulator library (@file{libsim.a)} from the linker command line.
20519 @item -mstack-increment=@var{size}
20520 @opindex mstack-increment
20521 Set the maximum amount for a single stack increment operation.  Large
20522 values can increase the speed of programs that contain functions
20523 that need a large amount of stack space, but they can also trigger a
20524 segmentation fault if the stack is extended too much.  The default
20525 value is 0x1000.
20527 @end table
20529 @node MeP Options
20530 @subsection MeP Options
20531 @cindex MeP options
20533 @table @gcctabopt
20535 @item -mabsdiff
20536 @opindex mabsdiff
20537 Enables the @code{abs} instruction, which is the absolute difference
20538 between two registers.
20540 @item -mall-opts
20541 @opindex mall-opts
20542 Enables all the optional instructions---average, multiply, divide, bit
20543 operations, leading zero, absolute difference, min/max, clip, and
20544 saturation.
20547 @item -maverage
20548 @opindex maverage
20549 Enables the @code{ave} instruction, which computes the average of two
20550 registers.
20552 @item -mbased=@var{n}
20553 @opindex mbased=
20554 Variables of size @var{n} bytes or smaller are placed in the
20555 @code{.based} section by default.  Based variables use the @code{$tp}
20556 register as a base register, and there is a 128-byte limit to the
20557 @code{.based} section.
20559 @item -mbitops
20560 @opindex mbitops
20561 Enables the bit operation instructions---bit test (@code{btstm}), set
20562 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
20563 test-and-set (@code{tas}).
20565 @item -mc=@var{name}
20566 @opindex mc=
20567 Selects which section constant data is placed in.  @var{name} may
20568 be @samp{tiny}, @samp{near}, or @samp{far}.
20570 @item -mclip
20571 @opindex mclip
20572 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
20573 useful unless you also provide @option{-mminmax}.
20575 @item -mconfig=@var{name}
20576 @opindex mconfig=
20577 Selects one of the built-in core configurations.  Each MeP chip has
20578 one or more modules in it; each module has a core CPU and a variety of
20579 coprocessors, optional instructions, and peripherals.  The
20580 @code{MeP-Integrator} tool, not part of GCC, provides these
20581 configurations through this option; using this option is the same as
20582 using all the corresponding command-line options.  The default
20583 configuration is @samp{default}.
20585 @item -mcop
20586 @opindex mcop
20587 Enables the coprocessor instructions.  By default, this is a 32-bit
20588 coprocessor.  Note that the coprocessor is normally enabled via the
20589 @option{-mconfig=} option.
20591 @item -mcop32
20592 @opindex mcop32
20593 Enables the 32-bit coprocessor's instructions.
20595 @item -mcop64
20596 @opindex mcop64
20597 Enables the 64-bit coprocessor's instructions.
20599 @item -mivc2
20600 @opindex mivc2
20601 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
20603 @item -mdc
20604 @opindex mdc
20605 Causes constant variables to be placed in the @code{.near} section.
20607 @item -mdiv
20608 @opindex mdiv
20609 Enables the @code{div} and @code{divu} instructions.
20611 @item -meb
20612 @opindex meb
20613 Generate big-endian code.
20615 @item -mel
20616 @opindex mel
20617 Generate little-endian code.
20619 @item -mio-volatile
20620 @opindex mio-volatile
20621 Tells the compiler that any variable marked with the @code{io}
20622 attribute is to be considered volatile.
20624 @item -ml
20625 @opindex ml
20626 Causes variables to be assigned to the @code{.far} section by default.
20628 @item -mleadz
20629 @opindex mleadz
20630 Enables the @code{leadz} (leading zero) instruction.
20632 @item -mm
20633 @opindex mm
20634 Causes variables to be assigned to the @code{.near} section by default.
20636 @item -mminmax
20637 @opindex mminmax
20638 Enables the @code{min} and @code{max} instructions.
20640 @item -mmult
20641 @opindex mmult
20642 Enables the multiplication and multiply-accumulate instructions.
20644 @item -mno-opts
20645 @opindex mno-opts
20646 Disables all the optional instructions enabled by @option{-mall-opts}.
20648 @item -mrepeat
20649 @opindex mrepeat
20650 Enables the @code{repeat} and @code{erepeat} instructions, used for
20651 low-overhead looping.
20653 @item -ms
20654 @opindex ms
20655 Causes all variables to default to the @code{.tiny} section.  Note
20656 that there is a 65536-byte limit to this section.  Accesses to these
20657 variables use the @code{%gp} base register.
20659 @item -msatur
20660 @opindex msatur
20661 Enables the saturation instructions.  Note that the compiler does not
20662 currently generate these itself, but this option is included for
20663 compatibility with other tools, like @code{as}.
20665 @item -msdram
20666 @opindex msdram
20667 Link the SDRAM-based runtime instead of the default ROM-based runtime.
20669 @item -msim
20670 @opindex msim
20671 Link the simulator run-time libraries.
20673 @item -msimnovec
20674 @opindex msimnovec
20675 Link the simulator runtime libraries, excluding built-in support
20676 for reset and exception vectors and tables.
20678 @item -mtf
20679 @opindex mtf
20680 Causes all functions to default to the @code{.far} section.  Without
20681 this option, functions default to the @code{.near} section.
20683 @item -mtiny=@var{n}
20684 @opindex mtiny=
20685 Variables that are @var{n} bytes or smaller are allocated to the
20686 @code{.tiny} section.  These variables use the @code{$gp} base
20687 register.  The default for this option is 4, but note that there's a
20688 65536-byte limit to the @code{.tiny} section.
20690 @end table
20692 @node MicroBlaze Options
20693 @subsection MicroBlaze Options
20694 @cindex MicroBlaze Options
20696 @table @gcctabopt
20698 @item -msoft-float
20699 @opindex msoft-float
20700 Use software emulation for floating point (default).
20702 @item -mhard-float
20703 @opindex mhard-float
20704 Use hardware floating-point instructions.
20706 @item -mmemcpy
20707 @opindex mmemcpy
20708 Do not optimize block moves, use @code{memcpy}.
20710 @item -mno-clearbss
20711 @opindex mno-clearbss
20712 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20714 @item -mcpu=@var{cpu-type}
20715 @opindex mcpu=
20716 Use features of, and schedule code for, the given CPU.
20717 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20718 where @var{X} is a major version, @var{YY} is the minor version, and
20719 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20720 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v6.00.a}.
20722 @item -mxl-soft-mul
20723 @opindex mxl-soft-mul
20724 Use software multiply emulation (default).
20726 @item -mxl-soft-div
20727 @opindex mxl-soft-div
20728 Use software emulation for divides (default).
20730 @item -mxl-barrel-shift
20731 @opindex mxl-barrel-shift
20732 Use the hardware barrel shifter.
20734 @item -mxl-pattern-compare
20735 @opindex mxl-pattern-compare
20736 Use pattern compare instructions.
20738 @item -msmall-divides
20739 @opindex msmall-divides
20740 Use table lookup optimization for small signed integer divisions.
20742 @item -mxl-stack-check
20743 @opindex mxl-stack-check
20744 This option is deprecated.  Use @option{-fstack-check} instead.
20746 @item -mxl-gp-opt
20747 @opindex mxl-gp-opt
20748 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20750 @item -mxl-multiply-high
20751 @opindex mxl-multiply-high
20752 Use multiply high instructions for high part of 32x32 multiply.
20754 @item -mxl-float-convert
20755 @opindex mxl-float-convert
20756 Use hardware floating-point conversion instructions.
20758 @item -mxl-float-sqrt
20759 @opindex mxl-float-sqrt
20760 Use hardware floating-point square root instruction.
20762 @item -mbig-endian
20763 @opindex mbig-endian
20764 Generate code for a big-endian target.
20766 @item -mlittle-endian
20767 @opindex mlittle-endian
20768 Generate code for a little-endian target.
20770 @item -mxl-reorder
20771 @opindex mxl-reorder
20772 Use reorder instructions (swap and byte reversed load/store).
20774 @item -mxl-mode-@var{app-model}
20775 Select application model @var{app-model}.  Valid models are
20776 @table @samp
20777 @item executable
20778 normal executable (default), uses startup code @file{crt0.o}.
20780 @item -mpic-data-is-text-relative
20781 @opindex mpic-data-is-text-relative
20782 Assume that the displacement between the text and data segments is fixed
20783 at static link time.  This allows data to be referenced by offset from start of
20784 text address instead of GOT since PC-relative addressing is not supported.
20786 @item xmdstub
20787 for use with Xilinx Microprocessor Debugger (XMD) based
20788 software intrusive debug agent called xmdstub. This uses startup file
20789 @file{crt1.o} and sets the start address of the program to 0x800.
20791 @item bootstrap
20792 for applications that are loaded using a bootloader.
20793 This model uses startup file @file{crt2.o} which does not contain a processor
20794 reset vector handler. This is suitable for transferring control on a
20795 processor reset to the bootloader rather than the application.
20797 @item novectors
20798 for applications that do not require any of the
20799 MicroBlaze vectors. This option may be useful for applications running
20800 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20801 @end table
20803 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20804 @option{-mxl-mode-@var{app-model}}.
20806 @end table
20808 @node MIPS Options
20809 @subsection MIPS Options
20810 @cindex MIPS options
20812 @table @gcctabopt
20814 @item -EB
20815 @opindex EB
20816 Generate big-endian code.
20818 @item -EL
20819 @opindex EL
20820 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20821 configurations.
20823 @item -march=@var{arch}
20824 @opindex march
20825 Generate code that runs on @var{arch}, which can be the name of a
20826 generic MIPS ISA, or the name of a particular processor.
20827 The ISA names are:
20828 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20829 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20830 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20831 @samp{mips64r5} and @samp{mips64r6}.
20832 The processor names are:
20833 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20834 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20835 @samp{5kc}, @samp{5kf},
20836 @samp{20kc},
20837 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20838 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20839 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20840 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20841 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20842 @samp{i6400}, @samp{i6500},
20843 @samp{interaptiv},
20844 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a}, @samp{gs464},
20845 @samp{gs464e}, @samp{gs264e},
20846 @samp{m4k},
20847 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20848 @samp{m5100}, @samp{m5101},
20849 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20850 @samp{orion},
20851 @samp{p5600}, @samp{p6600},
20852 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20853 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20854 @samp{rm7000}, @samp{rm9000},
20855 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20856 @samp{sb1},
20857 @samp{sr71000},
20858 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20859 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20860 @samp{xlr} and @samp{xlp}.
20861 The special value @samp{from-abi} selects the
20862 most compatible architecture for the selected ABI (that is,
20863 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20865 The native Linux/GNU toolchain also supports the value @samp{native},
20866 which selects the best architecture option for the host processor.
20867 @option{-march=native} has no effect if GCC does not recognize
20868 the processor.
20870 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20871 (for example, @option{-march=r2k}).  Prefixes are optional, and
20872 @samp{vr} may be written @samp{r}.
20874 Names of the form @samp{@var{n}f2_1} refer to processors with
20875 FPUs clocked at half the rate of the core, names of the form
20876 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20877 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20878 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20879 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20880 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20881 accepted as synonyms for @samp{@var{n}f1_1}.
20883 GCC defines two macros based on the value of this option.  The first
20884 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20885 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20886 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20887 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20888 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20890 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20891 above.  In other words, it has the full prefix and does not
20892 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20893 the macro names the resolved architecture (either @code{"mips1"} or
20894 @code{"mips3"}).  It names the default architecture when no
20895 @option{-march} option is given.
20897 @item -mtune=@var{arch}
20898 @opindex mtune
20899 Optimize for @var{arch}.  Among other things, this option controls
20900 the way instructions are scheduled, and the perceived cost of arithmetic
20901 operations.  The list of @var{arch} values is the same as for
20902 @option{-march}.
20904 When this option is not used, GCC optimizes for the processor
20905 specified by @option{-march}.  By using @option{-march} and
20906 @option{-mtune} together, it is possible to generate code that
20907 runs on a family of processors, but optimize the code for one
20908 particular member of that family.
20910 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20911 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20912 @option{-march} ones described above.
20914 @item -mips1
20915 @opindex mips1
20916 Equivalent to @option{-march=mips1}.
20918 @item -mips2
20919 @opindex mips2
20920 Equivalent to @option{-march=mips2}.
20922 @item -mips3
20923 @opindex mips3
20924 Equivalent to @option{-march=mips3}.
20926 @item -mips4
20927 @opindex mips4
20928 Equivalent to @option{-march=mips4}.
20930 @item -mips32
20931 @opindex mips32
20932 Equivalent to @option{-march=mips32}.
20934 @item -mips32r3
20935 @opindex mips32r3
20936 Equivalent to @option{-march=mips32r3}.
20938 @item -mips32r5
20939 @opindex mips32r5
20940 Equivalent to @option{-march=mips32r5}.
20942 @item -mips32r6
20943 @opindex mips32r6
20944 Equivalent to @option{-march=mips32r6}.
20946 @item -mips64
20947 @opindex mips64
20948 Equivalent to @option{-march=mips64}.
20950 @item -mips64r2
20951 @opindex mips64r2
20952 Equivalent to @option{-march=mips64r2}.
20954 @item -mips64r3
20955 @opindex mips64r3
20956 Equivalent to @option{-march=mips64r3}.
20958 @item -mips64r5
20959 @opindex mips64r5
20960 Equivalent to @option{-march=mips64r5}.
20962 @item -mips64r6
20963 @opindex mips64r6
20964 Equivalent to @option{-march=mips64r6}.
20966 @item -mips16
20967 @itemx -mno-mips16
20968 @opindex mips16
20969 @opindex mno-mips16
20970 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20971 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20973 MIPS16 code generation can also be controlled on a per-function basis
20974 by means of @code{mips16} and @code{nomips16} attributes.
20975 @xref{Function Attributes}, for more information.
20977 @item -mflip-mips16
20978 @opindex mflip-mips16
20979 Generate MIPS16 code on alternating functions.  This option is provided
20980 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20981 not intended for ordinary use in compiling user code.
20983 @item -minterlink-compressed
20984 @itemx -mno-interlink-compressed
20985 @opindex minterlink-compressed
20986 @opindex mno-interlink-compressed
20987 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20988 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20990 For example, code using the standard ISA encoding cannot jump directly
20991 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20992 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20993 knows that the target of the jump is not compressed.
20995 @item -minterlink-mips16
20996 @itemx -mno-interlink-mips16
20997 @opindex minterlink-mips16
20998 @opindex mno-interlink-mips16
20999 Aliases of @option{-minterlink-compressed} and
21000 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
21001 and are retained for backwards compatibility.
21003 @item -mabi=32
21004 @itemx -mabi=o64
21005 @itemx -mabi=n32
21006 @itemx -mabi=64
21007 @itemx -mabi=eabi
21008 @opindex mabi=32
21009 @opindex mabi=o64
21010 @opindex mabi=n32
21011 @opindex mabi=64
21012 @opindex mabi=eabi
21013 Generate code for the given ABI@.
21015 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
21016 generates 64-bit code when you select a 64-bit architecture, but you
21017 can use @option{-mgp32} to get 32-bit code instead.
21019 For information about the O64 ABI, see
21020 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
21022 GCC supports a variant of the o32 ABI in which floating-point registers
21023 are 64 rather than 32 bits wide.  You can select this combination with
21024 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
21025 and @code{mfhc1} instructions and is therefore only supported for
21026 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
21028 The register assignments for arguments and return values remain the
21029 same, but each scalar value is passed in a single 64-bit register
21030 rather than a pair of 32-bit registers.  For example, scalar
21031 floating-point values are returned in @samp{$f0} only, not a
21032 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
21033 remains the same in that the even-numbered double-precision registers
21034 are saved.
21036 Two additional variants of the o32 ABI are supported to enable
21037 a transition from 32-bit to 64-bit registers.  These are FPXX
21038 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
21039 The FPXX extension mandates that all code must execute correctly
21040 when run using 32-bit or 64-bit registers.  The code can be interlinked
21041 with either FP32 or FP64, but not both.
21042 The FP64A extension is similar to the FP64 extension but forbids the
21043 use of odd-numbered single-precision registers.  This can be used
21044 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
21045 processors and allows both FP32 and FP64A code to interlink and
21046 run in the same process without changing FPU modes.
21048 @item -mabicalls
21049 @itemx -mno-abicalls
21050 @opindex mabicalls
21051 @opindex mno-abicalls
21052 Generate (do not generate) code that is suitable for SVR4-style
21053 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
21054 systems.
21056 @item -mshared
21057 @itemx -mno-shared
21058 Generate (do not generate) code that is fully position-independent,
21059 and that can therefore be linked into shared libraries.  This option
21060 only affects @option{-mabicalls}.
21062 All @option{-mabicalls} code has traditionally been position-independent,
21063 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
21064 as an extension, the GNU toolchain allows executables to use absolute
21065 accesses for locally-binding symbols.  It can also use shorter GP
21066 initialization sequences and generate direct calls to locally-defined
21067 functions.  This mode is selected by @option{-mno-shared}.
21069 @option{-mno-shared} depends on binutils 2.16 or higher and generates
21070 objects that can only be linked by the GNU linker.  However, the option
21071 does not affect the ABI of the final executable; it only affects the ABI
21072 of relocatable objects.  Using @option{-mno-shared} generally makes
21073 executables both smaller and quicker.
21075 @option{-mshared} is the default.
21077 @item -mplt
21078 @itemx -mno-plt
21079 @opindex mplt
21080 @opindex mno-plt
21081 Assume (do not assume) that the static and dynamic linkers
21082 support PLTs and copy relocations.  This option only affects
21083 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
21084 has no effect without @option{-msym32}.
21086 You can make @option{-mplt} the default by configuring
21087 GCC with @option{--with-mips-plt}.  The default is
21088 @option{-mno-plt} otherwise.
21090 @item -mxgot
21091 @itemx -mno-xgot
21092 @opindex mxgot
21093 @opindex mno-xgot
21094 Lift (do not lift) the usual restrictions on the size of the global
21095 offset table.
21097 GCC normally uses a single instruction to load values from the GOT@.
21098 While this is relatively efficient, it only works if the GOT
21099 is smaller than about 64k.  Anything larger causes the linker
21100 to report an error such as:
21102 @cindex relocation truncated to fit (MIPS)
21103 @smallexample
21104 relocation truncated to fit: R_MIPS_GOT16 foobar
21105 @end smallexample
21107 If this happens, you should recompile your code with @option{-mxgot}.
21108 This works with very large GOTs, although the code is also
21109 less efficient, since it takes three instructions to fetch the
21110 value of a global symbol.
21112 Note that some linkers can create multiple GOTs.  If you have such a
21113 linker, you should only need to use @option{-mxgot} when a single object
21114 file accesses more than 64k's worth of GOT entries.  Very few do.
21116 These options have no effect unless GCC is generating position
21117 independent code.
21119 @item -mgp32
21120 @opindex mgp32
21121 Assume that general-purpose registers are 32 bits wide.
21123 @item -mgp64
21124 @opindex mgp64
21125 Assume that general-purpose registers are 64 bits wide.
21127 @item -mfp32
21128 @opindex mfp32
21129 Assume that floating-point registers are 32 bits wide.
21131 @item -mfp64
21132 @opindex mfp64
21133 Assume that floating-point registers are 64 bits wide.
21135 @item -mfpxx
21136 @opindex mfpxx
21137 Do not assume the width of floating-point registers.
21139 @item -mhard-float
21140 @opindex mhard-float
21141 Use floating-point coprocessor instructions.
21143 @item -msoft-float
21144 @opindex msoft-float
21145 Do not use floating-point coprocessor instructions.  Implement
21146 floating-point calculations using library calls instead.
21148 @item -mno-float
21149 @opindex mno-float
21150 Equivalent to @option{-msoft-float}, but additionally asserts that the
21151 program being compiled does not perform any floating-point operations.
21152 This option is presently supported only by some bare-metal MIPS
21153 configurations, where it may select a special set of libraries
21154 that lack all floating-point support (including, for example, the
21155 floating-point @code{printf} formats).  
21156 If code compiled with @option{-mno-float} accidentally contains
21157 floating-point operations, it is likely to suffer a link-time
21158 or run-time failure.
21160 @item -msingle-float
21161 @opindex msingle-float
21162 Assume that the floating-point coprocessor only supports single-precision
21163 operations.
21165 @item -mdouble-float
21166 @opindex mdouble-float
21167 Assume that the floating-point coprocessor supports double-precision
21168 operations.  This is the default.
21170 @item -modd-spreg
21171 @itemx -mno-odd-spreg
21172 @opindex modd-spreg
21173 @opindex mno-odd-spreg
21174 Enable the use of odd-numbered single-precision floating-point registers
21175 for the o32 ABI.  This is the default for processors that are known to
21176 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
21177 is set by default.
21179 @item -mabs=2008
21180 @itemx -mabs=legacy
21181 @opindex mabs=2008
21182 @opindex mabs=legacy
21183 These options control the treatment of the special not-a-number (NaN)
21184 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
21185 @code{neg.@i{fmt}} machine instructions.
21187 By default or when @option{-mabs=legacy} is used the legacy
21188 treatment is selected.  In this case these instructions are considered
21189 arithmetic and avoided where correct operation is required and the
21190 input operand might be a NaN.  A longer sequence of instructions that
21191 manipulate the sign bit of floating-point datum manually is used
21192 instead unless the @option{-ffinite-math-only} option has also been
21193 specified.
21195 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
21196 this case these instructions are considered non-arithmetic and therefore
21197 operating correctly in all cases, including in particular where the
21198 input operand is a NaN.  These instructions are therefore always used
21199 for the respective operations.
21201 @item -mnan=2008
21202 @itemx -mnan=legacy
21203 @opindex mnan=2008
21204 @opindex mnan=legacy
21205 These options control the encoding of the special not-a-number (NaN)
21206 IEEE 754 floating-point data.
21208 The @option{-mnan=legacy} option selects the legacy encoding.  In this
21209 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
21210 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
21211 by the first bit of their trailing significand field being 1.
21213 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
21214 this case qNaNs are denoted by the first bit of their trailing
21215 significand field being 1, whereas sNaNs are denoted by the first bit of
21216 their trailing significand field being 0.
21218 The default is @option{-mnan=legacy} unless GCC has been configured with
21219 @option{--with-nan=2008}.
21221 @item -mllsc
21222 @itemx -mno-llsc
21223 @opindex mllsc
21224 @opindex mno-llsc
21225 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
21226 implement atomic memory built-in functions.  When neither option is
21227 specified, GCC uses the instructions if the target architecture
21228 supports them.
21230 @option{-mllsc} is useful if the runtime environment can emulate the
21231 instructions and @option{-mno-llsc} can be useful when compiling for
21232 nonstandard ISAs.  You can make either option the default by
21233 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
21234 respectively.  @option{--with-llsc} is the default for some
21235 configurations; see the installation documentation for details.
21237 @item -mdsp
21238 @itemx -mno-dsp
21239 @opindex mdsp
21240 @opindex mno-dsp
21241 Use (do not use) revision 1 of the MIPS DSP ASE@.
21242 @xref{MIPS DSP Built-in Functions}.  This option defines the
21243 preprocessor macro @code{__mips_dsp}.  It also defines
21244 @code{__mips_dsp_rev} to 1.
21246 @item -mdspr2
21247 @itemx -mno-dspr2
21248 @opindex mdspr2
21249 @opindex mno-dspr2
21250 Use (do not use) revision 2 of the MIPS DSP ASE@.
21251 @xref{MIPS DSP Built-in Functions}.  This option defines the
21252 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
21253 It also defines @code{__mips_dsp_rev} to 2.
21255 @item -msmartmips
21256 @itemx -mno-smartmips
21257 @opindex msmartmips
21258 @opindex mno-smartmips
21259 Use (do not use) the MIPS SmartMIPS ASE.
21261 @item -mpaired-single
21262 @itemx -mno-paired-single
21263 @opindex mpaired-single
21264 @opindex mno-paired-single
21265 Use (do not use) paired-single floating-point instructions.
21266 @xref{MIPS Paired-Single Support}.  This option requires
21267 hardware floating-point support to be enabled.
21269 @item -mdmx
21270 @itemx -mno-mdmx
21271 @opindex mdmx
21272 @opindex mno-mdmx
21273 Use (do not use) MIPS Digital Media Extension instructions.
21274 This option can only be used when generating 64-bit code and requires
21275 hardware floating-point support to be enabled.
21277 @item -mips3d
21278 @itemx -mno-mips3d
21279 @opindex mips3d
21280 @opindex mno-mips3d
21281 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
21282 The option @option{-mips3d} implies @option{-mpaired-single}.
21284 @item -mmicromips
21285 @itemx -mno-micromips
21286 @opindex mmicromips
21287 @opindex mno-mmicromips
21288 Generate (do not generate) microMIPS code.
21290 MicroMIPS code generation can also be controlled on a per-function basis
21291 by means of @code{micromips} and @code{nomicromips} attributes.
21292 @xref{Function Attributes}, for more information.
21294 @item -mmt
21295 @itemx -mno-mt
21296 @opindex mmt
21297 @opindex mno-mt
21298 Use (do not use) MT Multithreading instructions.
21300 @item -mmcu
21301 @itemx -mno-mcu
21302 @opindex mmcu
21303 @opindex mno-mcu
21304 Use (do not use) the MIPS MCU ASE instructions.
21306 @item -meva
21307 @itemx -mno-eva
21308 @opindex meva
21309 @opindex mno-eva
21310 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
21312 @item -mvirt
21313 @itemx -mno-virt
21314 @opindex mvirt
21315 @opindex mno-virt
21316 Use (do not use) the MIPS Virtualization (VZ) instructions.
21318 @item -mxpa
21319 @itemx -mno-xpa
21320 @opindex mxpa
21321 @opindex mno-xpa
21322 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
21324 @item -mcrc
21325 @itemx -mno-crc
21326 @opindex mcrc
21327 @opindex mno-crc
21328 Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
21330 @item -mginv
21331 @itemx -mno-ginv
21332 @opindex mginv
21333 @opindex mno-ginv
21334 Use (do not use) the MIPS Global INValidate (GINV) instructions.
21336 @item -mloongson-mmi
21337 @itemx -mno-loongson-mmi
21338 @opindex mloongson-mmi
21339 @opindex mno-loongson-mmi
21340 Use (do not use) the MIPS Loongson MultiMedia extensions Instructions (MMI).
21342 @item -mloongson-ext
21343 @itemx -mno-loongson-ext
21344 @opindex mloongson-ext
21345 @opindex mno-loongson-ext
21346 Use (do not use) the MIPS Loongson EXTensions (EXT) instructions.
21348 @item -mloongson-ext2
21349 @itemx -mno-loongson-ext2
21350 @opindex mloongson-ext2
21351 @opindex mno-loongson-ext2
21352 Use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
21354 @item -mlong64
21355 @opindex mlong64
21356 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
21357 an explanation of the default and the way that the pointer size is
21358 determined.
21360 @item -mlong32
21361 @opindex mlong32
21362 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
21364 The default size of @code{int}s, @code{long}s and pointers depends on
21365 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
21366 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
21367 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
21368 or the same size as integer registers, whichever is smaller.
21370 @item -msym32
21371 @itemx -mno-sym32
21372 @opindex msym32
21373 @opindex mno-sym32
21374 Assume (do not assume) that all symbols have 32-bit values, regardless
21375 of the selected ABI@.  This option is useful in combination with
21376 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
21377 to generate shorter and faster references to symbolic addresses.
21379 @item -G @var{num}
21380 @opindex G
21381 Put definitions of externally-visible data in a small data section
21382 if that data is no bigger than @var{num} bytes.  GCC can then generate
21383 more efficient accesses to the data; see @option{-mgpopt} for details.
21385 The default @option{-G} option depends on the configuration.
21387 @item -mlocal-sdata
21388 @itemx -mno-local-sdata
21389 @opindex mlocal-sdata
21390 @opindex mno-local-sdata
21391 Extend (do not extend) the @option{-G} behavior to local data too,
21392 such as to static variables in C@.  @option{-mlocal-sdata} is the
21393 default for all configurations.
21395 If the linker complains that an application is using too much small data,
21396 you might want to try rebuilding the less performance-critical parts with
21397 @option{-mno-local-sdata}.  You might also want to build large
21398 libraries with @option{-mno-local-sdata}, so that the libraries leave
21399 more room for the main program.
21401 @item -mextern-sdata
21402 @itemx -mno-extern-sdata
21403 @opindex mextern-sdata
21404 @opindex mno-extern-sdata
21405 Assume (do not assume) that externally-defined data is in
21406 a small data section if the size of that data is within the @option{-G} limit.
21407 @option{-mextern-sdata} is the default for all configurations.
21409 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
21410 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
21411 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
21412 is placed in a small data section.  If @var{Var} is defined by another
21413 module, you must either compile that module with a high-enough
21414 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
21415 definition.  If @var{Var} is common, you must link the application
21416 with a high-enough @option{-G} setting.
21418 The easiest way of satisfying these restrictions is to compile
21419 and link every module with the same @option{-G} option.  However,
21420 you may wish to build a library that supports several different
21421 small data limits.  You can do this by compiling the library with
21422 the highest supported @option{-G} setting and additionally using
21423 @option{-mno-extern-sdata} to stop the library from making assumptions
21424 about externally-defined data.
21426 @item -mgpopt
21427 @itemx -mno-gpopt
21428 @opindex mgpopt
21429 @opindex mno-gpopt
21430 Use (do not use) GP-relative accesses for symbols that are known to be
21431 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
21432 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
21433 configurations.
21435 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
21436 might not hold the value of @code{_gp}.  For example, if the code is
21437 part of a library that might be used in a boot monitor, programs that
21438 call boot monitor routines pass an unknown value in @code{$gp}.
21439 (In such situations, the boot monitor itself is usually compiled
21440 with @option{-G0}.)
21442 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
21443 @option{-mno-extern-sdata}.
21445 @item -membedded-data
21446 @itemx -mno-embedded-data
21447 @opindex membedded-data
21448 @opindex mno-embedded-data
21449 Allocate variables to the read-only data section first if possible, then
21450 next in the small data section if possible, otherwise in data.  This gives
21451 slightly slower code than the default, but reduces the amount of RAM required
21452 when executing, and thus may be preferred for some embedded systems.
21454 @item -muninit-const-in-rodata
21455 @itemx -mno-uninit-const-in-rodata
21456 @opindex muninit-const-in-rodata
21457 @opindex mno-uninit-const-in-rodata
21458 Put uninitialized @code{const} variables in the read-only data section.
21459 This option is only meaningful in conjunction with @option{-membedded-data}.
21461 @item -mcode-readable=@var{setting}
21462 @opindex mcode-readable
21463 Specify whether GCC may generate code that reads from executable sections.
21464 There are three possible settings:
21466 @table @gcctabopt
21467 @item -mcode-readable=yes
21468 Instructions may freely access executable sections.  This is the
21469 default setting.
21471 @item -mcode-readable=pcrel
21472 MIPS16 PC-relative load instructions can access executable sections,
21473 but other instructions must not do so.  This option is useful on 4KSc
21474 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
21475 It is also useful on processors that can be configured to have a dual
21476 instruction/data SRAM interface and that, like the M4K, automatically
21477 redirect PC-relative loads to the instruction RAM.
21479 @item -mcode-readable=no
21480 Instructions must not access executable sections.  This option can be
21481 useful on targets that are configured to have a dual instruction/data
21482 SRAM interface but that (unlike the M4K) do not automatically redirect
21483 PC-relative loads to the instruction RAM.
21484 @end table
21486 @item -msplit-addresses
21487 @itemx -mno-split-addresses
21488 @opindex msplit-addresses
21489 @opindex mno-split-addresses
21490 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
21491 relocation operators.  This option has been superseded by
21492 @option{-mexplicit-relocs} but is retained for backwards compatibility.
21494 @item -mexplicit-relocs
21495 @itemx -mno-explicit-relocs
21496 @opindex mexplicit-relocs
21497 @opindex mno-explicit-relocs
21498 Use (do not use) assembler relocation operators when dealing with symbolic
21499 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
21500 is to use assembler macros instead.
21502 @option{-mexplicit-relocs} is the default if GCC was configured
21503 to use an assembler that supports relocation operators.
21505 @item -mcheck-zero-division
21506 @itemx -mno-check-zero-division
21507 @opindex mcheck-zero-division
21508 @opindex mno-check-zero-division
21509 Trap (do not trap) on integer division by zero.
21511 The default is @option{-mcheck-zero-division}.
21513 @item -mdivide-traps
21514 @itemx -mdivide-breaks
21515 @opindex mdivide-traps
21516 @opindex mdivide-breaks
21517 MIPS systems check for division by zero by generating either a
21518 conditional trap or a break instruction.  Using traps results in
21519 smaller code, but is only supported on MIPS II and later.  Also, some
21520 versions of the Linux kernel have a bug that prevents trap from
21521 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
21522 allow conditional traps on architectures that support them and
21523 @option{-mdivide-breaks} to force the use of breaks.
21525 The default is usually @option{-mdivide-traps}, but this can be
21526 overridden at configure time using @option{--with-divide=breaks}.
21527 Divide-by-zero checks can be completely disabled using
21528 @option{-mno-check-zero-division}.
21530 @item -mload-store-pairs
21531 @itemx -mno-load-store-pairs
21532 @opindex mload-store-pairs
21533 @opindex mno-load-store-pairs
21534 Enable (disable) an optimization that pairs consecutive load or store
21535 instructions to enable load/store bonding.  This option is enabled by
21536 default but only takes effect when the selected architecture is known
21537 to support bonding.
21539 @item -mmemcpy
21540 @itemx -mno-memcpy
21541 @opindex mmemcpy
21542 @opindex mno-memcpy
21543 Force (do not force) the use of @code{memcpy} for non-trivial block
21544 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
21545 most constant-sized copies.
21547 @item -mlong-calls
21548 @itemx -mno-long-calls
21549 @opindex mlong-calls
21550 @opindex mno-long-calls
21551 Disable (do not disable) use of the @code{jal} instruction.  Calling
21552 functions using @code{jal} is more efficient but requires the caller
21553 and callee to be in the same 256 megabyte segment.
21555 This option has no effect on abicalls code.  The default is
21556 @option{-mno-long-calls}.
21558 @item -mmad
21559 @itemx -mno-mad
21560 @opindex mmad
21561 @opindex mno-mad
21562 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
21563 instructions, as provided by the R4650 ISA@.
21565 @item -mimadd
21566 @itemx -mno-imadd
21567 @opindex mimadd
21568 @opindex mno-imadd
21569 Enable (disable) use of the @code{madd} and @code{msub} integer
21570 instructions.  The default is @option{-mimadd} on architectures
21571 that support @code{madd} and @code{msub} except for the 74k 
21572 architecture where it was found to generate slower code.
21574 @item -mfused-madd
21575 @itemx -mno-fused-madd
21576 @opindex mfused-madd
21577 @opindex mno-fused-madd
21578 Enable (disable) use of the floating-point multiply-accumulate
21579 instructions, when they are available.  The default is
21580 @option{-mfused-madd}.
21582 On the R8000 CPU when multiply-accumulate instructions are used,
21583 the intermediate product is calculated to infinite precision
21584 and is not subject to the FCSR Flush to Zero bit.  This may be
21585 undesirable in some circumstances.  On other processors the result
21586 is numerically identical to the equivalent computation using
21587 separate multiply, add, subtract and negate instructions.
21589 @item -nocpp
21590 @opindex nocpp
21591 Tell the MIPS assembler to not run its preprocessor over user
21592 assembler files (with a @samp{.s} suffix) when assembling them.
21594 @item -mfix-24k
21595 @itemx -mno-fix-24k
21596 @opindex mfix-24k
21597 @opindex mno-fix-24k
21598 Work around the 24K E48 (lost data on stores during refill) errata.
21599 The workarounds are implemented by the assembler rather than by GCC@.
21601 @item -mfix-r4000
21602 @itemx -mno-fix-r4000
21603 @opindex mfix-r4000
21604 @opindex mno-fix-r4000
21605 Work around certain R4000 CPU errata:
21606 @itemize @minus
21607 @item
21608 A double-word or a variable shift may give an incorrect result if executed
21609 immediately after starting an integer division.
21610 @item
21611 A double-word or a variable shift may give an incorrect result if executed
21612 while an integer multiplication is in progress.
21613 @item
21614 An integer division may give an incorrect result if started in a delay slot
21615 of a taken branch or a jump.
21616 @end itemize
21618 @item -mfix-r4400
21619 @itemx -mno-fix-r4400
21620 @opindex mfix-r4400
21621 @opindex mno-fix-r4400
21622 Work around certain R4400 CPU errata:
21623 @itemize @minus
21624 @item
21625 A double-word or a variable shift may give an incorrect result if executed
21626 immediately after starting an integer division.
21627 @end itemize
21629 @item -mfix-r10000
21630 @itemx -mno-fix-r10000
21631 @opindex mfix-r10000
21632 @opindex mno-fix-r10000
21633 Work around certain R10000 errata:
21634 @itemize @minus
21635 @item
21636 @code{ll}/@code{sc} sequences may not behave atomically on revisions
21637 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
21638 @end itemize
21640 This option can only be used if the target architecture supports
21641 branch-likely instructions.  @option{-mfix-r10000} is the default when
21642 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
21643 otherwise.
21645 @item -mfix-rm7000
21646 @itemx -mno-fix-rm7000
21647 @opindex mfix-rm7000
21648 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
21649 workarounds are implemented by the assembler rather than by GCC@.
21651 @item -mfix-vr4120
21652 @itemx -mno-fix-vr4120
21653 @opindex mfix-vr4120
21654 Work around certain VR4120 errata:
21655 @itemize @minus
21656 @item
21657 @code{dmultu} does not always produce the correct result.
21658 @item
21659 @code{div} and @code{ddiv} do not always produce the correct result if one
21660 of the operands is negative.
21661 @end itemize
21662 The workarounds for the division errata rely on special functions in
21663 @file{libgcc.a}.  At present, these functions are only provided by
21664 the @code{mips64vr*-elf} configurations.
21666 Other VR4120 errata require a NOP to be inserted between certain pairs of
21667 instructions.  These errata are handled by the assembler, not by GCC itself.
21669 @item -mfix-vr4130
21670 @opindex mfix-vr4130
21671 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
21672 workarounds are implemented by the assembler rather than by GCC,
21673 although GCC avoids using @code{mflo} and @code{mfhi} if the
21674 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
21675 instructions are available instead.
21677 @item -mfix-sb1
21678 @itemx -mno-fix-sb1
21679 @opindex mfix-sb1
21680 Work around certain SB-1 CPU core errata.
21681 (This flag currently works around the SB-1 revision 2
21682 ``F1'' and ``F2'' floating-point errata.)
21684 @item -mr10k-cache-barrier=@var{setting}
21685 @opindex mr10k-cache-barrier
21686 Specify whether GCC should insert cache barriers to avoid the
21687 side effects of speculation on R10K processors.
21689 In common with many processors, the R10K tries to predict the outcome
21690 of a conditional branch and speculatively executes instructions from
21691 the ``taken'' branch.  It later aborts these instructions if the
21692 predicted outcome is wrong.  However, on the R10K, even aborted
21693 instructions can have side effects.
21695 This problem only affects kernel stores and, depending on the system,
21696 kernel loads.  As an example, a speculatively-executed store may load
21697 the target memory into cache and mark the cache line as dirty, even if
21698 the store itself is later aborted.  If a DMA operation writes to the
21699 same area of memory before the ``dirty'' line is flushed, the cached
21700 data overwrites the DMA-ed data.  See the R10K processor manual
21701 for a full description, including other potential problems.
21703 One workaround is to insert cache barrier instructions before every memory
21704 access that might be speculatively executed and that might have side
21705 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
21706 controls GCC's implementation of this workaround.  It assumes that
21707 aborted accesses to any byte in the following regions does not have
21708 side effects:
21710 @enumerate
21711 @item
21712 the memory occupied by the current function's stack frame;
21714 @item
21715 the memory occupied by an incoming stack argument;
21717 @item
21718 the memory occupied by an object with a link-time-constant address.
21719 @end enumerate
21721 It is the kernel's responsibility to ensure that speculative
21722 accesses to these regions are indeed safe.
21724 If the input program contains a function declaration such as:
21726 @smallexample
21727 void foo (void);
21728 @end smallexample
21730 then the implementation of @code{foo} must allow @code{j foo} and
21731 @code{jal foo} to be executed speculatively.  GCC honors this
21732 restriction for functions it compiles itself.  It expects non-GCC
21733 functions (such as hand-written assembly code) to do the same.
21735 The option has three forms:
21737 @table @gcctabopt
21738 @item -mr10k-cache-barrier=load-store
21739 Insert a cache barrier before a load or store that might be
21740 speculatively executed and that might have side effects even
21741 if aborted.
21743 @item -mr10k-cache-barrier=store
21744 Insert a cache barrier before a store that might be speculatively
21745 executed and that might have side effects even if aborted.
21747 @item -mr10k-cache-barrier=none
21748 Disable the insertion of cache barriers.  This is the default setting.
21749 @end table
21751 @item -mflush-func=@var{func}
21752 @itemx -mno-flush-func
21753 @opindex mflush-func
21754 Specifies the function to call to flush the I and D caches, or to not
21755 call any such function.  If called, the function must take the same
21756 arguments as the common @code{_flush_func}, that is, the address of the
21757 memory range for which the cache is being flushed, the size of the
21758 memory range, and the number 3 (to flush both caches).  The default
21759 depends on the target GCC was configured for, but commonly is either
21760 @code{_flush_func} or @code{__cpu_flush}.
21762 @item mbranch-cost=@var{num}
21763 @opindex mbranch-cost
21764 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21765 This cost is only a heuristic and is not guaranteed to produce
21766 consistent results across releases.  A zero cost redundantly selects
21767 the default, which is based on the @option{-mtune} setting.
21769 @item -mbranch-likely
21770 @itemx -mno-branch-likely
21771 @opindex mbranch-likely
21772 @opindex mno-branch-likely
21773 Enable or disable use of Branch Likely instructions, regardless of the
21774 default for the selected architecture.  By default, Branch Likely
21775 instructions may be generated if they are supported by the selected
21776 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21777 and processors that implement those architectures; for those, Branch
21778 Likely instructions are not be generated by default because the MIPS32
21779 and MIPS64 architectures specifically deprecate their use.
21781 @item -mcompact-branches=never
21782 @itemx -mcompact-branches=optimal
21783 @itemx -mcompact-branches=always
21784 @opindex mcompact-branches=never
21785 @opindex mcompact-branches=optimal
21786 @opindex mcompact-branches=always
21787 These options control which form of branches will be generated.  The
21788 default is @option{-mcompact-branches=optimal}.
21790 The @option{-mcompact-branches=never} option ensures that compact branch
21791 instructions will never be generated.
21793 The @option{-mcompact-branches=always} option ensures that a compact
21794 branch instruction will be generated if available.  If a compact branch
21795 instruction is not available, a delay slot form of the branch will be
21796 used instead.
21798 This option is supported from MIPS Release 6 onwards.
21800 The @option{-mcompact-branches=optimal} option will cause a delay slot
21801 branch to be used if one is available in the current ISA and the delay
21802 slot is successfully filled.  If the delay slot is not filled, a compact
21803 branch will be chosen if one is available.
21805 @item -mfp-exceptions
21806 @itemx -mno-fp-exceptions
21807 @opindex mfp-exceptions
21808 Specifies whether FP exceptions are enabled.  This affects how
21809 FP instructions are scheduled for some processors.
21810 The default is that FP exceptions are
21811 enabled.
21813 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21814 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21815 FP pipe.
21817 @item -mvr4130-align
21818 @itemx -mno-vr4130-align
21819 @opindex mvr4130-align
21820 The VR4130 pipeline is two-way superscalar, but can only issue two
21821 instructions together if the first one is 8-byte aligned.  When this
21822 option is enabled, GCC aligns pairs of instructions that it
21823 thinks should execute in parallel.
21825 This option only has an effect when optimizing for the VR4130.
21826 It normally makes code faster, but at the expense of making it bigger.
21827 It is enabled by default at optimization level @option{-O3}.
21829 @item -msynci
21830 @itemx -mno-synci
21831 @opindex msynci
21832 Enable (disable) generation of @code{synci} instructions on
21833 architectures that support it.  The @code{synci} instructions (if
21834 enabled) are generated when @code{__builtin___clear_cache} is
21835 compiled.
21837 This option defaults to @option{-mno-synci}, but the default can be
21838 overridden by configuring GCC with @option{--with-synci}.
21840 When compiling code for single processor systems, it is generally safe
21841 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21842 does not invalidate the instruction caches on all cores and may lead
21843 to undefined behavior.
21845 @item -mrelax-pic-calls
21846 @itemx -mno-relax-pic-calls
21847 @opindex mrelax-pic-calls
21848 Try to turn PIC calls that are normally dispatched via register
21849 @code{$25} into direct calls.  This is only possible if the linker can
21850 resolve the destination at link time and if the destination is within
21851 range for a direct call.
21853 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21854 an assembler and a linker that support the @code{.reloc} assembly
21855 directive and @option{-mexplicit-relocs} is in effect.  With
21856 @option{-mno-explicit-relocs}, this optimization can be performed by the
21857 assembler and the linker alone without help from the compiler.
21859 @item -mmcount-ra-address
21860 @itemx -mno-mcount-ra-address
21861 @opindex mmcount-ra-address
21862 @opindex mno-mcount-ra-address
21863 Emit (do not emit) code that allows @code{_mcount} to modify the
21864 calling function's return address.  When enabled, this option extends
21865 the usual @code{_mcount} interface with a new @var{ra-address}
21866 parameter, which has type @code{intptr_t *} and is passed in register
21867 @code{$12}.  @code{_mcount} can then modify the return address by
21868 doing both of the following:
21869 @itemize
21870 @item
21871 Returning the new address in register @code{$31}.
21872 @item
21873 Storing the new address in @code{*@var{ra-address}},
21874 if @var{ra-address} is nonnull.
21875 @end itemize
21877 The default is @option{-mno-mcount-ra-address}.
21879 @item -mframe-header-opt
21880 @itemx -mno-frame-header-opt
21881 @opindex mframe-header-opt
21882 Enable (disable) frame header optimization in the o32 ABI.  When using the
21883 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21884 function to write out register arguments.  When enabled, this optimization
21885 will suppress the allocation of the frame header if it can be determined that
21886 it is unused.
21888 This optimization is off by default at all optimization levels.
21890 @item -mlxc1-sxc1
21891 @itemx -mno-lxc1-sxc1
21892 @opindex mlxc1-sxc1
21893 When applicable, enable (disable) the generation of @code{lwxc1},
21894 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21896 @item -mmadd4
21897 @itemx -mno-madd4
21898 @opindex mmadd4
21899 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21900 @code{madd.d} and related instructions.  Enabled by default.
21902 @end table
21904 @node MMIX Options
21905 @subsection MMIX Options
21906 @cindex MMIX Options
21908 These options are defined for the MMIX:
21910 @table @gcctabopt
21911 @item -mlibfuncs
21912 @itemx -mno-libfuncs
21913 @opindex mlibfuncs
21914 @opindex mno-libfuncs
21915 Specify that intrinsic library functions are being compiled, passing all
21916 values in registers, no matter the size.
21918 @item -mepsilon
21919 @itemx -mno-epsilon
21920 @opindex mepsilon
21921 @opindex mno-epsilon
21922 Generate floating-point comparison instructions that compare with respect
21923 to the @code{rE} epsilon register.
21925 @item -mabi=mmixware
21926 @itemx -mabi=gnu
21927 @opindex mabi=mmixware
21928 @opindex mabi=gnu
21929 Generate code that passes function parameters and return values that (in
21930 the called function) are seen as registers @code{$0} and up, as opposed to
21931 the GNU ABI which uses global registers @code{$231} and up.
21933 @item -mzero-extend
21934 @itemx -mno-zero-extend
21935 @opindex mzero-extend
21936 @opindex mno-zero-extend
21937 When reading data from memory in sizes shorter than 64 bits, use (do not
21938 use) zero-extending load instructions by default, rather than
21939 sign-extending ones.
21941 @item -mknuthdiv
21942 @itemx -mno-knuthdiv
21943 @opindex mknuthdiv
21944 @opindex mno-knuthdiv
21945 Make the result of a division yielding a remainder have the same sign as
21946 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21947 remainder follows the sign of the dividend.  Both methods are
21948 arithmetically valid, the latter being almost exclusively used.
21950 @item -mtoplevel-symbols
21951 @itemx -mno-toplevel-symbols
21952 @opindex mtoplevel-symbols
21953 @opindex mno-toplevel-symbols
21954 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21955 code can be used with the @code{PREFIX} assembly directive.
21957 @item -melf
21958 @opindex melf
21959 Generate an executable in the ELF format, rather than the default
21960 @samp{mmo} format used by the @command{mmix} simulator.
21962 @item -mbranch-predict
21963 @itemx -mno-branch-predict
21964 @opindex mbranch-predict
21965 @opindex mno-branch-predict
21966 Use (do not use) the probable-branch instructions, when static branch
21967 prediction indicates a probable branch.
21969 @item -mbase-addresses
21970 @itemx -mno-base-addresses
21971 @opindex mbase-addresses
21972 @opindex mno-base-addresses
21973 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21974 base address automatically generates a request (handled by the assembler
21975 and the linker) for a constant to be set up in a global register.  The
21976 register is used for one or more base address requests within the range 0
21977 to 255 from the value held in the register.  The generally leads to short
21978 and fast code, but the number of different data items that can be
21979 addressed is limited.  This means that a program that uses lots of static
21980 data may require @option{-mno-base-addresses}.
21982 @item -msingle-exit
21983 @itemx -mno-single-exit
21984 @opindex msingle-exit
21985 @opindex mno-single-exit
21986 Force (do not force) generated code to have a single exit point in each
21987 function.
21988 @end table
21990 @node MN10300 Options
21991 @subsection MN10300 Options
21992 @cindex MN10300 options
21994 These @option{-m} options are defined for Matsushita MN10300 architectures:
21996 @table @gcctabopt
21997 @item -mmult-bug
21998 @opindex mmult-bug
21999 Generate code to avoid bugs in the multiply instructions for the MN10300
22000 processors.  This is the default.
22002 @item -mno-mult-bug
22003 @opindex mno-mult-bug
22004 Do not generate code to avoid bugs in the multiply instructions for the
22005 MN10300 processors.
22007 @item -mam33
22008 @opindex mam33
22009 Generate code using features specific to the AM33 processor.
22011 @item -mno-am33
22012 @opindex mno-am33
22013 Do not generate code using features specific to the AM33 processor.  This
22014 is the default.
22016 @item -mam33-2
22017 @opindex mam33-2
22018 Generate code using features specific to the AM33/2.0 processor.
22020 @item -mam34
22021 @opindex mam34
22022 Generate code using features specific to the AM34 processor.
22024 @item -mtune=@var{cpu-type}
22025 @opindex mtune
22026 Use the timing characteristics of the indicated CPU type when
22027 scheduling instructions.  This does not change the targeted processor
22028 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
22029 @samp{am33-2} or @samp{am34}.
22031 @item -mreturn-pointer-on-d0
22032 @opindex mreturn-pointer-on-d0
22033 When generating a function that returns a pointer, return the pointer
22034 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
22035 only in @code{a0}, and attempts to call such functions without a prototype
22036 result in errors.  Note that this option is on by default; use
22037 @option{-mno-return-pointer-on-d0} to disable it.
22039 @item -mno-crt0
22040 @opindex mno-crt0
22041 Do not link in the C run-time initialization object file.
22043 @item -mrelax
22044 @opindex mrelax
22045 Indicate to the linker that it should perform a relaxation optimization pass
22046 to shorten branches, calls and absolute memory addresses.  This option only
22047 has an effect when used on the command line for the final link step.
22049 This option makes symbolic debugging impossible.
22051 @item -mliw
22052 @opindex mliw
22053 Allow the compiler to generate @emph{Long Instruction Word}
22054 instructions if the target is the @samp{AM33} or later.  This is the
22055 default.  This option defines the preprocessor macro @code{__LIW__}.
22057 @item -mnoliw
22058 @opindex mnoliw
22059 Do not allow the compiler to generate @emph{Long Instruction Word}
22060 instructions.  This option defines the preprocessor macro
22061 @code{__NO_LIW__}.
22063 @item -msetlb
22064 @opindex msetlb
22065 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
22066 instructions if the target is the @samp{AM33} or later.  This is the
22067 default.  This option defines the preprocessor macro @code{__SETLB__}.
22069 @item -mnosetlb
22070 @opindex mnosetlb
22071 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
22072 instructions.  This option defines the preprocessor macro
22073 @code{__NO_SETLB__}.
22075 @end table
22077 @node Moxie Options
22078 @subsection Moxie Options
22079 @cindex Moxie Options
22081 @table @gcctabopt
22083 @item -meb
22084 @opindex meb
22085 Generate big-endian code.  This is the default for @samp{moxie-*-*}
22086 configurations.
22088 @item -mel
22089 @opindex mel
22090 Generate little-endian code.
22092 @item -mmul.x
22093 @opindex mmul.x
22094 Generate mul.x and umul.x instructions.  This is the default for
22095 @samp{moxiebox-*-*} configurations.
22097 @item -mno-crt0
22098 @opindex mno-crt0
22099 Do not link in the C run-time initialization object file.
22101 @end table
22103 @node MSP430 Options
22104 @subsection MSP430 Options
22105 @cindex MSP430 Options
22107 These options are defined for the MSP430:
22109 @table @gcctabopt
22111 @item -masm-hex
22112 @opindex masm-hex
22113 Force assembly output to always use hex constants.  Normally such
22114 constants are signed decimals, but this option is available for
22115 testsuite and/or aesthetic purposes.
22117 @item -mmcu=
22118 @opindex mmcu=
22119 Select the MCU to target.  This is used to create a C preprocessor
22120 symbol based upon the MCU name, converted to upper case and pre- and
22121 post-fixed with @samp{__}.  This in turn is used by the
22122 @file{msp430.h} header file to select an MCU-specific supplementary
22123 header file.
22125 The option also sets the ISA to use.  If the MCU name is one that is
22126 known to only support the 430 ISA then that is selected, otherwise the
22127 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
22128 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
22129 name selects the 430X ISA.
22131 In addition an MCU-specific linker script is added to the linker
22132 command line.  The script's name is the name of the MCU with
22133 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
22134 command line defines the C preprocessor symbol @code{__XXX__} and
22135 cause the linker to search for a script called @file{xxx.ld}.
22137 This option is also passed on to the assembler.
22139 @item -mwarn-mcu
22140 @itemx -mno-warn-mcu
22141 @opindex mwarn-mcu
22142 @opindex mno-warn-mcu
22143 This option enables or disables warnings about conflicts between the
22144 MCU name specified by the @option{-mmcu} option and the ISA set by the
22145 @option{-mcpu} option and/or the hardware multiply support set by the
22146 @option{-mhwmult} option.  It also toggles warnings about unrecognized
22147 MCU names.  This option is on by default.
22149 @item -mcpu=
22150 @opindex mcpu=
22151 Specifies the ISA to use.  Accepted values are @samp{msp430},
22152 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
22153 @option{-mmcu=} option should be used to select the ISA.
22155 @item -msim
22156 @opindex msim
22157 Link to the simulator runtime libraries and linker script.  Overrides
22158 any scripts that would be selected by the @option{-mmcu=} option.
22160 @item -mlarge
22161 @opindex mlarge
22162 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
22164 @item -msmall
22165 @opindex msmall
22166 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
22168 @item -mrelax
22169 @opindex mrelax
22170 This option is passed to the assembler and linker, and allows the
22171 linker to perform certain optimizations that cannot be done until
22172 the final link.
22174 @item mhwmult=
22175 @opindex mhwmult=
22176 Describes the type of hardware multiply supported by the target.
22177 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
22178 for the original 16-bit-only multiply supported by early MCUs.
22179 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
22180 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
22181 A value of @samp{auto} can also be given.  This tells GCC to deduce
22182 the hardware multiply support based upon the MCU name provided by the
22183 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
22184 the MCU name is not recognized then no hardware multiply support is
22185 assumed.  @code{auto} is the default setting.
22187 Hardware multiplies are normally performed by calling a library
22188 routine.  This saves space in the generated code.  When compiling at
22189 @option{-O3} or higher however the hardware multiplier is invoked
22190 inline.  This makes for bigger, but faster code.
22192 The hardware multiply routines disable interrupts whilst running and
22193 restore the previous interrupt state when they finish.  This makes
22194 them safe to use inside interrupt handlers as well as in normal code.
22196 @item -minrt
22197 @opindex minrt
22198 Enable the use of a minimum runtime environment - no static
22199 initializers or constructors.  This is intended for memory-constrained
22200 devices.  The compiler includes special symbols in some objects
22201 that tell the linker and runtime which code fragments are required.
22203 @item -mcode-region=
22204 @itemx -mdata-region=
22205 @opindex mcode-region
22206 @opindex mdata-region
22207 These options tell the compiler where to place functions and data that
22208 do not have one of the @code{lower}, @code{upper}, @code{either} or
22209 @code{section} attributes.  Possible values are @code{lower},
22210 @code{upper}, @code{either} or @code{any}.  The first three behave
22211 like the corresponding attribute.  The fourth possible value -
22212 @code{any} - is the default.  It leaves placement entirely up to the
22213 linker script and how it assigns the standard sections
22214 (@code{.text}, @code{.data}, etc) to the memory regions.
22216 @item -msilicon-errata=
22217 @opindex msilicon-errata
22218 This option passes on a request to assembler to enable the fixes for
22219 the named silicon errata.
22221 @item -msilicon-errata-warn=
22222 @opindex msilicon-errata-warn
22223 This option passes on a request to the assembler to enable warning
22224 messages when a silicon errata might need to be applied.
22226 @end table
22228 @node NDS32 Options
22229 @subsection NDS32 Options
22230 @cindex NDS32 Options
22232 These options are defined for NDS32 implementations:
22234 @table @gcctabopt
22236 @item -mbig-endian
22237 @opindex mbig-endian
22238 Generate code in big-endian mode.
22240 @item -mlittle-endian
22241 @opindex mlittle-endian
22242 Generate code in little-endian mode.
22244 @item -mreduced-regs
22245 @opindex mreduced-regs
22246 Use reduced-set registers for register allocation.
22248 @item -mfull-regs
22249 @opindex mfull-regs
22250 Use full-set registers for register allocation.
22252 @item -mcmov
22253 @opindex mcmov
22254 Generate conditional move instructions.
22256 @item -mno-cmov
22257 @opindex mno-cmov
22258 Do not generate conditional move instructions.
22260 @item -mext-perf
22261 @opindex mperf-ext
22262 Generate performance extension instructions.
22264 @item -mno-ext-perf
22265 @opindex mno-perf-ext
22266 Do not generate performance extension instructions.
22268 @item -mext-perf2
22269 @opindex mperf-ext
22270 Generate performance extension 2 instructions.
22272 @item -mno-ext-perf2
22273 @opindex mno-perf-ext
22274 Do not generate performance extension 2 instructions.
22276 @item -mext-string
22277 @opindex mperf-ext
22278 Generate string extension instructions.
22280 @item -mno-ext-string
22281 @opindex mno-perf-ext
22282 Do not generate string extension instructions.
22284 @item -mv3push
22285 @opindex mv3push
22286 Generate v3 push25/pop25 instructions.
22288 @item -mno-v3push
22289 @opindex mno-v3push
22290 Do not generate v3 push25/pop25 instructions.
22292 @item -m16-bit
22293 @opindex m16-bit
22294 Generate 16-bit instructions.
22296 @item -mno-16-bit
22297 @opindex mno-16-bit
22298 Do not generate 16-bit instructions.
22300 @item -misr-vector-size=@var{num}
22301 @opindex misr-vector-size
22302 Specify the size of each interrupt vector, which must be 4 or 16.
22304 @item -mcache-block-size=@var{num}
22305 @opindex mcache-block-size
22306 Specify the size of each cache block,
22307 which must be a power of 2 between 4 and 512.
22309 @item -march=@var{arch}
22310 @opindex march
22311 Specify the name of the target architecture.
22313 @item -mcmodel=@var{code-model}
22314 @opindex mcmodel
22315 Set the code model to one of
22316 @table @asis
22317 @item @samp{small}
22318 All the data and read-only data segments must be within 512KB addressing space.
22319 The text segment must be within 16MB addressing space.
22320 @item @samp{medium}
22321 The data segment must be within 512KB while the read-only data segment can be
22322 within 4GB addressing space.  The text segment should be still within 16MB
22323 addressing space.
22324 @item @samp{large}
22325 All the text and data segments can be within 4GB addressing space.
22326 @end table
22328 @item -mctor-dtor
22329 @opindex mctor-dtor
22330 Enable constructor/destructor feature.
22332 @item -mrelax
22333 @opindex mrelax
22334 Guide linker to relax instructions.
22336 @end table
22338 @node Nios II Options
22339 @subsection Nios II Options
22340 @cindex Nios II options
22341 @cindex Altera Nios II options
22343 These are the options defined for the Altera Nios II processor.
22345 @table @gcctabopt
22347 @item -G @var{num}
22348 @opindex G
22349 @cindex smaller data references
22350 Put global and static objects less than or equal to @var{num} bytes
22351 into the small data or BSS sections instead of the normal data or BSS
22352 sections.  The default value of @var{num} is 8.
22354 @item -mgpopt=@var{option}
22355 @itemx -mgpopt
22356 @itemx -mno-gpopt
22357 @opindex mgpopt
22358 @opindex mno-gpopt
22359 Generate (do not generate) GP-relative accesses.  The following 
22360 @var{option} names are recognized:
22362 @table @samp
22364 @item none
22365 Do not generate GP-relative accesses.
22367 @item local
22368 Generate GP-relative accesses for small data objects that are not 
22369 external, weak, or uninitialized common symbols.  
22370 Also use GP-relative addressing for objects that
22371 have been explicitly placed in a small data section via a @code{section}
22372 attribute.
22374 @item global
22375 As for @samp{local}, but also generate GP-relative accesses for
22376 small data objects that are external, weak, or common.  If you use this option,
22377 you must ensure that all parts of your program (including libraries) are
22378 compiled with the same @option{-G} setting.
22380 @item data
22381 Generate GP-relative accesses for all data objects in the program.  If you
22382 use this option, the entire data and BSS segments
22383 of your program must fit in 64K of memory and you must use an appropriate
22384 linker script to allocate them within the addressable range of the
22385 global pointer.
22387 @item all
22388 Generate GP-relative addresses for function pointers as well as data
22389 pointers.  If you use this option, the entire text, data, and BSS segments
22390 of your program must fit in 64K of memory and you must use an appropriate
22391 linker script to allocate them within the addressable range of the
22392 global pointer.
22394 @end table
22396 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
22397 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
22399 The default is @option{-mgpopt} except when @option{-fpic} or
22400 @option{-fPIC} is specified to generate position-independent code.
22401 Note that the Nios II ABI does not permit GP-relative accesses from
22402 shared libraries.
22404 You may need to specify @option{-mno-gpopt} explicitly when building
22405 programs that include large amounts of small data, including large
22406 GOT data sections.  In this case, the 16-bit offset for GP-relative
22407 addressing may not be large enough to allow access to the entire 
22408 small data section.
22410 @item -mgprel-sec=@var{regexp}
22411 @opindex mgprel-sec
22412 This option specifies additional section names that can be accessed via
22413 GP-relative addressing.  It is most useful in conjunction with 
22414 @code{section} attributes on variable declarations 
22415 (@pxref{Common Variable Attributes}) and a custom linker script.  
22416 The @var{regexp} is a POSIX Extended Regular Expression.
22418 This option does not affect the behavior of the @option{-G} option, and 
22419 the specified sections are in addition to the standard @code{.sdata}
22420 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
22422 @item -mr0rel-sec=@var{regexp}
22423 @opindex mr0rel-sec
22424 This option specifies names of sections that can be accessed via a 
22425 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
22426 of the 32-bit address space.  It is most useful in conjunction with 
22427 @code{section} attributes on variable declarations 
22428 (@pxref{Common Variable Attributes}) and a custom linker script.  
22429 The @var{regexp} is a POSIX Extended Regular Expression.
22431 In contrast to the use of GP-relative addressing for small data, 
22432 zero-based addressing is never generated by default and there are no 
22433 conventional section names used in standard linker scripts for sections
22434 in the low or high areas of memory.
22436 @item -mel
22437 @itemx -meb
22438 @opindex mel
22439 @opindex meb
22440 Generate little-endian (default) or big-endian (experimental) code,
22441 respectively.
22443 @item -march=@var{arch}
22444 @opindex march
22445 This specifies the name of the target Nios II architecture.  GCC uses this
22446 name to determine what kind of instructions it can emit when generating
22447 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
22449 The preprocessor macro @code{__nios2_arch__} is available to programs,
22450 with value 1 or 2, indicating the targeted ISA level.
22452 @item -mbypass-cache
22453 @itemx -mno-bypass-cache
22454 @opindex mno-bypass-cache
22455 @opindex mbypass-cache
22456 Force all load and store instructions to always bypass cache by 
22457 using I/O variants of the instructions. The default is not to
22458 bypass the cache.
22460 @item -mno-cache-volatile 
22461 @itemx -mcache-volatile       
22462 @opindex mcache-volatile 
22463 @opindex mno-cache-volatile
22464 Volatile memory access bypass the cache using the I/O variants of 
22465 the load and store instructions. The default is not to bypass the cache.
22467 @item -mno-fast-sw-div
22468 @itemx -mfast-sw-div
22469 @opindex mno-fast-sw-div
22470 @opindex mfast-sw-div
22471 Do not use table-based fast divide for small numbers. The default 
22472 is to use the fast divide at @option{-O3} and above.
22474 @item -mno-hw-mul
22475 @itemx -mhw-mul
22476 @itemx -mno-hw-mulx
22477 @itemx -mhw-mulx
22478 @itemx -mno-hw-div
22479 @itemx -mhw-div
22480 @opindex mno-hw-mul
22481 @opindex mhw-mul
22482 @opindex mno-hw-mulx
22483 @opindex mhw-mulx
22484 @opindex mno-hw-div
22485 @opindex mhw-div
22486 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
22487 instructions by the compiler. The default is to emit @code{mul}
22488 and not emit @code{div} and @code{mulx}.
22490 @item -mbmx
22491 @itemx -mno-bmx
22492 @itemx -mcdx
22493 @itemx -mno-cdx
22494 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
22495 CDX (code density) instructions.  Enabling these instructions also
22496 requires @option{-march=r2}.  Since these instructions are optional
22497 extensions to the R2 architecture, the default is not to emit them.
22499 @item -mcustom-@var{insn}=@var{N}
22500 @itemx -mno-custom-@var{insn}
22501 @opindex mcustom-@var{insn}
22502 @opindex mno-custom-@var{insn}
22503 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
22504 custom instruction with encoding @var{N} when generating code that uses 
22505 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
22506 instruction 253 for single-precision floating-point add operations instead
22507 of the default behavior of using a library call.
22509 The following values of @var{insn} are supported.  Except as otherwise
22510 noted, floating-point operations are expected to be implemented with
22511 normal IEEE 754 semantics and correspond directly to the C operators or the
22512 equivalent GCC built-in functions (@pxref{Other Builtins}).
22514 Single-precision floating point:
22515 @table @asis
22517 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
22518 Binary arithmetic operations.
22520 @item @samp{fnegs}
22521 Unary negation.
22523 @item @samp{fabss}
22524 Unary absolute value.
22526 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
22527 Comparison operations.
22529 @item @samp{fmins}, @samp{fmaxs}
22530 Floating-point minimum and maximum.  These instructions are only
22531 generated if @option{-ffinite-math-only} is specified.
22533 @item @samp{fsqrts}
22534 Unary square root operation.
22536 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
22537 Floating-point trigonometric and exponential functions.  These instructions
22538 are only generated if @option{-funsafe-math-optimizations} is also specified.
22540 @end table
22542 Double-precision floating point:
22543 @table @asis
22545 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
22546 Binary arithmetic operations.
22548 @item @samp{fnegd}
22549 Unary negation.
22551 @item @samp{fabsd}
22552 Unary absolute value.
22554 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
22555 Comparison operations.
22557 @item @samp{fmind}, @samp{fmaxd}
22558 Double-precision minimum and maximum.  These instructions are only
22559 generated if @option{-ffinite-math-only} is specified.
22561 @item @samp{fsqrtd}
22562 Unary square root operation.
22564 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
22565 Double-precision trigonometric and exponential functions.  These instructions
22566 are only generated if @option{-funsafe-math-optimizations} is also specified.
22568 @end table
22570 Conversions:
22571 @table @asis
22572 @item @samp{fextsd}
22573 Conversion from single precision to double precision.
22575 @item @samp{ftruncds}
22576 Conversion from double precision to single precision.
22578 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
22579 Conversion from floating point to signed or unsigned integer types, with
22580 truncation towards zero.
22582 @item @samp{round}
22583 Conversion from single-precision floating point to signed integer,
22584 rounding to the nearest integer and ties away from zero.
22585 This corresponds to the @code{__builtin_lroundf} function when
22586 @option{-fno-math-errno} is used.
22588 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
22589 Conversion from signed or unsigned integer types to floating-point types.
22591 @end table
22593 In addition, all of the following transfer instructions for internal
22594 registers X and Y must be provided to use any of the double-precision
22595 floating-point instructions.  Custom instructions taking two
22596 double-precision source operands expect the first operand in the
22597 64-bit register X.  The other operand (or only operand of a unary
22598 operation) is given to the custom arithmetic instruction with the
22599 least significant half in source register @var{src1} and the most
22600 significant half in @var{src2}.  A custom instruction that returns a
22601 double-precision result returns the most significant 32 bits in the
22602 destination register and the other half in 32-bit register Y.  
22603 GCC automatically generates the necessary code sequences to write
22604 register X and/or read register Y when double-precision floating-point
22605 instructions are used.
22607 @table @asis
22609 @item @samp{fwrx}
22610 Write @var{src1} into the least significant half of X and @var{src2} into
22611 the most significant half of X.
22613 @item @samp{fwry}
22614 Write @var{src1} into Y.
22616 @item @samp{frdxhi}, @samp{frdxlo}
22617 Read the most or least (respectively) significant half of X and store it in
22618 @var{dest}.
22620 @item @samp{frdy}
22621 Read the value of Y and store it into @var{dest}.
22622 @end table
22624 Note that you can gain more local control over generation of Nios II custom
22625 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
22626 and @code{target("no-custom-@var{insn}")} function attributes
22627 (@pxref{Function Attributes})
22628 or pragmas (@pxref{Function Specific Option Pragmas}).
22630 @item -mcustom-fpu-cfg=@var{name}
22631 @opindex mcustom-fpu-cfg
22633 This option enables a predefined, named set of custom instruction encodings
22634 (see @option{-mcustom-@var{insn}} above).  
22635 Currently, the following sets are defined:
22637 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
22638 @gccoptlist{-mcustom-fmuls=252 @gol
22639 -mcustom-fadds=253 @gol
22640 -mcustom-fsubs=254 @gol
22641 -fsingle-precision-constant}
22643 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
22644 @gccoptlist{-mcustom-fmuls=252 @gol
22645 -mcustom-fadds=253 @gol
22646 -mcustom-fsubs=254 @gol
22647 -mcustom-fdivs=255 @gol
22648 -fsingle-precision-constant}
22650 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
22651 @gccoptlist{-mcustom-floatus=243 @gol
22652 -mcustom-fixsi=244 @gol
22653 -mcustom-floatis=245 @gol
22654 -mcustom-fcmpgts=246 @gol
22655 -mcustom-fcmples=249 @gol
22656 -mcustom-fcmpeqs=250 @gol
22657 -mcustom-fcmpnes=251 @gol
22658 -mcustom-fmuls=252 @gol
22659 -mcustom-fadds=253 @gol
22660 -mcustom-fsubs=254 @gol
22661 -mcustom-fdivs=255 @gol
22662 -fsingle-precision-constant}
22664 Custom instruction assignments given by individual
22665 @option{-mcustom-@var{insn}=} options override those given by
22666 @option{-mcustom-fpu-cfg=}, regardless of the
22667 order of the options on the command line.
22669 Note that you can gain more local control over selection of a FPU
22670 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
22671 function attribute (@pxref{Function Attributes})
22672 or pragma (@pxref{Function Specific Option Pragmas}).
22674 @end table
22676 These additional @samp{-m} options are available for the Altera Nios II
22677 ELF (bare-metal) target:
22679 @table @gcctabopt
22681 @item -mhal
22682 @opindex mhal
22683 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
22684 startup and termination code, and is typically used in conjunction with
22685 @option{-msys-crt0=} to specify the location of the alternate startup code
22686 provided by the HAL BSP.
22688 @item -msmallc
22689 @opindex msmallc
22690 Link with a limited version of the C library, @option{-lsmallc}, rather than
22691 Newlib.
22693 @item -msys-crt0=@var{startfile}
22694 @opindex msys-crt0
22695 @var{startfile} is the file name of the startfile (crt0) to use 
22696 when linking.  This option is only useful in conjunction with @option{-mhal}.
22698 @item -msys-lib=@var{systemlib}
22699 @opindex msys-lib
22700 @var{systemlib} is the library name of the library that provides
22701 low-level system calls required by the C library,
22702 e.g.@: @code{read} and @code{write}.
22703 This option is typically used to link with a library provided by a HAL BSP.
22705 @end table
22707 @node Nvidia PTX Options
22708 @subsection Nvidia PTX Options
22709 @cindex Nvidia PTX options
22710 @cindex nvptx options
22712 These options are defined for Nvidia PTX:
22714 @table @gcctabopt
22716 @item -m32
22717 @itemx -m64
22718 @opindex m32
22719 @opindex m64
22720 Generate code for 32-bit or 64-bit ABI.
22722 @item -misa=@var{ISA-string}
22723 @opindex march
22724 Generate code for given the specified PTX ISA (e.g.@: @samp{sm_35}).  ISA
22725 strings must be lower-case.  Valid ISA strings include @samp{sm_30} and
22726 @samp{sm_35}.  The default ISA is sm_30.
22728 @item -mmainkernel
22729 @opindex mmainkernel
22730 Link in code for a __main kernel.  This is for stand-alone instead of
22731 offloading execution.
22733 @item -moptimize
22734 @opindex moptimize
22735 Apply partitioned execution optimizations.  This is the default when any
22736 level of optimization is selected.
22738 @item -msoft-stack
22739 @opindex msoft-stack
22740 Generate code that does not use @code{.local} memory
22741 directly for stack storage. Instead, a per-warp stack pointer is
22742 maintained explicitly. This enables variable-length stack allocation (with
22743 variable-length arrays or @code{alloca}), and when global memory is used for
22744 underlying storage, makes it possible to access automatic variables from other
22745 threads, or with atomic instructions. This code generation variant is used
22746 for OpenMP offloading, but the option is exposed on its own for the purpose
22747 of testing the compiler; to generate code suitable for linking into programs
22748 using OpenMP offloading, use option @option{-mgomp}.
22750 @item -muniform-simt
22751 @opindex muniform-simt
22752 Switch to code generation variant that allows to execute all threads in each
22753 warp, while maintaining memory state and side effects as if only one thread
22754 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22755 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22756 current lane index equals the master lane index), and the register being
22757 assigned is copied via a shuffle instruction from the master lane.  Outside of
22758 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22759 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22760 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22761 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22762 with current lane index to compute the master lane index.
22764 @item -mgomp
22765 @opindex mgomp
22766 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22767 @option{-muniform-simt} options, and selects corresponding multilib variant.
22769 @end table
22771 @node OpenRISC Options
22772 @subsection OpenRISC Options
22773 @cindex OpenRISC Options
22775 These options are defined for OpenRISC:
22777 @table @gcctabopt
22779 @item -mboard=@var{name}
22780 @opindex mboard
22781 Configure a board specific runtime.  This will be passed to the linker for
22782 newlib board library linking.  The default is @code{or1ksim}.
22784 @item -mnewlib
22785 @opindex mnewlib
22786 For compatibility, it's always newlib for elf now.
22788 @item -mhard-div
22789 @opindex mhard-div
22790 Generate code for hardware which supports divide instructions.  This is the
22791 default.
22793 @item -mhard-mul
22794 @opindex mhard-mul
22795 Generate code for hardware which supports multiply instructions.  This is the
22796 default.
22798 @item -mcmov
22799 @opindex mcmov
22800 Generate code for hardware which supports the conditional move (@code{l.cmov})
22801 instruction.
22803 @item -mror
22804 @opindex mror
22805 Generate code for hardware which supports rotate right instructions.
22807 @item -msext
22808 @opindex msext
22809 Generate code for hardware which supports sign-extension instructions.
22811 @item -msfimm
22812 @opindex msfimm
22813 Generate code for hardware which supports set flag immediate (@code{l.sf*i})
22814 instructions.
22816 @item -mshftimm
22817 @opindex mshftimm
22818 Generate code for hardware which supports shift immediate related instructions
22819 (i.e. @code{l.srai}, @code{l.srli}, @code{l.slli}, @code{1.rori}).  Note, to
22820 enable generation of the @code{l.rori} instruction the @option{-mror} flag must
22821 also be specified.
22823 @item -msoft-div
22824 @opindex msoft-div
22825 Generate code for hardware which requires divide instruction emulation.
22827 @item -msoft-mul
22828 @opindex msoft-mul
22829 Generate code for hardware which requires multiply instruction emulation.
22831 @end table
22833 @node PDP-11 Options
22834 @subsection PDP-11 Options
22835 @cindex PDP-11 Options
22837 These options are defined for the PDP-11:
22839 @table @gcctabopt
22840 @item -mfpu
22841 @opindex mfpu
22842 Use hardware FPP floating point.  This is the default.  (FIS floating
22843 point on the PDP-11/40 is not supported.)  Implies -m45.
22845 @item -msoft-float
22846 @opindex msoft-float
22847 Do not use hardware floating point.
22849 @item -mac0
22850 @opindex mac0
22851 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22853 @item -mno-ac0
22854 @opindex mno-ac0
22855 Return floating-point results in memory.  This is the default.
22857 @item -m40
22858 @opindex m40
22859 Generate code for a PDP-11/40.  Implies -msoft-float -mno-split.
22861 @item -m45
22862 @opindex m45
22863 Generate code for a PDP-11/45.  This is the default.
22865 @item -m10
22866 @opindex m10
22867 Generate code for a PDP-11/10.  Implies -msoft-float -mno-split.
22869 @item -mint16
22870 @itemx -mno-int32
22871 @opindex mint16
22872 @opindex mno-int32
22873 Use 16-bit @code{int}.  This is the default.
22875 @item -mint32
22876 @itemx -mno-int16
22877 @opindex mint32
22878 @opindex mno-int16
22879 Use 32-bit @code{int}.
22881 @item -msplit
22882 @opindex msplit
22883 Target has split instruction and data space.  Implies -m45.
22885 @item -munix-asm
22886 @opindex munix-asm
22887 Use Unix assembler syntax.
22889 @item -mdec-asm
22890 @opindex mdec-asm
22891 Use DEC assembler syntax.
22893 @item -mgnu-asm
22894 @opindex mgnu-asm
22895 Use GNU assembler syntax.  This is the default.
22897 @item -mlra
22898 @opindex mlra
22899 Use the new LRA register allocator.  By default, the old ``reload''
22900 allocator is used.
22901 @end table
22903 @node picoChip Options
22904 @subsection picoChip Options
22905 @cindex picoChip options
22907 These @samp{-m} options are defined for picoChip implementations:
22909 @table @gcctabopt
22911 @item -mae=@var{ae_type}
22912 @opindex mcpu
22913 Set the instruction set, register set, and instruction scheduling
22914 parameters for array element type @var{ae_type}.  Supported values
22915 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22917 @option{-mae=ANY} selects a completely generic AE type.  Code
22918 generated with this option runs on any of the other AE types.  The
22919 code is not as efficient as it would be if compiled for a specific
22920 AE type, and some types of operation (e.g., multiplication) do not
22921 work properly on all types of AE.
22923 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22924 for compiled code, and is the default.
22926 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22927 option may suffer from poor performance of byte (char) manipulation,
22928 since the DSP AE does not provide hardware support for byte load/stores.
22930 @item -msymbol-as-address
22931 Enable the compiler to directly use a symbol name as an address in a
22932 load/store instruction, without first loading it into a
22933 register.  Typically, the use of this option generates larger
22934 programs, which run faster than when the option isn't used.  However, the
22935 results vary from program to program, so it is left as a user option,
22936 rather than being permanently enabled.
22938 @item -mno-inefficient-warnings
22939 Disables warnings about the generation of inefficient code.  These
22940 warnings can be generated, for example, when compiling code that
22941 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22942 no hardware support for byte-level memory operations, so all byte
22943 load/stores must be synthesized from word load/store operations.  This is
22944 inefficient and a warning is generated to indicate
22945 that you should rewrite the code to avoid byte operations, or to target
22946 an AE type that has the necessary hardware support.  This option disables
22947 these warnings.
22949 @end table
22951 @node PowerPC Options
22952 @subsection PowerPC Options
22953 @cindex PowerPC options
22955 These are listed under @xref{RS/6000 and PowerPC Options}.
22957 @node PowerPC SPE Options
22958 @subsection PowerPC SPE Options
22959 @cindex PowerPC SPE options
22961 These @samp{-m} options are defined for PowerPC SPE:
22962 @table @gcctabopt
22963 @item -mmfcrf
22964 @itemx -mno-mfcrf
22965 @itemx -mpopcntb
22966 @itemx -mno-popcntb
22967 @opindex mmfcrf
22968 @opindex mno-mfcrf
22969 @opindex mpopcntb
22970 @opindex mno-popcntb
22971 You use these options to specify which instructions are available on the
22972 processor you are using.  The default value of these options is
22973 determined when configuring GCC@.  Specifying the
22974 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22975 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22976 rather than the options listed above.
22978 The @option{-mmfcrf} option allows GCC to generate the move from
22979 condition register field instruction implemented on the POWER4
22980 processor and other processors that support the PowerPC V2.01
22981 architecture.
22982 The @option{-mpopcntb} option allows GCC to generate the popcount and
22983 double-precision FP reciprocal estimate instruction implemented on the
22984 POWER5 processor and other processors that support the PowerPC V2.02
22985 architecture.
22987 @item -mcpu=@var{cpu_type}
22988 @opindex mcpu
22989 Set architecture type, register usage, and
22990 instruction scheduling parameters for machine type @var{cpu_type}.
22991 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22992 and @samp{native}.
22994 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22995 endian), with an appropriate, generic processor model assumed for
22996 scheduling purposes.
22998 Specifying @samp{native} as cpu type detects and selects the
22999 architecture option that corresponds to the host processor of the
23000 system performing the compilation.
23001 @option{-mcpu=native} has no effect if GCC does not recognize the
23002 processor.
23004 The other options specify a specific processor.  Code generated under
23005 those options runs best on that processor, and may not run at all on
23006 others.
23008 The @option{-mcpu} options automatically enable or disable the
23009 following options:
23011 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
23012 -mpopcntb -mpopcntd @gol
23013 -msingle-float -mdouble-float @gol
23014 -mfloat128}
23016 The particular options set for any particular CPU varies between
23017 compiler versions, depending on what setting seems to produce optimal
23018 code for that CPU; it doesn't necessarily reflect the actual hardware's
23019 capabilities.  If you wish to set an individual option to a particular
23020 value, you may specify it after the @option{-mcpu} option, like
23021 @option{-mcpu=8548}.
23023 @item -mtune=@var{cpu_type}
23024 @opindex mtune
23025 Set the instruction scheduling parameters for machine type
23026 @var{cpu_type}, but do not set the architecture type or register usage,
23027 as @option{-mcpu=@var{cpu_type}} does.  The same
23028 values for @var{cpu_type} are used for @option{-mtune} as for
23029 @option{-mcpu}.  If both are specified, the code generated uses the
23030 architecture and registers set by @option{-mcpu}, but the
23031 scheduling parameters set by @option{-mtune}.
23033 @item -msecure-plt
23034 @opindex msecure-plt
23035 Generate code that allows @command{ld} and @command{ld.so}
23036 to build executables and shared
23037 libraries with non-executable @code{.plt} and @code{.got} sections.
23038 This is a PowerPC
23039 32-bit SYSV ABI option.
23041 @item -mbss-plt
23042 @opindex mbss-plt
23043 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23044 fills in, and
23045 requires @code{.plt} and @code{.got}
23046 sections that are both writable and executable.
23047 This is a PowerPC 32-bit SYSV ABI option.
23049 @item -misel
23050 @itemx -mno-isel
23051 @opindex misel
23052 @opindex mno-isel
23053 This switch enables or disables the generation of ISEL instructions.
23055 @item -misel=@var{yes/no}
23056 This switch has been deprecated.  Use @option{-misel} and
23057 @option{-mno-isel} instead.
23059 @item -mspe
23060 @itemx -mno-spe
23061 @opindex mspe
23062 @opindex mno-spe
23063 This switch enables or disables the generation of SPE simd
23064 instructions.
23066 @item -mspe=@var{yes/no}
23067 This option has been deprecated.  Use @option{-mspe} and
23068 @option{-mno-spe} instead.
23070 @item -mfloat128
23071 @itemx -mno-float128
23072 @opindex mfloat128
23073 @opindex mno-float128
23074 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23075 and use either software emulation for IEEE 128-bit floating point or
23076 hardware instructions.
23078 @item -mfloat-gprs=@var{yes/single/double/no}
23079 @itemx -mfloat-gprs
23080 @opindex mfloat-gprs
23081 This switch enables or disables the generation of floating-point
23082 operations on the general-purpose registers for architectures that
23083 support it.
23085 The argument @samp{yes} or @samp{single} enables the use of
23086 single-precision floating-point operations.
23088 The argument @samp{double} enables the use of single and
23089 double-precision floating-point operations.
23091 The argument @samp{no} disables floating-point operations on the
23092 general-purpose registers.
23094 This option is currently only available on the MPC854x.
23096 @item -mfull-toc
23097 @itemx -mno-fp-in-toc
23098 @itemx -mno-sum-in-toc
23099 @itemx -mminimal-toc
23100 @opindex mfull-toc
23101 @opindex mno-fp-in-toc
23102 @opindex mno-sum-in-toc
23103 @opindex mminimal-toc
23104 Modify generation of the TOC (Table Of Contents), which is created for
23105 every executable file.  The @option{-mfull-toc} option is selected by
23106 default.  In that case, GCC allocates at least one TOC entry for
23107 each unique non-automatic variable reference in your program.  GCC
23108 also places floating-point constants in the TOC@.  However, only
23109 16,384 entries are available in the TOC@.
23111 If you receive a linker error message that saying you have overflowed
23112 the available TOC space, you can reduce the amount of TOC space used
23113 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23114 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23115 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23116 generate code to calculate the sum of an address and a constant at
23117 run time instead of putting that sum into the TOC@.  You may specify one
23118 or both of these options.  Each causes GCC to produce very slightly
23119 slower and larger code at the expense of conserving TOC space.
23121 If you still run out of space in the TOC even when you specify both of
23122 these options, specify @option{-mminimal-toc} instead.  This option causes
23123 GCC to make only one TOC entry for every file.  When you specify this
23124 option, GCC produces code that is slower and larger but which
23125 uses extremely little TOC space.  You may wish to use this option
23126 only on files that contain less frequently-executed code.
23128 @item -maix32
23129 @opindex maix32
23130 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
23132 @item -mxl-compat
23133 @itemx -mno-xl-compat
23134 @opindex mxl-compat
23135 @opindex mno-xl-compat
23136 Produce code that conforms more closely to IBM XL compiler semantics
23137 when using AIX-compatible ABI@.  Pass floating-point arguments to
23138 prototyped functions beyond the register save area (RSA) on the stack
23139 in addition to argument FPRs.  Do not assume that most significant
23140 double in 128-bit long double value is properly rounded when comparing
23141 values and converting to double.  Use XL symbol names for long double
23142 support routines.
23144 The AIX calling convention was extended but not initially documented to
23145 handle an obscure K&R C case of calling a function that takes the
23146 address of its arguments with fewer arguments than declared.  IBM XL
23147 compilers access floating-point arguments that do not fit in the
23148 RSA from the stack when a subroutine is compiled without
23149 optimization.  Because always storing floating-point arguments on the
23150 stack is inefficient and rarely needed, this option is not enabled by
23151 default and only is necessary when calling subroutines compiled by IBM
23152 XL compilers without optimization.
23154 @item -malign-natural
23155 @itemx -malign-power
23156 @opindex malign-natural
23157 @opindex malign-power
23158 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23159 @option{-malign-natural} overrides the ABI-defined alignment of larger
23160 types, such as floating-point doubles, on their natural size-based boundary.
23161 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23162 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23164 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23165 is not supported.
23167 @item -msoft-float
23168 @itemx -mhard-float
23169 @opindex msoft-float
23170 @opindex mhard-float
23171 Generate code that does not use (uses) the floating-point register set.
23172 Software floating-point emulation is provided if you use the
23173 @option{-msoft-float} option, and pass the option to GCC when linking.
23175 @item -msingle-float
23176 @itemx -mdouble-float
23177 @opindex msingle-float
23178 @opindex mdouble-float
23179 Generate code for single- or double-precision floating-point operations.
23180 @option{-mdouble-float} implies @option{-msingle-float}.
23182 @item -mmultiple
23183 @itemx -mno-multiple
23184 @opindex mmultiple
23185 @opindex mno-multiple
23186 Generate code that uses (does not use) the load multiple word
23187 instructions and the store multiple word instructions.  These
23188 instructions are generated by default on POWER systems, and not
23189 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23190 PowerPC systems, since those instructions do not work when the
23191 processor is in little-endian mode.  The exceptions are PPC740 and
23192 PPC750 which permit these instructions in little-endian mode.
23194 @item -mupdate
23195 @itemx -mno-update
23196 @opindex mupdate
23197 @opindex mno-update
23198 Generate code that uses (does not use) the load or store instructions
23199 that update the base register to the address of the calculated memory
23200 location.  These instructions are generated by default.  If you use
23201 @option{-mno-update}, there is a small window between the time that the
23202 stack pointer is updated and the address of the previous frame is
23203 stored, which means code that walks the stack frame across interrupts or
23204 signals may get corrupted data.
23206 @item -mavoid-indexed-addresses
23207 @itemx -mno-avoid-indexed-addresses
23208 @opindex mavoid-indexed-addresses
23209 @opindex mno-avoid-indexed-addresses
23210 Generate code that tries to avoid (not avoid) the use of indexed load
23211 or store instructions. These instructions can incur a performance
23212 penalty on Power6 processors in certain situations, such as when
23213 stepping through large arrays that cross a 16M boundary.  This option
23214 is enabled by default when targeting Power6 and disabled otherwise.
23216 @item -mfused-madd
23217 @itemx -mno-fused-madd
23218 @opindex mfused-madd
23219 @opindex mno-fused-madd
23220 Generate code that uses (does not use) the floating-point multiply and
23221 accumulate instructions.  These instructions are generated by default
23222 if hardware floating point is used.  The machine-dependent
23223 @option{-mfused-madd} option is now mapped to the machine-independent
23224 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23225 mapped to @option{-ffp-contract=off}.
23227 @item -mno-strict-align
23228 @itemx -mstrict-align
23229 @opindex mno-strict-align
23230 @opindex mstrict-align
23231 On System V.4 and embedded PowerPC systems do not (do) assume that
23232 unaligned memory references are handled by the system.
23234 @item -mrelocatable
23235 @itemx -mno-relocatable
23236 @opindex mrelocatable
23237 @opindex mno-relocatable
23238 Generate code that allows (does not allow) a static executable to be
23239 relocated to a different address at run time.  A simple embedded
23240 PowerPC system loader should relocate the entire contents of
23241 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23242 a table of 32-bit addresses generated by this option.  For this to
23243 work, all objects linked together must be compiled with
23244 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23245 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23247 @item -mrelocatable-lib
23248 @itemx -mno-relocatable-lib
23249 @opindex mrelocatable-lib
23250 @opindex mno-relocatable-lib
23251 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23252 @code{.fixup} section to allow static executables to be relocated at
23253 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23254 alignment of @option{-mrelocatable}.  Objects compiled with
23255 @option{-mrelocatable-lib} may be linked with objects compiled with
23256 any combination of the @option{-mrelocatable} options.
23258 @item -mno-toc
23259 @itemx -mtoc
23260 @opindex mno-toc
23261 @opindex mtoc
23262 On System V.4 and embedded PowerPC systems do not (do) assume that
23263 register 2 contains a pointer to a global area pointing to the addresses
23264 used in the program.
23266 @item -mlittle
23267 @itemx -mlittle-endian
23268 @opindex mlittle
23269 @opindex mlittle-endian
23270 On System V.4 and embedded PowerPC systems compile code for the
23271 processor in little-endian mode.  The @option{-mlittle-endian} option is
23272 the same as @option{-mlittle}.
23274 @item -mbig
23275 @itemx -mbig-endian
23276 @opindex mbig
23277 @opindex mbig-endian
23278 On System V.4 and embedded PowerPC systems compile code for the
23279 processor in big-endian mode.  The @option{-mbig-endian} option is
23280 the same as @option{-mbig}.
23282 @item -mdynamic-no-pic
23283 @opindex mdynamic-no-pic
23284 On Darwin and Mac OS X systems, compile code so that it is not
23285 relocatable, but that its external references are relocatable.  The
23286 resulting code is suitable for applications, but not shared
23287 libraries.
23289 @item -msingle-pic-base
23290 @opindex msingle-pic-base
23291 Treat the register used for PIC addressing as read-only, rather than
23292 loading it in the prologue for each function.  The runtime system is
23293 responsible for initializing this register with an appropriate value
23294 before execution begins.
23296 @item -mprioritize-restricted-insns=@var{priority}
23297 @opindex mprioritize-restricted-insns
23298 This option controls the priority that is assigned to
23299 dispatch-slot restricted instructions during the second scheduling
23300 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23301 or @samp{2} to assign no, highest, or second-highest (respectively)
23302 priority to dispatch-slot restricted
23303 instructions.
23305 @item -msched-costly-dep=@var{dependence_type}
23306 @opindex msched-costly-dep
23307 This option controls which dependences are considered costly
23308 by the target during instruction scheduling.  The argument
23309 @var{dependence_type} takes one of the following values:
23311 @table @asis
23312 @item @samp{no}
23313 No dependence is costly.
23315 @item @samp{all}
23316 All dependences are costly.
23318 @item @samp{true_store_to_load}
23319 A true dependence from store to load is costly.
23321 @item @samp{store_to_load}
23322 Any dependence from store to load is costly.
23324 @item @var{number}
23325 Any dependence for which the latency is greater than or equal to
23326 @var{number} is costly.
23327 @end table
23329 @item -minsert-sched-nops=@var{scheme}
23330 @opindex minsert-sched-nops
23331 This option controls which NOP insertion scheme is used during
23332 the second scheduling pass.  The argument @var{scheme} takes one of the
23333 following values:
23335 @table @asis
23336 @item @samp{no}
23337 Don't insert NOPs.
23339 @item @samp{pad}
23340 Pad with NOPs any dispatch group that has vacant issue slots,
23341 according to the scheduler's grouping.
23343 @item @samp{regroup_exact}
23344 Insert NOPs to force costly dependent insns into
23345 separate groups.  Insert exactly as many NOPs as needed to force an insn
23346 to a new group, according to the estimated processor grouping.
23348 @item @var{number}
23349 Insert NOPs to force costly dependent insns into
23350 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23351 @end table
23353 @item -mcall-sysv
23354 @opindex mcall-sysv
23355 On System V.4 and embedded PowerPC systems compile code using calling
23356 conventions that adhere to the March 1995 draft of the System V
23357 Application Binary Interface, PowerPC processor supplement.  This is the
23358 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23360 @item -mcall-sysv-eabi
23361 @itemx -mcall-eabi
23362 @opindex mcall-sysv-eabi
23363 @opindex mcall-eabi
23364 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23366 @item -mcall-sysv-noeabi
23367 @opindex mcall-sysv-noeabi
23368 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23370 @item -mcall-aixdesc
23371 @opindex m
23372 On System V.4 and embedded PowerPC systems compile code for the AIX
23373 operating system.
23375 @item -mcall-linux
23376 @opindex mcall-linux
23377 On System V.4 and embedded PowerPC systems compile code for the
23378 Linux-based GNU system.
23380 @item -mcall-freebsd
23381 @opindex mcall-freebsd
23382 On System V.4 and embedded PowerPC systems compile code for the
23383 FreeBSD operating system.
23385 @item -mcall-netbsd
23386 @opindex mcall-netbsd
23387 On System V.4 and embedded PowerPC systems compile code for the
23388 NetBSD operating system.
23390 @item -mcall-openbsd
23391 @opindex mcall-netbsd
23392 On System V.4 and embedded PowerPC systems compile code for the
23393 OpenBSD operating system.
23395 @item -maix-struct-return
23396 @opindex maix-struct-return
23397 Return all structures in memory (as specified by the AIX ABI)@.
23399 @item -msvr4-struct-return
23400 @opindex msvr4-struct-return
23401 Return structures smaller than 8 bytes in registers (as specified by the
23402 SVR4 ABI)@.
23404 @item -mabi=@var{abi-type}
23405 @opindex mabi
23406 Extend the current ABI with a particular extension, or remove such extension.
23407 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23408 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23409 @samp{elfv1}, @samp{elfv2}@.
23411 @item -mabi=spe
23412 @opindex mabi=spe
23413 Extend the current ABI with SPE ABI extensions.  This does not change
23414 the default ABI, instead it adds the SPE ABI extensions to the current
23415 ABI@.
23417 @item -mabi=no-spe
23418 @opindex mabi=no-spe
23419 Disable Book-E SPE ABI extensions for the current ABI@.
23421 @item -mabi=ibmlongdouble
23422 @opindex mabi=ibmlongdouble
23423 Change the current ABI to use IBM extended-precision long double.
23424 This is not likely to work if your system defaults to using IEEE
23425 extended-precision long double.  If you change the long double type
23426 from IEEE extended-precision, the compiler will issue a warning unless
23427 you use the @option{-Wno-psabi} option.
23429 @item -mabi=ieeelongdouble
23430 @opindex mabi=ieeelongdouble
23431 Change the current ABI to use IEEE extended-precision long double.
23432 This is not likely to work if your system defaults to using IBM
23433 extended-precision long double.  If you change the long double type
23434 from IBM extended-precision, the compiler will issue a warning unless
23435 you use the @option{-Wno-psabi} option.
23437 @item -mabi=elfv1
23438 @opindex mabi=elfv1
23439 Change the current ABI to use the ELFv1 ABI.
23440 This is the default ABI for big-endian PowerPC 64-bit Linux.
23441 Overriding the default ABI requires special system support and is
23442 likely to fail in spectacular ways.
23444 @item -mabi=elfv2
23445 @opindex mabi=elfv2
23446 Change the current ABI to use the ELFv2 ABI.
23447 This is the default ABI for little-endian PowerPC 64-bit Linux.
23448 Overriding the default ABI requires special system support and is
23449 likely to fail in spectacular ways.
23451 @item -mgnu-attribute
23452 @itemx -mno-gnu-attribute
23453 @opindex mgnu-attribute
23454 @opindex mno-gnu-attribute
23455 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23456 .gnu.attributes section that specify ABI variations in function
23457 parameters or return values.
23459 @item -mprototype
23460 @itemx -mno-prototype
23461 @opindex mprototype
23462 @opindex mno-prototype
23463 On System V.4 and embedded PowerPC systems assume that all calls to
23464 variable argument functions are properly prototyped.  Otherwise, the
23465 compiler must insert an instruction before every non-prototyped call to
23466 set or clear bit 6 of the condition code register (@code{CR}) to
23467 indicate whether floating-point values are passed in the floating-point
23468 registers in case the function takes variable arguments.  With
23469 @option{-mprototype}, only calls to prototyped variable argument functions
23470 set or clear the bit.
23472 @item -msim
23473 @opindex msim
23474 On embedded PowerPC systems, assume that the startup module is called
23475 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23476 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23477 configurations.
23479 @item -mmvme
23480 @opindex mmvme
23481 On embedded PowerPC systems, assume that the startup module is called
23482 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23483 @file{libc.a}.
23485 @item -mads
23486 @opindex mads
23487 On embedded PowerPC systems, assume that the startup module is called
23488 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23489 @file{libc.a}.
23491 @item -myellowknife
23492 @opindex myellowknife
23493 On embedded PowerPC systems, assume that the startup module is called
23494 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
23495 @file{libc.a}.
23497 @item -mvxworks
23498 @opindex mvxworks
23499 On System V.4 and embedded PowerPC systems, specify that you are
23500 compiling for a VxWorks system.
23502 @item -memb
23503 @opindex memb
23504 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23505 header to indicate that @samp{eabi} extended relocations are used.
23507 @item -meabi
23508 @itemx -mno-eabi
23509 @opindex meabi
23510 @opindex mno-eabi
23511 On System V.4 and embedded PowerPC systems do (do not) adhere to the
23512 Embedded Applications Binary Interface (EABI), which is a set of
23513 modifications to the System V.4 specifications.  Selecting @option{-meabi}
23514 means that the stack is aligned to an 8-byte boundary, a function
23515 @code{__eabi} is called from @code{main} to set up the EABI
23516 environment, and the @option{-msdata} option can use both @code{r2} and
23517 @code{r13} to point to two separate small data areas.  Selecting
23518 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
23519 no EABI initialization function is called from @code{main}, and the
23520 @option{-msdata} option only uses @code{r13} to point to a single
23521 small data area.  The @option{-meabi} option is on by default if you
23522 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
23524 @item -msdata=eabi
23525 @opindex msdata=eabi
23526 On System V.4 and embedded PowerPC systems, put small initialized
23527 @code{const} global and static data in the @code{.sdata2} section, which
23528 is pointed to by register @code{r2}.  Put small initialized
23529 non-@code{const} global and static data in the @code{.sdata} section,
23530 which is pointed to by register @code{r13}.  Put small uninitialized
23531 global and static data in the @code{.sbss} section, which is adjacent to
23532 the @code{.sdata} section.  The @option{-msdata=eabi} option is
23533 incompatible with the @option{-mrelocatable} option.  The
23534 @option{-msdata=eabi} option also sets the @option{-memb} option.
23536 @item -msdata=sysv
23537 @opindex msdata=sysv
23538 On System V.4 and embedded PowerPC systems, put small global and static
23539 data in the @code{.sdata} section, which is pointed to by register
23540 @code{r13}.  Put small uninitialized global and static data in the
23541 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
23542 The @option{-msdata=sysv} option is incompatible with the
23543 @option{-mrelocatable} option.
23545 @item -msdata=default
23546 @itemx -msdata
23547 @opindex msdata=default
23548 @opindex msdata
23549 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
23550 compile code the same as @option{-msdata=eabi}, otherwise compile code the
23551 same as @option{-msdata=sysv}.
23553 @item -msdata=data
23554 @opindex msdata=data
23555 On System V.4 and embedded PowerPC systems, put small global
23556 data in the @code{.sdata} section.  Put small uninitialized global
23557 data in the @code{.sbss} section.  Do not use register @code{r13}
23558 to address small data however.  This is the default behavior unless
23559 other @option{-msdata} options are used.
23561 @item -msdata=none
23562 @itemx -mno-sdata
23563 @opindex msdata=none
23564 @opindex mno-sdata
23565 On embedded PowerPC systems, put all initialized global and static data
23566 in the @code{.data} section, and all uninitialized data in the
23567 @code{.bss} section.
23569 @item -mblock-move-inline-limit=@var{num}
23570 @opindex mblock-move-inline-limit
23571 Inline all block moves (such as calls to @code{memcpy} or structure
23572 copies) less than or equal to @var{num} bytes.  The minimum value for
23573 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23574 targets.  The default value is target-specific.
23576 @item -G @var{num}
23577 @opindex G
23578 @cindex smaller data references (PowerPC)
23579 @cindex .sdata/.sdata2 references (PowerPC)
23580 On embedded PowerPC systems, put global and static items less than or
23581 equal to @var{num} bytes into the small data or BSS sections instead of
23582 the normal data or BSS section.  By default, @var{num} is 8.  The
23583 @option{-G @var{num}} switch is also passed to the linker.
23584 All modules should be compiled with the same @option{-G @var{num}} value.
23586 @item -mregnames
23587 @itemx -mno-regnames
23588 @opindex mregnames
23589 @opindex mno-regnames
23590 On System V.4 and embedded PowerPC systems do (do not) emit register
23591 names in the assembly language output using symbolic forms.
23593 @item -mlongcall
23594 @itemx -mno-longcall
23595 @opindex mlongcall
23596 @opindex mno-longcall
23597 By default assume that all calls are far away so that a longer and more
23598 expensive calling sequence is required.  This is required for calls
23599 farther than 32 megabytes (33,554,432 bytes) from the current location.
23600 A short call is generated if the compiler knows
23601 the call cannot be that far away.  This setting can be overridden by
23602 the @code{shortcall} function attribute, or by @code{#pragma
23603 longcall(0)}.
23605 Some linkers are capable of detecting out-of-range calls and generating
23606 glue code on the fly.  On these systems, long calls are unnecessary and
23607 generate slower code.  As of this writing, the AIX linker can do this,
23608 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23609 to the GNU linker for 32-bit PowerPC systems as well.
23611 In the future, GCC may ignore all longcall specifications
23612 when the linker is known to generate glue.
23614 @item -mtls-markers
23615 @itemx -mno-tls-markers
23616 @opindex mtls-markers
23617 @opindex mno-tls-markers
23618 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23619 specifying the function argument.  The relocation allows the linker to
23620 reliably associate function call with argument setup instructions for
23621 TLS optimization, which in turn allows GCC to better schedule the
23622 sequence.
23624 @item -mrecip
23625 @itemx -mno-recip
23626 @opindex mrecip
23627 This option enables use of the reciprocal estimate and
23628 reciprocal square root estimate instructions with additional
23629 Newton-Raphson steps to increase precision instead of doing a divide or
23630 square root and divide for floating-point arguments.  You should use
23631 the @option{-ffast-math} option when using @option{-mrecip} (or at
23632 least @option{-funsafe-math-optimizations},
23633 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23634 @option{-fno-trapping-math}).  Note that while the throughput of the
23635 sequence is generally higher than the throughput of the non-reciprocal
23636 instruction, the precision of the sequence can be decreased by up to 2
23637 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23638 roots.
23640 @item -mrecip=@var{opt}
23641 @opindex mrecip=opt
23642 This option controls which reciprocal estimate instructions
23643 may be used.  @var{opt} is a comma-separated list of options, which may
23644 be preceded by a @code{!} to invert the option:
23646 @table @samp
23648 @item all
23649 Enable all estimate instructions.
23651 @item default
23652 Enable the default instructions, equivalent to @option{-mrecip}.
23654 @item none
23655 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23657 @item div
23658 Enable the reciprocal approximation instructions for both
23659 single and double precision.
23661 @item divf
23662 Enable the single-precision reciprocal approximation instructions.
23664 @item divd
23665 Enable the double-precision reciprocal approximation instructions.
23667 @item rsqrt
23668 Enable the reciprocal square root approximation instructions for both
23669 single and double precision.
23671 @item rsqrtf
23672 Enable the single-precision reciprocal square root approximation instructions.
23674 @item rsqrtd
23675 Enable the double-precision reciprocal square root approximation instructions.
23677 @end table
23679 So, for example, @option{-mrecip=all,!rsqrtd} enables
23680 all of the reciprocal estimate instructions, except for the
23681 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23682 which handle the double-precision reciprocal square root calculations.
23684 @item -mrecip-precision
23685 @itemx -mno-recip-precision
23686 @opindex mrecip-precision
23687 Assume (do not assume) that the reciprocal estimate instructions
23688 provide higher-precision estimates than is mandated by the PowerPC
23689 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23690 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23691 The double-precision square root estimate instructions are not generated by
23692 default on low-precision machines, since they do not provide an
23693 estimate that converges after three steps.
23695 @item -mpointers-to-nested-functions
23696 @itemx -mno-pointers-to-nested-functions
23697 @opindex mpointers-to-nested-functions
23698 Generate (do not generate) code to load up the static chain register
23699 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23700 systems where a function pointer points to a 3-word descriptor giving
23701 the function address, TOC value to be loaded in register @code{r2}, and
23702 static chain value to be loaded in register @code{r11}.  The
23703 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23704 call through pointers to nested functions or pointers
23705 to functions compiled in other languages that use the static chain if
23706 you use @option{-mno-pointers-to-nested-functions}.
23708 @item -msave-toc-indirect
23709 @itemx -mno-save-toc-indirect
23710 @opindex msave-toc-indirect
23711 Generate (do not generate) code to save the TOC value in the reserved
23712 stack location in the function prologue if the function calls through
23713 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23714 saved in the prologue, it is saved just before the call through the
23715 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23717 @item -mcompat-align-parm
23718 @itemx -mno-compat-align-parm
23719 @opindex mcompat-align-parm
23720 Generate (do not generate) code to pass structure parameters with a
23721 maximum alignment of 64 bits, for compatibility with older versions
23722 of GCC.
23724 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23725 structure parameter on a 128-bit boundary when that structure contained
23726 a member requiring 128-bit alignment.  This is corrected in more
23727 recent versions of GCC.  This option may be used to generate code
23728 that is compatible with functions compiled with older versions of
23729 GCC.
23731 The @option{-mno-compat-align-parm} option is the default.
23733 @item -mstack-protector-guard=@var{guard}
23734 @itemx -mstack-protector-guard-reg=@var{reg}
23735 @itemx -mstack-protector-guard-offset=@var{offset}
23736 @itemx -mstack-protector-guard-symbol=@var{symbol}
23737 @opindex mstack-protector-guard
23738 @opindex mstack-protector-guard-reg
23739 @opindex mstack-protector-guard-offset
23740 @opindex mstack-protector-guard-symbol
23741 Generate stack protection code using canary at @var{guard}.  Supported
23742 locations are @samp{global} for global canary or @samp{tls} for per-thread
23743 canary in the TLS block (the default with GNU libc version 2.4 or later).
23745 With the latter choice the options
23746 @option{-mstack-protector-guard-reg=@var{reg}} and
23747 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23748 which register to use as base register for reading the canary, and from what
23749 offset from that base register. The default for those is as specified in the
23750 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23751 the offset with a symbol reference to a canary in the TLS block.
23752 @end table
23755 @node RISC-V Options
23756 @subsection RISC-V Options
23757 @cindex RISC-V Options
23759 These command-line options are defined for RISC-V targets:
23761 @table @gcctabopt
23762 @item -mbranch-cost=@var{n}
23763 @opindex mbranch-cost
23764 Set the cost of branches to roughly @var{n} instructions.
23766 @item -mplt
23767 @itemx -mno-plt
23768 @opindex plt
23769 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23770 non-PIC.  The default is @option{-mplt}.
23772 @item -mabi=@var{ABI-string}
23773 @opindex mabi
23774 Specify integer and floating-point calling convention.  @var{ABI-string}
23775 contains two parts: the size of integer types and the registers used for
23776 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23777 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23778 32-bit), and that floating-point values up to 64 bits wide are passed in F
23779 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23780 allows the compiler to generate code that uses the F and D extensions but only
23781 allows floating-point values up to 32 bits long to be passed in registers; or
23782 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23783 passed in registers.
23785 The default for this argument is system dependent, users who want a specific
23786 calling convention should specify one explicitly.  The valid calling
23787 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23788 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23789 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23790 invalid because the ABI requires 64-bit values be passed in F registers, but F
23791 registers are only 32 bits wide.  There is also the @samp{ilp32e} ABI that can
23792 only be used with the @samp{rv32e} architecture.  This ABI is not well
23793 specified at present, and is subject to change.
23795 @item -mfdiv
23796 @itemx -mno-fdiv
23797 @opindex mfdiv
23798 Do or don't use hardware floating-point divide and square root instructions.
23799 This requires the F or D extensions for floating-point registers.  The default
23800 is to use them if the specified architecture has these instructions.
23802 @item -mdiv
23803 @itemx -mno-div
23804 @opindex mdiv
23805 Do or don't use hardware instructions for integer division.  This requires the
23806 M extension.  The default is to use them if the specified architecture has
23807 these instructions.
23809 @item -march=@var{ISA-string}
23810 @opindex march
23811 Generate code for given RISC-V ISA (e.g.@: @samp{rv64im}).  ISA strings must be
23812 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
23813 @samp{rv32imaf}.
23815 @item -mtune=@var{processor-string}
23816 @opindex mtune
23817 Optimize the output for the given processor, specified by microarchitecture
23818 name.
23820 @item -mpreferred-stack-boundary=@var{num}
23821 @opindex mpreferred-stack-boundary
23822 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23823 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23824 the default is 4 (16 bytes or 128-bits).
23826 @strong{Warning:} If you use this switch, then you must build all modules with
23827 the same value, including any libraries.  This includes the system libraries
23828 and startup modules.
23830 @item -msmall-data-limit=@var{n}
23831 @opindex msmall-data-limit
23832 Put global and static data smaller than @var{n} bytes into a special section
23833 (on some targets).
23835 @item -msave-restore
23836 @itemx -mno-save-restore
23837 @opindex msave-restore
23838 Do or don't use smaller but slower prologue and epilogue code that uses
23839 library function calls.  The default is to use fast inline prologues and
23840 epilogues.
23842 @item -mstrict-align
23843 @itemx -mno-strict-align
23844 @opindex mstrict-align
23845 Do not or do generate unaligned memory accesses.  The default is set depending
23846 on whether the processor we are optimizing for supports fast unaligned access
23847 or not.
23849 @item -mcmodel=medlow
23850 @opindex mcmodel=medlow
23851 Generate code for the medium-low code model. The program and its statically
23852 defined symbols must lie within a single 2 GiB address range and must lie
23853 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23854 statically or dynamically linked. This is the default code model.
23856 @item -mcmodel=medany
23857 @opindex mcmodel=medany
23858 Generate code for the medium-any code model. The program and its statically
23859 defined symbols must be within any single 2 GiB address range. Programs can be
23860 statically or dynamically linked.
23862 @item -mexplicit-relocs
23863 @itemx -mno-exlicit-relocs
23864 Use or do not use assembler relocation operators when dealing with symbolic
23865 addresses.  The alternative is to use assembler macros instead, which may
23866 limit optimization.
23868 @item -mrelax
23869 @itemx -mno-relax
23870 Take advantage of linker relaxations to reduce the number of instructions
23871 required to materialize symbol addresses. The default is to take advantage of
23872 linker relaxations.
23874 @end table
23876 @node RL78 Options
23877 @subsection RL78 Options
23878 @cindex RL78 Options
23880 @table @gcctabopt
23882 @item -msim
23883 @opindex msim
23884 Links in additional target libraries to support operation within a
23885 simulator.
23887 @item -mmul=none
23888 @itemx -mmul=g10
23889 @itemx -mmul=g13
23890 @itemx -mmul=g14
23891 @itemx -mmul=rl78
23892 @opindex mmul
23893 Specifies the type of hardware multiplication and division support to
23894 be used.  The simplest is @code{none}, which uses software for both
23895 multiplication and division.  This is the default.  The @code{g13}
23896 value is for the hardware multiply/divide peripheral found on the
23897 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23898 the multiplication and division instructions supported by the RL78/G14
23899 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23900 the value @code{mg10} is an alias for @code{none}.
23902 In addition a C preprocessor macro is defined, based upon the setting
23903 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23904 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23906 @item -mcpu=g10
23907 @itemx -mcpu=g13
23908 @itemx -mcpu=g14
23909 @itemx -mcpu=rl78
23910 @opindex mcpu
23911 Specifies the RL78 core to target.  The default is the G14 core, also
23912 known as an S3 core or just RL78.  The G13 or S2 core does not have
23913 multiply or divide instructions, instead it uses a hardware peripheral
23914 for these operations.  The G10 or S1 core does not have register
23915 banks, so it uses a different calling convention.
23917 If this option is set it also selects the type of hardware multiply
23918 support to use, unless this is overridden by an explicit
23919 @option{-mmul=none} option on the command line.  Thus specifying
23920 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23921 peripheral and specifying @option{-mcpu=g10} disables the use of
23922 hardware multiplications altogether.
23924 Note, although the RL78/G14 core is the default target, specifying
23925 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23926 change the behavior of the toolchain since it also enables G14
23927 hardware multiply support.  If these options are not specified on the
23928 command line then software multiplication routines will be used even
23929 though the code targets the RL78 core.  This is for backwards
23930 compatibility with older toolchains which did not have hardware
23931 multiply and divide support.
23933 In addition a C preprocessor macro is defined, based upon the setting
23934 of this option.  Possible values are: @code{__RL78_G10__},
23935 @code{__RL78_G13__} or @code{__RL78_G14__}.
23937 @item -mg10
23938 @itemx -mg13
23939 @itemx -mg14
23940 @itemx -mrl78
23941 @opindex mg10
23942 @opindex mg13
23943 @opindex mg14
23944 @opindex mrl78
23945 These are aliases for the corresponding @option{-mcpu=} option.  They
23946 are provided for backwards compatibility.
23948 @item -mallregs
23949 @opindex mallregs
23950 Allow the compiler to use all of the available registers.  By default
23951 registers @code{r24..r31} are reserved for use in interrupt handlers.
23952 With this option enabled these registers can be used in ordinary
23953 functions as well.
23955 @item -m64bit-doubles
23956 @itemx -m32bit-doubles
23957 @opindex m64bit-doubles
23958 @opindex m32bit-doubles
23959 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23960 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23961 @option{-m32bit-doubles}.
23963 @item -msave-mduc-in-interrupts
23964 @itemx -mno-save-mduc-in-interrupts
23965 @opindex msave-mduc-in-interrupts
23966 @opindex mno-save-mduc-in-interrupts
23967 Specifies that interrupt handler functions should preserve the
23968 MDUC registers.  This is only necessary if normal code might use
23969 the MDUC registers, for example because it performs multiplication
23970 and division operations.  The default is to ignore the MDUC registers
23971 as this makes the interrupt handlers faster.  The target option -mg13
23972 needs to be passed for this to work as this feature is only available
23973 on the G13 target (S2 core).  The MDUC registers will only be saved
23974 if the interrupt handler performs a multiplication or division
23975 operation or it calls another function.
23977 @end table
23979 @node RS/6000 and PowerPC Options
23980 @subsection IBM RS/6000 and PowerPC Options
23981 @cindex RS/6000 and PowerPC Options
23982 @cindex IBM RS/6000 and PowerPC Options
23984 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23985 @table @gcctabopt
23986 @item -mpowerpc-gpopt
23987 @itemx -mno-powerpc-gpopt
23988 @itemx -mpowerpc-gfxopt
23989 @itemx -mno-powerpc-gfxopt
23990 @need 800
23991 @itemx -mpowerpc64
23992 @itemx -mno-powerpc64
23993 @itemx -mmfcrf
23994 @itemx -mno-mfcrf
23995 @itemx -mpopcntb
23996 @itemx -mno-popcntb
23997 @itemx -mpopcntd
23998 @itemx -mno-popcntd
23999 @itemx -mfprnd
24000 @itemx -mno-fprnd
24001 @need 800
24002 @itemx -mcmpb
24003 @itemx -mno-cmpb
24004 @itemx -mmfpgpr
24005 @itemx -mno-mfpgpr
24006 @itemx -mhard-dfp
24007 @itemx -mno-hard-dfp
24008 @opindex mpowerpc-gpopt
24009 @opindex mno-powerpc-gpopt
24010 @opindex mpowerpc-gfxopt
24011 @opindex mno-powerpc-gfxopt
24012 @opindex mpowerpc64
24013 @opindex mno-powerpc64
24014 @opindex mmfcrf
24015 @opindex mno-mfcrf
24016 @opindex mpopcntb
24017 @opindex mno-popcntb
24018 @opindex mpopcntd
24019 @opindex mno-popcntd
24020 @opindex mfprnd
24021 @opindex mno-fprnd
24022 @opindex mcmpb
24023 @opindex mno-cmpb
24024 @opindex mmfpgpr
24025 @opindex mno-mfpgpr
24026 @opindex mhard-dfp
24027 @opindex mno-hard-dfp
24028 You use these options to specify which instructions are available on the
24029 processor you are using.  The default value of these options is
24030 determined when configuring GCC@.  Specifying the
24031 @option{-mcpu=@var{cpu_type}} overrides the specification of these
24032 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
24033 rather than the options listed above.
24035 Specifying @option{-mpowerpc-gpopt} allows
24036 GCC to use the optional PowerPC architecture instructions in the
24037 General Purpose group, including floating-point square root.  Specifying
24038 @option{-mpowerpc-gfxopt} allows GCC to
24039 use the optional PowerPC architecture instructions in the Graphics
24040 group, including floating-point select.
24042 The @option{-mmfcrf} option allows GCC to generate the move from
24043 condition register field instruction implemented on the POWER4
24044 processor and other processors that support the PowerPC V2.01
24045 architecture.
24046 The @option{-mpopcntb} option allows GCC to generate the popcount and
24047 double-precision FP reciprocal estimate instruction implemented on the
24048 POWER5 processor and other processors that support the PowerPC V2.02
24049 architecture.
24050 The @option{-mpopcntd} option allows GCC to generate the popcount
24051 instruction implemented on the POWER7 processor and other processors
24052 that support the PowerPC V2.06 architecture.
24053 The @option{-mfprnd} option allows GCC to generate the FP round to
24054 integer instructions implemented on the POWER5+ processor and other
24055 processors that support the PowerPC V2.03 architecture.
24056 The @option{-mcmpb} option allows GCC to generate the compare bytes
24057 instruction implemented on the POWER6 processor and other processors
24058 that support the PowerPC V2.05 architecture.
24059 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
24060 general-purpose register instructions implemented on the POWER6X
24061 processor and other processors that support the extended PowerPC V2.05
24062 architecture.
24063 The @option{-mhard-dfp} option allows GCC to generate the decimal
24064 floating-point instructions implemented on some POWER processors.
24066 The @option{-mpowerpc64} option allows GCC to generate the additional
24067 64-bit instructions that are found in the full PowerPC64 architecture
24068 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
24069 @option{-mno-powerpc64}.
24071 @item -mcpu=@var{cpu_type}
24072 @opindex mcpu
24073 Set architecture type, register usage, and
24074 instruction scheduling parameters for machine type @var{cpu_type}.
24075 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
24076 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
24077 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
24078 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
24079 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
24080 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
24081 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
24082 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
24083 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
24084 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
24085 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
24086 @samp{rs64}, and @samp{native}.
24088 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
24089 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
24090 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
24091 architecture machine types, with an appropriate, generic processor
24092 model assumed for scheduling purposes.
24094 Specifying @samp{native} as cpu type detects and selects the
24095 architecture option that corresponds to the host processor of the
24096 system performing the compilation.
24097 @option{-mcpu=native} has no effect if GCC does not recognize the
24098 processor.
24100 The other options specify a specific processor.  Code generated under
24101 those options runs best on that processor, and may not run at all on
24102 others.
24104 The @option{-mcpu} options automatically enable or disable the
24105 following options:
24107 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
24108 -mpopcntb -mpopcntd  -mpowerpc64 @gol
24109 -mpowerpc-gpopt  -mpowerpc-gfxopt @gol
24110 -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
24111 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
24112 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
24114 The particular options set for any particular CPU varies between
24115 compiler versions, depending on what setting seems to produce optimal
24116 code for that CPU; it doesn't necessarily reflect the actual hardware's
24117 capabilities.  If you wish to set an individual option to a particular
24118 value, you may specify it after the @option{-mcpu} option, like
24119 @option{-mcpu=970 -mno-altivec}.
24121 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
24122 not enabled or disabled by the @option{-mcpu} option at present because
24123 AIX does not have full support for these options.  You may still
24124 enable or disable them individually if you're sure it'll work in your
24125 environment.
24127 @item -mtune=@var{cpu_type}
24128 @opindex mtune
24129 Set the instruction scheduling parameters for machine type
24130 @var{cpu_type}, but do not set the architecture type or register usage,
24131 as @option{-mcpu=@var{cpu_type}} does.  The same
24132 values for @var{cpu_type} are used for @option{-mtune} as for
24133 @option{-mcpu}.  If both are specified, the code generated uses the
24134 architecture and registers set by @option{-mcpu}, but the
24135 scheduling parameters set by @option{-mtune}.
24137 @item -mcmodel=small
24138 @opindex mcmodel=small
24139 Generate PowerPC64 code for the small model: The TOC is limited to
24140 64k.
24142 @item -mcmodel=medium
24143 @opindex mcmodel=medium
24144 Generate PowerPC64 code for the medium model: The TOC and other static
24145 data may be up to a total of 4G in size.  This is the default for 64-bit
24146 Linux.
24148 @item -mcmodel=large
24149 @opindex mcmodel=large
24150 Generate PowerPC64 code for the large model: The TOC may be up to 4G
24151 in size.  Other data and code is only limited by the 64-bit address
24152 space.
24154 @item -maltivec
24155 @itemx -mno-altivec
24156 @opindex maltivec
24157 @opindex mno-altivec
24158 Generate code that uses (does not use) AltiVec instructions, and also
24159 enable the use of built-in functions that allow more direct access to
24160 the AltiVec instruction set.  You may also need to set
24161 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
24162 enhancements.
24164 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
24165 @option{-maltivec=be}, the element order for AltiVec intrinsics such
24166 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
24167 match array element order corresponding to the endianness of the
24168 target.  That is, element zero identifies the leftmost element in a
24169 vector register when targeting a big-endian platform, and identifies
24170 the rightmost element in a vector register when targeting a
24171 little-endian platform.
24173 @item -maltivec=be
24174 @opindex maltivec=be
24175 Generate AltiVec instructions using big-endian element order,
24176 regardless of whether the target is big- or little-endian.  This is
24177 the default when targeting a big-endian platform.  Using this option
24178 is currently deprecated.  Support for this feature will be removed in
24179 GCC 9.
24181 The element order is used to interpret element numbers in AltiVec
24182 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
24183 @code{vec_insert}.  By default, these match array element order
24184 corresponding to the endianness for the target.
24186 @item -maltivec=le
24187 @opindex maltivec=le
24188 Generate AltiVec instructions using little-endian element order,
24189 regardless of whether the target is big- or little-endian.  This is
24190 the default when targeting a little-endian platform.  This option is
24191 currently ignored when targeting a big-endian platform.
24193 The element order is used to interpret element numbers in AltiVec
24194 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
24195 @code{vec_insert}.  By default, these match array element order
24196 corresponding to the endianness for the target.
24198 @item -mvrsave
24199 @itemx -mno-vrsave
24200 @opindex mvrsave
24201 @opindex mno-vrsave
24202 Generate VRSAVE instructions when generating AltiVec code.
24204 @item -msecure-plt
24205 @opindex msecure-plt
24206 Generate code that allows @command{ld} and @command{ld.so}
24207 to build executables and shared
24208 libraries with non-executable @code{.plt} and @code{.got} sections.
24209 This is a PowerPC
24210 32-bit SYSV ABI option.
24212 @item -mbss-plt
24213 @opindex mbss-plt
24214 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
24215 fills in, and
24216 requires @code{.plt} and @code{.got}
24217 sections that are both writable and executable.
24218 This is a PowerPC 32-bit SYSV ABI option.
24220 @item -misel
24221 @itemx -mno-isel
24222 @opindex misel
24223 @opindex mno-isel
24224 This switch enables or disables the generation of ISEL instructions.
24226 @item -mvsx
24227 @itemx -mno-vsx
24228 @opindex mvsx
24229 @opindex mno-vsx
24230 Generate code that uses (does not use) vector/scalar (VSX)
24231 instructions, and also enable the use of built-in functions that allow
24232 more direct access to the VSX instruction set.
24234 @item -mcrypto
24235 @itemx -mno-crypto
24236 @opindex mcrypto
24237 @opindex mno-crypto
24238 Enable the use (disable) of the built-in functions that allow direct
24239 access to the cryptographic instructions that were added in version
24240 2.07 of the PowerPC ISA.
24242 @item -mhtm
24243 @itemx -mno-htm
24244 @opindex mhtm
24245 @opindex mno-htm
24246 Enable (disable) the use of the built-in functions that allow direct
24247 access to the Hardware Transactional Memory (HTM) instructions that
24248 were added in version 2.07 of the PowerPC ISA.
24250 @item -mpower8-fusion
24251 @itemx -mno-power8-fusion
24252 @opindex mpower8-fusion
24253 @opindex mno-power8-fusion
24254 Generate code that keeps (does not keeps) some integer operations
24255 adjacent so that the instructions can be fused together on power8 and
24256 later processors.
24258 @item -mpower8-vector
24259 @itemx -mno-power8-vector
24260 @opindex mpower8-vector
24261 @opindex mno-power8-vector
24262 Generate code that uses (does not use) the vector and scalar
24263 instructions that were added in version 2.07 of the PowerPC ISA.  Also
24264 enable the use of built-in functions that allow more direct access to
24265 the vector instructions.
24267 @item -mquad-memory
24268 @itemx -mno-quad-memory
24269 @opindex mquad-memory
24270 @opindex mno-quad-memory
24271 Generate code that uses (does not use) the non-atomic quad word memory
24272 instructions.  The @option{-mquad-memory} option requires use of
24273 64-bit mode.
24275 @item -mquad-memory-atomic
24276 @itemx -mno-quad-memory-atomic
24277 @opindex mquad-memory-atomic
24278 @opindex mno-quad-memory-atomic
24279 Generate code that uses (does not use) the atomic quad word memory
24280 instructions.  The @option{-mquad-memory-atomic} option requires use of
24281 64-bit mode.
24283 @item -mfloat128
24284 @itemx -mno-float128
24285 @opindex mfloat128
24286 @opindex mno-float128
24287 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
24288 and use either software emulation for IEEE 128-bit floating point or
24289 hardware instructions.
24291 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
24292 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
24293 use the IEEE 128-bit floating point support.  The IEEE 128-bit
24294 floating point support only works on PowerPC Linux systems.
24296 The default for @option{-mfloat128} is enabled on PowerPC Linux
24297 systems using the VSX instruction set, and disabled on other systems.
24299 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
24300 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
24301 point support will also enable the generation of ISA 3.0 IEEE 128-bit
24302 floating point instructions.  Otherwise, if you do not specify to
24303 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
24304 system, IEEE 128-bit floating point will be done with software
24305 emulation.
24307 @item -mfloat128-hardware
24308 @itemx -mno-float128-hardware
24309 @opindex mfloat128-hardware
24310 @opindex mno-float128-hardware
24311 Enable/disable using ISA 3.0 hardware instructions to support the
24312 @var{__float128} data type.
24314 The default for @option{-mfloat128-hardware} is enabled on PowerPC
24315 Linux systems using the ISA 3.0 instruction set, and disabled on other
24316 systems.
24318 @item -m32
24319 @itemx -m64
24320 @opindex m32
24321 @opindex m64
24322 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
24323 targets (including GNU/Linux).  The 32-bit environment sets int, long
24324 and pointer to 32 bits and generates code that runs on any PowerPC
24325 variant.  The 64-bit environment sets int to 32 bits and long and
24326 pointer to 64 bits, and generates code for PowerPC64, as for
24327 @option{-mpowerpc64}.
24329 @item -mfull-toc
24330 @itemx -mno-fp-in-toc
24331 @itemx -mno-sum-in-toc
24332 @itemx -mminimal-toc
24333 @opindex mfull-toc
24334 @opindex mno-fp-in-toc
24335 @opindex mno-sum-in-toc
24336 @opindex mminimal-toc
24337 Modify generation of the TOC (Table Of Contents), which is created for
24338 every executable file.  The @option{-mfull-toc} option is selected by
24339 default.  In that case, GCC allocates at least one TOC entry for
24340 each unique non-automatic variable reference in your program.  GCC
24341 also places floating-point constants in the TOC@.  However, only
24342 16,384 entries are available in the TOC@.
24344 If you receive a linker error message that saying you have overflowed
24345 the available TOC space, you can reduce the amount of TOC space used
24346 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
24347 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
24348 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
24349 generate code to calculate the sum of an address and a constant at
24350 run time instead of putting that sum into the TOC@.  You may specify one
24351 or both of these options.  Each causes GCC to produce very slightly
24352 slower and larger code at the expense of conserving TOC space.
24354 If you still run out of space in the TOC even when you specify both of
24355 these options, specify @option{-mminimal-toc} instead.  This option causes
24356 GCC to make only one TOC entry for every file.  When you specify this
24357 option, GCC produces code that is slower and larger but which
24358 uses extremely little TOC space.  You may wish to use this option
24359 only on files that contain less frequently-executed code.
24361 @item -maix64
24362 @itemx -maix32
24363 @opindex maix64
24364 @opindex maix32
24365 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
24366 @code{long} type, and the infrastructure needed to support them.
24367 Specifying @option{-maix64} implies @option{-mpowerpc64},
24368 while @option{-maix32} disables the 64-bit ABI and
24369 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
24371 @item -mxl-compat
24372 @itemx -mno-xl-compat
24373 @opindex mxl-compat
24374 @opindex mno-xl-compat
24375 Produce code that conforms more closely to IBM XL compiler semantics
24376 when using AIX-compatible ABI@.  Pass floating-point arguments to
24377 prototyped functions beyond the register save area (RSA) on the stack
24378 in addition to argument FPRs.  Do not assume that most significant
24379 double in 128-bit long double value is properly rounded when comparing
24380 values and converting to double.  Use XL symbol names for long double
24381 support routines.
24383 The AIX calling convention was extended but not initially documented to
24384 handle an obscure K&R C case of calling a function that takes the
24385 address of its arguments with fewer arguments than declared.  IBM XL
24386 compilers access floating-point arguments that do not fit in the
24387 RSA from the stack when a subroutine is compiled without
24388 optimization.  Because always storing floating-point arguments on the
24389 stack is inefficient and rarely needed, this option is not enabled by
24390 default and only is necessary when calling subroutines compiled by IBM
24391 XL compilers without optimization.
24393 @item -mpe
24394 @opindex mpe
24395 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
24396 application written to use message passing with special startup code to
24397 enable the application to run.  The system must have PE installed in the
24398 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
24399 must be overridden with the @option{-specs=} option to specify the
24400 appropriate directory location.  The Parallel Environment does not
24401 support threads, so the @option{-mpe} option and the @option{-pthread}
24402 option are incompatible.
24404 @item -malign-natural
24405 @itemx -malign-power
24406 @opindex malign-natural
24407 @opindex malign-power
24408 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
24409 @option{-malign-natural} overrides the ABI-defined alignment of larger
24410 types, such as floating-point doubles, on their natural size-based boundary.
24411 The option @option{-malign-power} instructs GCC to follow the ABI-specified
24412 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
24414 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
24415 is not supported.
24417 @item -msoft-float
24418 @itemx -mhard-float
24419 @opindex msoft-float
24420 @opindex mhard-float
24421 Generate code that does not use (uses) the floating-point register set.
24422 Software floating-point emulation is provided if you use the
24423 @option{-msoft-float} option, and pass the option to GCC when linking.
24425 @item -mmultiple
24426 @itemx -mno-multiple
24427 @opindex mmultiple
24428 @opindex mno-multiple
24429 Generate code that uses (does not use) the load multiple word
24430 instructions and the store multiple word instructions.  These
24431 instructions are generated by default on POWER systems, and not
24432 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
24433 PowerPC systems, since those instructions do not work when the
24434 processor is in little-endian mode.  The exceptions are PPC740 and
24435 PPC750 which permit these instructions in little-endian mode.
24437 @item -mupdate
24438 @itemx -mno-update
24439 @opindex mupdate
24440 @opindex mno-update
24441 Generate code that uses (does not use) the load or store instructions
24442 that update the base register to the address of the calculated memory
24443 location.  These instructions are generated by default.  If you use
24444 @option{-mno-update}, there is a small window between the time that the
24445 stack pointer is updated and the address of the previous frame is
24446 stored, which means code that walks the stack frame across interrupts or
24447 signals may get corrupted data.
24449 @item -mavoid-indexed-addresses
24450 @itemx -mno-avoid-indexed-addresses
24451 @opindex mavoid-indexed-addresses
24452 @opindex mno-avoid-indexed-addresses
24453 Generate code that tries to avoid (not avoid) the use of indexed load
24454 or store instructions. These instructions can incur a performance
24455 penalty on Power6 processors in certain situations, such as when
24456 stepping through large arrays that cross a 16M boundary.  This option
24457 is enabled by default when targeting Power6 and disabled otherwise.
24459 @item -mfused-madd
24460 @itemx -mno-fused-madd
24461 @opindex mfused-madd
24462 @opindex mno-fused-madd
24463 Generate code that uses (does not use) the floating-point multiply and
24464 accumulate instructions.  These instructions are generated by default
24465 if hardware floating point is used.  The machine-dependent
24466 @option{-mfused-madd} option is now mapped to the machine-independent
24467 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24468 mapped to @option{-ffp-contract=off}.
24470 @item -mmulhw
24471 @itemx -mno-mulhw
24472 @opindex mmulhw
24473 @opindex mno-mulhw
24474 Generate code that uses (does not use) the half-word multiply and
24475 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
24476 These instructions are generated by default when targeting those
24477 processors.
24479 @item -mdlmzb
24480 @itemx -mno-dlmzb
24481 @opindex mdlmzb
24482 @opindex mno-dlmzb
24483 Generate code that uses (does not use) the string-search @samp{dlmzb}
24484 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
24485 generated by default when targeting those processors.
24487 @item -mno-bit-align
24488 @itemx -mbit-align
24489 @opindex mno-bit-align
24490 @opindex mbit-align
24491 On System V.4 and embedded PowerPC systems do not (do) force structures
24492 and unions that contain bit-fields to be aligned to the base type of the
24493 bit-field.
24495 For example, by default a structure containing nothing but 8
24496 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
24497 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
24498 the structure is aligned to a 1-byte boundary and is 1 byte in
24499 size.
24501 @item -mno-strict-align
24502 @itemx -mstrict-align
24503 @opindex mno-strict-align
24504 @opindex mstrict-align
24505 On System V.4 and embedded PowerPC systems do not (do) assume that
24506 unaligned memory references are handled by the system.
24508 @item -mrelocatable
24509 @itemx -mno-relocatable
24510 @opindex mrelocatable
24511 @opindex mno-relocatable
24512 Generate code that allows (does not allow) a static executable to be
24513 relocated to a different address at run time.  A simple embedded
24514 PowerPC system loader should relocate the entire contents of
24515 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
24516 a table of 32-bit addresses generated by this option.  For this to
24517 work, all objects linked together must be compiled with
24518 @option{-mrelocatable} or @option{-mrelocatable-lib}.
24519 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
24521 @item -mrelocatable-lib
24522 @itemx -mno-relocatable-lib
24523 @opindex mrelocatable-lib
24524 @opindex mno-relocatable-lib
24525 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
24526 @code{.fixup} section to allow static executables to be relocated at
24527 run time, but @option{-mrelocatable-lib} does not use the smaller stack
24528 alignment of @option{-mrelocatable}.  Objects compiled with
24529 @option{-mrelocatable-lib} may be linked with objects compiled with
24530 any combination of the @option{-mrelocatable} options.
24532 @item -mno-toc
24533 @itemx -mtoc
24534 @opindex mno-toc
24535 @opindex mtoc
24536 On System V.4 and embedded PowerPC systems do not (do) assume that
24537 register 2 contains a pointer to a global area pointing to the addresses
24538 used in the program.
24540 @item -mlittle
24541 @itemx -mlittle-endian
24542 @opindex mlittle
24543 @opindex mlittle-endian
24544 On System V.4 and embedded PowerPC systems compile code for the
24545 processor in little-endian mode.  The @option{-mlittle-endian} option is
24546 the same as @option{-mlittle}.
24548 @item -mbig
24549 @itemx -mbig-endian
24550 @opindex mbig
24551 @opindex mbig-endian
24552 On System V.4 and embedded PowerPC systems compile code for the
24553 processor in big-endian mode.  The @option{-mbig-endian} option is
24554 the same as @option{-mbig}.
24556 @item -mdynamic-no-pic
24557 @opindex mdynamic-no-pic
24558 On Darwin and Mac OS X systems, compile code so that it is not
24559 relocatable, but that its external references are relocatable.  The
24560 resulting code is suitable for applications, but not shared
24561 libraries.
24563 @item -msingle-pic-base
24564 @opindex msingle-pic-base
24565 Treat the register used for PIC addressing as read-only, rather than
24566 loading it in the prologue for each function.  The runtime system is
24567 responsible for initializing this register with an appropriate value
24568 before execution begins.
24570 @item -mprioritize-restricted-insns=@var{priority}
24571 @opindex mprioritize-restricted-insns
24572 This option controls the priority that is assigned to
24573 dispatch-slot restricted instructions during the second scheduling
24574 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
24575 or @samp{2} to assign no, highest, or second-highest (respectively) 
24576 priority to dispatch-slot restricted
24577 instructions.
24579 @item -msched-costly-dep=@var{dependence_type}
24580 @opindex msched-costly-dep
24581 This option controls which dependences are considered costly
24582 by the target during instruction scheduling.  The argument
24583 @var{dependence_type} takes one of the following values:
24585 @table @asis
24586 @item @samp{no}
24587 No dependence is costly.
24589 @item @samp{all}
24590 All dependences are costly.
24592 @item @samp{true_store_to_load}
24593 A true dependence from store to load is costly.
24595 @item @samp{store_to_load}
24596 Any dependence from store to load is costly.
24598 @item @var{number}
24599 Any dependence for which the latency is greater than or equal to 
24600 @var{number} is costly.
24601 @end table
24603 @item -minsert-sched-nops=@var{scheme}
24604 @opindex minsert-sched-nops
24605 This option controls which NOP insertion scheme is used during
24606 the second scheduling pass.  The argument @var{scheme} takes one of the
24607 following values:
24609 @table @asis
24610 @item @samp{no}
24611 Don't insert NOPs.
24613 @item @samp{pad}
24614 Pad with NOPs any dispatch group that has vacant issue slots,
24615 according to the scheduler's grouping.
24617 @item @samp{regroup_exact}
24618 Insert NOPs to force costly dependent insns into
24619 separate groups.  Insert exactly as many NOPs as needed to force an insn
24620 to a new group, according to the estimated processor grouping.
24622 @item @var{number}
24623 Insert NOPs to force costly dependent insns into
24624 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
24625 @end table
24627 @item -mcall-sysv
24628 @opindex mcall-sysv
24629 On System V.4 and embedded PowerPC systems compile code using calling
24630 conventions that adhere to the March 1995 draft of the System V
24631 Application Binary Interface, PowerPC processor supplement.  This is the
24632 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
24634 @item -mcall-sysv-eabi
24635 @itemx -mcall-eabi
24636 @opindex mcall-sysv-eabi
24637 @opindex mcall-eabi
24638 Specify both @option{-mcall-sysv} and @option{-meabi} options.
24640 @item -mcall-sysv-noeabi
24641 @opindex mcall-sysv-noeabi
24642 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
24644 @item -mcall-aixdesc
24645 @opindex m
24646 On System V.4 and embedded PowerPC systems compile code for the AIX
24647 operating system.
24649 @item -mcall-linux
24650 @opindex mcall-linux
24651 On System V.4 and embedded PowerPC systems compile code for the
24652 Linux-based GNU system.
24654 @item -mcall-freebsd
24655 @opindex mcall-freebsd
24656 On System V.4 and embedded PowerPC systems compile code for the
24657 FreeBSD operating system.
24659 @item -mcall-netbsd
24660 @opindex mcall-netbsd
24661 On System V.4 and embedded PowerPC systems compile code for the
24662 NetBSD operating system.
24664 @item -mcall-openbsd
24665 @opindex mcall-netbsd
24666 On System V.4 and embedded PowerPC systems compile code for the
24667 OpenBSD operating system.
24669 @item -mtraceback=@var{traceback_type}
24670 @opindex mtraceback
24671 Select the type of traceback table. Valid values for @var{traceback_type}
24672 are @samp{full}, @samp{part}, and @samp{no}.
24674 @item -maix-struct-return
24675 @opindex maix-struct-return
24676 Return all structures in memory (as specified by the AIX ABI)@.
24678 @item -msvr4-struct-return
24679 @opindex msvr4-struct-return
24680 Return structures smaller than 8 bytes in registers (as specified by the
24681 SVR4 ABI)@.
24683 @item -mabi=@var{abi-type}
24684 @opindex mabi
24685 Extend the current ABI with a particular extension, or remove such extension.
24686 Valid values are @samp{altivec}, @samp{no-altivec},
24687 @samp{ibmlongdouble}, @samp{ieeelongdouble},
24688 @samp{elfv1}, @samp{elfv2}@.
24690 @item -mabi=ibmlongdouble
24691 @opindex mabi=ibmlongdouble
24692 Change the current ABI to use IBM extended-precision long double.
24693 This is not likely to work if your system defaults to using IEEE
24694 extended-precision long double.  If you change the long double type
24695 from IEEE extended-precision, the compiler will issue a warning unless
24696 you use the @option{-Wno-psabi} option.
24698 @item -mabi=ieeelongdouble
24699 @opindex mabi=ieeelongdouble
24700 Change the current ABI to use IEEE extended-precision long double.
24701 This is not likely to work if your system defaults to using IBM
24702 extended-precision long double.  If you change the long double type
24703 from IBM extended-precision, the compiler will issue a warning unless
24704 you use the @option{-Wno-psabi} option.
24706 @item -mabi=elfv1
24707 @opindex mabi=elfv1
24708 Change the current ABI to use the ELFv1 ABI.
24709 This is the default ABI for big-endian PowerPC 64-bit Linux.
24710 Overriding the default ABI requires special system support and is
24711 likely to fail in spectacular ways.
24713 @item -mabi=elfv2
24714 @opindex mabi=elfv2
24715 Change the current ABI to use the ELFv2 ABI.
24716 This is the default ABI for little-endian PowerPC 64-bit Linux.
24717 Overriding the default ABI requires special system support and is
24718 likely to fail in spectacular ways.
24720 @item -mgnu-attribute
24721 @itemx -mno-gnu-attribute
24722 @opindex mgnu-attribute
24723 @opindex mno-gnu-attribute
24724 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24725 .gnu.attributes section that specify ABI variations in function
24726 parameters or return values.
24728 @item -mprototype
24729 @itemx -mno-prototype
24730 @opindex mprototype
24731 @opindex mno-prototype
24732 On System V.4 and embedded PowerPC systems assume that all calls to
24733 variable argument functions are properly prototyped.  Otherwise, the
24734 compiler must insert an instruction before every non-prototyped call to
24735 set or clear bit 6 of the condition code register (@code{CR}) to
24736 indicate whether floating-point values are passed in the floating-point
24737 registers in case the function takes variable arguments.  With
24738 @option{-mprototype}, only calls to prototyped variable argument functions
24739 set or clear the bit.
24741 @item -msim
24742 @opindex msim
24743 On embedded PowerPC systems, assume that the startup module is called
24744 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24745 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24746 configurations.
24748 @item -mmvme
24749 @opindex mmvme
24750 On embedded PowerPC systems, assume that the startup module is called
24751 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24752 @file{libc.a}.
24754 @item -mads
24755 @opindex mads
24756 On embedded PowerPC systems, assume that the startup module is called
24757 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24758 @file{libc.a}.
24760 @item -myellowknife
24761 @opindex myellowknife
24762 On embedded PowerPC systems, assume that the startup module is called
24763 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24764 @file{libc.a}.
24766 @item -mvxworks
24767 @opindex mvxworks
24768 On System V.4 and embedded PowerPC systems, specify that you are
24769 compiling for a VxWorks system.
24771 @item -memb
24772 @opindex memb
24773 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24774 header to indicate that @samp{eabi} extended relocations are used.
24776 @item -meabi
24777 @itemx -mno-eabi
24778 @opindex meabi
24779 @opindex mno-eabi
24780 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24781 Embedded Applications Binary Interface (EABI), which is a set of
24782 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24783 means that the stack is aligned to an 8-byte boundary, a function
24784 @code{__eabi} is called from @code{main} to set up the EABI
24785 environment, and the @option{-msdata} option can use both @code{r2} and
24786 @code{r13} to point to two separate small data areas.  Selecting
24787 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24788 no EABI initialization function is called from @code{main}, and the
24789 @option{-msdata} option only uses @code{r13} to point to a single
24790 small data area.  The @option{-meabi} option is on by default if you
24791 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24793 @item -msdata=eabi
24794 @opindex msdata=eabi
24795 On System V.4 and embedded PowerPC systems, put small initialized
24796 @code{const} global and static data in the @code{.sdata2} section, which
24797 is pointed to by register @code{r2}.  Put small initialized
24798 non-@code{const} global and static data in the @code{.sdata} section,
24799 which is pointed to by register @code{r13}.  Put small uninitialized
24800 global and static data in the @code{.sbss} section, which is adjacent to
24801 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24802 incompatible with the @option{-mrelocatable} option.  The
24803 @option{-msdata=eabi} option also sets the @option{-memb} option.
24805 @item -msdata=sysv
24806 @opindex msdata=sysv
24807 On System V.4 and embedded PowerPC systems, put small global and static
24808 data in the @code{.sdata} section, which is pointed to by register
24809 @code{r13}.  Put small uninitialized global and static data in the
24810 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24811 The @option{-msdata=sysv} option is incompatible with the
24812 @option{-mrelocatable} option.
24814 @item -msdata=default
24815 @itemx -msdata
24816 @opindex msdata=default
24817 @opindex msdata
24818 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24819 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24820 same as @option{-msdata=sysv}.
24822 @item -msdata=data
24823 @opindex msdata=data
24824 On System V.4 and embedded PowerPC systems, put small global
24825 data in the @code{.sdata} section.  Put small uninitialized global
24826 data in the @code{.sbss} section.  Do not use register @code{r13}
24827 to address small data however.  This is the default behavior unless
24828 other @option{-msdata} options are used.
24830 @item -msdata=none
24831 @itemx -mno-sdata
24832 @opindex msdata=none
24833 @opindex mno-sdata
24834 On embedded PowerPC systems, put all initialized global and static data
24835 in the @code{.data} section, and all uninitialized data in the
24836 @code{.bss} section.
24838 @item -mreadonly-in-sdata
24839 @opindex mreadonly-in-sdata
24840 @opindex mno-readonly-in-sdata
24841 Put read-only objects in the @code{.sdata} section as well.  This is the
24842 default.
24844 @item -mblock-move-inline-limit=@var{num}
24845 @opindex mblock-move-inline-limit
24846 Inline all block moves (such as calls to @code{memcpy} or structure
24847 copies) less than or equal to @var{num} bytes.  The minimum value for
24848 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24849 targets.  The default value is target-specific.
24851 @item -mblock-compare-inline-limit=@var{num}
24852 @opindex mblock-compare-inline-limit
24853 Generate non-looping inline code for all block compares (such as calls
24854 to @code{memcmp} or structure compares) less than or equal to @var{num}
24855 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24856 block compare is disabled. The default value is target-specific.
24858 @item -mblock-compare-inline-loop-limit=@var{num}
24859 @opindex mblock-compare-inline-loop-limit
24860 Generate an inline expansion using loop code for all block compares that
24861 are less than or equal to @var{num} bytes, but greater than the limit
24862 for non-loop inline block compare expansion. If the block length is not
24863 constant, at most @var{num} bytes will be compared before @code{memcmp}
24864 is called to compare the remainder of the block. The default value is
24865 target-specific.
24867 @item -mstring-compare-inline-limit=@var{num}
24868 @opindex mstring-compare-inline-limit
24869 Compare at most @var{num} string bytes with inline code.
24870 If the difference or end of string is not found at the
24871 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24872 take care of the rest of the comparison. The default is 64 bytes.
24874 @item -G @var{num}
24875 @opindex G
24876 @cindex smaller data references (PowerPC)
24877 @cindex .sdata/.sdata2 references (PowerPC)
24878 On embedded PowerPC systems, put global and static items less than or
24879 equal to @var{num} bytes into the small data or BSS sections instead of
24880 the normal data or BSS section.  By default, @var{num} is 8.  The
24881 @option{-G @var{num}} switch is also passed to the linker.
24882 All modules should be compiled with the same @option{-G @var{num}} value.
24884 @item -mregnames
24885 @itemx -mno-regnames
24886 @opindex mregnames
24887 @opindex mno-regnames
24888 On System V.4 and embedded PowerPC systems do (do not) emit register
24889 names in the assembly language output using symbolic forms.
24891 @item -mlongcall
24892 @itemx -mno-longcall
24893 @opindex mlongcall
24894 @opindex mno-longcall
24895 By default assume that all calls are far away so that a longer and more
24896 expensive calling sequence is required.  This is required for calls
24897 farther than 32 megabytes (33,554,432 bytes) from the current location.
24898 A short call is generated if the compiler knows
24899 the call cannot be that far away.  This setting can be overridden by
24900 the @code{shortcall} function attribute, or by @code{#pragma
24901 longcall(0)}.
24903 Some linkers are capable of detecting out-of-range calls and generating
24904 glue code on the fly.  On these systems, long calls are unnecessary and
24905 generate slower code.  As of this writing, the AIX linker can do this,
24906 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24907 to the GNU linker for 32-bit PowerPC systems as well.
24909 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24910 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24911 addresses represent the callee and the branch island.  The
24912 Darwin/PPC linker prefers the first address and generates a @code{bl
24913 callee} if the PPC @code{bl} instruction reaches the callee directly;
24914 otherwise, the linker generates @code{bl L42} to call the branch
24915 island.  The branch island is appended to the body of the
24916 calling function; it computes the full 32-bit address of the callee
24917 and jumps to it.
24919 On Mach-O (Darwin) systems, this option directs the compiler emit to
24920 the glue for every direct call, and the Darwin linker decides whether
24921 to use or discard it.
24923 In the future, GCC may ignore all longcall specifications
24924 when the linker is known to generate glue.
24926 @item -mtls-markers
24927 @itemx -mno-tls-markers
24928 @opindex mtls-markers
24929 @opindex mno-tls-markers
24930 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24931 specifying the function argument.  The relocation allows the linker to
24932 reliably associate function call with argument setup instructions for
24933 TLS optimization, which in turn allows GCC to better schedule the
24934 sequence.
24936 @item -mrecip
24937 @itemx -mno-recip
24938 @opindex mrecip
24939 This option enables use of the reciprocal estimate and
24940 reciprocal square root estimate instructions with additional
24941 Newton-Raphson steps to increase precision instead of doing a divide or
24942 square root and divide for floating-point arguments.  You should use
24943 the @option{-ffast-math} option when using @option{-mrecip} (or at
24944 least @option{-funsafe-math-optimizations},
24945 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24946 @option{-fno-trapping-math}).  Note that while the throughput of the
24947 sequence is generally higher than the throughput of the non-reciprocal
24948 instruction, the precision of the sequence can be decreased by up to 2
24949 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24950 roots.
24952 @item -mrecip=@var{opt}
24953 @opindex mrecip=opt
24954 This option controls which reciprocal estimate instructions
24955 may be used.  @var{opt} is a comma-separated list of options, which may
24956 be preceded by a @code{!} to invert the option:
24958 @table @samp
24960 @item all
24961 Enable all estimate instructions.
24963 @item default 
24964 Enable the default instructions, equivalent to @option{-mrecip}.
24966 @item none 
24967 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24969 @item div 
24970 Enable the reciprocal approximation instructions for both 
24971 single and double precision.
24973 @item divf 
24974 Enable the single-precision reciprocal approximation instructions.
24976 @item divd 
24977 Enable the double-precision reciprocal approximation instructions.
24979 @item rsqrt 
24980 Enable the reciprocal square root approximation instructions for both
24981 single and double precision.
24983 @item rsqrtf 
24984 Enable the single-precision reciprocal square root approximation instructions.
24986 @item rsqrtd 
24987 Enable the double-precision reciprocal square root approximation instructions.
24989 @end table
24991 So, for example, @option{-mrecip=all,!rsqrtd} enables
24992 all of the reciprocal estimate instructions, except for the
24993 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24994 which handle the double-precision reciprocal square root calculations.
24996 @item -mrecip-precision
24997 @itemx -mno-recip-precision
24998 @opindex mrecip-precision
24999 Assume (do not assume) that the reciprocal estimate instructions
25000 provide higher-precision estimates than is mandated by the PowerPC
25001 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
25002 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
25003 The double-precision square root estimate instructions are not generated by
25004 default on low-precision machines, since they do not provide an
25005 estimate that converges after three steps.
25007 @item -mveclibabi=@var{type}
25008 @opindex mveclibabi
25009 Specifies the ABI type to use for vectorizing intrinsics using an
25010 external library.  The only type supported at present is @samp{mass},
25011 which specifies to use IBM's Mathematical Acceleration Subsystem
25012 (MASS) libraries for vectorizing intrinsics using external libraries.
25013 GCC currently emits calls to @code{acosd2}, @code{acosf4},
25014 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
25015 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
25016 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
25017 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
25018 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
25019 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
25020 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
25021 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
25022 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
25023 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
25024 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
25025 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
25026 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
25027 for power7.  Both @option{-ftree-vectorize} and
25028 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
25029 libraries must be specified at link time.
25031 @item -mfriz
25032 @itemx -mno-friz
25033 @opindex mfriz
25034 Generate (do not generate) the @code{friz} instruction when the
25035 @option{-funsafe-math-optimizations} option is used to optimize
25036 rounding of floating-point values to 64-bit integer and back to floating
25037 point.  The @code{friz} instruction does not return the same value if
25038 the floating-point number is too large to fit in an integer.
25040 @item -mpointers-to-nested-functions
25041 @itemx -mno-pointers-to-nested-functions
25042 @opindex mpointers-to-nested-functions
25043 Generate (do not generate) code to load up the static chain register
25044 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
25045 systems where a function pointer points to a 3-word descriptor giving
25046 the function address, TOC value to be loaded in register @code{r2}, and
25047 static chain value to be loaded in register @code{r11}.  The
25048 @option{-mpointers-to-nested-functions} is on by default.  You cannot
25049 call through pointers to nested functions or pointers
25050 to functions compiled in other languages that use the static chain if
25051 you use @option{-mno-pointers-to-nested-functions}.
25053 @item -msave-toc-indirect
25054 @itemx -mno-save-toc-indirect
25055 @opindex msave-toc-indirect
25056 Generate (do not generate) code to save the TOC value in the reserved
25057 stack location in the function prologue if the function calls through
25058 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
25059 saved in the prologue, it is saved just before the call through the
25060 pointer.  The @option{-mno-save-toc-indirect} option is the default.
25062 @item -mcompat-align-parm
25063 @itemx -mno-compat-align-parm
25064 @opindex mcompat-align-parm
25065 Generate (do not generate) code to pass structure parameters with a
25066 maximum alignment of 64 bits, for compatibility with older versions
25067 of GCC.
25069 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
25070 structure parameter on a 128-bit boundary when that structure contained
25071 a member requiring 128-bit alignment.  This is corrected in more
25072 recent versions of GCC.  This option may be used to generate code
25073 that is compatible with functions compiled with older versions of
25074 GCC.
25076 The @option{-mno-compat-align-parm} option is the default.
25078 @item -mstack-protector-guard=@var{guard}
25079 @itemx -mstack-protector-guard-reg=@var{reg}
25080 @itemx -mstack-protector-guard-offset=@var{offset}
25081 @itemx -mstack-protector-guard-symbol=@var{symbol}
25082 @opindex mstack-protector-guard
25083 @opindex mstack-protector-guard-reg
25084 @opindex mstack-protector-guard-offset
25085 @opindex mstack-protector-guard-symbol
25086 Generate stack protection code using canary at @var{guard}.  Supported
25087 locations are @samp{global} for global canary or @samp{tls} for per-thread
25088 canary in the TLS block (the default with GNU libc version 2.4 or later).
25090 With the latter choice the options
25091 @option{-mstack-protector-guard-reg=@var{reg}} and
25092 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
25093 which register to use as base register for reading the canary, and from what
25094 offset from that base register. The default for those is as specified in the
25095 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
25096 the offset with a symbol reference to a canary in the TLS block.
25097 @end table
25099 @node RX Options
25100 @subsection RX Options
25101 @cindex RX Options
25103 These command-line options are defined for RX targets:
25105 @table @gcctabopt
25106 @item -m64bit-doubles
25107 @itemx -m32bit-doubles
25108 @opindex m64bit-doubles
25109 @opindex m32bit-doubles
25110 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
25111 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
25112 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
25113 works on 32-bit values, which is why the default is
25114 @option{-m32bit-doubles}.
25116 @item -fpu
25117 @itemx -nofpu
25118 @opindex fpu
25119 @opindex nofpu
25120 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
25121 floating-point hardware.  The default is enabled for the RX600
25122 series and disabled for the RX200 series.
25124 Floating-point instructions are only generated for 32-bit floating-point 
25125 values, however, so the FPU hardware is not used for doubles if the
25126 @option{-m64bit-doubles} option is used.
25128 @emph{Note} If the @option{-fpu} option is enabled then
25129 @option{-funsafe-math-optimizations} is also enabled automatically.
25130 This is because the RX FPU instructions are themselves unsafe.
25132 @item -mcpu=@var{name}
25133 @opindex mcpu
25134 Selects the type of RX CPU to be targeted.  Currently three types are
25135 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
25136 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
25138 The only difference between @samp{RX600} and @samp{RX610} is that the
25139 @samp{RX610} does not support the @code{MVTIPL} instruction.
25141 The @samp{RX200} series does not have a hardware floating-point unit
25142 and so @option{-nofpu} is enabled by default when this type is
25143 selected.
25145 @item -mbig-endian-data
25146 @itemx -mlittle-endian-data
25147 @opindex mbig-endian-data
25148 @opindex mlittle-endian-data
25149 Store data (but not code) in the big-endian format.  The default is
25150 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
25151 format.
25153 @item -msmall-data-limit=@var{N}
25154 @opindex msmall-data-limit
25155 Specifies the maximum size in bytes of global and static variables
25156 which can be placed into the small data area.  Using the small data
25157 area can lead to smaller and faster code, but the size of area is
25158 limited and it is up to the programmer to ensure that the area does
25159 not overflow.  Also when the small data area is used one of the RX's
25160 registers (usually @code{r13}) is reserved for use pointing to this
25161 area, so it is no longer available for use by the compiler.  This
25162 could result in slower and/or larger code if variables are pushed onto
25163 the stack instead of being held in this register.
25165 Note, common variables (variables that have not been initialized) and
25166 constants are not placed into the small data area as they are assigned
25167 to other sections in the output executable.
25169 The default value is zero, which disables this feature.  Note, this
25170 feature is not enabled by default with higher optimization levels
25171 (@option{-O2} etc) because of the potentially detrimental effects of
25172 reserving a register.  It is up to the programmer to experiment and
25173 discover whether this feature is of benefit to their program.  See the
25174 description of the @option{-mpid} option for a description of how the
25175 actual register to hold the small data area pointer is chosen.
25177 @item -msim
25178 @itemx -mno-sim
25179 @opindex msim
25180 @opindex mno-sim
25181 Use the simulator runtime.  The default is to use the libgloss
25182 board-specific runtime.
25184 @item -mas100-syntax
25185 @itemx -mno-as100-syntax
25186 @opindex mas100-syntax
25187 @opindex mno-as100-syntax
25188 When generating assembler output use a syntax that is compatible with
25189 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
25190 assembler, but it has some restrictions so it is not generated by default.
25192 @item -mmax-constant-size=@var{N}
25193 @opindex mmax-constant-size
25194 Specifies the maximum size, in bytes, of a constant that can be used as
25195 an operand in a RX instruction.  Although the RX instruction set does
25196 allow constants of up to 4 bytes in length to be used in instructions,
25197 a longer value equates to a longer instruction.  Thus in some
25198 circumstances it can be beneficial to restrict the size of constants
25199 that are used in instructions.  Constants that are too big are instead
25200 placed into a constant pool and referenced via register indirection.
25202 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
25203 or 4 means that constants of any size are allowed.
25205 @item -mrelax
25206 @opindex mrelax
25207 Enable linker relaxation.  Linker relaxation is a process whereby the
25208 linker attempts to reduce the size of a program by finding shorter
25209 versions of various instructions.  Disabled by default.
25211 @item -mint-register=@var{N}
25212 @opindex mint-register
25213 Specify the number of registers to reserve for fast interrupt handler
25214 functions.  The value @var{N} can be between 0 and 4.  A value of 1
25215 means that register @code{r13} is reserved for the exclusive use
25216 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
25217 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
25218 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
25219 A value of 0, the default, does not reserve any registers.
25221 @item -msave-acc-in-interrupts
25222 @opindex msave-acc-in-interrupts
25223 Specifies that interrupt handler functions should preserve the
25224 accumulator register.  This is only necessary if normal code might use
25225 the accumulator register, for example because it performs 64-bit
25226 multiplications.  The default is to ignore the accumulator as this
25227 makes the interrupt handlers faster.
25229 @item -mpid
25230 @itemx -mno-pid
25231 @opindex mpid
25232 @opindex mno-pid
25233 Enables the generation of position independent data.  When enabled any
25234 access to constant data is done via an offset from a base address
25235 held in a register.  This allows the location of constant data to be
25236 determined at run time without requiring the executable to be
25237 relocated, which is a benefit to embedded applications with tight
25238 memory constraints.  Data that can be modified is not affected by this
25239 option.
25241 Note, using this feature reserves a register, usually @code{r13}, for
25242 the constant data base address.  This can result in slower and/or
25243 larger code, especially in complicated functions.
25245 The actual register chosen to hold the constant data base address
25246 depends upon whether the @option{-msmall-data-limit} and/or the
25247 @option{-mint-register} command-line options are enabled.  Starting
25248 with register @code{r13} and proceeding downwards, registers are
25249 allocated first to satisfy the requirements of @option{-mint-register},
25250 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
25251 is possible for the small data area register to be @code{r8} if both
25252 @option{-mint-register=4} and @option{-mpid} are specified on the
25253 command line.
25255 By default this feature is not enabled.  The default can be restored
25256 via the @option{-mno-pid} command-line option.
25258 @item -mno-warn-multiple-fast-interrupts
25259 @itemx -mwarn-multiple-fast-interrupts
25260 @opindex mno-warn-multiple-fast-interrupts
25261 @opindex mwarn-multiple-fast-interrupts
25262 Prevents GCC from issuing a warning message if it finds more than one
25263 fast interrupt handler when it is compiling a file.  The default is to
25264 issue a warning for each extra fast interrupt handler found, as the RX
25265 only supports one such interrupt.
25267 @item -mallow-string-insns
25268 @itemx -mno-allow-string-insns
25269 @opindex mallow-string-insns
25270 @opindex mno-allow-string-insns
25271 Enables or disables the use of the string manipulation instructions
25272 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
25273 @code{SWHILE} and also the @code{RMPA} instruction.  These
25274 instructions may prefetch data, which is not safe to do if accessing
25275 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
25276 for more information).
25278 The default is to allow these instructions, but it is not possible for
25279 GCC to reliably detect all circumstances where a string instruction
25280 might be used to access an I/O register, so their use cannot be
25281 disabled automatically.  Instead it is reliant upon the programmer to
25282 use the @option{-mno-allow-string-insns} option if their program
25283 accesses I/O space.
25285 When the instructions are enabled GCC defines the C preprocessor
25286 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
25287 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
25289 @item -mjsr
25290 @itemx -mno-jsr
25291 @opindex mjsr
25292 @opindex mno-jsr
25293 Use only (or not only) @code{JSR} instructions to access functions.
25294 This option can be used when code size exceeds the range of @code{BSR}
25295 instructions.  Note that @option{-mno-jsr} does not mean to not use
25296 @code{JSR} but instead means that any type of branch may be used.
25297 @end table
25299 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
25300 has special significance to the RX port when used with the
25301 @code{interrupt} function attribute.  This attribute indicates a
25302 function intended to process fast interrupts.  GCC ensures
25303 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
25304 and/or @code{r13} and only provided that the normal use of the
25305 corresponding registers have been restricted via the
25306 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
25307 options.
25309 @node S/390 and zSeries Options
25310 @subsection S/390 and zSeries Options
25311 @cindex S/390 and zSeries Options
25313 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
25315 @table @gcctabopt
25316 @item -mhard-float
25317 @itemx -msoft-float
25318 @opindex mhard-float
25319 @opindex msoft-float
25320 Use (do not use) the hardware floating-point instructions and registers
25321 for floating-point operations.  When @option{-msoft-float} is specified,
25322 functions in @file{libgcc.a} are used to perform floating-point
25323 operations.  When @option{-mhard-float} is specified, the compiler
25324 generates IEEE floating-point instructions.  This is the default.
25326 @item -mhard-dfp
25327 @itemx -mno-hard-dfp
25328 @opindex mhard-dfp
25329 @opindex mno-hard-dfp
25330 Use (do not use) the hardware decimal-floating-point instructions for
25331 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
25332 specified, functions in @file{libgcc.a} are used to perform
25333 decimal-floating-point operations.  When @option{-mhard-dfp} is
25334 specified, the compiler generates decimal-floating-point hardware
25335 instructions.  This is the default for @option{-march=z9-ec} or higher.
25337 @item -mlong-double-64
25338 @itemx -mlong-double-128
25339 @opindex mlong-double-64
25340 @opindex mlong-double-128
25341 These switches control the size of @code{long double} type. A size
25342 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25343 type. This is the default.
25345 @item -mbackchain
25346 @itemx -mno-backchain
25347 @opindex mbackchain
25348 @opindex mno-backchain
25349 Store (do not store) the address of the caller's frame as backchain pointer
25350 into the callee's stack frame.
25351 A backchain may be needed to allow debugging using tools that do not understand
25352 DWARF call frame information.
25353 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
25354 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
25355 the backchain is placed into the topmost word of the 96/160 byte register
25356 save area.
25358 In general, code compiled with @option{-mbackchain} is call-compatible with
25359 code compiled with @option{-mmo-backchain}; however, use of the backchain
25360 for debugging purposes usually requires that the whole binary is built with
25361 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
25362 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
25363 to build a linux kernel use @option{-msoft-float}.
25365 The default is to not maintain the backchain.
25367 @item -mpacked-stack
25368 @itemx -mno-packed-stack
25369 @opindex mpacked-stack
25370 @opindex mno-packed-stack
25371 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
25372 specified, the compiler uses the all fields of the 96/160 byte register save
25373 area only for their default purpose; unused fields still take up stack space.
25374 When @option{-mpacked-stack} is specified, register save slots are densely
25375 packed at the top of the register save area; unused space is reused for other
25376 purposes, allowing for more efficient use of the available stack space.
25377 However, when @option{-mbackchain} is also in effect, the topmost word of
25378 the save area is always used to store the backchain, and the return address
25379 register is always saved two words below the backchain.
25381 As long as the stack frame backchain is not used, code generated with
25382 @option{-mpacked-stack} is call-compatible with code generated with
25383 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
25384 S/390 or zSeries generated code that uses the stack frame backchain at run
25385 time, not just for debugging purposes.  Such code is not call-compatible
25386 with code compiled with @option{-mpacked-stack}.  Also, note that the
25387 combination of @option{-mbackchain},
25388 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
25389 to build a linux kernel use @option{-msoft-float}.
25391 The default is to not use the packed stack layout.
25393 @item -msmall-exec
25394 @itemx -mno-small-exec
25395 @opindex msmall-exec
25396 @opindex mno-small-exec
25397 Generate (or do not generate) code using the @code{bras} instruction
25398 to do subroutine calls.
25399 This only works reliably if the total executable size does not
25400 exceed 64k.  The default is to use the @code{basr} instruction instead,
25401 which does not have this limitation.
25403 @item -m64
25404 @itemx -m31
25405 @opindex m64
25406 @opindex m31
25407 When @option{-m31} is specified, generate code compliant to the
25408 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
25409 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
25410 particular to generate 64-bit instructions.  For the @samp{s390}
25411 targets, the default is @option{-m31}, while the @samp{s390x}
25412 targets default to @option{-m64}.
25414 @item -mzarch
25415 @itemx -mesa
25416 @opindex mzarch
25417 @opindex mesa
25418 When @option{-mzarch} is specified, generate code using the
25419 instructions available on z/Architecture.
25420 When @option{-mesa} is specified, generate code using the
25421 instructions available on ESA/390.  Note that @option{-mesa} is
25422 not possible with @option{-m64}.
25423 When generating code compliant to the GNU/Linux for S/390 ABI,
25424 the default is @option{-mesa}.  When generating code compliant
25425 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
25427 @item -mhtm
25428 @itemx -mno-htm
25429 @opindex mhtm
25430 @opindex mno-htm
25431 The @option{-mhtm} option enables a set of builtins making use of
25432 instructions available with the transactional execution facility
25433 introduced with the IBM zEnterprise EC12 machine generation
25434 @ref{S/390 System z Built-in Functions}.
25435 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
25437 @item -mvx
25438 @itemx -mno-vx
25439 @opindex mvx
25440 @opindex mno-vx
25441 When @option{-mvx} is specified, generate code using the instructions
25442 available with the vector extension facility introduced with the IBM
25443 z13 machine generation.
25444 This option changes the ABI for some vector type values with regard to
25445 alignment and calling conventions.  In case vector type values are
25446 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
25447 command will be added to mark the resulting binary with the ABI used.
25448 @option{-mvx} is enabled by default when using @option{-march=z13}.
25450 @item -mzvector
25451 @itemx -mno-zvector
25452 @opindex mzvector
25453 @opindex mno-zvector
25454 The @option{-mzvector} option enables vector language extensions and
25455 builtins using instructions available with the vector extension
25456 facility introduced with the IBM z13 machine generation.
25457 This option adds support for @samp{vector} to be used as a keyword to
25458 define vector type variables and arguments.  @samp{vector} is only
25459 available when GNU extensions are enabled.  It will not be expanded
25460 when requesting strict standard compliance e.g.@: with @option{-std=c99}.
25461 In addition to the GCC low-level builtins @option{-mzvector} enables
25462 a set of builtins added for compatibility with AltiVec-style
25463 implementations like Power and Cell.  In order to make use of these
25464 builtins the header file @file{vecintrin.h} needs to be included.
25465 @option{-mzvector} is disabled by default.
25467 @item -mmvcle
25468 @itemx -mno-mvcle
25469 @opindex mmvcle
25470 @opindex mno-mvcle
25471 Generate (or do not generate) code using the @code{mvcle} instruction
25472 to perform block moves.  When @option{-mno-mvcle} is specified,
25473 use a @code{mvc} loop instead.  This is the default unless optimizing for
25474 size.
25476 @item -mdebug
25477 @itemx -mno-debug
25478 @opindex mdebug
25479 @opindex mno-debug
25480 Print (or do not print) additional debug information when compiling.
25481 The default is to not print debug information.
25483 @item -march=@var{cpu-type}
25484 @opindex march
25485 Generate code that runs on @var{cpu-type}, which is the name of a
25486 system representing a certain processor type.  Possible values for
25487 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
25488 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
25489 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
25490 @samp{native}.
25492 The default is @option{-march=z900}.
25494 Specifying @samp{native} as cpu type can be used to select the best
25495 architecture option for the host processor.
25496 @option{-march=native} has no effect if GCC does not recognize the
25497 processor.
25499 @item -mtune=@var{cpu-type}
25500 @opindex mtune
25501 Tune to @var{cpu-type} everything applicable about the generated code,
25502 except for the ABI and the set of available instructions.
25503 The list of @var{cpu-type} values is the same as for @option{-march}.
25504 The default is the value used for @option{-march}.
25506 @item -mtpf-trace
25507 @itemx -mno-tpf-trace
25508 @opindex mtpf-trace
25509 @opindex mno-tpf-trace
25510 Generate code that adds (does not add) in TPF OS specific branches to trace
25511 routines in the operating system.  This option is off by default, even
25512 when compiling for the TPF OS@.
25514 @item -mfused-madd
25515 @itemx -mno-fused-madd
25516 @opindex mfused-madd
25517 @opindex mno-fused-madd
25518 Generate code that uses (does not use) the floating-point multiply and
25519 accumulate instructions.  These instructions are generated by default if
25520 hardware floating point is used.
25522 @item -mwarn-framesize=@var{framesize}
25523 @opindex mwarn-framesize
25524 Emit a warning if the current function exceeds the given frame size.  Because
25525 this is a compile-time check it doesn't need to be a real problem when the program
25526 runs.  It is intended to identify functions that most probably cause
25527 a stack overflow.  It is useful to be used in an environment with limited stack
25528 size e.g.@: the linux kernel.
25530 @item -mwarn-dynamicstack
25531 @opindex mwarn-dynamicstack
25532 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
25533 arrays.  This is generally a bad idea with a limited stack size.
25535 @item -mstack-guard=@var{stack-guard}
25536 @itemx -mstack-size=@var{stack-size}
25537 @opindex mstack-guard
25538 @opindex mstack-size
25539 If these options are provided the S/390 back end emits additional instructions in
25540 the function prologue that trigger a trap if the stack size is @var{stack-guard}
25541 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
25542 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
25543 the frame size of the compiled function is chosen.
25544 These options are intended to be used to help debugging stack overflow problems.
25545 The additionally emitted code causes only little overhead and hence can also be
25546 used in production-like systems without greater performance degradation.  The given
25547 values have to be exact powers of 2 and @var{stack-size} has to be greater than
25548 @var{stack-guard} without exceeding 64k.
25549 In order to be efficient the extra code makes the assumption that the stack starts
25550 at an address aligned to the value given by @var{stack-size}.
25551 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
25553 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
25554 @opindex mhotpatch
25555 If the hotpatch option is enabled, a ``hot-patching'' function
25556 prologue is generated for all functions in the compilation unit.
25557 The funtion label is prepended with the given number of two-byte
25558 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
25559 the label, 2 * @var{post-halfwords} bytes are appended, using the
25560 largest NOP like instructions the architecture allows (maximum
25561 1000000).
25563 If both arguments are zero, hotpatching is disabled.
25565 This option can be overridden for individual functions with the
25566 @code{hotpatch} attribute.
25567 @end table
25569 @node Score Options
25570 @subsection Score Options
25571 @cindex Score Options
25573 These options are defined for Score implementations:
25575 @table @gcctabopt
25576 @item -meb
25577 @opindex meb
25578 Compile code for big-endian mode.  This is the default.
25580 @item -mel
25581 @opindex mel
25582 Compile code for little-endian mode.
25584 @item -mnhwloop
25585 @opindex mnhwloop
25586 Disable generation of @code{bcnz} instructions.
25588 @item -muls
25589 @opindex muls
25590 Enable generation of unaligned load and store instructions.
25592 @item -mmac
25593 @opindex mmac
25594 Enable the use of multiply-accumulate instructions. Disabled by default.
25596 @item -mscore5
25597 @opindex mscore5
25598 Specify the SCORE5 as the target architecture.
25600 @item -mscore5u
25601 @opindex mscore5u
25602 Specify the SCORE5U of the target architecture.
25604 @item -mscore7
25605 @opindex mscore7
25606 Specify the SCORE7 as the target architecture. This is the default.
25608 @item -mscore7d
25609 @opindex mscore7d
25610 Specify the SCORE7D as the target architecture.
25611 @end table
25613 @node SH Options
25614 @subsection SH Options
25616 These @samp{-m} options are defined for the SH implementations:
25618 @table @gcctabopt
25619 @item -m1
25620 @opindex m1
25621 Generate code for the SH1.
25623 @item -m2
25624 @opindex m2
25625 Generate code for the SH2.
25627 @item -m2e
25628 Generate code for the SH2e.
25630 @item -m2a-nofpu
25631 @opindex m2a-nofpu
25632 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
25633 that the floating-point unit is not used.
25635 @item -m2a-single-only
25636 @opindex m2a-single-only
25637 Generate code for the SH2a-FPU, in such a way that no double-precision
25638 floating-point operations are used.
25640 @item -m2a-single
25641 @opindex m2a-single
25642 Generate code for the SH2a-FPU assuming the floating-point unit is in
25643 single-precision mode by default.
25645 @item -m2a
25646 @opindex m2a
25647 Generate code for the SH2a-FPU assuming the floating-point unit is in
25648 double-precision mode by default.
25650 @item -m3
25651 @opindex m3
25652 Generate code for the SH3.
25654 @item -m3e
25655 @opindex m3e
25656 Generate code for the SH3e.
25658 @item -m4-nofpu
25659 @opindex m4-nofpu
25660 Generate code for the SH4 without a floating-point unit.
25662 @item -m4-single-only
25663 @opindex m4-single-only
25664 Generate code for the SH4 with a floating-point unit that only
25665 supports single-precision arithmetic.
25667 @item -m4-single
25668 @opindex m4-single
25669 Generate code for the SH4 assuming the floating-point unit is in
25670 single-precision mode by default.
25672 @item -m4
25673 @opindex m4
25674 Generate code for the SH4.
25676 @item -m4-100
25677 @opindex m4-100
25678 Generate code for SH4-100.
25680 @item -m4-100-nofpu
25681 @opindex m4-100-nofpu
25682 Generate code for SH4-100 in such a way that the
25683 floating-point unit is not used.
25685 @item -m4-100-single
25686 @opindex m4-100-single
25687 Generate code for SH4-100 assuming the floating-point unit is in
25688 single-precision mode by default.
25690 @item -m4-100-single-only
25691 @opindex m4-100-single-only
25692 Generate code for SH4-100 in such a way that no double-precision
25693 floating-point operations are used.
25695 @item -m4-200
25696 @opindex m4-200
25697 Generate code for SH4-200.
25699 @item -m4-200-nofpu
25700 @opindex m4-200-nofpu
25701 Generate code for SH4-200 without in such a way that the
25702 floating-point unit is not used.
25704 @item -m4-200-single
25705 @opindex m4-200-single
25706 Generate code for SH4-200 assuming the floating-point unit is in
25707 single-precision mode by default.
25709 @item -m4-200-single-only
25710 @opindex m4-200-single-only
25711 Generate code for SH4-200 in such a way that no double-precision
25712 floating-point operations are used.
25714 @item -m4-300
25715 @opindex m4-300
25716 Generate code for SH4-300.
25718 @item -m4-300-nofpu
25719 @opindex m4-300-nofpu
25720 Generate code for SH4-300 without in such a way that the
25721 floating-point unit is not used.
25723 @item -m4-300-single
25724 @opindex m4-300-single
25725 Generate code for SH4-300 in such a way that no double-precision
25726 floating-point operations are used.
25728 @item -m4-300-single-only
25729 @opindex m4-300-single-only
25730 Generate code for SH4-300 in such a way that no double-precision
25731 floating-point operations are used.
25733 @item -m4-340
25734 @opindex m4-340
25735 Generate code for SH4-340 (no MMU, no FPU).
25737 @item -m4-500
25738 @opindex m4-500
25739 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
25740 assembler.
25742 @item -m4a-nofpu
25743 @opindex m4a-nofpu
25744 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25745 floating-point unit is not used.
25747 @item -m4a-single-only
25748 @opindex m4a-single-only
25749 Generate code for the SH4a, in such a way that no double-precision
25750 floating-point operations are used.
25752 @item -m4a-single
25753 @opindex m4a-single
25754 Generate code for the SH4a assuming the floating-point unit is in
25755 single-precision mode by default.
25757 @item -m4a
25758 @opindex m4a
25759 Generate code for the SH4a.
25761 @item -m4al
25762 @opindex m4al
25763 Same as @option{-m4a-nofpu}, except that it implicitly passes
25764 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25765 instructions at the moment.
25767 @item -mb
25768 @opindex mb
25769 Compile code for the processor in big-endian mode.
25771 @item -ml
25772 @opindex ml
25773 Compile code for the processor in little-endian mode.
25775 @item -mdalign
25776 @opindex mdalign
25777 Align doubles at 64-bit boundaries.  Note that this changes the calling
25778 conventions, and thus some functions from the standard C library do
25779 not work unless you recompile it first with @option{-mdalign}.
25781 @item -mrelax
25782 @opindex mrelax
25783 Shorten some address references at link time, when possible; uses the
25784 linker option @option{-relax}.
25786 @item -mbigtable
25787 @opindex mbigtable
25788 Use 32-bit offsets in @code{switch} tables.  The default is to use
25789 16-bit offsets.
25791 @item -mbitops
25792 @opindex mbitops
25793 Enable the use of bit manipulation instructions on SH2A.
25795 @item -mfmovd
25796 @opindex mfmovd
25797 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25798 alignment constraints.
25800 @item -mrenesas
25801 @opindex mrenesas
25802 Comply with the calling conventions defined by Renesas.
25804 @item -mno-renesas
25805 @opindex mno-renesas
25806 Comply with the calling conventions defined for GCC before the Renesas
25807 conventions were available.  This option is the default for all
25808 targets of the SH toolchain.
25810 @item -mnomacsave
25811 @opindex mnomacsave
25812 Mark the @code{MAC} register as call-clobbered, even if
25813 @option{-mrenesas} is given.
25815 @item -mieee
25816 @itemx -mno-ieee
25817 @opindex mieee
25818 @opindex mno-ieee
25819 Control the IEEE compliance of floating-point comparisons, which affects the
25820 handling of cases where the result of a comparison is unordered.  By default
25821 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25822 enabled @option{-mno-ieee} is implicitly set, which results in faster
25823 floating-point greater-equal and less-equal comparisons.  The implicit settings
25824 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25826 @item -minline-ic_invalidate
25827 @opindex minline-ic_invalidate
25828 Inline code to invalidate instruction cache entries after setting up
25829 nested function trampolines.
25830 This option has no effect if @option{-musermode} is in effect and the selected
25831 code generation option (e.g.@: @option{-m4}) does not allow the use of the @code{icbi}
25832 instruction.
25833 If the selected code generation option does not allow the use of the @code{icbi}
25834 instruction, and @option{-musermode} is not in effect, the inlined code
25835 manipulates the instruction cache address array directly with an associative
25836 write.  This not only requires privileged mode at run time, but it also
25837 fails if the cache line had been mapped via the TLB and has become unmapped.
25839 @item -misize
25840 @opindex misize
25841 Dump instruction size and location in the assembly code.
25843 @item -mpadstruct
25844 @opindex mpadstruct
25845 This option is deprecated.  It pads structures to multiple of 4 bytes,
25846 which is incompatible with the SH ABI@.
25848 @item -matomic-model=@var{model}
25849 @opindex matomic-model=@var{model}
25850 Sets the model of atomic operations and additional parameters as a comma
25851 separated list.  For details on the atomic built-in functions see
25852 @ref{__atomic Builtins}.  The following models and parameters are supported:
25854 @table @samp
25856 @item none
25857 Disable compiler generated atomic sequences and emit library calls for atomic
25858 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25860 @item soft-gusa
25861 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25862 built-in functions.  The generated atomic sequences require additional support
25863 from the interrupt/exception handling code of the system and are only suitable
25864 for SH3* and SH4* single-core systems.  This option is enabled by default when
25865 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25866 this option also partially utilizes the hardware atomic instructions
25867 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25868 @samp{strict} is specified.  
25870 @item soft-tcb
25871 Generate software atomic sequences that use a variable in the thread control
25872 block.  This is a variation of the gUSA sequences which can also be used on
25873 SH1* and SH2* targets.  The generated atomic sequences require additional
25874 support from the interrupt/exception handling code of the system and are only
25875 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25876 parameter has to be specified as well.
25878 @item soft-imask
25879 Generate software atomic sequences that temporarily disable interrupts by
25880 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25881 in privileged mode and is only suitable for single-core systems.  Additional
25882 support from the interrupt/exception handling code of the system is not
25883 required.  This model is enabled by default when the target is
25884 @code{sh*-*-linux*} and SH1* or SH2*.
25886 @item hard-llcs
25887 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25888 instructions only.  This is only available on SH4A and is suitable for
25889 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25890 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25891 Code compiled with this option is also compatible with other software
25892 atomic model interrupt/exception handling systems if executed on an SH4A
25893 system.  Additional support from the interrupt/exception handling code of the
25894 system is not required for this model.
25896 @item gbr-offset=
25897 This parameter specifies the offset in bytes of the variable in the thread
25898 control block structure that should be used by the generated atomic sequences
25899 when the @samp{soft-tcb} model has been selected.  For other models this
25900 parameter is ignored.  The specified value must be an integer multiple of four
25901 and in the range 0-1020.
25903 @item strict
25904 This parameter prevents mixed usage of multiple atomic models, even if they
25905 are compatible, and makes the compiler generate atomic sequences of the
25906 specified model only.
25908 @end table
25910 @item -mtas
25911 @opindex mtas
25912 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25913 Notice that depending on the particular hardware and software configuration
25914 this can degrade overall performance due to the operand cache line flushes
25915 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25916 processors the @code{tas.b} instruction must be used with caution since it
25917 can result in data corruption for certain cache configurations.
25919 @item -mprefergot
25920 @opindex mprefergot
25921 When generating position-independent code, emit function calls using
25922 the Global Offset Table instead of the Procedure Linkage Table.
25924 @item -musermode
25925 @itemx -mno-usermode
25926 @opindex musermode
25927 @opindex mno-usermode
25928 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25929 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25930 inlined code would not work in user mode.  @option{-musermode} is the default
25931 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25932 @option{-musermode} has no effect, since there is no user mode.
25934 @item -multcost=@var{number}
25935 @opindex multcost=@var{number}
25936 Set the cost to assume for a multiply insn.
25938 @item -mdiv=@var{strategy}
25939 @opindex mdiv=@var{strategy}
25940 Set the division strategy to be used for integer division operations.
25941 @var{strategy} can be one of: 
25943 @table @samp
25945 @item call-div1
25946 Calls a library function that uses the single-step division instruction
25947 @code{div1} to perform the operation.  Division by zero calculates an
25948 unspecified result and does not trap.  This is the default except for SH4,
25949 SH2A and SHcompact.
25951 @item call-fp
25952 Calls a library function that performs the operation in double precision
25953 floating point.  Division by zero causes a floating-point exception.  This is
25954 the default for SHcompact with FPU.  Specifying this for targets that do not
25955 have a double precision FPU defaults to @code{call-div1}.
25957 @item call-table
25958 Calls a library function that uses a lookup table for small divisors and
25959 the @code{div1} instruction with case distinction for larger divisors.  Division
25960 by zero calculates an unspecified result and does not trap.  This is the default
25961 for SH4.  Specifying this for targets that do not have dynamic shift
25962 instructions defaults to @code{call-div1}.
25964 @end table
25966 When a division strategy has not been specified the default strategy is
25967 selected based on the current target.  For SH2A the default strategy is to
25968 use the @code{divs} and @code{divu} instructions instead of library function
25969 calls.
25971 @item -maccumulate-outgoing-args
25972 @opindex maccumulate-outgoing-args
25973 Reserve space once for outgoing arguments in the function prologue rather
25974 than around each call.  Generally beneficial for performance and size.  Also
25975 needed for unwinding to avoid changing the stack frame around conditional code.
25977 @item -mdivsi3_libfunc=@var{name}
25978 @opindex mdivsi3_libfunc=@var{name}
25979 Set the name of the library function used for 32-bit signed division to
25980 @var{name}.
25981 This only affects the name used in the @samp{call} division strategies, and
25982 the compiler still expects the same sets of input/output/clobbered registers as
25983 if this option were not present.
25985 @item -mfixed-range=@var{register-range}
25986 @opindex mfixed-range
25987 Generate code treating the given register range as fixed registers.
25988 A fixed register is one that the register allocator can not use.  This is
25989 useful when compiling kernel code.  A register range is specified as
25990 two registers separated by a dash.  Multiple register ranges can be
25991 specified separated by a comma.
25993 @item -mbranch-cost=@var{num}
25994 @opindex mbranch-cost=@var{num}
25995 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25996 make the compiler try to generate more branch-free code if possible.  
25997 If not specified the value is selected depending on the processor type that
25998 is being compiled for.
26000 @item -mzdcbranch
26001 @itemx -mno-zdcbranch
26002 @opindex mzdcbranch
26003 @opindex mno-zdcbranch
26004 Assume (do not assume) that zero displacement conditional branch instructions
26005 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
26006 compiler prefers zero displacement branch code sequences.  This is
26007 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
26008 disabled by specifying @option{-mno-zdcbranch}.
26010 @item -mcbranch-force-delay-slot
26011 @opindex mcbranch-force-delay-slot
26012 Force the usage of delay slots for conditional branches, which stuffs the delay
26013 slot with a @code{nop} if a suitable instruction cannot be found.  By default
26014 this option is disabled.  It can be enabled to work around hardware bugs as
26015 found in the original SH7055.
26017 @item -mfused-madd
26018 @itemx -mno-fused-madd
26019 @opindex mfused-madd
26020 @opindex mno-fused-madd
26021 Generate code that uses (does not use) the floating-point multiply and
26022 accumulate instructions.  These instructions are generated by default
26023 if hardware floating point is used.  The machine-dependent
26024 @option{-mfused-madd} option is now mapped to the machine-independent
26025 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
26026 mapped to @option{-ffp-contract=off}.
26028 @item -mfsca
26029 @itemx -mno-fsca
26030 @opindex mfsca
26031 @opindex mno-fsca
26032 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
26033 and cosine approximations.  The option @option{-mfsca} must be used in
26034 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
26035 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
26036 approximations even if @option{-funsafe-math-optimizations} is in effect.
26038 @item -mfsrra
26039 @itemx -mno-fsrra
26040 @opindex mfsrra
26041 @opindex mno-fsrra
26042 Allow or disallow the compiler to emit the @code{fsrra} instruction for
26043 reciprocal square root approximations.  The option @option{-mfsrra} must be used
26044 in combination with @option{-funsafe-math-optimizations} and
26045 @option{-ffinite-math-only}.  It is enabled by default when generating code for
26046 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
26047 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
26048 in effect.
26050 @item -mpretend-cmove
26051 @opindex mpretend-cmove
26052 Prefer zero-displacement conditional branches for conditional move instruction
26053 patterns.  This can result in faster code on the SH4 processor.
26055 @item -mfdpic
26056 @opindex fdpic
26057 Generate code using the FDPIC ABI.
26059 @end table
26061 @node Solaris 2 Options
26062 @subsection Solaris 2 Options
26063 @cindex Solaris 2 options
26065 These @samp{-m} options are supported on Solaris 2:
26067 @table @gcctabopt
26068 @item -mclear-hwcap
26069 @opindex mclear-hwcap
26070 @option{-mclear-hwcap} tells the compiler to remove the hardware
26071 capabilities generated by the Solaris assembler.  This is only necessary
26072 when object files use ISA extensions not supported by the current
26073 machine, but check at runtime whether or not to use them.
26075 @item -mimpure-text
26076 @opindex mimpure-text
26077 @option{-mimpure-text}, used in addition to @option{-shared}, tells
26078 the compiler to not pass @option{-z text} to the linker when linking a
26079 shared object.  Using this option, you can link position-dependent
26080 code into a shared object.
26082 @option{-mimpure-text} suppresses the ``relocations remain against
26083 allocatable but non-writable sections'' linker error message.
26084 However, the necessary relocations trigger copy-on-write, and the
26085 shared object is not actually shared across processes.  Instead of
26086 using @option{-mimpure-text}, you should compile all source code with
26087 @option{-fpic} or @option{-fPIC}.
26089 @end table
26091 These switches are supported in addition to the above on Solaris 2:
26093 @table @gcctabopt
26094 @item -pthreads
26095 @opindex pthreads
26096 This is a synonym for @option{-pthread}.
26097 @end table
26099 @node SPARC Options
26100 @subsection SPARC Options
26101 @cindex SPARC options
26103 These @samp{-m} options are supported on the SPARC:
26105 @table @gcctabopt
26106 @item -mno-app-regs
26107 @itemx -mapp-regs
26108 @opindex mno-app-regs
26109 @opindex mapp-regs
26110 Specify @option{-mapp-regs} to generate output using the global registers
26111 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
26112 global register 1, each global register 2 through 4 is then treated as an
26113 allocable register that is clobbered by function calls.  This is the default.
26115 To be fully SVR4 ABI-compliant at the cost of some performance loss,
26116 specify @option{-mno-app-regs}.  You should compile libraries and system
26117 software with this option.
26119 @item -mflat
26120 @itemx -mno-flat
26121 @opindex mflat
26122 @opindex mno-flat
26123 With @option{-mflat}, the compiler does not generate save/restore instructions
26124 and uses a ``flat'' or single register window model.  This model is compatible
26125 with the regular register window model.  The local registers and the input
26126 registers (0--5) are still treated as ``call-saved'' registers and are
26127 saved on the stack as needed.
26129 With @option{-mno-flat} (the default), the compiler generates save/restore
26130 instructions (except for leaf functions).  This is the normal operating mode.
26132 @item -mfpu
26133 @itemx -mhard-float
26134 @opindex mfpu
26135 @opindex mhard-float
26136 Generate output containing floating-point instructions.  This is the
26137 default.
26139 @item -mno-fpu
26140 @itemx -msoft-float
26141 @opindex mno-fpu
26142 @opindex msoft-float
26143 Generate output containing library calls for floating point.
26144 @strong{Warning:} the requisite libraries are not available for all SPARC
26145 targets.  Normally the facilities of the machine's usual C compiler are
26146 used, but this cannot be done directly in cross-compilation.  You must make
26147 your own arrangements to provide suitable library functions for
26148 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
26149 @samp{sparclite-*-*} do provide software floating-point support.
26151 @option{-msoft-float} changes the calling convention in the output file;
26152 therefore, it is only useful if you compile @emph{all} of a program with
26153 this option.  In particular, you need to compile @file{libgcc.a}, the
26154 library that comes with GCC, with @option{-msoft-float} in order for
26155 this to work.
26157 @item -mhard-quad-float
26158 @opindex mhard-quad-float
26159 Generate output containing quad-word (long double) floating-point
26160 instructions.
26162 @item -msoft-quad-float
26163 @opindex msoft-quad-float
26164 Generate output containing library calls for quad-word (long double)
26165 floating-point instructions.  The functions called are those specified
26166 in the SPARC ABI@.  This is the default.
26168 As of this writing, there are no SPARC implementations that have hardware
26169 support for the quad-word floating-point instructions.  They all invoke
26170 a trap handler for one of these instructions, and then the trap handler
26171 emulates the effect of the instruction.  Because of the trap handler overhead,
26172 this is much slower than calling the ABI library routines.  Thus the
26173 @option{-msoft-quad-float} option is the default.
26175 @item -mno-unaligned-doubles
26176 @itemx -munaligned-doubles
26177 @opindex mno-unaligned-doubles
26178 @opindex munaligned-doubles
26179 Assume that doubles have 8-byte alignment.  This is the default.
26181 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
26182 alignment only if they are contained in another type, or if they have an
26183 absolute address.  Otherwise, it assumes they have 4-byte alignment.
26184 Specifying this option avoids some rare compatibility problems with code
26185 generated by other compilers.  It is not the default because it results
26186 in a performance loss, especially for floating-point code.
26188 @item -muser-mode
26189 @itemx -mno-user-mode
26190 @opindex muser-mode
26191 @opindex mno-user-mode
26192 Do not generate code that can only run in supervisor mode.  This is relevant
26193 only for the @code{casa} instruction emitted for the LEON3 processor.  This
26194 is the default.
26196 @item -mfaster-structs
26197 @itemx -mno-faster-structs
26198 @opindex mfaster-structs
26199 @opindex mno-faster-structs
26200 With @option{-mfaster-structs}, the compiler assumes that structures
26201 should have 8-byte alignment.  This enables the use of pairs of
26202 @code{ldd} and @code{std} instructions for copies in structure
26203 assignment, in place of twice as many @code{ld} and @code{st} pairs.
26204 However, the use of this changed alignment directly violates the SPARC
26205 ABI@.  Thus, it's intended only for use on targets where the developer
26206 acknowledges that their resulting code is not directly in line with
26207 the rules of the ABI@.
26209 @item -mstd-struct-return
26210 @itemx -mno-std-struct-return
26211 @opindex mstd-struct-return
26212 @opindex mno-std-struct-return
26213 With @option{-mstd-struct-return}, the compiler generates checking code
26214 in functions returning structures or unions to detect size mismatches
26215 between the two sides of function calls, as per the 32-bit ABI@.
26217 The default is @option{-mno-std-struct-return}.  This option has no effect
26218 in 64-bit mode.
26220 @item -mlra
26221 @itemx -mno-lra
26222 @opindex mlra
26223 @opindex mno-lra
26224 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
26225 so @option{-mno-lra} needs to be passed to get old Reload.
26227 @item -mcpu=@var{cpu_type}
26228 @opindex mcpu
26229 Set the instruction set, register set, and instruction scheduling parameters
26230 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26231 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
26232 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
26233 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
26234 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
26235 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
26237 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
26238 which selects the best architecture option for the host processor.
26239 @option{-mcpu=native} has no effect if GCC does not recognize
26240 the processor.
26242 Default instruction scheduling parameters are used for values that select
26243 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
26244 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
26246 Here is a list of each supported architecture and their supported
26247 implementations.
26249 @table @asis
26250 @item v7
26251 cypress, leon3v7
26253 @item v8
26254 supersparc, hypersparc, leon, leon3
26256 @item sparclite
26257 f930, f934, sparclite86x
26259 @item sparclet
26260 tsc701
26262 @item v9
26263 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
26264 niagara7, m8
26265 @end table
26267 By default (unless configured otherwise), GCC generates code for the V7
26268 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
26269 additionally optimizes it for the Cypress CY7C602 chip, as used in the
26270 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
26271 SPARCStation 1, 2, IPX etc.
26273 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
26274 architecture.  The only difference from V7 code is that the compiler emits
26275 the integer multiply and integer divide instructions which exist in SPARC-V8
26276 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
26277 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
26278 2000 series.
26280 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
26281 the SPARC architecture.  This adds the integer multiply, integer divide step
26282 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
26283 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
26284 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
26285 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
26286 MB86934 chip, which is the more recent SPARClite with FPU@.
26288 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
26289 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
26290 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
26291 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
26292 optimizes it for the TEMIC SPARClet chip.
26294 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
26295 architecture.  This adds 64-bit integer and floating-point move instructions,
26296 3 additional floating-point condition code registers and conditional move
26297 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
26298 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
26299 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
26300 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
26301 @option{-mcpu=niagara}, the compiler additionally optimizes it for
26302 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
26303 additionally optimizes it for Sun UltraSPARC T2 chips. With
26304 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
26305 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
26306 additionally optimizes it for Sun UltraSPARC T4 chips.  With
26307 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
26308 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
26309 additionally optimizes it for Oracle M8 chips.
26311 @item -mtune=@var{cpu_type}
26312 @opindex mtune
26313 Set the instruction scheduling parameters for machine type
26314 @var{cpu_type}, but do not set the instruction set or register set that the
26315 option @option{-mcpu=@var{cpu_type}} does.
26317 The same values for @option{-mcpu=@var{cpu_type}} can be used for
26318 @option{-mtune=@var{cpu_type}}, but the only useful values are those
26319 that select a particular CPU implementation.  Those are
26320 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
26321 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
26322 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
26323 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
26324 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
26325 and GNU/Linux toolchains, @samp{native} can also be used.
26327 @item -mv8plus
26328 @itemx -mno-v8plus
26329 @opindex mv8plus
26330 @opindex mno-v8plus
26331 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
26332 difference from the V8 ABI is that the global and out registers are
26333 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
26334 mode for all SPARC-V9 processors.
26336 @item -mvis
26337 @itemx -mno-vis
26338 @opindex mvis
26339 @opindex mno-vis
26340 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
26341 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
26343 @item -mvis2
26344 @itemx -mno-vis2
26345 @opindex mvis2
26346 @opindex mno-vis2
26347 With @option{-mvis2}, GCC generates code that takes advantage of
26348 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
26349 default is @option{-mvis2} when targeting a cpu that supports such
26350 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
26351 also sets @option{-mvis}.
26353 @item -mvis3
26354 @itemx -mno-vis3
26355 @opindex mvis3
26356 @opindex mno-vis3
26357 With @option{-mvis3}, GCC generates code that takes advantage of
26358 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
26359 default is @option{-mvis3} when targeting a cpu that supports such
26360 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
26361 also sets @option{-mvis2} and @option{-mvis}.
26363 @item -mvis4
26364 @itemx -mno-vis4
26365 @opindex mvis4
26366 @opindex mno-vis4
26367 With @option{-mvis4}, GCC generates code that takes advantage of
26368 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
26369 default is @option{-mvis4} when targeting a cpu that supports such
26370 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
26371 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
26373 @item -mvis4b
26374 @itemx -mno-vis4b
26375 @opindex mvis4b
26376 @opindex mno-vis4b
26377 With @option{-mvis4b}, GCC generates code that takes advantage of
26378 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
26379 the additional VIS instructions introduced in the Oracle SPARC
26380 Architecture 2017.  The default is @option{-mvis4b} when targeting a
26381 cpu that supports such instructions, such as m8 and later.  Setting
26382 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
26383 @option{-mvis2} and @option{-mvis}.
26385 @item -mcbcond
26386 @itemx -mno-cbcond
26387 @opindex mcbcond
26388 @opindex mno-cbcond
26389 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
26390 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
26391 when targeting a CPU that supports such instructions, such as Niagara-4 and
26392 later.
26394 @item -mfmaf
26395 @itemx -mno-fmaf
26396 @opindex mfmaf
26397 @opindex mno-fmaf
26398 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
26399 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
26400 when targeting a CPU that supports such instructions, such as Niagara-3 and
26401 later.
26403 @item -mfsmuld
26404 @itemx -mno-fsmuld
26405 @opindex mfsmuld
26406 @opindex mno-fsmuld
26407 With @option{-mfsmuld}, GCC generates code that takes advantage of the
26408 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
26409 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
26410 or V9 with FPU except @option{-mcpu=leon}.
26412 @item -mpopc
26413 @itemx -mno-popc
26414 @opindex mpopc
26415 @opindex mno-popc
26416 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
26417 Population Count instruction.  The default is @option{-mpopc}
26418 when targeting a CPU that supports such an instruction, such as Niagara-2 and
26419 later.
26421 @item -msubxc
26422 @itemx -mno-subxc
26423 @opindex msubxc
26424 @opindex mno-subxc
26425 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
26426 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
26427 when targeting a CPU that supports such an instruction, such as Niagara-7 and
26428 later.
26430 @item -mfix-at697f
26431 @opindex mfix-at697f
26432 Enable the documented workaround for the single erratum of the Atmel AT697F
26433 processor (which corresponds to erratum #13 of the AT697E processor).
26435 @item -mfix-ut699
26436 @opindex mfix-ut699
26437 Enable the documented workarounds for the floating-point errata and the data
26438 cache nullify errata of the UT699 processor.
26440 @item -mfix-ut700
26441 @opindex mfix-ut700
26442 Enable the documented workaround for the back-to-back store errata of
26443 the UT699E/UT700 processor.
26445 @item -mfix-gr712rc
26446 @opindex mfix-gr712rc
26447 Enable the documented workaround for the back-to-back store errata of
26448 the GR712RC processor.
26449 @end table
26451 These @samp{-m} options are supported in addition to the above
26452 on SPARC-V9 processors in 64-bit environments:
26454 @table @gcctabopt
26455 @item -m32
26456 @itemx -m64
26457 @opindex m32
26458 @opindex m64
26459 Generate code for a 32-bit or 64-bit environment.
26460 The 32-bit environment sets int, long and pointer to 32 bits.
26461 The 64-bit environment sets int to 32 bits and long and pointer
26462 to 64 bits.
26464 @item -mcmodel=@var{which}
26465 @opindex mcmodel
26466 Set the code model to one of
26468 @table @samp
26469 @item medlow
26470 The Medium/Low code model: 64-bit addresses, programs
26471 must be linked in the low 32 bits of memory.  Programs can be statically
26472 or dynamically linked.
26474 @item medmid
26475 The Medium/Middle code model: 64-bit addresses, programs
26476 must be linked in the low 44 bits of memory, the text and data segments must
26477 be less than 2GB in size and the data segment must be located within 2GB of
26478 the text segment.
26480 @item medany
26481 The Medium/Anywhere code model: 64-bit addresses, programs
26482 may be linked anywhere in memory, the text and data segments must be less
26483 than 2GB in size and the data segment must be located within 2GB of the
26484 text segment.
26486 @item embmedany
26487 The Medium/Anywhere code model for embedded systems:
26488 64-bit addresses, the text and data segments must be less than 2GB in
26489 size, both starting anywhere in memory (determined at link time).  The
26490 global register %g4 points to the base of the data segment.  Programs
26491 are statically linked and PIC is not supported.
26492 @end table
26494 @item -mmemory-model=@var{mem-model}
26495 @opindex mmemory-model
26496 Set the memory model in force on the processor to one of
26498 @table @samp
26499 @item default
26500 The default memory model for the processor and operating system.
26502 @item rmo
26503 Relaxed Memory Order
26505 @item pso
26506 Partial Store Order
26508 @item tso
26509 Total Store Order
26511 @item sc
26512 Sequential Consistency
26513 @end table
26515 These memory models are formally defined in Appendix D of the SPARC-V9
26516 architecture manual, as set in the processor's @code{PSTATE.MM} field.
26518 @item -mstack-bias
26519 @itemx -mno-stack-bias
26520 @opindex mstack-bias
26521 @opindex mno-stack-bias
26522 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
26523 frame pointer if present, are offset by @minus{}2047 which must be added back
26524 when making stack frame references.  This is the default in 64-bit mode.
26525 Otherwise, assume no such offset is present.
26526 @end table
26528 @node SPU Options
26529 @subsection SPU Options
26530 @cindex SPU options
26532 These @samp{-m} options are supported on the SPU:
26534 @table @gcctabopt
26535 @item -mwarn-reloc
26536 @itemx -merror-reloc
26537 @opindex mwarn-reloc
26538 @opindex merror-reloc
26540 The loader for SPU does not handle dynamic relocations.  By default, GCC
26541 gives an error when it generates code that requires a dynamic
26542 relocation.  @option{-mno-error-reloc} disables the error,
26543 @option{-mwarn-reloc} generates a warning instead.
26545 @item -msafe-dma
26546 @itemx -munsafe-dma
26547 @opindex msafe-dma
26548 @opindex munsafe-dma
26550 Instructions that initiate or test completion of DMA must not be
26551 reordered with respect to loads and stores of the memory that is being
26552 accessed.
26553 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
26554 memory accesses, but that can lead to inefficient code in places where the
26555 memory is known to not change.  Rather than mark the memory as volatile,
26556 you can use @option{-msafe-dma} to tell the compiler to treat
26557 the DMA instructions as potentially affecting all memory.  
26559 @item -mbranch-hints
26560 @opindex mbranch-hints
26562 By default, GCC generates a branch hint instruction to avoid
26563 pipeline stalls for always-taken or probably-taken branches.  A hint
26564 is not generated closer than 8 instructions away from its branch.
26565 There is little reason to disable them, except for debugging purposes,
26566 or to make an object a little bit smaller.
26568 @item -msmall-mem
26569 @itemx -mlarge-mem
26570 @opindex msmall-mem
26571 @opindex mlarge-mem
26573 By default, GCC generates code assuming that addresses are never larger
26574 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
26575 a full 32-bit address.
26577 @item -mstdmain
26578 @opindex mstdmain
26580 By default, GCC links against startup code that assumes the SPU-style
26581 main function interface (which has an unconventional parameter list).
26582 With @option{-mstdmain}, GCC links your program against startup
26583 code that assumes a C99-style interface to @code{main}, including a
26584 local copy of @code{argv} strings.
26586 @item -mfixed-range=@var{register-range}
26587 @opindex mfixed-range
26588 Generate code treating the given register range as fixed registers.
26589 A fixed register is one that the register allocator cannot use.  This is
26590 useful when compiling kernel code.  A register range is specified as
26591 two registers separated by a dash.  Multiple register ranges can be
26592 specified separated by a comma.
26594 @item -mea32
26595 @itemx -mea64
26596 @opindex mea32
26597 @opindex mea64
26598 Compile code assuming that pointers to the PPU address space accessed
26599 via the @code{__ea} named address space qualifier are either 32 or 64
26600 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
26601 all object code in an executable must be compiled with the same setting.
26603 @item -maddress-space-conversion
26604 @itemx -mno-address-space-conversion
26605 @opindex maddress-space-conversion
26606 @opindex mno-address-space-conversion
26607 Allow/disallow treating the @code{__ea} address space as superset
26608 of the generic address space.  This enables explicit type casts
26609 between @code{__ea} and generic pointer as well as implicit
26610 conversions of generic pointers to @code{__ea} pointers.  The
26611 default is to allow address space pointer conversions.
26613 @item -mcache-size=@var{cache-size}
26614 @opindex mcache-size
26615 This option controls the version of libgcc that the compiler links to an
26616 executable and selects a software-managed cache for accessing variables
26617 in the @code{__ea} address space with a particular cache size.  Possible
26618 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
26619 and @samp{128}.  The default cache size is 64KB.
26621 @item -matomic-updates
26622 @itemx -mno-atomic-updates
26623 @opindex matomic-updates
26624 @opindex mno-atomic-updates
26625 This option controls the version of libgcc that the compiler links to an
26626 executable and selects whether atomic updates to the software-managed
26627 cache of PPU-side variables are used.  If you use atomic updates, changes
26628 to a PPU variable from SPU code using the @code{__ea} named address space
26629 qualifier do not interfere with changes to other PPU variables residing
26630 in the same cache line from PPU code.  If you do not use atomic updates,
26631 such interference may occur; however, writing back cache lines is
26632 more efficient.  The default behavior is to use atomic updates.
26634 @item -mdual-nops
26635 @itemx -mdual-nops=@var{n}
26636 @opindex mdual-nops
26637 By default, GCC inserts NOPs to increase dual issue when it expects
26638 it to increase performance.  @var{n} can be a value from 0 to 10.  A
26639 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
26640 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
26642 @item -mhint-max-nops=@var{n}
26643 @opindex mhint-max-nops
26644 Maximum number of NOPs to insert for a branch hint.  A branch hint must
26645 be at least 8 instructions away from the branch it is affecting.  GCC
26646 inserts up to @var{n} NOPs to enforce this, otherwise it does not
26647 generate the branch hint.
26649 @item -mhint-max-distance=@var{n}
26650 @opindex mhint-max-distance
26651 The encoding of the branch hint instruction limits the hint to be within
26652 256 instructions of the branch it is affecting.  By default, GCC makes
26653 sure it is within 125.
26655 @item -msafe-hints
26656 @opindex msafe-hints
26657 Work around a hardware bug that causes the SPU to stall indefinitely.
26658 By default, GCC inserts the @code{hbrp} instruction to make sure
26659 this stall won't happen.
26661 @end table
26663 @node System V Options
26664 @subsection Options for System V
26666 These additional options are available on System V Release 4 for
26667 compatibility with other compilers on those systems:
26669 @table @gcctabopt
26670 @item -G
26671 @opindex G
26672 Create a shared object.
26673 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
26675 @item -Qy
26676 @opindex Qy
26677 Identify the versions of each tool used by the compiler, in a
26678 @code{.ident} assembler directive in the output.
26680 @item -Qn
26681 @opindex Qn
26682 Refrain from adding @code{.ident} directives to the output file (this is
26683 the default).
26685 @item -YP,@var{dirs}
26686 @opindex YP
26687 Search the directories @var{dirs}, and no others, for libraries
26688 specified with @option{-l}.
26690 @item -Ym,@var{dir}
26691 @opindex Ym
26692 Look in the directory @var{dir} to find the M4 preprocessor.
26693 The assembler uses this option.
26694 @c This is supposed to go with a -Yd for predefined M4 macro files, but
26695 @c the generic assembler that comes with Solaris takes just -Ym.
26696 @end table
26698 @node TILE-Gx Options
26699 @subsection TILE-Gx Options
26700 @cindex TILE-Gx options
26702 These @samp{-m} options are supported on the TILE-Gx:
26704 @table @gcctabopt
26705 @item -mcmodel=small
26706 @opindex mcmodel=small
26707 Generate code for the small model.  The distance for direct calls is
26708 limited to 500M in either direction.  PC-relative addresses are 32
26709 bits.  Absolute addresses support the full address range.
26711 @item -mcmodel=large
26712 @opindex mcmodel=large
26713 Generate code for the large model.  There is no limitation on call
26714 distance, pc-relative addresses, or absolute addresses.
26716 @item -mcpu=@var{name}
26717 @opindex mcpu
26718 Selects the type of CPU to be targeted.  Currently the only supported
26719 type is @samp{tilegx}.
26721 @item -m32
26722 @itemx -m64
26723 @opindex m32
26724 @opindex m64
26725 Generate code for a 32-bit or 64-bit environment.  The 32-bit
26726 environment sets int, long, and pointer to 32 bits.  The 64-bit
26727 environment sets int to 32 bits and long and pointer to 64 bits.
26729 @item -mbig-endian
26730 @itemx -mlittle-endian
26731 @opindex mbig-endian
26732 @opindex mlittle-endian
26733 Generate code in big/little endian mode, respectively.
26734 @end table
26736 @node TILEPro Options
26737 @subsection TILEPro Options
26738 @cindex TILEPro options
26740 These @samp{-m} options are supported on the TILEPro:
26742 @table @gcctabopt
26743 @item -mcpu=@var{name}
26744 @opindex mcpu
26745 Selects the type of CPU to be targeted.  Currently the only supported
26746 type is @samp{tilepro}.
26748 @item -m32
26749 @opindex m32
26750 Generate code for a 32-bit environment, which sets int, long, and
26751 pointer to 32 bits.  This is the only supported behavior so the flag
26752 is essentially ignored.
26753 @end table
26755 @node V850 Options
26756 @subsection V850 Options
26757 @cindex V850 Options
26759 These @samp{-m} options are defined for V850 implementations:
26761 @table @gcctabopt
26762 @item -mlong-calls
26763 @itemx -mno-long-calls
26764 @opindex mlong-calls
26765 @opindex mno-long-calls
26766 Treat all calls as being far away (near).  If calls are assumed to be
26767 far away, the compiler always loads the function's address into a
26768 register, and calls indirect through the pointer.
26770 @item -mno-ep
26771 @itemx -mep
26772 @opindex mno-ep
26773 @opindex mep
26774 Do not optimize (do optimize) basic blocks that use the same index
26775 pointer 4 or more times to copy pointer into the @code{ep} register, and
26776 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26777 option is on by default if you optimize.
26779 @item -mno-prolog-function
26780 @itemx -mprolog-function
26781 @opindex mno-prolog-function
26782 @opindex mprolog-function
26783 Do not use (do use) external functions to save and restore registers
26784 at the prologue and epilogue of a function.  The external functions
26785 are slower, but use less code space if more than one function saves
26786 the same number of registers.  The @option{-mprolog-function} option
26787 is on by default if you optimize.
26789 @item -mspace
26790 @opindex mspace
26791 Try to make the code as small as possible.  At present, this just turns
26792 on the @option{-mep} and @option{-mprolog-function} options.
26794 @item -mtda=@var{n}
26795 @opindex mtda
26796 Put static or global variables whose size is @var{n} bytes or less into
26797 the tiny data area that register @code{ep} points to.  The tiny data
26798 area can hold up to 256 bytes in total (128 bytes for byte references).
26800 @item -msda=@var{n}
26801 @opindex msda
26802 Put static or global variables whose size is @var{n} bytes or less into
26803 the small data area that register @code{gp} points to.  The small data
26804 area can hold up to 64 kilobytes.
26806 @item -mzda=@var{n}
26807 @opindex mzda
26808 Put static or global variables whose size is @var{n} bytes or less into
26809 the first 32 kilobytes of memory.
26811 @item -mv850
26812 @opindex mv850
26813 Specify that the target processor is the V850.
26815 @item -mv850e3v5
26816 @opindex mv850e3v5
26817 Specify that the target processor is the V850E3V5.  The preprocessor
26818 constant @code{__v850e3v5__} is defined if this option is used.
26820 @item -mv850e2v4
26821 @opindex mv850e2v4
26822 Specify that the target processor is the V850E3V5.  This is an alias for
26823 the @option{-mv850e3v5} option.
26825 @item -mv850e2v3
26826 @opindex mv850e2v3
26827 Specify that the target processor is the V850E2V3.  The preprocessor
26828 constant @code{__v850e2v3__} is defined if this option is used.
26830 @item -mv850e2
26831 @opindex mv850e2
26832 Specify that the target processor is the V850E2.  The preprocessor
26833 constant @code{__v850e2__} is defined if this option is used.
26835 @item -mv850e1
26836 @opindex mv850e1
26837 Specify that the target processor is the V850E1.  The preprocessor
26838 constants @code{__v850e1__} and @code{__v850e__} are defined if
26839 this option is used.
26841 @item -mv850es
26842 @opindex mv850es
26843 Specify that the target processor is the V850ES.  This is an alias for
26844 the @option{-mv850e1} option.
26846 @item -mv850e
26847 @opindex mv850e
26848 Specify that the target processor is the V850E@.  The preprocessor
26849 constant @code{__v850e__} is defined if this option is used.
26851 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26852 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26853 are defined then a default target processor is chosen and the
26854 relevant @samp{__v850*__} preprocessor constant is defined.
26856 The preprocessor constants @code{__v850} and @code{__v851__} are always
26857 defined, regardless of which processor variant is the target.
26859 @item -mdisable-callt
26860 @itemx -mno-disable-callt
26861 @opindex mdisable-callt
26862 @opindex mno-disable-callt
26863 This option suppresses generation of the @code{CALLT} instruction for the
26864 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26865 architecture.
26867 This option is enabled by default when the RH850 ABI is
26868 in use (see @option{-mrh850-abi}), and disabled by default when the
26869 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26870 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26872 @item -mrelax
26873 @itemx -mno-relax
26874 @opindex mrelax
26875 @opindex mno-relax
26876 Pass on (or do not pass on) the @option{-mrelax} command-line option
26877 to the assembler.
26879 @item -mlong-jumps
26880 @itemx -mno-long-jumps
26881 @opindex mlong-jumps
26882 @opindex mno-long-jumps
26883 Disable (or re-enable) the generation of PC-relative jump instructions.
26885 @item -msoft-float
26886 @itemx -mhard-float
26887 @opindex msoft-float
26888 @opindex mhard-float
26889 Disable (or re-enable) the generation of hardware floating point
26890 instructions.  This option is only significant when the target
26891 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26892 instructions are being generated then the C preprocessor symbol
26893 @code{__FPU_OK__} is defined, otherwise the symbol
26894 @code{__NO_FPU__} is defined.
26896 @item -mloop
26897 @opindex mloop
26898 Enables the use of the e3v5 LOOP instruction.  The use of this
26899 instruction is not enabled by default when the e3v5 architecture is
26900 selected because its use is still experimental.
26902 @item -mrh850-abi
26903 @itemx -mghs
26904 @opindex mrh850-abi
26905 @opindex mghs
26906 Enables support for the RH850 version of the V850 ABI.  This is the
26907 default.  With this version of the ABI the following rules apply:
26909 @itemize
26910 @item
26911 Integer sized structures and unions are returned via a memory pointer
26912 rather than a register.
26914 @item
26915 Large structures and unions (more than 8 bytes in size) are passed by
26916 value.
26918 @item
26919 Functions are aligned to 16-bit boundaries.
26921 @item
26922 The @option{-m8byte-align} command-line option is supported.
26924 @item
26925 The @option{-mdisable-callt} command-line option is enabled by
26926 default.  The @option{-mno-disable-callt} command-line option is not
26927 supported.
26928 @end itemize
26930 When this version of the ABI is enabled the C preprocessor symbol
26931 @code{__V850_RH850_ABI__} is defined.
26933 @item -mgcc-abi
26934 @opindex mgcc-abi
26935 Enables support for the old GCC version of the V850 ABI.  With this
26936 version of the ABI the following rules apply:
26938 @itemize
26939 @item
26940 Integer sized structures and unions are returned in register @code{r10}.
26942 @item
26943 Large structures and unions (more than 8 bytes in size) are passed by
26944 reference.
26946 @item
26947 Functions are aligned to 32-bit boundaries, unless optimizing for
26948 size.
26950 @item
26951 The @option{-m8byte-align} command-line option is not supported.
26953 @item
26954 The @option{-mdisable-callt} command-line option is supported but not
26955 enabled by default.
26956 @end itemize
26958 When this version of the ABI is enabled the C preprocessor symbol
26959 @code{__V850_GCC_ABI__} is defined.
26961 @item -m8byte-align
26962 @itemx -mno-8byte-align
26963 @opindex m8byte-align
26964 @opindex mno-8byte-align
26965 Enables support for @code{double} and @code{long long} types to be
26966 aligned on 8-byte boundaries.  The default is to restrict the
26967 alignment of all objects to at most 4-bytes.  When
26968 @option{-m8byte-align} is in effect the C preprocessor symbol
26969 @code{__V850_8BYTE_ALIGN__} is defined.
26971 @item -mbig-switch
26972 @opindex mbig-switch
26973 Generate code suitable for big switch tables.  Use this option only if
26974 the assembler/linker complain about out of range branches within a switch
26975 table.
26977 @item -mapp-regs
26978 @opindex mapp-regs
26979 This option causes r2 and r5 to be used in the code generated by
26980 the compiler.  This setting is the default.
26982 @item -mno-app-regs
26983 @opindex mno-app-regs
26984 This option causes r2 and r5 to be treated as fixed registers.
26986 @end table
26988 @node VAX Options
26989 @subsection VAX Options
26990 @cindex VAX options
26992 These @samp{-m} options are defined for the VAX:
26994 @table @gcctabopt
26995 @item -munix
26996 @opindex munix
26997 Do not output certain jump instructions (@code{aobleq} and so on)
26998 that the Unix assembler for the VAX cannot handle across long
26999 ranges.
27001 @item -mgnu
27002 @opindex mgnu
27003 Do output those jump instructions, on the assumption that the
27004 GNU assembler is being used.
27006 @item -mg
27007 @opindex mg
27008 Output code for G-format floating-point numbers instead of D-format.
27009 @end table
27011 @node Visium Options
27012 @subsection Visium Options
27013 @cindex Visium options
27015 @table @gcctabopt
27017 @item -mdebug
27018 @opindex mdebug
27019 A program which performs file I/O and is destined to run on an MCM target
27020 should be linked with this option.  It causes the libraries libc.a and
27021 libdebug.a to be linked.  The program should be run on the target under
27022 the control of the GDB remote debugging stub.
27024 @item -msim
27025 @opindex msim
27026 A program which performs file I/O and is destined to run on the simulator
27027 should be linked with option.  This causes libraries libc.a and libsim.a to
27028 be linked.
27030 @item -mfpu
27031 @itemx -mhard-float
27032 @opindex mfpu
27033 @opindex mhard-float
27034 Generate code containing floating-point instructions.  This is the
27035 default.
27037 @item -mno-fpu
27038 @itemx -msoft-float
27039 @opindex mno-fpu
27040 @opindex msoft-float
27041 Generate code containing library calls for floating-point.
27043 @option{-msoft-float} changes the calling convention in the output file;
27044 therefore, it is only useful if you compile @emph{all} of a program with
27045 this option.  In particular, you need to compile @file{libgcc.a}, the
27046 library that comes with GCC, with @option{-msoft-float} in order for
27047 this to work.
27049 @item -mcpu=@var{cpu_type}
27050 @opindex mcpu
27051 Set the instruction set, register set, and instruction scheduling parameters
27052 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
27053 @samp{mcm}, @samp{gr5} and @samp{gr6}.
27055 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
27057 By default (unless configured otherwise), GCC generates code for the GR5
27058 variant of the Visium architecture.  
27060 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
27061 architecture.  The only difference from GR5 code is that the compiler will
27062 generate block move instructions.
27064 @item -mtune=@var{cpu_type}
27065 @opindex mtune
27066 Set the instruction scheduling parameters for machine type @var{cpu_type},
27067 but do not set the instruction set or register set that the option
27068 @option{-mcpu=@var{cpu_type}} would.
27070 @item -msv-mode
27071 @opindex msv-mode
27072 Generate code for the supervisor mode, where there are no restrictions on
27073 the access to general registers.  This is the default.
27075 @item -muser-mode
27076 @opindex muser-mode
27077 Generate code for the user mode, where the access to some general registers
27078 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
27079 mode; on the GR6, only registers r29 to r31 are affected.
27080 @end table
27082 @node VMS Options
27083 @subsection VMS Options
27085 These @samp{-m} options are defined for the VMS implementations:
27087 @table @gcctabopt
27088 @item -mvms-return-codes
27089 @opindex mvms-return-codes
27090 Return VMS condition codes from @code{main}. The default is to return POSIX-style
27091 condition (e.g.@: error) codes.
27093 @item -mdebug-main=@var{prefix}
27094 @opindex mdebug-main=@var{prefix}
27095 Flag the first routine whose name starts with @var{prefix} as the main
27096 routine for the debugger.
27098 @item -mmalloc64
27099 @opindex mmalloc64
27100 Default to 64-bit memory allocation routines.
27102 @item -mpointer-size=@var{size}
27103 @opindex mpointer-size=@var{size}
27104 Set the default size of pointers. Possible options for @var{size} are
27105 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
27106 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
27107 The later option disables @code{pragma pointer_size}.
27108 @end table
27110 @node VxWorks Options
27111 @subsection VxWorks Options
27112 @cindex VxWorks Options
27114 The options in this section are defined for all VxWorks targets.
27115 Options specific to the target hardware are listed with the other
27116 options for that target.
27118 @table @gcctabopt
27119 @item -mrtp
27120 @opindex mrtp
27121 GCC can generate code for both VxWorks kernels and real time processes
27122 (RTPs).  This option switches from the former to the latter.  It also
27123 defines the preprocessor macro @code{__RTP__}.
27125 @item -non-static
27126 @opindex non-static
27127 Link an RTP executable against shared libraries rather than static
27128 libraries.  The options @option{-static} and @option{-shared} can
27129 also be used for RTPs (@pxref{Link Options}); @option{-static}
27130 is the default.
27132 @item -Bstatic
27133 @itemx -Bdynamic
27134 @opindex Bstatic
27135 @opindex Bdynamic
27136 These options are passed down to the linker.  They are defined for
27137 compatibility with Diab.
27139 @item -Xbind-lazy
27140 @opindex Xbind-lazy
27141 Enable lazy binding of function calls.  This option is equivalent to
27142 @option{-Wl,-z,now} and is defined for compatibility with Diab.
27144 @item -Xbind-now
27145 @opindex Xbind-now
27146 Disable lazy binding of function calls.  This option is the default and
27147 is defined for compatibility with Diab.
27148 @end table
27150 @node x86 Options
27151 @subsection x86 Options
27152 @cindex x86 Options
27154 These @samp{-m} options are defined for the x86 family of computers.
27156 @table @gcctabopt
27158 @item -march=@var{cpu-type}
27159 @opindex march
27160 Generate instructions for the machine type @var{cpu-type}.  In contrast to
27161 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
27162 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
27163 to generate code that may not run at all on processors other than the one
27164 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
27165 @option{-mtune=@var{cpu-type}}.
27167 The choices for @var{cpu-type} are:
27169 @table @samp
27170 @item native
27171 This selects the CPU to generate code for at compilation time by determining
27172 the processor type of the compiling machine.  Using @option{-march=native}
27173 enables all instruction subsets supported by the local machine (hence
27174 the result might not run on different machines).  Using @option{-mtune=native}
27175 produces code optimized for the local machine under the constraints
27176 of the selected instruction set.  
27178 @item x86-64
27179 A generic CPU with 64-bit extensions.
27181 @item i386
27182 Original Intel i386 CPU@.
27184 @item i486
27185 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
27187 @item i586
27188 @itemx pentium
27189 Intel Pentium CPU with no MMX support.
27191 @item lakemont
27192 Intel Lakemont MCU, based on Intel Pentium CPU.
27194 @item pentium-mmx
27195 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
27197 @item pentiumpro
27198 Intel Pentium Pro CPU@.
27200 @item i686
27201 When used with @option{-march}, the Pentium Pro
27202 instruction set is used, so the code runs on all i686 family chips.
27203 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
27205 @item pentium2
27206 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
27207 support.
27209 @item pentium3
27210 @itemx pentium3m
27211 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
27212 set support.
27214 @item pentium-m
27215 Intel Pentium M; low-power version of Intel Pentium III CPU
27216 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
27218 @item pentium4
27219 @itemx pentium4m
27220 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
27222 @item prescott
27223 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
27224 set support.
27226 @item nocona
27227 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
27228 SSE2 and SSE3 instruction set support.
27230 @item core2
27231 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
27232 instruction set support.
27234 @item nehalem
27235 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27236 SSE4.1, SSE4.2 and POPCNT instruction set support.
27238 @item westmere
27239 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27240 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
27242 @item sandybridge
27243 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27244 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
27246 @item ivybridge
27247 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27248 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
27249 instruction set support.
27251 @item haswell
27252 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27253 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27254 BMI, BMI2 and F16C instruction set support.
27256 @item broadwell
27257 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27258 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27259 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
27261 @item skylake
27262 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27263 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27264 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
27265 XSAVES instruction set support.
27267 @item bonnell
27268 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
27269 instruction set support.
27271 @item silvermont
27272 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27273 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
27275 @item goldmont
27276 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27277 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
27278 instruction set support.
27280 @item goldmont-plus
27281 Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27282 SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE,
27283 PTWRITE, RDPID, SGX and UMIP instruction set support.
27285 @item tremont
27286 Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27287 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, PTWRITE,
27288 RDPID, SGX, UMIP, GFNI-SSE, CLWB and ENCLV instruction set support.
27290 @item knl
27291 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27292 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27293 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
27294 AVX512CD instruction set support.
27296 @item knm
27297 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27298 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27299 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27300 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
27302 @item skylake-avx512
27303 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27304 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27305 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
27306 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
27308 @item cannonlake
27309 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27310 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27311 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27312 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27313 AVX512IFMA, SHA and UMIP instruction set support.
27315 @item icelake-client
27316 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27317 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27318 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27319 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27320 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
27321 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
27323 @item icelake-server
27324 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27325 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27326 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27327 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27328 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
27329 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
27330 set support.
27332 @item k6
27333 AMD K6 CPU with MMX instruction set support.
27335 @item k6-2
27336 @itemx k6-3
27337 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
27339 @item athlon
27340 @itemx athlon-tbird
27341 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
27342 support.
27344 @item athlon-4
27345 @itemx athlon-xp
27346 @itemx athlon-mp
27347 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
27348 instruction set support.
27350 @item k8
27351 @itemx opteron
27352 @itemx athlon64
27353 @itemx athlon-fx
27354 Processors based on the AMD K8 core with x86-64 instruction set support,
27355 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
27356 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
27357 instruction set extensions.)
27359 @item k8-sse3
27360 @itemx opteron-sse3
27361 @itemx athlon64-sse3
27362 Improved versions of AMD K8 cores with SSE3 instruction set support.
27364 @item amdfam10
27365 @itemx barcelona
27366 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
27367 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
27368 instruction set extensions.)
27370 @item bdver1
27371 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
27372 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
27373 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
27374 @item bdver2
27375 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
27376 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
27377 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
27378 extensions.)
27379 @item bdver3
27380 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
27381 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
27382 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
27383 64-bit instruction set extensions.
27384 @item bdver4
27385 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
27386 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
27387 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
27388 SSE4.2, ABM and 64-bit instruction set extensions.
27390 @item znver1
27391 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
27392 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
27393 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
27394 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
27395 instruction set extensions.
27396 @item znver2
27397 AMD Family 17h core based CPUs with x86-64 instruction set support. (This
27398 supersets BMI, BMI2, ,CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED,
27399 MWAITX, SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A,
27400 SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
27401 instruction set extensions.)
27404 @item btver1
27405 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
27406 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
27407 instruction set extensions.)
27409 @item btver2
27410 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
27411 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
27412 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
27414 @item winchip-c6
27415 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
27416 set support.
27418 @item winchip2
27419 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
27420 instruction set support.
27422 @item c3
27423 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
27424 (No scheduling is implemented for this chip.)
27426 @item c3-2
27427 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
27428 (No scheduling is implemented for this chip.)
27430 @item c7
27431 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
27432 (No scheduling is implemented for this chip.)
27434 @item samuel-2
27435 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
27436 (No scheduling is implemented for this chip.)
27438 @item nehemiah
27439 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
27440 (No scheduling is implemented for this chip.)
27442 @item esther
27443 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
27444 (No scheduling is implemented for this chip.)
27446 @item eden-x2
27447 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
27448 (No scheduling is implemented for this chip.)
27450 @item eden-x4
27451 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
27452 AVX and AVX2 instruction set support.
27453 (No scheduling is implemented for this chip.)
27455 @item nano
27456 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27457 instruction set support.
27458 (No scheduling is implemented for this chip.)
27460 @item nano-1000
27461 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27462 instruction set support.
27463 (No scheduling is implemented for this chip.)
27465 @item nano-2000
27466 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27467 instruction set support.
27468 (No scheduling is implemented for this chip.)
27470 @item nano-3000
27471 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27472 instruction set support.
27473 (No scheduling is implemented for this chip.)
27475 @item nano-x2
27476 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27477 instruction set support.
27478 (No scheduling is implemented for this chip.)
27480 @item nano-x4
27481 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27482 instruction set support.
27483 (No scheduling is implemented for this chip.)
27485 @item geode
27486 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
27487 @end table
27489 @item -mtune=@var{cpu-type}
27490 @opindex mtune
27491 Tune to @var{cpu-type} everything applicable about the generated code, except
27492 for the ABI and the set of available instructions.  
27493 While picking a specific @var{cpu-type} schedules things appropriately
27494 for that particular chip, the compiler does not generate any code that
27495 cannot run on the default machine type unless you use a
27496 @option{-march=@var{cpu-type}} option.
27497 For example, if GCC is configured for i686-pc-linux-gnu
27498 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
27499 but still runs on i686 machines.
27501 The choices for @var{cpu-type} are the same as for @option{-march}.
27502 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
27504 @table @samp
27505 @item generic
27506 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
27507 If you know the CPU on which your code will run, then you should use
27508 the corresponding @option{-mtune} or @option{-march} option instead of
27509 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
27510 of your application will have, then you should use this option.
27512 As new processors are deployed in the marketplace, the behavior of this
27513 option will change.  Therefore, if you upgrade to a newer version of
27514 GCC, code generation controlled by this option will change to reflect
27515 the processors
27516 that are most common at the time that version of GCC is released.
27518 There is no @option{-march=generic} option because @option{-march}
27519 indicates the instruction set the compiler can use, and there is no
27520 generic instruction set applicable to all processors.  In contrast,
27521 @option{-mtune} indicates the processor (or, in this case, collection of
27522 processors) for which the code is optimized.
27524 @item intel
27525 Produce code optimized for the most current Intel processors, which are
27526 Haswell and Silvermont for this version of GCC.  If you know the CPU
27527 on which your code will run, then you should use the corresponding
27528 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
27529 But, if you want your application performs better on both Haswell and
27530 Silvermont, then you should use this option.
27532 As new Intel processors are deployed in the marketplace, the behavior of
27533 this option will change.  Therefore, if you upgrade to a newer version of
27534 GCC, code generation controlled by this option will change to reflect
27535 the most current Intel processors at the time that version of GCC is
27536 released.
27538 There is no @option{-march=intel} option because @option{-march} indicates
27539 the instruction set the compiler can use, and there is no common
27540 instruction set applicable to all processors.  In contrast,
27541 @option{-mtune} indicates the processor (or, in this case, collection of
27542 processors) for which the code is optimized.
27543 @end table
27545 @item -mcpu=@var{cpu-type}
27546 @opindex mcpu
27547 A deprecated synonym for @option{-mtune}.
27549 @item -mfpmath=@var{unit}
27550 @opindex mfpmath
27551 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
27552 for @var{unit} are:
27554 @table @samp
27555 @item 387
27556 Use the standard 387 floating-point coprocessor present on the majority of chips and
27557 emulated otherwise.  Code compiled with this option runs almost everywhere.
27558 The temporary results are computed in 80-bit precision instead of the precision
27559 specified by the type, resulting in slightly different results compared to most
27560 of other chips.  See @option{-ffloat-store} for more detailed description.
27562 This is the default choice for non-Darwin x86-32 targets.
27564 @item sse
27565 Use scalar floating-point instructions present in the SSE instruction set.
27566 This instruction set is supported by Pentium III and newer chips,
27567 and in the AMD line
27568 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
27569 instruction set supports only single-precision arithmetic, thus the double and
27570 extended-precision arithmetic are still done using 387.  A later version, present
27571 only in Pentium 4 and AMD x86-64 chips, supports double-precision
27572 arithmetic too.
27574 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
27575 or @option{-msse2} switches to enable SSE extensions and make this option
27576 effective.  For the x86-64 compiler, these extensions are enabled by default.
27578 The resulting code should be considerably faster in the majority of cases and avoid
27579 the numerical instability problems of 387 code, but may break some existing
27580 code that expects temporaries to be 80 bits.
27582 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
27583 and the default choice for x86-32 targets with the SSE2 instruction set
27584 when @option{-ffast-math} is enabled.
27586 @item sse,387
27587 @itemx sse+387
27588 @itemx both
27589 Attempt to utilize both instruction sets at once.  This effectively doubles the
27590 amount of available registers, and on chips with separate execution units for
27591 387 and SSE the execution resources too.  Use this option with care, as it is
27592 still experimental, because the GCC register allocator does not model separate
27593 functional units well, resulting in unstable performance.
27594 @end table
27596 @item -masm=@var{dialect}
27597 @opindex masm=@var{dialect}
27598 Output assembly instructions using selected @var{dialect}.  Also affects
27599 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
27600 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
27601 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
27602 not support @samp{intel}.
27604 @item -mieee-fp
27605 @itemx -mno-ieee-fp
27606 @opindex mieee-fp
27607 @opindex mno-ieee-fp
27608 Control whether or not the compiler uses IEEE floating-point
27609 comparisons.  These correctly handle the case where the result of a
27610 comparison is unordered.
27612 @item -m80387
27613 @itemx -mhard-float
27614 @opindex 80387
27615 @opindex mhard-float
27616 Generate output containing 80387 instructions for floating point.
27618 @item -mno-80387
27619 @itemx -msoft-float
27620 @opindex no-80387
27621 @opindex msoft-float
27622 Generate output containing library calls for floating point.
27624 @strong{Warning:} the requisite libraries are not part of GCC@.
27625 Normally the facilities of the machine's usual C compiler are used, but
27626 this cannot be done directly in cross-compilation.  You must make your
27627 own arrangements to provide suitable library functions for
27628 cross-compilation.
27630 On machines where a function returns floating-point results in the 80387
27631 register stack, some floating-point opcodes may be emitted even if
27632 @option{-msoft-float} is used.
27634 @item -mno-fp-ret-in-387
27635 @opindex mno-fp-ret-in-387
27636 Do not use the FPU registers for return values of functions.
27638 The usual calling convention has functions return values of types
27639 @code{float} and @code{double} in an FPU register, even if there
27640 is no FPU@.  The idea is that the operating system should emulate
27641 an FPU@.
27643 The option @option{-mno-fp-ret-in-387} causes such values to be returned
27644 in ordinary CPU registers instead.
27646 @item -mno-fancy-math-387
27647 @opindex mno-fancy-math-387
27648 Some 387 emulators do not support the @code{sin}, @code{cos} and
27649 @code{sqrt} instructions for the 387.  Specify this option to avoid
27650 generating those instructions.
27651 This option is overridden when @option{-march}
27652 indicates that the target CPU always has an FPU and so the
27653 instruction does not need emulation.  These
27654 instructions are not generated unless you also use the
27655 @option{-funsafe-math-optimizations} switch.
27657 @item -malign-double
27658 @itemx -mno-align-double
27659 @opindex malign-double
27660 @opindex mno-align-double
27661 Control whether GCC aligns @code{double}, @code{long double}, and
27662 @code{long long} variables on a two-word boundary or a one-word
27663 boundary.  Aligning @code{double} variables on a two-word boundary
27664 produces code that runs somewhat faster on a Pentium at the
27665 expense of more memory.
27667 On x86-64, @option{-malign-double} is enabled by default.
27669 @strong{Warning:} if you use the @option{-malign-double} switch,
27670 structures containing the above types are aligned differently than
27671 the published application binary interface specifications for the x86-32
27672 and are not binary compatible with structures in code compiled
27673 without that switch.
27675 @item -m96bit-long-double
27676 @itemx -m128bit-long-double
27677 @opindex m96bit-long-double
27678 @opindex m128bit-long-double
27679 These switches control the size of @code{long double} type.  The x86-32
27680 application binary interface specifies the size to be 96 bits,
27681 so @option{-m96bit-long-double} is the default in 32-bit mode.
27683 Modern architectures (Pentium and newer) prefer @code{long double}
27684 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
27685 conforming to the ABI, this is not possible.  So specifying
27686 @option{-m128bit-long-double} aligns @code{long double}
27687 to a 16-byte boundary by padding the @code{long double} with an additional
27688 32-bit zero.
27690 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
27691 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
27693 Notice that neither of these options enable any extra precision over the x87
27694 standard of 80 bits for a @code{long double}.
27696 @strong{Warning:} if you override the default value for your target ABI, this
27697 changes the size of 
27698 structures and arrays containing @code{long double} variables,
27699 as well as modifying the function calling convention for functions taking
27700 @code{long double}.  Hence they are not binary-compatible
27701 with code compiled without that switch.
27703 @item -mlong-double-64
27704 @itemx -mlong-double-80
27705 @itemx -mlong-double-128
27706 @opindex mlong-double-64
27707 @opindex mlong-double-80
27708 @opindex mlong-double-128
27709 These switches control the size of @code{long double} type. A size
27710 of 64 bits makes the @code{long double} type equivalent to the @code{double}
27711 type. This is the default for 32-bit Bionic C library.  A size
27712 of 128 bits makes the @code{long double} type equivalent to the
27713 @code{__float128} type. This is the default for 64-bit Bionic C library.
27715 @strong{Warning:} if you override the default value for your target ABI, this
27716 changes the size of
27717 structures and arrays containing @code{long double} variables,
27718 as well as modifying the function calling convention for functions taking
27719 @code{long double}.  Hence they are not binary-compatible
27720 with code compiled without that switch.
27722 @item -malign-data=@var{type}
27723 @opindex malign-data
27724 Control how GCC aligns variables.  Supported values for @var{type} are
27725 @samp{compat} uses increased alignment value compatible uses GCC 4.8
27726 and earlier, @samp{abi} uses alignment value as specified by the
27727 psABI, and @samp{cacheline} uses increased alignment value to match
27728 the cache line size.  @samp{compat} is the default.
27730 @item -mlarge-data-threshold=@var{threshold}
27731 @opindex mlarge-data-threshold
27732 When @option{-mcmodel=medium} is specified, data objects larger than
27733 @var{threshold} are placed in the large data section.  This value must be the
27734 same across all objects linked into the binary, and defaults to 65535.
27736 @item -mrtd
27737 @opindex mrtd
27738 Use a different function-calling convention, in which functions that
27739 take a fixed number of arguments return with the @code{ret @var{num}}
27740 instruction, which pops their arguments while returning.  This saves one
27741 instruction in the caller since there is no need to pop the arguments
27742 there.
27744 You can specify that an individual function is called with this calling
27745 sequence with the function attribute @code{stdcall}.  You can also
27746 override the @option{-mrtd} option by using the function attribute
27747 @code{cdecl}.  @xref{Function Attributes}.
27749 @strong{Warning:} this calling convention is incompatible with the one
27750 normally used on Unix, so you cannot use it if you need to call
27751 libraries compiled with the Unix compiler.
27753 Also, you must provide function prototypes for all functions that
27754 take variable numbers of arguments (including @code{printf});
27755 otherwise incorrect code is generated for calls to those
27756 functions.
27758 In addition, seriously incorrect code results if you call a
27759 function with too many arguments.  (Normally, extra arguments are
27760 harmlessly ignored.)
27762 @item -mregparm=@var{num}
27763 @opindex mregparm
27764 Control how many registers are used to pass integer arguments.  By
27765 default, no registers are used to pass arguments, and at most 3
27766 registers can be used.  You can control this behavior for a specific
27767 function by using the function attribute @code{regparm}.
27768 @xref{Function Attributes}.
27770 @strong{Warning:} if you use this switch, and
27771 @var{num} is nonzero, then you must build all modules with the same
27772 value, including any libraries.  This includes the system libraries and
27773 startup modules.
27775 @item -msseregparm
27776 @opindex msseregparm
27777 Use SSE register passing conventions for float and double arguments
27778 and return values.  You can control this behavior for a specific
27779 function by using the function attribute @code{sseregparm}.
27780 @xref{Function Attributes}.
27782 @strong{Warning:} if you use this switch then you must build all
27783 modules with the same value, including any libraries.  This includes
27784 the system libraries and startup modules.
27786 @item -mvect8-ret-in-mem
27787 @opindex mvect8-ret-in-mem
27788 Return 8-byte vectors in memory instead of MMX registers.  This is the
27789 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27790 Studio compilers until version 12.  Later compiler versions (starting
27791 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27792 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27793 you need to remain compatible with existing code produced by those
27794 previous compiler versions or older versions of GCC@.
27796 @item -mpc32
27797 @itemx -mpc64
27798 @itemx -mpc80
27799 @opindex mpc32
27800 @opindex mpc64
27801 @opindex mpc80
27803 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27804 is specified, the significands of results of floating-point operations are
27805 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27806 significands of results of floating-point operations to 53 bits (double
27807 precision) and @option{-mpc80} rounds the significands of results of
27808 floating-point operations to 64 bits (extended double precision), which is
27809 the default.  When this option is used, floating-point operations in higher
27810 precisions are not available to the programmer without setting the FPU
27811 control word explicitly.
27813 Setting the rounding of floating-point operations to less than the default
27814 80 bits can speed some programs by 2% or more.  Note that some mathematical
27815 libraries assume that extended-precision (80-bit) floating-point operations
27816 are enabled by default; routines in such libraries could suffer significant
27817 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27818 when this option is used to set the precision to less than extended precision.
27820 @item -mstackrealign
27821 @opindex mstackrealign
27822 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27823 option generates an alternate prologue and epilogue that realigns the
27824 run-time stack if necessary.  This supports mixing legacy codes that keep
27825 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27826 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27827 applicable to individual functions.
27829 @item -mpreferred-stack-boundary=@var{num}
27830 @opindex mpreferred-stack-boundary
27831 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27832 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27833 the default is 4 (16 bytes or 128 bits).
27835 @strong{Warning:} When generating code for the x86-64 architecture with
27836 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27837 used to keep the stack boundary aligned to 8 byte boundary.  Since
27838 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27839 intended to be used in controlled environment where stack space is
27840 important limitation.  This option leads to wrong code when functions
27841 compiled with 16 byte stack alignment (such as functions from a standard
27842 library) are called with misaligned stack.  In this case, SSE
27843 instructions may lead to misaligned memory access traps.  In addition,
27844 variable arguments are handled incorrectly for 16 byte aligned
27845 objects (including x87 long double and __int128), leading to wrong
27846 results.  You must build all modules with
27847 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27848 includes the system libraries and startup modules.
27850 @item -mincoming-stack-boundary=@var{num}
27851 @opindex mincoming-stack-boundary
27852 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27853 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27854 the one specified by @option{-mpreferred-stack-boundary} is used.
27856 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27857 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27858 suffer significant run time performance penalties.  On Pentium III, the
27859 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27860 properly if it is not 16-byte aligned.
27862 To ensure proper alignment of this values on the stack, the stack boundary
27863 must be as aligned as that required by any value stored on the stack.
27864 Further, every function must be generated such that it keeps the stack
27865 aligned.  Thus calling a function compiled with a higher preferred
27866 stack boundary from a function compiled with a lower preferred stack
27867 boundary most likely misaligns the stack.  It is recommended that
27868 libraries that use callbacks always use the default setting.
27870 This extra alignment does consume extra stack space, and generally
27871 increases code size.  Code that is sensitive to stack space usage, such
27872 as embedded systems and operating system kernels, may want to reduce the
27873 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27875 @need 200
27876 @item -mmmx
27877 @opindex mmmx
27878 @need 200
27879 @itemx -msse
27880 @opindex msse
27881 @need 200
27882 @itemx -msse2
27883 @opindex msse2
27884 @need 200
27885 @itemx -msse3
27886 @opindex msse3
27887 @need 200
27888 @itemx -mssse3
27889 @opindex mssse3
27890 @need 200
27891 @itemx -msse4
27892 @opindex msse4
27893 @need 200
27894 @itemx -msse4a
27895 @opindex msse4a
27896 @need 200
27897 @itemx -msse4.1
27898 @opindex msse4.1
27899 @need 200
27900 @itemx -msse4.2
27901 @opindex msse4.2
27902 @need 200
27903 @itemx -mavx
27904 @opindex mavx
27905 @need 200
27906 @itemx -mavx2
27907 @opindex mavx2
27908 @need 200
27909 @itemx -mavx512f
27910 @opindex mavx512f
27911 @need 200
27912 @itemx -mavx512pf
27913 @opindex mavx512pf
27914 @need 200
27915 @itemx -mavx512er
27916 @opindex mavx512er
27917 @need 200
27918 @itemx -mavx512cd
27919 @opindex mavx512cd
27920 @need 200
27921 @itemx -mavx512vl
27922 @opindex mavx512vl
27923 @need 200
27924 @itemx -mavx512bw
27925 @opindex mavx512bw
27926 @need 200
27927 @itemx -mavx512dq
27928 @opindex mavx512dq
27929 @need 200
27930 @itemx -mavx512ifma
27931 @opindex mavx512ifma
27932 @need 200
27933 @itemx -mavx512vbmi
27934 @opindex mavx512vbmi
27935 @need 200
27936 @itemx -msha
27937 @opindex msha
27938 @need 200
27939 @itemx -maes
27940 @opindex maes
27941 @need 200
27942 @itemx -mpclmul
27943 @opindex mpclmul
27944 @need 200
27945 @itemx -mclflushopt
27946 @opindex mclflushopt
27947 @need 200
27948 @itemx -mfsgsbase
27949 @opindex mfsgsbase
27950 @need 200
27951 @itemx -mptwrite
27952 @opindex mptwrite
27953 @need 200
27954 @itemx -mrdrnd
27955 @opindex mrdrnd
27956 @need 200
27957 @itemx -mf16c
27958 @opindex mf16c
27959 @need 200
27960 @itemx -mfma
27961 @opindex mfma
27962 @need 200
27963 @itemx -mpconfig
27964 @opindex mpconfig
27965 @need 200
27966 @itemx -mwbnoinvd
27967 @opindex mwbnoinvd
27968 @need 200
27969 @itemx -mfma4
27970 @opindex mfma4
27971 @need 200
27972 @itemx -mprefetchwt1
27973 @opindex mprefetchwt1
27974 @need 200
27975 @itemx -mxop
27976 @opindex mxop
27977 @need 200
27978 @itemx -mlwp
27979 @opindex mlwp
27980 @need 200
27981 @itemx -m3dnow
27982 @opindex m3dnow
27983 @need 200
27984 @itemx -m3dnowa
27985 @opindex m3dnowa
27986 @need 200
27987 @itemx -mpopcnt
27988 @opindex mpopcnt
27989 @need 200
27990 @itemx -mabm
27991 @opindex mabm
27992 @need 200
27993 @itemx -mbmi
27994 @opindex mbmi
27995 @need 200
27996 @itemx -mbmi2
27997 @need 200
27998 @itemx -mlzcnt
27999 @opindex mlzcnt
28000 @need 200
28001 @itemx -mfxsr
28002 @opindex mfxsr
28003 @need 200
28004 @itemx -mxsave
28005 @opindex mxsave
28006 @need 200
28007 @itemx -mxsaveopt
28008 @opindex mxsaveopt
28009 @need 200
28010 @itemx -mxsavec
28011 @opindex mxsavec
28012 @need 200
28013 @itemx -mxsaves
28014 @opindex mxsaves
28015 @need 200
28016 @itemx -mrtm
28017 @opindex mrtm
28018 @need 200
28019 @itemx -mtbm
28020 @opindex mtbm
28021 @need 200
28022 @itemx -mmwaitx
28023 @opindex mmwaitx
28024 @need 200
28025 @itemx -mclzero
28026 @opindex mclzero
28027 @need 200
28028 @itemx -mpku
28029 @opindex mpku
28030 @need 200
28031 @itemx -mavx512vbmi2
28032 @opindex mavx512vbmi2
28033 @need 200
28034 @itemx -mgfni
28035 @opindex mgfni
28036 @need 200
28037 @itemx -mvaes
28038 @opindex mvaes
28039 @need 200
28040 @itemx -mwaitpkg
28041 @opindex mwaitpkg
28042 @need 200
28043 @itemx -mvpclmulqdq
28044 @opindex mvpclmulqdq
28045 @need 200
28046 @itemx -mavx512bitalg
28047 @opindex mavx512bitalg
28048 @need 200
28049 @itemx -mmovdiri
28050 @opindex mmovdiri
28051 @need 200
28052 @itemx -mmovdir64b
28053 @opindex mmovdir64b
28054 @need 200
28055 @itemx -mavx512vpopcntdq
28056 @opindex mavx512vpopcntdq
28057 @need 200
28058 @itemx -mcldemote
28059 @opindex mcldemote
28060 These switches enable the use of instructions in the MMX, SSE,
28061 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
28062 SHA, AES, PCLMUL, FSGSBASE, PTWRITE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
28063 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES, WAITPKG,
28064 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
28065 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
28066 AVX512VPOPCNTDQ, CLDEMOTE, 3DNow!@: or enhanced 3DNow!@: extended instruction
28067 sets. Each has a corresponding @option{-mno-} option to disable use of these
28068 instructions.
28070 These extensions are also available as built-in functions: see
28071 @ref{x86 Built-in Functions}, for details of the functions enabled and
28072 disabled by these switches.
28074 To generate SSE/SSE2 instructions automatically from floating-point
28075 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
28077 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
28078 generates new AVX instructions or AVX equivalence for all SSEx instructions
28079 when needed.
28081 These options enable GCC to use these extended instructions in
28082 generated code, even without @option{-mfpmath=sse}.  Applications that
28083 perform run-time CPU detection must compile separate files for each
28084 supported architecture, using the appropriate flags.  In particular,
28085 the file containing the CPU detection code should be compiled without
28086 these options.
28088 @item -mdump-tune-features
28089 @opindex mdump-tune-features
28090 This option instructs GCC to dump the names of the x86 performance 
28091 tuning features and default settings. The names can be used in 
28092 @option{-mtune-ctrl=@var{feature-list}}.
28094 @item -mtune-ctrl=@var{feature-list}
28095 @opindex mtune-ctrl=@var{feature-list}
28096 This option is used to do fine grain control of x86 code generation features.
28097 @var{feature-list} is a comma separated list of @var{feature} names. See also
28098 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
28099 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
28100 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
28101 developers. Using it may lead to code paths not covered by testing and can
28102 potentially result in compiler ICEs or runtime errors.
28104 @item -mno-default
28105 @opindex mno-default
28106 This option instructs GCC to turn off all tunable features. See also 
28107 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
28109 @item -mcld
28110 @opindex mcld
28111 This option instructs GCC to emit a @code{cld} instruction in the prologue
28112 of functions that use string instructions.  String instructions depend on
28113 the DF flag to select between autoincrement or autodecrement mode.  While the
28114 ABI specifies the DF flag to be cleared on function entry, some operating
28115 systems violate this specification by not clearing the DF flag in their
28116 exception dispatchers.  The exception handler can be invoked with the DF flag
28117 set, which leads to wrong direction mode when string instructions are used.
28118 This option can be enabled by default on 32-bit x86 targets by configuring
28119 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
28120 instructions can be suppressed with the @option{-mno-cld} compiler option
28121 in this case.
28123 @item -mvzeroupper
28124 @opindex mvzeroupper
28125 This option instructs GCC to emit a @code{vzeroupper} instruction
28126 before a transfer of control flow out of the function to minimize
28127 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
28128 intrinsics.
28130 @item -mprefer-avx128
28131 @opindex mprefer-avx128
28132 This option instructs GCC to use 128-bit AVX instructions instead of
28133 256-bit AVX instructions in the auto-vectorizer.
28135 @item -mprefer-vector-width=@var{opt}
28136 @opindex mprefer-vector-width
28137 This option instructs GCC to use @var{opt}-bit vector width in instructions
28138 instead of default on the selected platform.
28140 @table @samp
28141 @item none
28142 No extra limitations applied to GCC other than defined by the selected platform.
28144 @item 128
28145 Prefer 128-bit vector width for instructions.
28147 @item 256
28148 Prefer 256-bit vector width for instructions.
28150 @item 512
28151 Prefer 512-bit vector width for instructions.
28152 @end table
28154 @item -mcx16
28155 @opindex mcx16
28156 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
28157 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
28158 objects.  This is useful for atomic updates of data structures exceeding one
28159 machine word in size.  The compiler uses this instruction to implement
28160 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
28161 128-bit integers, a library call is always used.
28163 @item -msahf
28164 @opindex msahf
28165 This option enables generation of @code{SAHF} instructions in 64-bit code.
28166 Early Intel Pentium 4 CPUs with Intel 64 support,
28167 prior to the introduction of Pentium 4 G1 step in December 2005,
28168 lacked the @code{LAHF} and @code{SAHF} instructions
28169 which are supported by AMD64.
28170 These are load and store instructions, respectively, for certain status flags.
28171 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
28172 @code{drem}, and @code{remainder} built-in functions;
28173 see @ref{Other Builtins} for details.
28175 @item -mmovbe
28176 @opindex mmovbe
28177 This option enables use of the @code{movbe} instruction to implement
28178 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
28180 @item -mshstk
28181 @opindex mshstk
28182 The @option{-mshstk} option enables shadow stack built-in functions
28183 from x86 Control-flow Enforcement Technology (CET).
28185 @item -mcrc32
28186 @opindex mcrc32
28187 This option enables built-in functions @code{__builtin_ia32_crc32qi},
28188 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
28189 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
28191 @item -mrecip
28192 @opindex mrecip
28193 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
28194 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
28195 with an additional Newton-Raphson step
28196 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
28197 (and their vectorized
28198 variants) for single-precision floating-point arguments.  These instructions
28199 are generated only when @option{-funsafe-math-optimizations} is enabled
28200 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
28201 Note that while the throughput of the sequence is higher than the throughput
28202 of the non-reciprocal instruction, the precision of the sequence can be
28203 decreased by up to 2 ulp (i.e.@: the inverse of 1.0 equals 0.99999994).
28205 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
28206 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
28207 combination), and doesn't need @option{-mrecip}.
28209 Also note that GCC emits the above sequence with additional Newton-Raphson step
28210 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
28211 already with @option{-ffast-math} (or the above option combination), and
28212 doesn't need @option{-mrecip}.
28214 @item -mrecip=@var{opt}
28215 @opindex mrecip=opt
28216 This option controls which reciprocal estimate instructions
28217 may be used.  @var{opt} is a comma-separated list of options, which may
28218 be preceded by a @samp{!} to invert the option:
28220 @table @samp
28221 @item all
28222 Enable all estimate instructions.
28224 @item default
28225 Enable the default instructions, equivalent to @option{-mrecip}.
28227 @item none
28228 Disable all estimate instructions, equivalent to @option{-mno-recip}.
28230 @item div
28231 Enable the approximation for scalar division.
28233 @item vec-div
28234 Enable the approximation for vectorized division.
28236 @item sqrt
28237 Enable the approximation for scalar square root.
28239 @item vec-sqrt
28240 Enable the approximation for vectorized square root.
28241 @end table
28243 So, for example, @option{-mrecip=all,!sqrt} enables
28244 all of the reciprocal approximations, except for square root.
28246 @item -mveclibabi=@var{type}
28247 @opindex mveclibabi
28248 Specifies the ABI type to use for vectorizing intrinsics using an
28249 external library.  Supported values for @var{type} are @samp{svml} 
28250 for the Intel short
28251 vector math library and @samp{acml} for the AMD math core library.
28252 To use this option, both @option{-ftree-vectorize} and
28253 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
28254 ABI-compatible library must be specified at link time.
28256 GCC currently emits calls to @code{vmldExp2},
28257 @code{vmldLn2}, @code{vmldLog102}, @code{vmldPow2},
28258 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
28259 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
28260 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
28261 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4},
28262 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
28263 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
28264 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
28265 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
28266 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
28267 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
28268 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
28269 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
28270 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
28271 when @option{-mveclibabi=acml} is used.  
28273 @item -mabi=@var{name}
28274 @opindex mabi
28275 Generate code for the specified calling convention.  Permissible values
28276 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
28277 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
28278 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
28279 You can control this behavior for specific functions by
28280 using the function attributes @code{ms_abi} and @code{sysv_abi}.
28281 @xref{Function Attributes}.
28283 @item -mforce-indirect-call
28284 @opindex mforce-indirect-call
28285 Force all calls to functions to be indirect. This is useful
28286 when using Intel Processor Trace where it generates more precise timing
28287 information for function calls.
28289 @item -mcall-ms2sysv-xlogues
28290 @opindex mcall-ms2sysv-xlogues
28291 @opindex mno-call-ms2sysv-xlogues
28292 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
28293 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
28294 default, the code for saving and restoring these registers is emitted inline,
28295 resulting in fairly lengthy prologues and epilogues.  Using
28296 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
28297 use stubs in the static portion of libgcc to perform these saves and restores,
28298 thus reducing function size at the cost of a few extra instructions.
28300 @item -mtls-dialect=@var{type}
28301 @opindex mtls-dialect
28302 Generate code to access thread-local storage using the @samp{gnu} or
28303 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
28304 @samp{gnu2} is more efficient, but it may add compile- and run-time
28305 requirements that cannot be satisfied on all systems.
28307 @item -mpush-args
28308 @itemx -mno-push-args
28309 @opindex mpush-args
28310 @opindex mno-push-args
28311 Use PUSH operations to store outgoing parameters.  This method is shorter
28312 and usually equally fast as method using SUB/MOV operations and is enabled
28313 by default.  In some cases disabling it may improve performance because of
28314 improved scheduling and reduced dependencies.
28316 @item -maccumulate-outgoing-args
28317 @opindex maccumulate-outgoing-args
28318 If enabled, the maximum amount of space required for outgoing arguments is
28319 computed in the function prologue.  This is faster on most modern CPUs
28320 because of reduced dependencies, improved scheduling and reduced stack usage
28321 when the preferred stack boundary is not equal to 2.  The drawback is a notable
28322 increase in code size.  This switch implies @option{-mno-push-args}.
28324 @item -mthreads
28325 @opindex mthreads
28326 Support thread-safe exception handling on MinGW.  Programs that rely
28327 on thread-safe exception handling must compile and link all code with the
28328 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
28329 @option{-D_MT}; when linking, it links in a special thread helper library
28330 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
28332 @item -mms-bitfields
28333 @itemx -mno-ms-bitfields
28334 @opindex mms-bitfields
28335 @opindex mno-ms-bitfields
28337 Enable/disable bit-field layout compatible with the native Microsoft
28338 Windows compiler.  
28340 If @code{packed} is used on a structure, or if bit-fields are used,
28341 it may be that the Microsoft ABI lays out the structure differently
28342 than the way GCC normally does.  Particularly when moving packed
28343 data between functions compiled with GCC and the native Microsoft compiler
28344 (either via function call or as data in a file), it may be necessary to access
28345 either format.
28347 This option is enabled by default for Microsoft Windows
28348 targets.  This behavior can also be controlled locally by use of variable
28349 or type attributes.  For more information, see @ref{x86 Variable Attributes}
28350 and @ref{x86 Type Attributes}.
28352 The Microsoft structure layout algorithm is fairly simple with the exception
28353 of the bit-field packing.  
28354 The padding and alignment of members of structures and whether a bit-field 
28355 can straddle a storage-unit boundary are determine by these rules:
28357 @enumerate
28358 @item Structure members are stored sequentially in the order in which they are
28359 declared: the first member has the lowest memory address and the last member
28360 the highest.
28362 @item Every data object has an alignment requirement.  The alignment requirement
28363 for all data except structures, unions, and arrays is either the size of the
28364 object or the current packing size (specified with either the
28365 @code{aligned} attribute or the @code{pack} pragma),
28366 whichever is less.  For structures, unions, and arrays,
28367 the alignment requirement is the largest alignment requirement of its members.
28368 Every object is allocated an offset so that:
28370 @smallexample
28371 offset % alignment_requirement == 0
28372 @end smallexample
28374 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
28375 unit if the integral types are the same size and if the next bit-field fits
28376 into the current allocation unit without crossing the boundary imposed by the
28377 common alignment requirements of the bit-fields.
28378 @end enumerate
28380 MSVC interprets zero-length bit-fields in the following ways:
28382 @enumerate
28383 @item If a zero-length bit-field is inserted between two bit-fields that
28384 are normally coalesced, the bit-fields are not coalesced.
28386 For example:
28388 @smallexample
28389 struct
28390  @{
28391    unsigned long bf_1 : 12;
28392    unsigned long : 0;
28393    unsigned long bf_2 : 12;
28394  @} t1;
28395 @end smallexample
28397 @noindent
28398 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
28399 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
28401 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
28402 alignment of the zero-length bit-field is greater than the member that follows it,
28403 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
28405 For example:
28407 @smallexample
28408 struct
28409  @{
28410    char foo : 4;
28411    short : 0;
28412    char bar;
28413  @} t2;
28415 struct
28416  @{
28417    char foo : 4;
28418    short : 0;
28419    double bar;
28420  @} t3;
28421 @end smallexample
28423 @noindent
28424 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
28425 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
28426 bit-field does not affect the alignment of @code{bar} or, as a result, the size
28427 of the structure.
28429 Taking this into account, it is important to note the following:
28431 @enumerate
28432 @item If a zero-length bit-field follows a normal bit-field, the type of the
28433 zero-length bit-field may affect the alignment of the structure as whole. For
28434 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
28435 normal bit-field, and is of type short.
28437 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
28438 still affect the alignment of the structure:
28440 @smallexample
28441 struct
28442  @{
28443    char foo : 6;
28444    long : 0;
28445  @} t4;
28446 @end smallexample
28448 @noindent
28449 Here, @code{t4} takes up 4 bytes.
28450 @end enumerate
28452 @item Zero-length bit-fields following non-bit-field members are ignored:
28454 @smallexample
28455 struct
28456  @{
28457    char foo;
28458    long : 0;
28459    char bar;
28460  @} t5;
28461 @end smallexample
28463 @noindent
28464 Here, @code{t5} takes up 2 bytes.
28465 @end enumerate
28468 @item -mno-align-stringops
28469 @opindex mno-align-stringops
28470 Do not align the destination of inlined string operations.  This switch reduces
28471 code size and improves performance in case the destination is already aligned,
28472 but GCC doesn't know about it.
28474 @item -minline-all-stringops
28475 @opindex minline-all-stringops
28476 By default GCC inlines string operations only when the destination is 
28477 known to be aligned to least a 4-byte boundary.  
28478 This enables more inlining and increases code
28479 size, but may improve performance of code that depends on fast
28480 @code{memcpy}, @code{strlen},
28481 and @code{memset} for short lengths.
28483 @item -minline-stringops-dynamically
28484 @opindex minline-stringops-dynamically
28485 For string operations of unknown size, use run-time checks with
28486 inline code for small blocks and a library call for large blocks.
28488 @item -mstringop-strategy=@var{alg}
28489 @opindex mstringop-strategy=@var{alg}
28490 Override the internal decision heuristic for the particular algorithm to use
28491 for inlining string operations.  The allowed values for @var{alg} are:
28493 @table @samp
28494 @item rep_byte
28495 @itemx rep_4byte
28496 @itemx rep_8byte
28497 Expand using i386 @code{rep} prefix of the specified size.
28499 @item byte_loop
28500 @itemx loop
28501 @itemx unrolled_loop
28502 Expand into an inline loop.
28504 @item libcall
28505 Always use a library call.
28506 @end table
28508 @item -mmemcpy-strategy=@var{strategy}
28509 @opindex mmemcpy-strategy=@var{strategy}
28510 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
28511 should be inlined and what inline algorithm to use when the expected size
28512 of the copy operation is known. @var{strategy} 
28513 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
28514 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
28515 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
28516 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
28517 in the list must be specified in increasing order.  The minimal byte size for 
28518 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
28519 preceding range.
28521 @item -mmemset-strategy=@var{strategy}
28522 @opindex mmemset-strategy=@var{strategy}
28523 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
28524 @code{__builtin_memset} expansion.
28526 @item -momit-leaf-frame-pointer
28527 @opindex momit-leaf-frame-pointer
28528 Don't keep the frame pointer in a register for leaf functions.  This
28529 avoids the instructions to save, set up, and restore frame pointers and
28530 makes an extra register available in leaf functions.  The option
28531 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
28532 which might make debugging harder.
28534 @item -mtls-direct-seg-refs
28535 @itemx -mno-tls-direct-seg-refs
28536 @opindex mtls-direct-seg-refs
28537 Controls whether TLS variables may be accessed with offsets from the
28538 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
28539 or whether the thread base pointer must be added.  Whether or not this
28540 is valid depends on the operating system, and whether it maps the
28541 segment to cover the entire TLS area.
28543 For systems that use the GNU C Library, the default is on.
28545 @item -msse2avx
28546 @itemx -mno-sse2avx
28547 @opindex msse2avx
28548 Specify that the assembler should encode SSE instructions with VEX
28549 prefix.  The option @option{-mavx} turns this on by default.
28551 @item -mfentry
28552 @itemx -mno-fentry
28553 @opindex mfentry
28554 If profiling is active (@option{-pg}), put the profiling
28555 counter call before the prologue.
28556 Note: On x86 architectures the attribute @code{ms_hook_prologue}
28557 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
28559 @item -mrecord-mcount
28560 @itemx -mno-record-mcount
28561 @opindex mrecord-mcount
28562 If profiling is active (@option{-pg}), generate a __mcount_loc section
28563 that contains pointers to each profiling call. This is useful for
28564 automatically patching and out calls.
28566 @item -mnop-mcount
28567 @itemx -mno-nop-mcount
28568 @opindex mnop-mcount
28569 If profiling is active (@option{-pg}), generate the calls to
28570 the profiling functions as NOPs. This is useful when they
28571 should be patched in later dynamically. This is likely only
28572 useful together with @option{-mrecord-mcount}.
28574 @item -mskip-rax-setup
28575 @itemx -mno-skip-rax-setup
28576 @opindex mskip-rax-setup
28577 When generating code for the x86-64 architecture with SSE extensions
28578 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
28579 register when there are no variable arguments passed in vector registers.
28581 @strong{Warning:} Since RAX register is used to avoid unnecessarily
28582 saving vector registers on stack when passing variable arguments, the
28583 impacts of this option are callees may waste some stack space,
28584 misbehave or jump to a random location.  GCC 4.4 or newer don't have
28585 those issues, regardless the RAX register value.
28587 @item -m8bit-idiv
28588 @itemx -mno-8bit-idiv
28589 @opindex m8bit-idiv
28590 On some processors, like Intel Atom, 8-bit unsigned integer divide is
28591 much faster than 32-bit/64-bit integer divide.  This option generates a
28592 run-time check.  If both dividend and divisor are within range of 0
28593 to 255, 8-bit unsigned integer divide is used instead of
28594 32-bit/64-bit integer divide.
28596 @item -mavx256-split-unaligned-load
28597 @itemx -mavx256-split-unaligned-store
28598 @opindex mavx256-split-unaligned-load
28599 @opindex mavx256-split-unaligned-store
28600 Split 32-byte AVX unaligned load and store.
28602 @item -mstack-protector-guard=@var{guard}
28603 @itemx -mstack-protector-guard-reg=@var{reg}
28604 @itemx -mstack-protector-guard-offset=@var{offset}
28605 @opindex mstack-protector-guard
28606 @opindex mstack-protector-guard-reg
28607 @opindex mstack-protector-guard-offset
28608 Generate stack protection code using canary at @var{guard}.  Supported
28609 locations are @samp{global} for global canary or @samp{tls} for per-thread
28610 canary in the TLS block (the default).  This option has effect only when
28611 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
28613 With the latter choice the options
28614 @option{-mstack-protector-guard-reg=@var{reg}} and
28615 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
28616 which segment register (@code{%fs} or @code{%gs}) to use as base register
28617 for reading the canary, and from what offset from that base register.
28618 The default for those is as specified in the relevant ABI.
28620 @item -mgeneral-regs-only
28621 @opindex mgeneral-regs-only
28622 Generate code that uses only the general-purpose registers.  This
28623 prevents the compiler from using floating-point, vector, mask and bound
28624 registers.
28626 @item -mindirect-branch=@var{choice}
28627 @opindex mindirect-branch
28628 Convert indirect call and jump with @var{choice}.  The default is
28629 @samp{keep}, which keeps indirect call and jump unmodified.
28630 @samp{thunk} converts indirect call and jump to call and return thunk.
28631 @samp{thunk-inline} converts indirect call and jump to inlined call
28632 and return thunk.  @samp{thunk-extern} converts indirect call and jump
28633 to external call and return thunk provided in a separate object file.
28634 You can control this behavior for a specific function by using the
28635 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
28637 Note that @option{-mcmodel=large} is incompatible with
28638 @option{-mindirect-branch=thunk} and
28639 @option{-mindirect-branch=thunk-extern} since the thunk function may
28640 not be reachable in the large code model.
28642 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
28643 @option{-fcf-protection=branch} since the external thunk can not be modified
28644 to disable control-flow check.
28646 @item -mfunction-return=@var{choice}
28647 @opindex mfunction-return
28648 Convert function return with @var{choice}.  The default is @samp{keep},
28649 which keeps function return unmodified.  @samp{thunk} converts function
28650 return to call and return thunk.  @samp{thunk-inline} converts function
28651 return to inlined call and return thunk.  @samp{thunk-extern} converts
28652 function return to external call and return thunk provided in a separate
28653 object file.  You can control this behavior for a specific function by
28654 using the function attribute @code{function_return}.
28655 @xref{Function Attributes}.
28657 Note that @option{-mcmodel=large} is incompatible with
28658 @option{-mfunction-return=thunk} and
28659 @option{-mfunction-return=thunk-extern} since the thunk function may
28660 not be reachable in the large code model.
28663 @item -mindirect-branch-register
28664 @opindex mindirect-branch-register
28665 Force indirect call and jump via register.
28667 @end table
28669 These @samp{-m} switches are supported in addition to the above
28670 on x86-64 processors in 64-bit environments.
28672 @table @gcctabopt
28673 @item -m32
28674 @itemx -m64
28675 @itemx -mx32
28676 @itemx -m16
28677 @itemx -miamcu
28678 @opindex m32
28679 @opindex m64
28680 @opindex mx32
28681 @opindex m16
28682 @opindex miamcu
28683 Generate code for a 16-bit, 32-bit or 64-bit environment.
28684 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
28685 to 32 bits, and
28686 generates code that runs on any i386 system.
28688 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
28689 types to 64 bits, and generates code for the x86-64 architecture.
28690 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
28691 and @option{-mdynamic-no-pic} options.
28693 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
28694 to 32 bits, and
28695 generates code for the x86-64 architecture.
28697 The @option{-m16} option is the same as @option{-m32}, except for that
28698 it outputs the @code{.code16gcc} assembly directive at the beginning of
28699 the assembly output so that the binary can run in 16-bit mode.
28701 The @option{-miamcu} option generates code which conforms to Intel MCU
28702 psABI.  It requires the @option{-m32} option to be turned on.
28704 @item -mno-red-zone
28705 @opindex mno-red-zone
28706 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
28707 by the x86-64 ABI; it is a 128-byte area beyond the location of the
28708 stack pointer that is not modified by signal or interrupt handlers
28709 and therefore can be used for temporary data without adjusting the stack
28710 pointer.  The flag @option{-mno-red-zone} disables this red zone.
28712 @item -mcmodel=small
28713 @opindex mcmodel=small
28714 Generate code for the small code model: the program and its symbols must
28715 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
28716 Programs can be statically or dynamically linked.  This is the default
28717 code model.
28719 @item -mcmodel=kernel
28720 @opindex mcmodel=kernel
28721 Generate code for the kernel code model.  The kernel runs in the
28722 negative 2 GB of the address space.
28723 This model has to be used for Linux kernel code.
28725 @item -mcmodel=medium
28726 @opindex mcmodel=medium
28727 Generate code for the medium model: the program is linked in the lower 2
28728 GB of the address space.  Small symbols are also placed there.  Symbols
28729 with sizes larger than @option{-mlarge-data-threshold} are put into
28730 large data or BSS sections and can be located above 2GB.  Programs can
28731 be statically or dynamically linked.
28733 @item -mcmodel=large
28734 @opindex mcmodel=large
28735 Generate code for the large model.  This model makes no assumptions
28736 about addresses and sizes of sections.
28738 @item -maddress-mode=long
28739 @opindex maddress-mode=long
28740 Generate code for long address mode.  This is only supported for 64-bit
28741 and x32 environments.  It is the default address mode for 64-bit
28742 environments.
28744 @item -maddress-mode=short
28745 @opindex maddress-mode=short
28746 Generate code for short address mode.  This is only supported for 32-bit
28747 and x32 environments.  It is the default address mode for 32-bit and
28748 x32 environments.
28749 @end table
28751 @node x86 Windows Options
28752 @subsection x86 Windows Options
28753 @cindex x86 Windows Options
28754 @cindex Windows Options for x86
28756 These additional options are available for Microsoft Windows targets:
28758 @table @gcctabopt
28759 @item -mconsole
28760 @opindex mconsole
28761 This option
28762 specifies that a console application is to be generated, by
28763 instructing the linker to set the PE header subsystem type
28764 required for console applications.
28765 This option is available for Cygwin and MinGW targets and is
28766 enabled by default on those targets.
28768 @item -mdll
28769 @opindex mdll
28770 This option is available for Cygwin and MinGW targets.  It
28771 specifies that a DLL---a dynamic link library---is to be
28772 generated, enabling the selection of the required runtime
28773 startup object and entry point.
28775 @item -mnop-fun-dllimport
28776 @opindex mnop-fun-dllimport
28777 This option is available for Cygwin and MinGW targets.  It
28778 specifies that the @code{dllimport} attribute should be ignored.
28780 @item -mthread
28781 @opindex mthread
28782 This option is available for MinGW targets. It specifies
28783 that MinGW-specific thread support is to be used.
28785 @item -municode
28786 @opindex municode
28787 This option is available for MinGW-w64 targets.  It causes
28788 the @code{UNICODE} preprocessor macro to be predefined, and
28789 chooses Unicode-capable runtime startup code.
28791 @item -mwin32
28792 @opindex mwin32
28793 This option is available for Cygwin and MinGW targets.  It
28794 specifies that the typical Microsoft Windows predefined macros are to
28795 be set in the pre-processor, but does not influence the choice
28796 of runtime library/startup code.
28798 @item -mwindows
28799 @opindex mwindows
28800 This option is available for Cygwin and MinGW targets.  It
28801 specifies that a GUI application is to be generated by
28802 instructing the linker to set the PE header subsystem type
28803 appropriately.
28805 @item -fno-set-stack-executable
28806 @opindex fno-set-stack-executable
28807 This option is available for MinGW targets. It specifies that
28808 the executable flag for the stack used by nested functions isn't
28809 set. This is necessary for binaries running in kernel mode of
28810 Microsoft Windows, as there the User32 API, which is used to set executable
28811 privileges, isn't available.
28813 @item -fwritable-relocated-rdata
28814 @opindex fno-writable-relocated-rdata
28815 This option is available for MinGW and Cygwin targets.  It specifies
28816 that relocated-data in read-only section is put into the @code{.data}
28817 section.  This is a necessary for older runtimes not supporting
28818 modification of @code{.rdata} sections for pseudo-relocation.
28820 @item -mpe-aligned-commons
28821 @opindex mpe-aligned-commons
28822 This option is available for Cygwin and MinGW targets.  It
28823 specifies that the GNU extension to the PE file format that
28824 permits the correct alignment of COMMON variables should be
28825 used when generating code.  It is enabled by default if
28826 GCC detects that the target assembler found during configuration
28827 supports the feature.
28828 @end table
28830 See also under @ref{x86 Options} for standard options.
28832 @node Xstormy16 Options
28833 @subsection Xstormy16 Options
28834 @cindex Xstormy16 Options
28836 These options are defined for Xstormy16:
28838 @table @gcctabopt
28839 @item -msim
28840 @opindex msim
28841 Choose startup files and linker script suitable for the simulator.
28842 @end table
28844 @node Xtensa Options
28845 @subsection Xtensa Options
28846 @cindex Xtensa Options
28848 These options are supported for Xtensa targets:
28850 @table @gcctabopt
28851 @item -mconst16
28852 @itemx -mno-const16
28853 @opindex mconst16
28854 @opindex mno-const16
28855 Enable or disable use of @code{CONST16} instructions for loading
28856 constant values.  The @code{CONST16} instruction is currently not a
28857 standard option from Tensilica.  When enabled, @code{CONST16}
28858 instructions are always used in place of the standard @code{L32R}
28859 instructions.  The use of @code{CONST16} is enabled by default only if
28860 the @code{L32R} instruction is not available.
28862 @item -mfused-madd
28863 @itemx -mno-fused-madd
28864 @opindex mfused-madd
28865 @opindex mno-fused-madd
28866 Enable or disable use of fused multiply/add and multiply/subtract
28867 instructions in the floating-point option.  This has no effect if the
28868 floating-point option is not also enabled.  Disabling fused multiply/add
28869 and multiply/subtract instructions forces the compiler to use separate
28870 instructions for the multiply and add/subtract operations.  This may be
28871 desirable in some cases where strict IEEE 754-compliant results are
28872 required: the fused multiply add/subtract instructions do not round the
28873 intermediate result, thereby producing results with @emph{more} bits of
28874 precision than specified by the IEEE standard.  Disabling fused multiply
28875 add/subtract instructions also ensures that the program output is not
28876 sensitive to the compiler's ability to combine multiply and add/subtract
28877 operations.
28879 @item -mserialize-volatile
28880 @itemx -mno-serialize-volatile
28881 @opindex mserialize-volatile
28882 @opindex mno-serialize-volatile
28883 When this option is enabled, GCC inserts @code{MEMW} instructions before
28884 @code{volatile} memory references to guarantee sequential consistency.
28885 The default is @option{-mserialize-volatile}.  Use
28886 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28888 @item -mforce-no-pic
28889 @opindex mforce-no-pic
28890 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28891 position-independent code (PIC), this option disables PIC for compiling
28892 kernel code.
28894 @item -mtext-section-literals
28895 @itemx -mno-text-section-literals
28896 @opindex mtext-section-literals
28897 @opindex mno-text-section-literals
28898 These options control the treatment of literal pools.  The default is
28899 @option{-mno-text-section-literals}, which places literals in a separate
28900 section in the output file.  This allows the literal pool to be placed
28901 in a data RAM/ROM, and it also allows the linker to combine literal
28902 pools from separate object files to remove redundant literals and
28903 improve code size.  With @option{-mtext-section-literals}, the literals
28904 are interspersed in the text section in order to keep them as close as
28905 possible to their references.  This may be necessary for large assembly
28906 files.  Literals for each function are placed right before that function.
28908 @item -mauto-litpools
28909 @itemx -mno-auto-litpools
28910 @opindex mauto-litpools
28911 @opindex mno-auto-litpools
28912 These options control the treatment of literal pools.  The default is
28913 @option{-mno-auto-litpools}, which places literals in a separate
28914 section in the output file unless @option{-mtext-section-literals} is
28915 used.  With @option{-mauto-litpools} the literals are interspersed in
28916 the text section by the assembler.  Compiler does not produce explicit
28917 @code{.literal} directives and loads literals into registers with
28918 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28919 do relaxation and place literals as necessary.  This option allows
28920 assembler to create several literal pools per function and assemble
28921 very big functions, which may not be possible with
28922 @option{-mtext-section-literals}.
28924 @item -mtarget-align
28925 @itemx -mno-target-align
28926 @opindex mtarget-align
28927 @opindex mno-target-align
28928 When this option is enabled, GCC instructs the assembler to
28929 automatically align instructions to reduce branch penalties at the
28930 expense of some code density.  The assembler attempts to widen density
28931 instructions to align branch targets and the instructions following call
28932 instructions.  If there are not enough preceding safe density
28933 instructions to align a target, no widening is performed.  The
28934 default is @option{-mtarget-align}.  These options do not affect the
28935 treatment of auto-aligned instructions like @code{LOOP}, which the
28936 assembler always aligns, either by widening density instructions or
28937 by inserting NOP instructions.
28939 @item -mlongcalls
28940 @itemx -mno-longcalls
28941 @opindex mlongcalls
28942 @opindex mno-longcalls
28943 When this option is enabled, GCC instructs the assembler to translate
28944 direct calls to indirect calls unless it can determine that the target
28945 of a direct call is in the range allowed by the call instruction.  This
28946 translation typically occurs for calls to functions in other source
28947 files.  Specifically, the assembler translates a direct @code{CALL}
28948 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28949 The default is @option{-mno-longcalls}.  This option should be used in
28950 programs where the call target can potentially be out of range.  This
28951 option is implemented in the assembler, not the compiler, so the
28952 assembly code generated by GCC still shows direct call
28953 instructions---look at the disassembled object code to see the actual
28954 instructions.  Note that the assembler uses an indirect call for
28955 every cross-file call, not just those that really are out of range.
28956 @end table
28958 @node zSeries Options
28959 @subsection zSeries Options
28960 @cindex zSeries options
28962 These are listed under @xref{S/390 and zSeries Options}.
28965 @c man end
28967 @node Spec Files
28968 @section Specifying Subprocesses and the Switches to Pass to Them
28969 @cindex Spec Files
28971 @command{gcc} is a driver program.  It performs its job by invoking a
28972 sequence of other programs to do the work of compiling, assembling and
28973 linking.  GCC interprets its command-line parameters and uses these to
28974 deduce which programs it should invoke, and which command-line options
28975 it ought to place on their command lines.  This behavior is controlled
28976 by @dfn{spec strings}.  In most cases there is one spec string for each
28977 program that GCC can invoke, but a few programs have multiple spec
28978 strings to control their behavior.  The spec strings built into GCC can
28979 be overridden by using the @option{-specs=} command-line switch to specify
28980 a spec file.
28982 @dfn{Spec files} are plain-text files that are used to construct spec
28983 strings.  They consist of a sequence of directives separated by blank
28984 lines.  The type of directive is determined by the first non-whitespace
28985 character on the line, which can be one of the following:
28987 @table @code
28988 @item %@var{command}
28989 Issues a @var{command} to the spec file processor.  The commands that can
28990 appear here are:
28992 @table @code
28993 @item %include <@var{file}>
28994 @cindex @code{%include}
28995 Search for @var{file} and insert its text at the current point in the
28996 specs file.
28998 @item %include_noerr <@var{file}>
28999 @cindex @code{%include_noerr}
29000 Just like @samp{%include}, but do not generate an error message if the include
29001 file cannot be found.
29003 @item %rename @var{old_name} @var{new_name}
29004 @cindex @code{%rename}
29005 Rename the spec string @var{old_name} to @var{new_name}.
29007 @end table
29009 @item *[@var{spec_name}]:
29010 This tells the compiler to create, override or delete the named spec
29011 string.  All lines after this directive up to the next directive or
29012 blank line are considered to be the text for the spec string.  If this
29013 results in an empty string then the spec is deleted.  (Or, if the
29014 spec did not exist, then nothing happens.)  Otherwise, if the spec
29015 does not currently exist a new spec is created.  If the spec does
29016 exist then its contents are overridden by the text of this
29017 directive, unless the first character of that text is the @samp{+}
29018 character, in which case the text is appended to the spec.
29020 @item [@var{suffix}]:
29021 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
29022 and up to the next directive or blank line are considered to make up the
29023 spec string for the indicated suffix.  When the compiler encounters an
29024 input file with the named suffix, it processes the spec string in
29025 order to work out how to compile that file.  For example:
29027 @smallexample
29028 .ZZ:
29029 z-compile -input %i
29030 @end smallexample
29032 This says that any input file whose name ends in @samp{.ZZ} should be
29033 passed to the program @samp{z-compile}, which should be invoked with the
29034 command-line switch @option{-input} and with the result of performing the
29035 @samp{%i} substitution.  (See below.)
29037 As an alternative to providing a spec string, the text following a
29038 suffix directive can be one of the following:
29040 @table @code
29041 @item @@@var{language}
29042 This says that the suffix is an alias for a known @var{language}.  This is
29043 similar to using the @option{-x} command-line switch to GCC to specify a
29044 language explicitly.  For example:
29046 @smallexample
29047 .ZZ:
29048 @@c++
29049 @end smallexample
29051 Says that .ZZ files are, in fact, C++ source files.
29053 @item #@var{name}
29054 This causes an error messages saying:
29056 @smallexample
29057 @var{name} compiler not installed on this system.
29058 @end smallexample
29059 @end table
29061 GCC already has an extensive list of suffixes built into it.
29062 This directive adds an entry to the end of the list of suffixes, but
29063 since the list is searched from the end backwards, it is effectively
29064 possible to override earlier entries using this technique.
29066 @end table
29068 GCC has the following spec strings built into it.  Spec files can
29069 override these strings or create their own.  Note that individual
29070 targets can also add their own spec strings to this list.
29072 @smallexample
29073 asm          Options to pass to the assembler
29074 asm_final    Options to pass to the assembler post-processor
29075 cpp          Options to pass to the C preprocessor
29076 cc1          Options to pass to the C compiler
29077 cc1plus      Options to pass to the C++ compiler
29078 endfile      Object files to include at the end of the link
29079 link         Options to pass to the linker
29080 lib          Libraries to include on the command line to the linker
29081 libgcc       Decides which GCC support library to pass to the linker
29082 linker       Sets the name of the linker
29083 predefines   Defines to be passed to the C preprocessor
29084 signed_char  Defines to pass to CPP to say whether @code{char} is signed
29085              by default
29086 startfile    Object files to include at the start of the link
29087 @end smallexample
29089 Here is a small example of a spec file:
29091 @smallexample
29092 %rename lib                 old_lib
29094 *lib:
29095 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
29096 @end smallexample
29098 This example renames the spec called @samp{lib} to @samp{old_lib} and
29099 then overrides the previous definition of @samp{lib} with a new one.
29100 The new definition adds in some extra command-line options before
29101 including the text of the old definition.
29103 @dfn{Spec strings} are a list of command-line options to be passed to their
29104 corresponding program.  In addition, the spec strings can contain
29105 @samp{%}-prefixed sequences to substitute variable text or to
29106 conditionally insert text into the command line.  Using these constructs
29107 it is possible to generate quite complex command lines.
29109 Here is a table of all defined @samp{%}-sequences for spec
29110 strings.  Note that spaces are not generated automatically around the
29111 results of expanding these sequences.  Therefore you can concatenate them
29112 together or combine them with constant text in a single argument.
29114 @table @code
29115 @item %%
29116 Substitute one @samp{%} into the program name or argument.
29118 @item %i
29119 Substitute the name of the input file being processed.
29121 @item %b
29122 Substitute the basename of the input file being processed.
29123 This is the substring up to (and not including) the last period
29124 and not including the directory.
29126 @item %B
29127 This is the same as @samp{%b}, but include the file suffix (text after
29128 the last period).
29130 @item %d
29131 Marks the argument containing or following the @samp{%d} as a
29132 temporary file name, so that that file is deleted if GCC exits
29133 successfully.  Unlike @samp{%g}, this contributes no text to the
29134 argument.
29136 @item %g@var{suffix}
29137 Substitute a file name that has suffix @var{suffix} and is chosen
29138 once per compilation, and mark the argument in the same way as
29139 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
29140 name is now chosen in a way that is hard to predict even when previously
29141 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
29142 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
29143 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
29144 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
29145 was simply substituted with a file name chosen once per compilation,
29146 without regard to any appended suffix (which was therefore treated
29147 just like ordinary text), making such attacks more likely to succeed.
29149 @item %u@var{suffix}
29150 Like @samp{%g}, but generates a new temporary file name
29151 each time it appears instead of once per compilation.
29153 @item %U@var{suffix}
29154 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
29155 new one if there is no such last file name.  In the absence of any
29156 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
29157 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
29158 involves the generation of two distinct file names, one
29159 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
29160 simply substituted with a file name chosen for the previous @samp{%u},
29161 without regard to any appended suffix.
29163 @item %j@var{suffix}
29164 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
29165 writable, and if @option{-save-temps} is not used; 
29166 otherwise, substitute the name
29167 of a temporary file, just like @samp{%u}.  This temporary file is not
29168 meant for communication between processes, but rather as a junk
29169 disposal mechanism.
29171 @item %|@var{suffix}
29172 @itemx %m@var{suffix}
29173 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
29174 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
29175 all.  These are the two most common ways to instruct a program that it
29176 should read from standard input or write to standard output.  If you
29177 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
29178 construct: see for example @file{f/lang-specs.h}.
29180 @item %.@var{SUFFIX}
29181 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
29182 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
29183 terminated by the next space or %.
29185 @item %w
29186 Marks the argument containing or following the @samp{%w} as the
29187 designated output file of this compilation.  This puts the argument
29188 into the sequence of arguments that @samp{%o} substitutes.
29190 @item %o
29191 Substitutes the names of all the output files, with spaces
29192 automatically placed around them.  You should write spaces
29193 around the @samp{%o} as well or the results are undefined.
29194 @samp{%o} is for use in the specs for running the linker.
29195 Input files whose names have no recognized suffix are not compiled
29196 at all, but they are included among the output files, so they are
29197 linked.
29199 @item %O
29200 Substitutes the suffix for object files.  Note that this is
29201 handled specially when it immediately follows @samp{%g, %u, or %U},
29202 because of the need for those to form complete file names.  The
29203 handling is such that @samp{%O} is treated exactly as if it had already
29204 been substituted, except that @samp{%g, %u, and %U} do not currently
29205 support additional @var{suffix} characters following @samp{%O} as they do
29206 following, for example, @samp{.o}.
29208 @item %p
29209 Substitutes the standard macro predefinitions for the
29210 current target machine.  Use this when running @command{cpp}.
29212 @item %P
29213 Like @samp{%p}, but puts @samp{__} before and after the name of each
29214 predefined macro, except for macros that start with @samp{__} or with
29215 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
29218 @item %I
29219 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
29220 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
29221 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
29222 and @option{-imultilib} as necessary.
29224 @item %s
29225 Current argument is the name of a library or startup file of some sort.
29226 Search for that file in a standard list of directories and substitute
29227 the full name found.  The current working directory is included in the
29228 list of directories scanned.
29230 @item %T
29231 Current argument is the name of a linker script.  Search for that file
29232 in the current list of directories to scan for libraries. If the file
29233 is located insert a @option{--script} option into the command line
29234 followed by the full path name found.  If the file is not found then
29235 generate an error message.  Note: the current working directory is not
29236 searched.
29238 @item %e@var{str}
29239 Print @var{str} as an error message.  @var{str} is terminated by a newline.
29240 Use this when inconsistent options are detected.
29242 @item %(@var{name})
29243 Substitute the contents of spec string @var{name} at this point.
29245 @item %x@{@var{option}@}
29246 Accumulate an option for @samp{%X}.
29248 @item %X
29249 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
29250 spec string.
29252 @item %Y
29253 Output the accumulated assembler options specified by @option{-Wa}.
29255 @item %Z
29256 Output the accumulated preprocessor options specified by @option{-Wp}.
29258 @item %a
29259 Process the @code{asm} spec.  This is used to compute the
29260 switches to be passed to the assembler.
29262 @item %A
29263 Process the @code{asm_final} spec.  This is a spec string for
29264 passing switches to an assembler post-processor, if such a program is
29265 needed.
29267 @item %l
29268 Process the @code{link} spec.  This is the spec for computing the
29269 command line passed to the linker.  Typically it makes use of the
29270 @samp{%L %G %S %D and %E} sequences.
29272 @item %D
29273 Dump out a @option{-L} option for each directory that GCC believes might
29274 contain startup files.  If the target supports multilibs then the
29275 current multilib directory is prepended to each of these paths.
29277 @item %L
29278 Process the @code{lib} spec.  This is a spec string for deciding which
29279 libraries are included on the command line to the linker.
29281 @item %G
29282 Process the @code{libgcc} spec.  This is a spec string for deciding
29283 which GCC support library is included on the command line to the linker.
29285 @item %S
29286 Process the @code{startfile} spec.  This is a spec for deciding which
29287 object files are the first ones passed to the linker.  Typically
29288 this might be a file named @file{crt0.o}.
29290 @item %E
29291 Process the @code{endfile} spec.  This is a spec string that specifies
29292 the last object files that are passed to the linker.
29294 @item %C
29295 Process the @code{cpp} spec.  This is used to construct the arguments
29296 to be passed to the C preprocessor.
29298 @item %1
29299 Process the @code{cc1} spec.  This is used to construct the options to be
29300 passed to the actual C compiler (@command{cc1}).
29302 @item %2
29303 Process the @code{cc1plus} spec.  This is used to construct the options to be
29304 passed to the actual C++ compiler (@command{cc1plus}).
29306 @item %*
29307 Substitute the variable part of a matched option.  See below.
29308 Note that each comma in the substituted string is replaced by
29309 a single space.
29311 @item %<S
29312 Remove all occurrences of @code{-S} from the command line.  Note---this
29313 command is position dependent.  @samp{%} commands in the spec string
29314 before this one see @code{-S}, @samp{%} commands in the spec string
29315 after this one do not.
29317 @item %:@var{function}(@var{args})
29318 Call the named function @var{function}, passing it @var{args}.
29319 @var{args} is first processed as a nested spec string, then split
29320 into an argument vector in the usual fashion.  The function returns
29321 a string which is processed as if it had appeared literally as part
29322 of the current spec.
29324 The following built-in spec functions are provided:
29326 @table @code
29327 @item @code{getenv}
29328 The @code{getenv} spec function takes two arguments: an environment
29329 variable name and a string.  If the environment variable is not
29330 defined, a fatal error is issued.  Otherwise, the return value is the
29331 value of the environment variable concatenated with the string.  For
29332 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
29334 @smallexample
29335 %:getenv(TOPDIR /include)
29336 @end smallexample
29338 expands to @file{/path/to/top/include}.
29340 @item @code{if-exists}
29341 The @code{if-exists} spec function takes one argument, an absolute
29342 pathname to a file.  If the file exists, @code{if-exists} returns the
29343 pathname.  Here is a small example of its usage:
29345 @smallexample
29346 *startfile:
29347 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
29348 @end smallexample
29350 @item @code{if-exists-else}
29351 The @code{if-exists-else} spec function is similar to the @code{if-exists}
29352 spec function, except that it takes two arguments.  The first argument is
29353 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
29354 returns the pathname.  If it does not exist, it returns the second argument.
29355 This way, @code{if-exists-else} can be used to select one file or another,
29356 based on the existence of the first.  Here is a small example of its usage:
29358 @smallexample
29359 *startfile:
29360 crt0%O%s %:if-exists(crti%O%s) \
29361 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
29362 @end smallexample
29364 @item @code{replace-outfile}
29365 The @code{replace-outfile} spec function takes two arguments.  It looks for the
29366 first argument in the outfiles array and replaces it with the second argument.  Here
29367 is a small example of its usage:
29369 @smallexample
29370 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
29371 @end smallexample
29373 @item @code{remove-outfile}
29374 The @code{remove-outfile} spec function takes one argument.  It looks for the
29375 first argument in the outfiles array and removes it.  Here is a small example
29376 its usage:
29378 @smallexample
29379 %:remove-outfile(-lm)
29380 @end smallexample
29382 @item @code{pass-through-libs}
29383 The @code{pass-through-libs} spec function takes any number of arguments.  It
29384 finds any @option{-l} options and any non-options ending in @file{.a} (which it
29385 assumes are the names of linker input library archive files) and returns a
29386 result containing all the found arguments each prepended by
29387 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
29388 intended to be passed to the LTO linker plugin.
29390 @smallexample
29391 %:pass-through-libs(%G %L %G)
29392 @end smallexample
29394 @item @code{print-asm-header}
29395 The @code{print-asm-header} function takes no arguments and simply
29396 prints a banner like:
29398 @smallexample
29399 Assembler options
29400 =================
29402 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
29403 @end smallexample
29405 It is used to separate compiler options from assembler options
29406 in the @option{--target-help} output.
29407 @end table
29409 @item %@{S@}
29410 Substitutes the @code{-S} switch, if that switch is given to GCC@.
29411 If that switch is not specified, this substitutes nothing.  Note that
29412 the leading dash is omitted when specifying this option, and it is
29413 automatically inserted if the substitution is performed.  Thus the spec
29414 string @samp{%@{foo@}} matches the command-line option @option{-foo}
29415 and outputs the command-line option @option{-foo}.
29417 @item %W@{S@}
29418 Like %@{@code{S}@} but mark last argument supplied within as a file to be
29419 deleted on failure.
29421 @item %@{S*@}
29422 Substitutes all the switches specified to GCC whose names start
29423 with @code{-S}, but which also take an argument.  This is used for
29424 switches like @option{-o}, @option{-D}, @option{-I}, etc.
29425 GCC considers @option{-o foo} as being
29426 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
29427 text, including the space.  Thus two arguments are generated.
29429 @item %@{S*&T*@}
29430 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
29431 (the order of @code{S} and @code{T} in the spec is not significant).
29432 There can be any number of ampersand-separated variables; for each the
29433 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
29435 @item %@{S:X@}
29436 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
29438 @item %@{!S:X@}
29439 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
29441 @item %@{S*:X@}
29442 Substitutes @code{X} if one or more switches whose names start with
29443 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
29444 once, no matter how many such switches appeared.  However, if @code{%*}
29445 appears somewhere in @code{X}, then @code{X} is substituted once
29446 for each matching switch, with the @code{%*} replaced by the part of
29447 that switch matching the @code{*}.
29449 If @code{%*} appears as the last part of a spec sequence then a space
29450 is added after the end of the last substitution.  If there is more
29451 text in the sequence, however, then a space is not generated.  This
29452 allows the @code{%*} substitution to be used as part of a larger
29453 string.  For example, a spec string like this:
29455 @smallexample
29456 %@{mcu=*:--script=%*/memory.ld@}
29457 @end smallexample
29459 @noindent
29460 when matching an option like @option{-mcu=newchip} produces:
29462 @smallexample
29463 --script=newchip/memory.ld
29464 @end smallexample
29466 @item %@{.S:X@}
29467 Substitutes @code{X}, if processing a file with suffix @code{S}.
29469 @item %@{!.S:X@}
29470 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
29472 @item %@{,S:X@}
29473 Substitutes @code{X}, if processing a file for language @code{S}.
29475 @item %@{!,S:X@}
29476 Substitutes @code{X}, if not processing a file for language @code{S}.
29478 @item %@{S|P:X@}
29479 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
29480 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
29481 @code{*} sequences as well, although they have a stronger binding than
29482 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
29483 alternatives must be starred, and only the first matching alternative
29484 is substituted.
29486 For example, a spec string like this:
29488 @smallexample
29489 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
29490 @end smallexample
29492 @noindent
29493 outputs the following command-line options from the following input
29494 command-line options:
29496 @smallexample
29497 fred.c        -foo -baz
29498 jim.d         -bar -boggle
29499 -d fred.c     -foo -baz -boggle
29500 -d jim.d      -bar -baz -boggle
29501 @end smallexample
29503 @item %@{S:X; T:Y; :D@}
29505 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
29506 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
29507 be as many clauses as you need.  This may be combined with @code{.},
29508 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
29511 @end table
29513 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
29514 or similar construct can use a backslash to ignore the special meaning
29515 of the character following it, thus allowing literal matching of a
29516 character that is otherwise specially treated.  For example,
29517 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
29518 @option{-std=iso9899:1999} option is given.
29520 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
29521 construct may contain other nested @samp{%} constructs or spaces, or
29522 even newlines.  They are processed as usual, as described above.
29523 Trailing white space in @code{X} is ignored.  White space may also
29524 appear anywhere on the left side of the colon in these constructs,
29525 except between @code{.} or @code{*} and the corresponding word.
29527 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
29528 handled specifically in these constructs.  If another value of
29529 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
29530 @option{-W} switch is found later in the command line, the earlier
29531 switch value is ignored, except with @{@code{S}*@} where @code{S} is
29532 just one letter, which passes all matching options.
29534 The character @samp{|} at the beginning of the predicate text is used to
29535 indicate that a command should be piped to the following command, but
29536 only if @option{-pipe} is specified.
29538 It is built into GCC which switches take arguments and which do not.
29539 (You might think it would be useful to generalize this to allow each
29540 compiler's spec to say which switches take arguments.  But this cannot
29541 be done in a consistent fashion.  GCC cannot even decide which input
29542 files have been specified without knowing which switches take arguments,
29543 and it must know which input files to compile in order to tell which
29544 compilers to run).
29546 GCC also knows implicitly that arguments starting in @option{-l} are to be
29547 treated as compiler output files, and passed to the linker in their
29548 proper position among the other output files.
29550 @node Environment Variables
29551 @section Environment Variables Affecting GCC
29552 @cindex environment variables
29554 @c man begin ENVIRONMENT
29555 This section describes several environment variables that affect how GCC
29556 operates.  Some of them work by specifying directories or prefixes to use
29557 when searching for various kinds of files.  Some are used to specify other
29558 aspects of the compilation environment.
29560 Note that you can also specify places to search using options such as
29561 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
29562 take precedence over places specified using environment variables, which
29563 in turn take precedence over those specified by the configuration of GCC@.
29564 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
29565 GNU Compiler Collection (GCC) Internals}.
29567 @table @env
29568 @item LANG
29569 @itemx LC_CTYPE
29570 @c @itemx LC_COLLATE
29571 @itemx LC_MESSAGES
29572 @c @itemx LC_MONETARY
29573 @c @itemx LC_NUMERIC
29574 @c @itemx LC_TIME
29575 @itemx LC_ALL
29576 @findex LANG
29577 @findex LC_CTYPE
29578 @c @findex LC_COLLATE
29579 @findex LC_MESSAGES
29580 @c @findex LC_MONETARY
29581 @c @findex LC_NUMERIC
29582 @c @findex LC_TIME
29583 @findex LC_ALL
29584 @cindex locale
29585 These environment variables control the way that GCC uses
29586 localization information which allows GCC to work with different
29587 national conventions.  GCC inspects the locale categories
29588 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
29589 so.  These locale categories can be set to any value supported by your
29590 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
29591 Kingdom encoded in UTF-8.
29593 The @env{LC_CTYPE} environment variable specifies character
29594 classification.  GCC uses it to determine the character boundaries in
29595 a string; this is needed for some multibyte encodings that contain quote
29596 and escape characters that are otherwise interpreted as a string
29597 end or escape.
29599 The @env{LC_MESSAGES} environment variable specifies the language to
29600 use in diagnostic messages.
29602 If the @env{LC_ALL} environment variable is set, it overrides the value
29603 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
29604 and @env{LC_MESSAGES} default to the value of the @env{LANG}
29605 environment variable.  If none of these variables are set, GCC
29606 defaults to traditional C English behavior.
29608 @item TMPDIR
29609 @findex TMPDIR
29610 If @env{TMPDIR} is set, it specifies the directory to use for temporary
29611 files.  GCC uses temporary files to hold the output of one stage of
29612 compilation which is to be used as input to the next stage: for example,
29613 the output of the preprocessor, which is the input to the compiler
29614 proper.
29616 @item GCC_COMPARE_DEBUG
29617 @findex GCC_COMPARE_DEBUG
29618 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
29619 @option{-fcompare-debug} to the compiler driver.  See the documentation
29620 of this option for more details.
29622 @item GCC_EXEC_PREFIX
29623 @findex GCC_EXEC_PREFIX
29624 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
29625 names of the subprograms executed by the compiler.  No slash is added
29626 when this prefix is combined with the name of a subprogram, but you can
29627 specify a prefix that ends with a slash if you wish.
29629 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
29630 an appropriate prefix to use based on the pathname it is invoked with.
29632 If GCC cannot find the subprogram using the specified prefix, it
29633 tries looking in the usual places for the subprogram.
29635 The default value of @env{GCC_EXEC_PREFIX} is
29636 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
29637 the installed compiler. In many cases @var{prefix} is the value
29638 of @code{prefix} when you ran the @file{configure} script.
29640 Other prefixes specified with @option{-B} take precedence over this prefix.
29642 This prefix is also used for finding files such as @file{crt0.o} that are
29643 used for linking.
29645 In addition, the prefix is used in an unusual way in finding the
29646 directories to search for header files.  For each of the standard
29647 directories whose name normally begins with @samp{/usr/local/lib/gcc}
29648 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
29649 replacing that beginning with the specified prefix to produce an
29650 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
29651 @file{foo/bar} just before it searches the standard directory 
29652 @file{/usr/local/lib/bar}.
29653 If a standard directory begins with the configured
29654 @var{prefix} then the value of @var{prefix} is replaced by
29655 @env{GCC_EXEC_PREFIX} when looking for header files.
29657 @item COMPILER_PATH
29658 @findex COMPILER_PATH
29659 The value of @env{COMPILER_PATH} is a colon-separated list of
29660 directories, much like @env{PATH}.  GCC tries the directories thus
29661 specified when searching for subprograms, if it cannot find the
29662 subprograms using @env{GCC_EXEC_PREFIX}.
29664 @item LIBRARY_PATH
29665 @findex LIBRARY_PATH
29666 The value of @env{LIBRARY_PATH} is a colon-separated list of
29667 directories, much like @env{PATH}.  When configured as a native compiler,
29668 GCC tries the directories thus specified when searching for special
29669 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
29670 using GCC also uses these directories when searching for ordinary
29671 libraries for the @option{-l} option (but directories specified with
29672 @option{-L} come first).
29674 @item LANG
29675 @findex LANG
29676 @cindex locale definition
29677 This variable is used to pass locale information to the compiler.  One way in
29678 which this information is used is to determine the character set to be used
29679 when character literals, string literals and comments are parsed in C and C++.
29680 When the compiler is configured to allow multibyte characters,
29681 the following values for @env{LANG} are recognized:
29683 @table @samp
29684 @item C-JIS
29685 Recognize JIS characters.
29686 @item C-SJIS
29687 Recognize SJIS characters.
29688 @item C-EUCJP
29689 Recognize EUCJP characters.
29690 @end table
29692 If @env{LANG} is not defined, or if it has some other value, then the
29693 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
29694 recognize and translate multibyte characters.
29695 @end table
29697 @noindent
29698 Some additional environment variables affect the behavior of the
29699 preprocessor.
29701 @include cppenv.texi
29703 @c man end
29705 @node Precompiled Headers
29706 @section Using Precompiled Headers
29707 @cindex precompiled headers
29708 @cindex speed of compilation
29710 Often large projects have many header files that are included in every
29711 source file.  The time the compiler takes to process these header files
29712 over and over again can account for nearly all of the time required to
29713 build the project.  To make builds faster, GCC allows you to
29714 @dfn{precompile} a header file.
29716 To create a precompiled header file, simply compile it as you would any
29717 other file, if necessary using the @option{-x} option to make the driver
29718 treat it as a C or C++ header file.  You may want to use a
29719 tool like @command{make} to keep the precompiled header up-to-date when
29720 the headers it contains change.
29722 A precompiled header file is searched for when @code{#include} is
29723 seen in the compilation.  As it searches for the included file
29724 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
29725 compiler looks for a precompiled header in each directory just before it
29726 looks for the include file in that directory.  The name searched for is
29727 the name specified in the @code{#include} with @samp{.gch} appended.  If
29728 the precompiled header file cannot be used, it is ignored.
29730 For instance, if you have @code{#include "all.h"}, and you have
29731 @file{all.h.gch} in the same directory as @file{all.h}, then the
29732 precompiled header file is used if possible, and the original
29733 header is used otherwise.
29735 Alternatively, you might decide to put the precompiled header file in a
29736 directory and use @option{-I} to ensure that directory is searched
29737 before (or instead of) the directory containing the original header.
29738 Then, if you want to check that the precompiled header file is always
29739 used, you can put a file of the same name as the original header in this
29740 directory containing an @code{#error} command.
29742 This also works with @option{-include}.  So yet another way to use
29743 precompiled headers, good for projects not designed with precompiled
29744 header files in mind, is to simply take most of the header files used by
29745 a project, include them from another header file, precompile that header
29746 file, and @option{-include} the precompiled header.  If the header files
29747 have guards against multiple inclusion, they are skipped because
29748 they've already been included (in the precompiled header).
29750 If you need to precompile the same header file for different
29751 languages, targets, or compiler options, you can instead make a
29752 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29753 header in the directory, perhaps using @option{-o}.  It doesn't matter
29754 what you call the files in the directory; every precompiled header in
29755 the directory is considered.  The first precompiled header
29756 encountered in the directory that is valid for this compilation is
29757 used; they're searched in no particular order.
29759 There are many other possibilities, limited only by your imagination,
29760 good sense, and the constraints of your build system.
29762 A precompiled header file can be used only when these conditions apply:
29764 @itemize
29765 @item
29766 Only one precompiled header can be used in a particular compilation.
29768 @item
29769 A precompiled header cannot be used once the first C token is seen.  You
29770 can have preprocessor directives before a precompiled header; you cannot
29771 include a precompiled header from inside another header.
29773 @item
29774 The precompiled header file must be produced for the same language as
29775 the current compilation.  You cannot use a C precompiled header for a C++
29776 compilation.
29778 @item
29779 The precompiled header file must have been produced by the same compiler
29780 binary as the current compilation is using.
29782 @item
29783 Any macros defined before the precompiled header is included must
29784 either be defined in the same way as when the precompiled header was
29785 generated, or must not affect the precompiled header, which usually
29786 means that they don't appear in the precompiled header at all.
29788 The @option{-D} option is one way to define a macro before a
29789 precompiled header is included; using a @code{#define} can also do it.
29790 There are also some options that define macros implicitly, like
29791 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29792 defined this way.
29794 @item If debugging information is output when using the precompiled
29795 header, using @option{-g} or similar, the same kind of debugging information
29796 must have been output when building the precompiled header.  However,
29797 a precompiled header built using @option{-g} can be used in a compilation
29798 when no debugging information is being output.
29800 @item The same @option{-m} options must generally be used when building
29801 and using the precompiled header.  @xref{Submodel Options},
29802 for any cases where this rule is relaxed.
29804 @item Each of the following options must be the same when building and using
29805 the precompiled header:
29807 @gccoptlist{-fexceptions}
29809 @item
29810 Some other command-line options starting with @option{-f},
29811 @option{-p}, or @option{-O} must be defined in the same way as when
29812 the precompiled header was generated.  At present, it's not clear
29813 which options are safe to change and which are not; the safest choice
29814 is to use exactly the same options when generating and using the
29815 precompiled header.  The following are known to be safe:
29817 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29818 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29819 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29820 -pedantic-errors}
29822 @end itemize
29824 For all of these except the last, the compiler automatically
29825 ignores the precompiled header if the conditions aren't met.  If you
29826 find an option combination that doesn't work and doesn't cause the
29827 precompiled header to be ignored, please consider filing a bug report,
29828 see @ref{Bugs}.
29830 If you do use differing options when generating and using the
29831 precompiled header, the actual behavior is a mixture of the
29832 behavior for the options.  For instance, if you use @option{-g} to
29833 generate the precompiled header but not when using it, you may or may
29834 not get debugging information for routines in the precompiled header.