]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/doc/invoke.texi
subreg: Add -fsplit-wide-types-early (PR88233)
[thirdparty/gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988-2019 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
4
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
9
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2019 Free Software Foundation, Inc.
12
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.
20
21 (a) The FSF's Front-Cover Text is:
22
23 A GNU Manual
24
25 (b) The FSF's Back-Cover Text is:
26
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{}
42
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
62
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
68
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}.
76
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.
81
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.
88
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.
101
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}}.
108
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.
116
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.
123
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.
138
139 @c man end
140
141 @xref{Option Index}, for an index to GCC's options.
142
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
175
176 @c man begin OPTIONS
177
178 @node Option Summary
179 @section Option Summary
180
181 Here is a summary of all the options, grouped by type. Explanations are
182 in the following sections.
183
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}}
193
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 @gol
201 -fopenacc -fopenacc-dim=@var{geom} @gol
202 -fopenmp -fopenmp-simd @gol
203 -fms-extensions -fplan9-extensions -fsso-struct=@var{endianness} @gol
204 -fallow-single-precision -fcond-mismatch -flax-vector-conversions @gol
205 -fsigned-bitfields -fsigned-char @gol
206 -funsigned-bitfields -funsigned-char}
207
208 @item C++ Language Options
209 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
210 @gccoptlist{-fabi-version=@var{n} -fno-access-control @gol
211 -faligned-new=@var{n} -fargs-in-order=@var{n} -fchar8_t -fcheck-new @gol
212 -fconstexpr-depth=@var{n} -fconstexpr-cache-depth=@var{n} @gol
213 -fconstexpr-loop-limit=@var{n} -fconstexpr-ops-limit=@var{n} @gol
214 -fno-elide-constructors @gol
215 -fno-enforce-eh-specs @gol
216 -fno-gnu-keywords @gol
217 -fno-implicit-templates @gol
218 -fno-implicit-inline-templates @gol
219 -fno-implement-inlines -fms-extensions @gol
220 -fnew-inheriting-ctors @gol
221 -fnew-ttp-matching @gol
222 -fno-nonansi-builtins -fnothrow-opt -fno-operator-names @gol
223 -fno-optional-diags -fpermissive @gol
224 -fno-pretty-templates @gol
225 -frepo -fno-rtti -fsized-deallocation @gol
226 -ftemplate-backtrace-limit=@var{n} @gol
227 -ftemplate-depth=@var{n} @gol
228 -fno-threadsafe-statics -fuse-cxa-atexit @gol
229 -fno-weak -nostdinc++ @gol
230 -fvisibility-inlines-hidden @gol
231 -fvisibility-ms-compat @gol
232 -fext-numeric-literals @gol
233 -Wabi=@var{n} -Wabi-tag -Wconversion-null -Wctor-dtor-privacy @gol
234 -Wdelete-non-virtual-dtor -Wdeprecated-copy -Wdeprecated-copy-dtor @gol
235 -Wliteral-suffix @gol
236 -Wmultiple-inheritance -Wno-init-list-lifetime @gol
237 -Wnamespaces -Wnarrowing @gol
238 -Wpessimizing-move -Wredundant-move @gol
239 -Wnoexcept -Wnoexcept-type -Wclass-memaccess @gol
240 -Wnon-virtual-dtor -Wreorder -Wregister @gol
241 -Weffc++ -Wstrict-null-sentinel -Wtemplates @gol
242 -Wno-non-template-friend -Wold-style-cast @gol
243 -Woverloaded-virtual -Wno-pmf-conversions @gol
244 -Wno-class-conversion -Wno-terminate @gol
245 -Wsign-promo -Wvirtual-inheritance}
246
247 @item Objective-C and Objective-C++ Language Options
248 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
249 Objective-C and Objective-C++ Dialects}.
250 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
251 -fgnu-runtime -fnext-runtime @gol
252 -fno-nil-receivers @gol
253 -fobjc-abi-version=@var{n} @gol
254 -fobjc-call-cxx-cdtors @gol
255 -fobjc-direct-dispatch @gol
256 -fobjc-exceptions @gol
257 -fobjc-gc @gol
258 -fobjc-nilcheck @gol
259 -fobjc-std=objc1 @gol
260 -fno-local-ivars @gol
261 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
262 -freplace-objc-classes @gol
263 -fzero-link @gol
264 -gen-decls @gol
265 -Wassign-intercept @gol
266 -Wno-protocol -Wselector @gol
267 -Wstrict-selector-match @gol
268 -Wundeclared-selector}
269
270 @item Diagnostic Message Formatting Options
271 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
272 @gccoptlist{-fmessage-length=@var{n} @gol
273 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
274 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]} @gol
275 -fdiagnostics-format=@r{[}text@r{|}json@r{]} @gol
276 -fno-diagnostics-show-option -fno-diagnostics-show-caret @gol
277 -fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers @gol
278 -fdiagnostics-minimum-margin-width=@var{width} @gol
279 -fdiagnostics-parseable-fixits -fdiagnostics-generate-patch @gol
280 -fdiagnostics-show-template-tree -fno-elide-type @gol
281 -fno-show-column}
282
283 @item Warning Options
284 @xref{Warning Options,,Options to Request or Suppress Warnings}.
285 @gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic @gol
286 -pedantic-errors @gol
287 -w -Wextra -Wall -Waddress -Waddress-of-packed-member @gol
288 -Waggregate-return -Waligned-new @gol
289 -Walloc-zero -Walloc-size-larger-than=@var{byte-size} @gol
290 -Walloca -Walloca-larger-than=@var{byte-size} @gol
291 -Wno-aggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
292 -Wno-attributes -Wattribute-alias=@var{n} @gol
293 -Wbool-compare -Wbool-operation @gol
294 -Wno-builtin-declaration-mismatch @gol
295 -Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat @gol
296 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wc++17-compat @gol
297 -Wcast-align -Wcast-align=strict -Wcast-function-type -Wcast-qual @gol
298 -Wchar-subscripts -Wcatch-value -Wcatch-value=@var{n} @gol
299 -Wclobbered -Wcomment -Wconditionally-supported @gol
300 -Wconversion -Wcoverage-mismatch -Wno-cpp -Wdangling-else -Wdate-time @gol
301 -Wdelete-incomplete @gol
302 -Wno-attribute-warning @gol
303 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
304 -Wdisabled-optimization @gol
305 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
306 -Wno-div-by-zero -Wdouble-promotion @gol
307 -Wduplicated-branches -Wduplicated-cond @gol
308 -Wempty-body -Wenum-compare -Wno-endif-labels -Wexpansion-to-defined @gol
309 -Werror -Werror=* -Wextra-semi -Wfatal-errors @gol
310 -Wfloat-equal -Wformat -Wformat=2 @gol
311 -Wno-format-contains-nul -Wno-format-extra-args @gol
312 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
313 -Wformat-security -Wformat-signedness -Wformat-truncation=@var{n} @gol
314 -Wformat-y2k -Wframe-address @gol
315 -Wframe-larger-than=@var{byte-size} -Wno-free-nonheap-object @gol
316 -Wjump-misses-init @gol
317 -Whsa -Wif-not-aligned @gol
318 -Wignored-qualifiers -Wignored-attributes -Wincompatible-pointer-types @gol
319 -Wimplicit -Wimplicit-fallthrough -Wimplicit-fallthrough=@var{n} @gol
320 -Wimplicit-function-declaration -Wimplicit-int @gol
321 -Winaccessible-base @gol
322 -Winit-self -Winline -Wno-int-conversion -Wint-in-bool-context @gol
323 -Wno-int-to-pointer-cast -Winvalid-memory-model -Wno-invalid-offsetof @gol
324 -Winvalid-pch -Wlarger-than=@var{byte-size} @gol
325 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
326 -Wmain -Wmaybe-uninitialized -Wmemset-elt-size -Wmemset-transposed-args @gol
327 -Wmisleading-indentation -Wmissing-attributes -Wmissing-braces @gol
328 -Wmissing-field-initializers -Wmissing-format-attribute @gol
329 -Wmissing-include-dirs -Wmissing-noreturn -Wmissing-profile @gol
330 -Wno-multichar -Wmultistatement-macros -Wnonnull -Wnonnull-compare @gol
331 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
332 -Wnull-dereference -Wodr -Wno-overflow -Wopenmp-simd @gol
333 -Woverride-init-side-effects -Woverlength-strings @gol
334 -Wpacked -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
335 -Wparentheses -Wno-pedantic-ms-format @gol
336 -Wplacement-new -Wplacement-new=@var{n} @gol
337 -Wpointer-arith -Wpointer-compare -Wno-pointer-to-int-cast @gol
338 -Wno-pragmas -Wno-prio-ctor-dtor -Wredundant-decls @gol
339 -Wrestrict -Wno-return-local-addr @gol
340 -Wreturn-type -Wsequence-point -Wshadow -Wno-shadow-ivar @gol
341 -Wshadow=global, -Wshadow=local, -Wshadow=compatible-local @gol
342 -Wshift-overflow -Wshift-overflow=@var{n} @gol
343 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
344 -Wsign-compare -Wsign-conversion -Wfloat-conversion @gol
345 -Wno-scalar-storage-order -Wsizeof-pointer-div @gol
346 -Wsizeof-pointer-memaccess -Wsizeof-array-argument @gol
347 -Wstack-protector -Wstack-usage=@var{byte-size} -Wstrict-aliasing @gol
348 -Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
349 -Wstringop-overflow=@var{n} -Wstringop-truncation -Wsubobject-linkage @gol
350 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
351 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
352 -Wswitch -Wswitch-bool -Wswitch-default -Wswitch-enum @gol
353 -Wswitch-unreachable -Wsync-nand @gol
354 -Wsystem-headers -Wtautological-compare -Wtrampolines -Wtrigraphs @gol
355 -Wtype-limits -Wundef @gol
356 -Wuninitialized -Wunknown-pragmas @gol
357 -Wunsuffixed-float-constants -Wunused -Wunused-function @gol
358 -Wunused-label -Wunused-local-typedefs -Wunused-macros @gol
359 -Wunused-parameter -Wno-unused-result @gol
360 -Wunused-value -Wunused-variable @gol
361 -Wunused-const-variable -Wunused-const-variable=@var{n} @gol
362 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
363 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
364 -Wvla -Wvla-larger-than=@var{byte-size} -Wvolatile-register-var @gol
365 -Wwrite-strings @gol
366 -Wzero-as-null-pointer-constant}
367
368 @item C and Objective-C-only Warning Options
369 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
370 -Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs @gol
371 -Wold-style-declaration -Wold-style-definition @gol
372 -Wstrict-prototypes -Wtraditional -Wtraditional-conversion @gol
373 -Wdeclaration-after-statement -Wpointer-sign}
374
375 @item Debugging Options
376 @xref{Debugging Options,,Options for Debugging Your Program}.
377 @gccoptlist{-g -g@var{level} -gdwarf -gdwarf-@var{version} @gol
378 -ggdb -grecord-gcc-switches -gno-record-gcc-switches @gol
379 -gstabs -gstabs+ -gstrict-dwarf -gno-strict-dwarf @gol
380 -gas-loc-support -gno-as-loc-support @gol
381 -gas-locview-support -gno-as-locview-support @gol
382 -gcolumn-info -gno-column-info @gol
383 -gstatement-frontiers -gno-statement-frontiers @gol
384 -gvariable-location-views -gno-variable-location-views @gol
385 -ginternal-reset-location-views -gno-internal-reset-location-views @gol
386 -ginline-points -gno-inline-points @gol
387 -gvms -gxcoff -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
388 -gsplit-dwarf -gdescribe-dies -gno-describe-dies @gol
389 -fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section @gol
390 -fno-eliminate-unused-debug-types @gol
391 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
392 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
393 -fno-eliminate-unused-debug-symbols -femit-class-debug-always @gol
394 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
395 -fvar-tracking -fvar-tracking-assignments}
396
397 @item Optimization Options
398 @xref{Optimize Options,,Options that Control Optimization}.
399 @gccoptlist{-faggressive-loop-optimizations @gol
400 -falign-functions[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
401 -falign-jumps[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
402 -falign-labels[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
403 -falign-loops[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
404 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
405 -fauto-inc-dec -fbranch-probabilities @gol
406 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
407 -fbtr-bb-exclusive -fcaller-saves @gol
408 -fcombine-stack-adjustments -fconserve-stack @gol
409 -fcompare-elim -fcprop-registers -fcrossjumping @gol
410 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
411 -fcx-limited-range @gol
412 -fdata-sections -fdce -fdelayed-branch @gol
413 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
414 -fdevirtualize-at-ltrans -fdse @gol
415 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
416 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
417 -ffinite-loops @gol
418 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
419 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
420 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
421 -fif-conversion2 -findirect-inlining @gol
422 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
423 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
424 -fipa-bit-cp -fipa-vrp -fipa-pta -fipa-profile -fipa-pure-const @gol
425 -fipa-reference -fipa-reference-addressable @gol
426 -fipa-stack-alignment -fipa-icf -fira-algorithm=@var{algorithm} @gol
427 -flive-patching=@var{level} @gol
428 -fira-region=@var{region} -fira-hoist-pressure @gol
429 -fira-loop-pressure -fno-ira-share-save-slots @gol
430 -fno-ira-share-spill-slots @gol
431 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
432 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
433 -fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage @gol
434 -floop-block -floop-interchange -floop-strip-mine @gol
435 -floop-unroll-and-jam -floop-nest-optimize @gol
436 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
437 -flto-partition=@var{alg} -fmerge-all-constants @gol
438 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
439 -fmove-loop-invariants -fno-branch-count-reg @gol
440 -fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse @gol
441 -fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole @gol
442 -fno-peephole2 -fno-printf-return-value -fno-sched-interblock @gol
443 -fno-sched-spec -fno-signed-zeros @gol
444 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
445 -fomit-frame-pointer -foptimize-sibling-calls @gol
446 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
447 -fprefetch-loop-arrays @gol
448 -fprofile-correction @gol
449 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
450 -fprofile-reorder-functions @gol
451 -freciprocal-math -free -frename-registers -freorder-blocks @gol
452 -freorder-blocks-algorithm=@var{algorithm} @gol
453 -freorder-blocks-and-partition -freorder-functions @gol
454 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
455 -frounding-math -fsave-optimization-record @gol
456 -fsched2-use-superblocks -fsched-pressure @gol
457 -fsched-spec-load -fsched-spec-load-dangerous @gol
458 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
459 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
460 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
461 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
462 -fschedule-fusion @gol
463 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
464 -fselective-scheduling -fselective-scheduling2 @gol
465 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
466 -fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate @gol
467 -fsignaling-nans @gol
468 -fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops@gol
469 -fsplit-paths @gol
470 -fsplit-wide-types -fsplit-wide-types-early -fssa-backprop -fssa-phiopt @gol
471 -fstdarg-opt -fstore-merging -fstrict-aliasing @gol
472 -fthread-jumps -ftracer -ftree-bit-ccp @gol
473 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
474 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
475 -ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting @gol
476 -ftree-loop-if-convert -ftree-loop-im @gol
477 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
478 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
479 -ftree-loop-vectorize @gol
480 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
481 -ftree-reassoc -ftree-scev-cprop -ftree-sink -ftree-slsr -ftree-sra @gol
482 -ftree-switch-conversion -ftree-tail-merge @gol
483 -ftree-ter -ftree-vectorize -ftree-vrp -funconstrained-commons @gol
484 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
485 -funsafe-math-optimizations -funswitch-loops @gol
486 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
487 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
488 --param @var{name}=@var{value}
489 -O -O0 -O1 -O2 -O3 -Os -Ofast -Og}
490
491 @item Program Instrumentation Options
492 @xref{Instrumentation Options,,Program Instrumentation Options}.
493 @gccoptlist{-p -pg -fprofile-arcs --coverage -ftest-coverage @gol
494 -fprofile-abs-path @gol
495 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
496 -fprofile-note=@var{path} -fprofile-update=@var{method} @gol
497 -fprofile-filter-files=@var{regex} -fprofile-exclude-files=@var{regex} @gol
498 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
499 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
500 -fsanitize-undefined-trap-on-error -fbounds-check @gol
501 -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
502 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
503 -fstack-protector-explicit -fstack-check @gol
504 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
505 -fno-stack-limit -fsplit-stack @gol
506 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
507 -fvtv-counts -fvtv-debug @gol
508 -finstrument-functions @gol
509 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
510 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
511
512 @item Preprocessor Options
513 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
514 @gccoptlist{-A@var{question}=@var{answer} @gol
515 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
516 -C -CC -D@var{macro}@r{[}=@var{defn}@r{]} @gol
517 -dD -dI -dM -dN -dU @gol
518 -fdebug-cpp -fdirectives-only -fdollars-in-identifiers @gol
519 -fexec-charset=@var{charset} -fextended-identifiers @gol
520 -finput-charset=@var{charset} -fmacro-prefix-map=@var{old}=@var{new} @gol
521 -fmax-include-depth=@var{depth} @gol
522 -fno-canonical-system-headers -fpch-deps -fpch-preprocess @gol
523 -fpreprocessed -ftabstop=@var{width} -ftrack-macro-expansion @gol
524 -fwide-exec-charset=@var{charset} -fworking-directory @gol
525 -H -imacros @var{file} -include @var{file} @gol
526 -M -MD -MF -MG -MM -MMD -MP -MQ -MT @gol
527 -no-integrated-cpp -P -pthread -remap @gol
528 -traditional -traditional-cpp -trigraphs @gol
529 -U@var{macro} -undef @gol
530 -Wp,@var{option} -Xpreprocessor @var{option}}
531
532 @item Assembler Options
533 @xref{Assembler Options,,Passing Options to the Assembler}.
534 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
535
536 @item Linker Options
537 @xref{Link Options,,Options for Linking}.
538 @gccoptlist{@var{object-file-name} -fuse-ld=@var{linker} -l@var{library} @gol
539 -nostartfiles -nodefaultlibs -nolibc -nostdlib @gol
540 -e @var{entry} --entry=@var{entry} @gol
541 -pie -pthread -r -rdynamic @gol
542 -s -static -static-pie -static-libgcc -static-libstdc++ @gol
543 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
544 -shared -shared-libgcc -symbolic @gol
545 -T @var{script} -Wl,@var{option} -Xlinker @var{option} @gol
546 -u @var{symbol} -z @var{keyword}}
547
548 @item Directory Options
549 @xref{Directory Options,,Options for Directory Search}.
550 @gccoptlist{-B@var{prefix} -I@var{dir} -I- @gol
551 -idirafter @var{dir} @gol
552 -imacros @var{file} -imultilib @var{dir} @gol
553 -iplugindir=@var{dir} -iprefix @var{file} @gol
554 -iquote @var{dir} -isysroot @var{dir} -isystem @var{dir} @gol
555 -iwithprefix @var{dir} -iwithprefixbefore @var{dir} @gol
556 -L@var{dir} -no-canonical-prefixes --no-sysroot-suffix @gol
557 -nostdinc -nostdinc++ --sysroot=@var{dir}}
558
559 @item Code Generation Options
560 @xref{Code Gen Options,,Options for Code Generation Conventions}.
561 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
562 -ffixed-@var{reg} -fexceptions @gol
563 -fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables @gol
564 -fasynchronous-unwind-tables @gol
565 -fno-gnu-unique @gol
566 -finhibit-size-directive -fno-common -fno-ident @gol
567 -fpcc-struct-return -fpic -fPIC -fpie -fPIE -fno-plt @gol
568 -fno-jump-tables @gol
569 -frecord-gcc-switches @gol
570 -freg-struct-return -fshort-enums -fshort-wchar @gol
571 -fverbose-asm -fpack-struct[=@var{n}] @gol
572 -fleading-underscore -ftls-model=@var{model} @gol
573 -fstack-reuse=@var{reuse_level} @gol
574 -ftrampolines -ftrapv -fwrapv @gol
575 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
576 -fstrict-volatile-bitfields -fsync-libcalls}
577
578 @item Developer Options
579 @xref{Developer Options,,GCC Developer Options}.
580 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
581 -dumpfullversion -fchecking -fchecking=@var{n} -fdbg-cnt-list @gol
582 -fdbg-cnt=@var{counter-value-list} @gol
583 -fdisable-ipa-@var{pass_name} @gol
584 -fdisable-rtl-@var{pass_name} @gol
585 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
586 -fdisable-tree-@var{pass_name} @gol
587 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
588 -fdump-debug -fdump-earlydebug @gol
589 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
590 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
591 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
592 -fdump-lang-all @gol
593 -fdump-lang-@var{switch} @gol
594 -fdump-lang-@var{switch}-@var{options} @gol
595 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
596 -fdump-passes @gol
597 -fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} @gol
598 -fdump-statistics @gol
599 -fdump-tree-all @gol
600 -fdump-tree-@var{switch} @gol
601 -fdump-tree-@var{switch}-@var{options} @gol
602 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
603 -fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second @gol
604 -fenable-@var{kind}-@var{pass} @gol
605 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
606 -fira-verbose=@var{n} @gol
607 -flto-report -flto-report-wpa -fmem-report-wpa @gol
608 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report @gol
609 -fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
610 -fprofile-report @gol
611 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
612 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
613 -fstats -fstack-usage -ftime-report -ftime-report-details @gol
614 -fvar-tracking-assignments-toggle -gtoggle @gol
615 -print-file-name=@var{library} -print-libgcc-file-name @gol
616 -print-multi-directory -print-multi-lib -print-multi-os-directory @gol
617 -print-prog-name=@var{program} -print-search-dirs -Q @gol
618 -print-sysroot -print-sysroot-headers-suffix @gol
619 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
620
621 @item Machine-Dependent Options
622 @xref{Submodel Options,,Machine-Dependent Options}.
623 @c This list is ordered alphanumerically by subsection name.
624 @c Try and put the significant identifier (CPU or system) first,
625 @c so users have a clue at guessing where the ones they want will be.
626
627 @emph{AArch64 Options}
628 @gccoptlist{-mabi=@var{name} -mbig-endian -mlittle-endian @gol
629 -mgeneral-regs-only @gol
630 -mcmodel=tiny -mcmodel=small -mcmodel=large @gol
631 -mstrict-align -mno-strict-align @gol
632 -momit-leaf-frame-pointer @gol
633 -mtls-dialect=desc -mtls-dialect=traditional @gol
634 -mtls-size=@var{size} @gol
635 -mfix-cortex-a53-835769 -mfix-cortex-a53-843419 @gol
636 -mlow-precision-recip-sqrt -mlow-precision-sqrt -mlow-precision-div @gol
637 -mpc-relative-literal-loads @gol
638 -msign-return-address=@var{scope} @gol
639 -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}
640 +@var{b-key}]|@var{bti} @gol
641 -march=@var{name} -mcpu=@var{name} -mtune=@var{name} @gol
642 -moverride=@var{string} -mverbose-cost-dump @gol
643 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{sysreg} @gol
644 -mstack-protector-guard-offset=@var{offset} -mtrack-speculation }
645
646 @emph{Adapteva Epiphany Options}
647 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
648 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
649 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
650 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
651 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
652 -msplit-vecmove-early -m1reg-@var{reg}}
653
654 @emph{AMD GCN Options}
655 @gccoptlist{-march=@var{gpu} -mtune=@var{gpu} -mstack-size=@var{bytes}}
656
657 @emph{ARC Options}
658 @gccoptlist{-mbarrel-shifter -mjli-always @gol
659 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
660 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
661 -mea -mno-mpy -mmul32x16 -mmul64 -matomic @gol
662 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
663 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
664 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
665 -mlong-calls -mmedium-calls -msdata -mirq-ctrl-saved @gol
666 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
667 -mvolatile-cache -mtp-regno=@var{regno} @gol
668 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
669 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
670 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
671 -mlra-priority-compact mlra-priority-noncompact -mmillicode @gol
672 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
673 -mtune=@var{cpu} -mmultcost=@var{num} -mcode-density-frame @gol
674 -munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
675 -mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu} -mrf16 -mbranch-index}
676
677 @emph{ARM Options}
678 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
679 -mabi=@var{name} @gol
680 -mapcs-stack-check -mno-apcs-stack-check @gol
681 -mapcs-reentrant -mno-apcs-reentrant @gol
682 -mgeneral-regs-only @gol
683 -msched-prolog -mno-sched-prolog @gol
684 -mlittle-endian -mbig-endian @gol
685 -mbe8 -mbe32 @gol
686 -mfloat-abi=@var{name} @gol
687 -mfp16-format=@var{name}
688 -mthumb-interwork -mno-thumb-interwork @gol
689 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
690 -mtune=@var{name} -mprint-tune-info @gol
691 -mstructure-size-boundary=@var{n} @gol
692 -mabort-on-noreturn @gol
693 -mlong-calls -mno-long-calls @gol
694 -msingle-pic-base -mno-single-pic-base @gol
695 -mpic-register=@var{reg} @gol
696 -mnop-fun-dllimport @gol
697 -mpoke-function-name @gol
698 -mthumb -marm -mflip-thumb @gol
699 -mtpcs-frame -mtpcs-leaf-frame @gol
700 -mcaller-super-interworking -mcallee-super-interworking @gol
701 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
702 -mword-relocations @gol
703 -mfix-cortex-m3-ldrd @gol
704 -munaligned-access @gol
705 -mneon-for-64bits @gol
706 -mslow-flash-data @gol
707 -masm-syntax-unified @gol
708 -mrestrict-it @gol
709 -mverbose-cost-dump @gol
710 -mpure-code @gol
711 -mcmse}
712
713 @emph{AVR Options}
714 @gccoptlist{-mmcu=@var{mcu} -mabsdata -maccumulate-args @gol
715 -mbranch-cost=@var{cost} @gol
716 -mcall-prologues -mgas-isr-prologues -mint8 @gol
717 -mn_flash=@var{size} -mno-interrupts @gol
718 -mmain-is-OS_task -mrelax -mrmw -mstrict-X -mtiny-stack @gol
719 -mfract-convert-truncate @gol
720 -mshort-calls -nodevicelib @gol
721 -Waddr-space-convert -Wmisspelled-isr}
722
723 @emph{Blackfin Options}
724 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
725 -msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
726 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
727 -mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
728 -mno-id-shared-library -mshared-library-id=@var{n} @gol
729 -mleaf-id-shared-library -mno-leaf-id-shared-library @gol
730 -msep-data -mno-sep-data -mlong-calls -mno-long-calls @gol
731 -mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram @gol
732 -micplb}
733
734 @emph{C6X Options}
735 @gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu} @gol
736 -msim -msdata=@var{sdata-type}}
737
738 @emph{CRIS Options}
739 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
740 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
741 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
742 -mstack-align -mdata-align -mconst-align @gol
743 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
744 -melf -maout -melinux -mlinux -sim -sim2 @gol
745 -mmul-bug-workaround -mno-mul-bug-workaround}
746
747 @emph{CR16 Options}
748 @gccoptlist{-mmac @gol
749 -mcr16cplus -mcr16c @gol
750 -msim -mint32 -mbit-ops
751 -mdata-model=@var{model}}
752
753 @emph{C-SKY Options}
754 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} @gol
755 -mbig-endian -EB -mlittle-endian -EL @gol
756 -mhard-float -msoft-float -mfpu=@var{fpu} -mdouble-float -mfdivdu @gol
757 -melrw -mistack -mmp -mcp -mcache -msecurity -mtrust @gol
758 -mdsp -medsp -mvdsp @gol
759 -mdiv -msmart -mhigh-registers -manchor @gol
760 -mpushpop -mmultiple-stld -mconstpool -mstack-size -mccrt @gol
761 -mbranch-cost=@var{n} -mcse-cc -msched-prolog}
762
763 @emph{Darwin Options}
764 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
765 -arch_only -bind_at_load -bundle -bundle_loader @gol
766 -client_name -compatibility_version -current_version @gol
767 -dead_strip @gol
768 -dependency-file -dylib_file -dylinker_install_name @gol
769 -dynamic -dynamiclib -exported_symbols_list @gol
770 -filelist -flat_namespace -force_cpusubtype_ALL @gol
771 -force_flat_namespace -headerpad_max_install_names @gol
772 -iframework @gol
773 -image_base -init -install_name -keep_private_externs @gol
774 -multi_module -multiply_defined -multiply_defined_unused @gol
775 -noall_load -no_dead_strip_inits_and_terms @gol
776 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
777 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
778 -private_bundle -read_only_relocs -sectalign @gol
779 -sectobjectsymbols -whyload -seg1addr @gol
780 -sectcreate -sectobjectsymbols -sectorder @gol
781 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
782 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
783 -segprot -segs_read_only_addr -segs_read_write_addr @gol
784 -single_module -static -sub_library -sub_umbrella @gol
785 -twolevel_namespace -umbrella -undefined @gol
786 -unexported_symbols_list -weak_reference_mismatches @gol
787 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
788 -mkernel -mone-byte-bool}
789
790 @emph{DEC Alpha Options}
791 @gccoptlist{-mno-fp-regs -msoft-float @gol
792 -mieee -mieee-with-inexact -mieee-conformant @gol
793 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
794 -mtrap-precision=@var{mode} -mbuild-constants @gol
795 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
796 -mbwx -mmax -mfix -mcix @gol
797 -mfloat-vax -mfloat-ieee @gol
798 -mexplicit-relocs -msmall-data -mlarge-data @gol
799 -msmall-text -mlarge-text @gol
800 -mmemory-latency=@var{time}}
801
802 @emph{FR30 Options}
803 @gccoptlist{-msmall-model -mno-lsim}
804
805 @emph{FT32 Options}
806 @gccoptlist{-msim -mlra -mnodiv -mft32b -mcompress -mnopm}
807
808 @emph{FRV Options}
809 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
810 -mhard-float -msoft-float @gol
811 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
812 -mdouble -mno-double @gol
813 -mmedia -mno-media -mmuladd -mno-muladd @gol
814 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
815 -mlinked-fp -mlong-calls -malign-labels @gol
816 -mlibrary-pic -macc-4 -macc-8 @gol
817 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
818 -moptimize-membar -mno-optimize-membar @gol
819 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
820 -mvliw-branch -mno-vliw-branch @gol
821 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
822 -mno-nested-cond-exec -mtomcat-stats @gol
823 -mTLS -mtls @gol
824 -mcpu=@var{cpu}}
825
826 @emph{GNU/Linux Options}
827 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
828 -tno-android-cc -tno-android-ld}
829
830 @emph{H8/300 Options}
831 @gccoptlist{-mrelax -mh -ms -mn -mexr -mno-exr -mint32 -malign-300}
832
833 @emph{HPPA Options}
834 @gccoptlist{-march=@var{architecture-type} @gol
835 -mcaller-copies -mdisable-fpregs -mdisable-indexing @gol
836 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
837 -mfixed-range=@var{register-range} @gol
838 -mjump-in-delay -mlinker-opt -mlong-calls @gol
839 -mlong-load-store -mno-disable-fpregs @gol
840 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
841 -mno-jump-in-delay -mno-long-load-store @gol
842 -mno-portable-runtime -mno-soft-float @gol
843 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
844 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
845 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
846 -munix=@var{unix-std} -nolibdld -static -threads}
847
848 @emph{IA-64 Options}
849 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
850 -mvolatile-asm-stop -mregister-names -msdata -mno-sdata @gol
851 -mconstant-gp -mauto-pic -mfused-madd @gol
852 -minline-float-divide-min-latency @gol
853 -minline-float-divide-max-throughput @gol
854 -mno-inline-float-divide @gol
855 -minline-int-divide-min-latency @gol
856 -minline-int-divide-max-throughput @gol
857 -mno-inline-int-divide @gol
858 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
859 -mno-inline-sqrt @gol
860 -mdwarf2-asm -mearly-stop-bits @gol
861 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
862 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
863 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
864 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
865 -msched-spec-ldc -msched-spec-control-ldc @gol
866 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
867 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
868 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
869 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
870
871 @emph{LM32 Options}
872 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
873 -msign-extend-enabled -muser-enabled}
874
875 @emph{M32R/D Options}
876 @gccoptlist{-m32r2 -m32rx -m32r @gol
877 -mdebug @gol
878 -malign-loops -mno-align-loops @gol
879 -missue-rate=@var{number} @gol
880 -mbranch-cost=@var{number} @gol
881 -mmodel=@var{code-size-model-type} @gol
882 -msdata=@var{sdata-type} @gol
883 -mno-flush-func -mflush-func=@var{name} @gol
884 -mno-flush-trap -mflush-trap=@var{number} @gol
885 -G @var{num}}
886
887 @emph{M32C Options}
888 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
889
890 @emph{M680x0 Options}
891 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune} @gol
892 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
893 -m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
894 -mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020 @gol
895 -mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort @gol
896 -mno-short -mhard-float -m68881 -msoft-float -mpcrel @gol
897 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
898 -mshared-library-id=n -mid-shared-library -mno-id-shared-library @gol
899 -mxgot -mno-xgot -mlong-jump-table-offsets}
900
901 @emph{MCore Options}
902 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
903 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
904 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
905 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
906 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
907
908 @emph{MeP Options}
909 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
910 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
911 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
912 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
913 -mtiny=@var{n}}
914
915 @emph{MicroBlaze Options}
916 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
917 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
918 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
919 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
920 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model} @gol
921 -mpic-data-is-text-relative}
922
923 @emph{MIPS Options}
924 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
925 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips32r3 -mips32r5 @gol
926 -mips32r6 -mips64 -mips64r2 -mips64r3 -mips64r5 -mips64r6 @gol
927 -mips16 -mno-mips16 -mflip-mips16 @gol
928 -minterlink-compressed -mno-interlink-compressed @gol
929 -minterlink-mips16 -mno-interlink-mips16 @gol
930 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
931 -mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot @gol
932 -mgp32 -mgp64 -mfp32 -mfpxx -mfp64 -mhard-float -msoft-float @gol
933 -mno-float -msingle-float -mdouble-float @gol
934 -modd-spreg -mno-odd-spreg @gol
935 -mabs=@var{mode} -mnan=@var{encoding} @gol
936 -mdsp -mno-dsp -mdspr2 -mno-dspr2 @gol
937 -mmcu -mmno-mcu @gol
938 -meva -mno-eva @gol
939 -mvirt -mno-virt @gol
940 -mxpa -mno-xpa @gol
941 -mcrc -mno-crc @gol
942 -mginv -mno-ginv @gol
943 -mmicromips -mno-micromips @gol
944 -mmsa -mno-msa @gol
945 -mloongson-mmi -mno-loongson-mmi @gol
946 -mloongson-ext -mno-loongson-ext @gol
947 -mloongson-ext2 -mno-loongson-ext2 @gol
948 -mfpu=@var{fpu-type} @gol
949 -msmartmips -mno-smartmips @gol
950 -mpaired-single -mno-paired-single -mdmx -mno-mdmx @gol
951 -mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc @gol
952 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
953 -G@var{num} -mlocal-sdata -mno-local-sdata @gol
954 -mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt @gol
955 -membedded-data -mno-embedded-data @gol
956 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
957 -mcode-readable=@var{setting} @gol
958 -msplit-addresses -mno-split-addresses @gol
959 -mexplicit-relocs -mno-explicit-relocs @gol
960 -mcheck-zero-division -mno-check-zero-division @gol
961 -mdivide-traps -mdivide-breaks @gol
962 -mload-store-pairs -mno-load-store-pairs @gol
963 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
964 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd -mno-fused-madd -nocpp @gol
965 -mfix-24k -mno-fix-24k @gol
966 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
967 -mfix-r5900 -mno-fix-r5900 @gol
968 -mfix-r10000 -mno-fix-r10000 -mfix-rm7000 -mno-fix-rm7000 @gol
969 -mfix-vr4120 -mno-fix-vr4120 @gol
970 -mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1 @gol
971 -mflush-func=@var{func} -mno-flush-func @gol
972 -mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely @gol
973 -mcompact-branches=@var{policy} @gol
974 -mfp-exceptions -mno-fp-exceptions @gol
975 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
976 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
977 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
978 -mframe-header-opt -mno-frame-header-opt}
979
980 @emph{MMIX Options}
981 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
982 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
983 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
984 -mno-base-addresses -msingle-exit -mno-single-exit}
985
986 @emph{MN10300 Options}
987 @gccoptlist{-mmult-bug -mno-mult-bug @gol
988 -mno-am33 -mam33 -mam33-2 -mam34 @gol
989 -mtune=@var{cpu-type} @gol
990 -mreturn-pointer-on-d0 @gol
991 -mno-crt0 -mrelax -mliw -msetlb}
992
993 @emph{Moxie Options}
994 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
995
996 @emph{MSP430 Options}
997 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
998 -mwarn-mcu @gol
999 -mcode-region= -mdata-region= @gol
1000 -msilicon-errata= -msilicon-errata-warn= @gol
1001 -mhwmult= -minrt}
1002
1003 @emph{NDS32 Options}
1004 @gccoptlist{-mbig-endian -mlittle-endian @gol
1005 -mreduced-regs -mfull-regs @gol
1006 -mcmov -mno-cmov @gol
1007 -mext-perf -mno-ext-perf @gol
1008 -mext-perf2 -mno-ext-perf2 @gol
1009 -mext-string -mno-ext-string @gol
1010 -mv3push -mno-v3push @gol
1011 -m16bit -mno-16bit @gol
1012 -misr-vector-size=@var{num} @gol
1013 -mcache-block-size=@var{num} @gol
1014 -march=@var{arch} @gol
1015 -mcmodel=@var{code-model} @gol
1016 -mctor-dtor -mrelax}
1017
1018 @emph{Nios II Options}
1019 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
1020 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
1021 -mel -meb @gol
1022 -mno-bypass-cache -mbypass-cache @gol
1023 -mno-cache-volatile -mcache-volatile @gol
1024 -mno-fast-sw-div -mfast-sw-div @gol
1025 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
1026 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
1027 -mcustom-fpu-cfg=@var{name} @gol
1028 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
1029 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
1030
1031 @emph{Nvidia PTX Options}
1032 @gccoptlist{-m32 -m64 -mmainkernel -moptimize}
1033
1034 @emph{OpenRISC Options}
1035 @gccoptlist{-mboard=@var{name} -mnewlib -mhard-mul -mhard-div @gol
1036 -msoft-mul -msoft-div @gol
1037 -mcmov -mror -msext -msfimm -mshftimm}
1038
1039 @emph{PDP-11 Options}
1040 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
1041 -mint32 -mno-int16 -mint16 -mno-int32 @gol
1042 -msplit -munix-asm -mdec-asm -mgnu-asm -mlra}
1043
1044 @emph{picoChip Options}
1045 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
1046 -msymbol-as-address -mno-inefficient-warnings}
1047
1048 @emph{PowerPC Options}
1049 See RS/6000 and PowerPC Options.
1050
1051 @emph{PRU Options}
1052 @gccoptlist{-mmcu=@var{mcu} -minrt -mno-relax -mloop @gol
1053 -mabi=@var{variant} @gol}
1054
1055 @emph{RISC-V Options}
1056 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1057 -mplt -mno-plt @gol
1058 -mabi=@var{ABI-string} @gol
1059 -mfdiv -mno-fdiv @gol
1060 -mdiv -mno-div @gol
1061 -march=@var{ISA-string} @gol
1062 -mtune=@var{processor-string} @gol
1063 -mpreferred-stack-boundary=@var{num} @gol
1064 -msmall-data-limit=@var{N-bytes} @gol
1065 -msave-restore -mno-save-restore @gol
1066 -mstrict-align -mno-strict-align @gol
1067 -mcmodel=medlow -mcmodel=medany @gol
1068 -mexplicit-relocs -mno-explicit-relocs @gol
1069 -mrelax -mno-relax @gol
1070 -mriscv-attribute -mmo-riscv-attribute}
1071
1072 @emph{RL78 Options}
1073 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
1074 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
1075 -m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts}
1076
1077 @emph{RS/6000 and PowerPC Options}
1078 @gccoptlist{-mcpu=@var{cpu-type} @gol
1079 -mtune=@var{cpu-type} @gol
1080 -mcmodel=@var{code-model} @gol
1081 -mpowerpc64 @gol
1082 -maltivec -mno-altivec @gol
1083 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
1084 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
1085 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd @gol
1086 -mfprnd -mno-fprnd @gol
1087 -mcmpb -mno-cmpb -mhard-dfp -mno-hard-dfp @gol
1088 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
1089 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
1090 -malign-power -malign-natural @gol
1091 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
1092 -mupdate -mno-update @gol
1093 -mavoid-indexed-addresses -mno-avoid-indexed-addresses @gol
1094 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
1095 -mstrict-align -mno-strict-align -mrelocatable @gol
1096 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
1097 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
1098 -mdynamic-no-pic -mswdiv -msingle-pic-base @gol
1099 -mprioritize-restricted-insns=@var{priority} @gol
1100 -msched-costly-dep=@var{dependence_type} @gol
1101 -minsert-sched-nops=@var{scheme} @gol
1102 -mcall-aixdesc -mcall-eabi -mcall-freebsd @gol
1103 -mcall-linux -mcall-netbsd -mcall-openbsd @gol
1104 -mcall-sysv -mcall-sysv-eabi -mcall-sysv-noeabi @gol
1105 -mtraceback=@var{traceback_type} @gol
1106 -maix-struct-return -msvr4-struct-return @gol
1107 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
1108 -mlongcall -mno-longcall -mpltseq -mno-pltseq @gol
1109 -mblock-move-inline-limit=@var{num} @gol
1110 -mblock-compare-inline-limit=@var{num} @gol
1111 -mblock-compare-inline-loop-limit=@var{num} @gol
1112 -mstring-compare-inline-limit=@var{num} @gol
1113 -misel -mno-isel @gol
1114 -mvrsave -mno-vrsave @gol
1115 -mmulhw -mno-mulhw @gol
1116 -mdlmzb -mno-dlmzb @gol
1117 -mprototype -mno-prototype @gol
1118 -msim -mmvme -mads -myellowknife -memb -msdata @gol
1119 -msdata=@var{opt} -mreadonly-in-sdata -mvxworks -G @var{num} @gol
1120 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
1121 -mno-recip-precision @gol
1122 -mveclibabi=@var{type} -mfriz -mno-friz @gol
1123 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
1124 -msave-toc-indirect -mno-save-toc-indirect @gol
1125 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
1126 -mcrypto -mno-crypto -mhtm -mno-htm @gol
1127 -mquad-memory -mno-quad-memory @gol
1128 -mquad-memory-atomic -mno-quad-memory-atomic @gol
1129 -mcompat-align-parm -mno-compat-align-parm @gol
1130 -mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
1131 -mgnu-attribute -mno-gnu-attribute @gol
1132 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1133 -mstack-protector-guard-offset=@var{offset} -mpcrel -mno-pcrel}
1134
1135 @emph{RX Options}
1136 @gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu@gol
1137 -mcpu=@gol
1138 -mbig-endian-data -mlittle-endian-data @gol
1139 -msmall-data @gol
1140 -msim -mno-sim@gol
1141 -mas100-syntax -mno-as100-syntax@gol
1142 -mrelax@gol
1143 -mmax-constant-size=@gol
1144 -mint-register=@gol
1145 -mpid@gol
1146 -mallow-string-insns -mno-allow-string-insns@gol
1147 -mjsr@gol
1148 -mno-warn-multiple-fast-interrupts@gol
1149 -msave-acc-in-interrupts}
1150
1151 @emph{S/390 and zSeries Options}
1152 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
1153 -mhard-float -msoft-float -mhard-dfp -mno-hard-dfp @gol
1154 -mlong-double-64 -mlong-double-128 @gol
1155 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
1156 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
1157 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
1158 -mhtm -mvx -mzvector @gol
1159 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
1160 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard @gol
1161 -mhotpatch=@var{halfwords},@var{halfwords}}
1162
1163 @emph{Score Options}
1164 @gccoptlist{-meb -mel @gol
1165 -mnhwloop @gol
1166 -muls @gol
1167 -mmac @gol
1168 -mscore5 -mscore5u -mscore7 -mscore7d}
1169
1170 @emph{SH Options}
1171 @gccoptlist{-m1 -m2 -m2e @gol
1172 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
1173 -m3 -m3e @gol
1174 -m4-nofpu -m4-single-only -m4-single -m4 @gol
1175 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
1176 -mb -ml -mdalign -mrelax @gol
1177 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
1178 -mieee -mno-ieee -mbitops -misize -minline-ic_invalidate -mpadstruct @gol
1179 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
1180 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
1181 -maccumulate-outgoing-args @gol
1182 -matomic-model=@var{atomic-model} @gol
1183 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1184 -mcbranch-force-delay-slot @gol
1185 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1186 -mpretend-cmove -mtas}
1187
1188 @emph{Solaris 2 Options}
1189 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text -mno-impure-text @gol
1190 -pthreads}
1191
1192 @emph{SPARC Options}
1193 @gccoptlist{-mcpu=@var{cpu-type} @gol
1194 -mtune=@var{cpu-type} @gol
1195 -mcmodel=@var{code-model} @gol
1196 -mmemory-model=@var{mem-model} @gol
1197 -m32 -m64 -mapp-regs -mno-app-regs @gol
1198 -mfaster-structs -mno-faster-structs -mflat -mno-flat @gol
1199 -mfpu -mno-fpu -mhard-float -msoft-float @gol
1200 -mhard-quad-float -msoft-quad-float @gol
1201 -mstack-bias -mno-stack-bias @gol
1202 -mstd-struct-return -mno-std-struct-return @gol
1203 -munaligned-doubles -mno-unaligned-doubles @gol
1204 -muser-mode -mno-user-mode @gol
1205 -mv8plus -mno-v8plus -mvis -mno-vis @gol
1206 -mvis2 -mno-vis2 -mvis3 -mno-vis3 @gol
1207 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1208 -mcbcond -mno-cbcond -mfmaf -mno-fmaf -mfsmuld -mno-fsmuld @gol
1209 -mpopc -mno-popc -msubxc -mno-subxc @gol
1210 -mfix-at697f -mfix-ut699 -mfix-ut700 -mfix-gr712rc @gol
1211 -mlra -mno-lra}
1212
1213 @emph{SPU Options}
1214 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1215 -msafe-dma -munsafe-dma @gol
1216 -mbranch-hints @gol
1217 -msmall-mem -mlarge-mem -mstdmain @gol
1218 -mfixed-range=@var{register-range} @gol
1219 -mea32 -mea64 @gol
1220 -maddress-space-conversion -mno-address-space-conversion @gol
1221 -mcache-size=@var{cache-size} @gol
1222 -matomic-updates -mno-atomic-updates}
1223
1224 @emph{System V Options}
1225 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
1226
1227 @emph{TILE-Gx Options}
1228 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1229 -mcmodel=@var{code-model}}
1230
1231 @emph{TILEPro Options}
1232 @gccoptlist{-mcpu=@var{cpu} -m32}
1233
1234 @emph{V850 Options}
1235 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
1236 -mprolog-function -mno-prolog-function -mspace @gol
1237 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
1238 -mapp-regs -mno-app-regs @gol
1239 -mdisable-callt -mno-disable-callt @gol
1240 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1241 -mv850e -mv850 -mv850e3v5 @gol
1242 -mloop @gol
1243 -mrelax @gol
1244 -mlong-jumps @gol
1245 -msoft-float @gol
1246 -mhard-float @gol
1247 -mgcc-abi @gol
1248 -mrh850-abi @gol
1249 -mbig-switch}
1250
1251 @emph{VAX Options}
1252 @gccoptlist{-mg -mgnu -munix}
1253
1254 @emph{Visium Options}
1255 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1256 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1257
1258 @emph{VMS Options}
1259 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1260 -mpointer-size=@var{size}}
1261
1262 @emph{VxWorks Options}
1263 @gccoptlist{-mrtp -non-static -Bstatic -Bdynamic @gol
1264 -Xbind-lazy -Xbind-now}
1265
1266 @emph{x86 Options}
1267 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
1268 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1269 -mfpmath=@var{unit} @gol
1270 -masm=@var{dialect} -mno-fancy-math-387 @gol
1271 -mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float @gol
1272 -mno-wide-multiply -mrtd -malign-double @gol
1273 -mpreferred-stack-boundary=@var{num} @gol
1274 -mincoming-stack-boundary=@var{num} @gol
1275 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1276 -mrecip -mrecip=@var{opt} @gol
1277 -mvzeroupper -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1278 -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1279 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1280 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1281 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mpconfig -mwbnoinvd @gol
1282 -mptwrite -mprefetchwt1 -mclflushopt -mclwb -mxsavec -mxsaves @gol
1283 -msse4a -m3dnow -m3dnowa -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop @gol
1284 -madx -mlzcnt -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mhle -mlwp @gol
1285 -mmwaitx -mclzero -mpku -mthreads -mgfni -mvaes -mwaitpkg @gol
1286 -mshstk -mmanual-endbr -mforce-indirect-call -mavx512vbmi2 -mavx512bf16 -menqcmd @gol
1287 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq @gol
1288 -mavx5124fmaps -mavx512vnni -mavx5124vnniw -mprfchw -mrdpid @gol
1289 -mrdseed -msgx -mavx512vp2intersect@gol
1290 -mcldemote -mms-bitfields -mno-align-stringops -minline-all-stringops @gol
1291 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1292 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1293 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
1294 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1295 -mregparm=@var{num} -msseregparm @gol
1296 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1297 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1298 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
1299 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1300 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1301 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1302 -minstrument-return=@var{type} -mfentry-name=@var{name} -mfentry-section=@var{name} @gol
1303 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1304 -malign-data=@var{type} -mstack-protector-guard=@var{guard} @gol
1305 -mstack-protector-guard-reg=@var{reg} @gol
1306 -mstack-protector-guard-offset=@var{offset} @gol
1307 -mstack-protector-guard-symbol=@var{symbol} @gol
1308 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1309 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1310 -mindirect-branch-register}
1311
1312 @emph{x86 Windows Options}
1313 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1314 -mnop-fun-dllimport -mthread @gol
1315 -municode -mwin32 -mwindows -fno-set-stack-executable}
1316
1317 @emph{Xstormy16 Options}
1318 @gccoptlist{-msim}
1319
1320 @emph{Xtensa Options}
1321 @gccoptlist{-mconst16 -mno-const16 @gol
1322 -mfused-madd -mno-fused-madd @gol
1323 -mforce-no-pic @gol
1324 -mserialize-volatile -mno-serialize-volatile @gol
1325 -mtext-section-literals -mno-text-section-literals @gol
1326 -mauto-litpools -mno-auto-litpools @gol
1327 -mtarget-align -mno-target-align @gol
1328 -mlongcalls -mno-longcalls}
1329
1330 @emph{zSeries Options}
1331 See S/390 and zSeries Options.
1332 @end table
1333
1334
1335 @node Overall Options
1336 @section Options Controlling the Kind of Output
1337
1338 Compilation can involve up to four stages: preprocessing, compilation
1339 proper, assembly and linking, always in that order. GCC is capable of
1340 preprocessing and compiling several files either into several
1341 assembler input files, or into one assembler input file; then each
1342 assembler input file produces an object file, and linking combines all
1343 the object files (those newly compiled, and those specified as input)
1344 into an executable file.
1345
1346 @cindex file name suffix
1347 For any given input file, the file name suffix determines what kind of
1348 compilation is done:
1349
1350 @table @gcctabopt
1351 @item @var{file}.c
1352 C source code that must be preprocessed.
1353
1354 @item @var{file}.i
1355 C source code that should not be preprocessed.
1356
1357 @item @var{file}.ii
1358 C++ source code that should not be preprocessed.
1359
1360 @item @var{file}.m
1361 Objective-C source code. Note that you must link with the @file{libobjc}
1362 library to make an Objective-C program work.
1363
1364 @item @var{file}.mi
1365 Objective-C source code that should not be preprocessed.
1366
1367 @item @var{file}.mm
1368 @itemx @var{file}.M
1369 Objective-C++ source code. Note that you must link with the @file{libobjc}
1370 library to make an Objective-C++ program work. Note that @samp{.M} refers
1371 to a literal capital M@.
1372
1373 @item @var{file}.mii
1374 Objective-C++ source code that should not be preprocessed.
1375
1376 @item @var{file}.h
1377 C, C++, Objective-C or Objective-C++ header file to be turned into a
1378 precompiled header (default), or C, C++ header file to be turned into an
1379 Ada spec (via the @option{-fdump-ada-spec} switch).
1380
1381 @item @var{file}.cc
1382 @itemx @var{file}.cp
1383 @itemx @var{file}.cxx
1384 @itemx @var{file}.cpp
1385 @itemx @var{file}.CPP
1386 @itemx @var{file}.c++
1387 @itemx @var{file}.C
1388 C++ source code that must be preprocessed. Note that in @samp{.cxx},
1389 the last two letters must both be literally @samp{x}. Likewise,
1390 @samp{.C} refers to a literal capital C@.
1391
1392 @item @var{file}.mm
1393 @itemx @var{file}.M
1394 Objective-C++ source code that must be preprocessed.
1395
1396 @item @var{file}.mii
1397 Objective-C++ source code that should not be preprocessed.
1398
1399 @item @var{file}.hh
1400 @itemx @var{file}.H
1401 @itemx @var{file}.hp
1402 @itemx @var{file}.hxx
1403 @itemx @var{file}.hpp
1404 @itemx @var{file}.HPP
1405 @itemx @var{file}.h++
1406 @itemx @var{file}.tcc
1407 C++ header file to be turned into a precompiled header or Ada spec.
1408
1409 @item @var{file}.f
1410 @itemx @var{file}.for
1411 @itemx @var{file}.ftn
1412 Fixed form Fortran source code that should not be preprocessed.
1413
1414 @item @var{file}.F
1415 @itemx @var{file}.FOR
1416 @itemx @var{file}.fpp
1417 @itemx @var{file}.FPP
1418 @itemx @var{file}.FTN
1419 Fixed form Fortran source code that must be preprocessed (with the traditional
1420 preprocessor).
1421
1422 @item @var{file}.f90
1423 @itemx @var{file}.f95
1424 @itemx @var{file}.f03
1425 @itemx @var{file}.f08
1426 Free form Fortran source code that should not be preprocessed.
1427
1428 @item @var{file}.F90
1429 @itemx @var{file}.F95
1430 @itemx @var{file}.F03
1431 @itemx @var{file}.F08
1432 Free form Fortran source code that must be preprocessed (with the
1433 traditional preprocessor).
1434
1435 @item @var{file}.go
1436 Go source code.
1437
1438 @item @var{file}.brig
1439 BRIG files (binary representation of HSAIL).
1440
1441 @item @var{file}.d
1442 D source code.
1443
1444 @item @var{file}.di
1445 D interface file.
1446
1447 @item @var{file}.dd
1448 D documentation code (Ddoc).
1449
1450 @item @var{file}.ads
1451 Ada source code file that contains a library unit declaration (a
1452 declaration of a package, subprogram, or generic, or a generic
1453 instantiation), or a library unit renaming declaration (a package,
1454 generic, or subprogram renaming declaration). Such files are also
1455 called @dfn{specs}.
1456
1457 @item @var{file}.adb
1458 Ada source code file containing a library unit body (a subprogram or
1459 package body). Such files are also called @dfn{bodies}.
1460
1461 @c GCC also knows about some suffixes for languages not yet included:
1462 @c Ratfor:
1463 @c @var{file}.r
1464
1465 @item @var{file}.s
1466 Assembler code.
1467
1468 @item @var{file}.S
1469 @itemx @var{file}.sx
1470 Assembler code that must be preprocessed.
1471
1472 @item @var{other}
1473 An object file to be fed straight into linking.
1474 Any file name with no recognized suffix is treated this way.
1475 @end table
1476
1477 @opindex x
1478 You can specify the input language explicitly with the @option{-x} option:
1479
1480 @table @gcctabopt
1481 @item -x @var{language}
1482 Specify explicitly the @var{language} for the following input files
1483 (rather than letting the compiler choose a default based on the file
1484 name suffix). This option applies to all following input files until
1485 the next @option{-x} option. Possible values for @var{language} are:
1486 @smallexample
1487 c c-header cpp-output
1488 c++ c++-header c++-cpp-output
1489 objective-c objective-c-header objective-c-cpp-output
1490 objective-c++ objective-c++-header objective-c++-cpp-output
1491 assembler assembler-with-cpp
1492 ada
1493 d
1494 f77 f77-cpp-input f95 f95-cpp-input
1495 go
1496 brig
1497 @end smallexample
1498
1499 @item -x none
1500 Turn off any specification of a language, so that subsequent files are
1501 handled according to their file name suffixes (as they are if @option{-x}
1502 has not been used at all).
1503 @end table
1504
1505 If you only want some of the stages of compilation, you can use
1506 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1507 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1508 @command{gcc} is to stop. Note that some combinations (for example,
1509 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1510
1511 @table @gcctabopt
1512 @item -c
1513 @opindex c
1514 Compile or assemble the source files, but do not link. The linking
1515 stage simply is not done. The ultimate output is in the form of an
1516 object file for each source file.
1517
1518 By default, the object file name for a source file is made by replacing
1519 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1520
1521 Unrecognized input files, not requiring compilation or assembly, are
1522 ignored.
1523
1524 @item -S
1525 @opindex S
1526 Stop after the stage of compilation proper; do not assemble. The output
1527 is in the form of an assembler code file for each non-assembler input
1528 file specified.
1529
1530 By default, the assembler file name for a source file is made by
1531 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1532
1533 Input files that don't require compilation are ignored.
1534
1535 @item -E
1536 @opindex E
1537 Stop after the preprocessing stage; do not run the compiler proper. The
1538 output is in the form of preprocessed source code, which is sent to the
1539 standard output.
1540
1541 Input files that don't require preprocessing are ignored.
1542
1543 @cindex output file option
1544 @item -o @var{file}
1545 @opindex o
1546 Place output in file @var{file}. This applies to whatever
1547 sort of output is being produced, whether it be an executable file,
1548 an object file, an assembler file or preprocessed C code.
1549
1550 If @option{-o} is not specified, the default is to put an executable
1551 file in @file{a.out}, the object file for
1552 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1553 assembler file in @file{@var{source}.s}, a precompiled header file in
1554 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1555 standard output.
1556
1557 @item -v
1558 @opindex v
1559 Print (on standard error output) the commands executed to run the stages
1560 of compilation. Also print the version number of the compiler driver
1561 program and of the preprocessor and the compiler proper.
1562
1563 @item -###
1564 @opindex ###
1565 Like @option{-v} except the commands are not executed and arguments
1566 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1567 This is useful for shell scripts to capture the driver-generated command lines.
1568
1569 @item --help
1570 @opindex help
1571 Print (on the standard output) a description of the command-line options
1572 understood by @command{gcc}. If the @option{-v} option is also specified
1573 then @option{--help} is also passed on to the various processes
1574 invoked by @command{gcc}, so that they can display the command-line options
1575 they accept. If the @option{-Wextra} option has also been specified
1576 (prior to the @option{--help} option), then command-line options that
1577 have no documentation associated with them are also displayed.
1578
1579 @item --target-help
1580 @opindex target-help
1581 Print (on the standard output) a description of target-specific command-line
1582 options for each tool. For some targets extra target-specific
1583 information may also be printed.
1584
1585 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1586 Print (on the standard output) a description of the command-line
1587 options understood by the compiler that fit into all specified classes
1588 and qualifiers. These are the supported classes:
1589
1590 @table @asis
1591 @item @samp{optimizers}
1592 Display all of the optimization options supported by the
1593 compiler.
1594
1595 @item @samp{warnings}
1596 Display all of the options controlling warning messages
1597 produced by the compiler.
1598
1599 @item @samp{target}
1600 Display target-specific options. Unlike the
1601 @option{--target-help} option however, target-specific options of the
1602 linker and assembler are not displayed. This is because those
1603 tools do not currently support the extended @option{--help=} syntax.
1604
1605 @item @samp{params}
1606 Display the values recognized by the @option{--param}
1607 option.
1608
1609 @item @var{language}
1610 Display the options supported for @var{language}, where
1611 @var{language} is the name of one of the languages supported in this
1612 version of GCC@.
1613
1614 @item @samp{common}
1615 Display the options that are common to all languages.
1616 @end table
1617
1618 These are the supported qualifiers:
1619
1620 @table @asis
1621 @item @samp{undocumented}
1622 Display only those options that are undocumented.
1623
1624 @item @samp{joined}
1625 Display options taking an argument that appears after an equal
1626 sign in the same continuous piece of text, such as:
1627 @samp{--help=target}.
1628
1629 @item @samp{separate}
1630 Display options taking an argument that appears as a separate word
1631 following the original option, such as: @samp{-o output-file}.
1632 @end table
1633
1634 Thus for example to display all the undocumented target-specific
1635 switches supported by the compiler, use:
1636
1637 @smallexample
1638 --help=target,undocumented
1639 @end smallexample
1640
1641 The sense of a qualifier can be inverted by prefixing it with the
1642 @samp{^} character, so for example to display all binary warning
1643 options (i.e., ones that are either on or off and that do not take an
1644 argument) that have a description, use:
1645
1646 @smallexample
1647 --help=warnings,^joined,^undocumented
1648 @end smallexample
1649
1650 The argument to @option{--help=} should not consist solely of inverted
1651 qualifiers.
1652
1653 Combining several classes is possible, although this usually
1654 restricts the output so much that there is nothing to display. One
1655 case where it does work, however, is when one of the classes is
1656 @var{target}. For example, to display all the target-specific
1657 optimization options, use:
1658
1659 @smallexample
1660 --help=target,optimizers
1661 @end smallexample
1662
1663 The @option{--help=} option can be repeated on the command line. Each
1664 successive use displays its requested class of options, skipping
1665 those that have already been displayed. If @option{--help} is also
1666 specified anywhere on the command line then this takes precedence
1667 over any @option{--help=} option.
1668
1669 If the @option{-Q} option appears on the command line before the
1670 @option{--help=} option, then the descriptive text displayed by
1671 @option{--help=} is changed. Instead of describing the displayed
1672 options, an indication is given as to whether the option is enabled,
1673 disabled or set to a specific value (assuming that the compiler
1674 knows this at the point where the @option{--help=} option is used).
1675
1676 Here is a truncated example from the ARM port of @command{gcc}:
1677
1678 @smallexample
1679 % gcc -Q -mabi=2 --help=target -c
1680 The following options are target specific:
1681 -mabi= 2
1682 -mabort-on-noreturn [disabled]
1683 -mapcs [disabled]
1684 @end smallexample
1685
1686 The output is sensitive to the effects of previous command-line
1687 options, so for example it is possible to find out which optimizations
1688 are enabled at @option{-O2} by using:
1689
1690 @smallexample
1691 -Q -O2 --help=optimizers
1692 @end smallexample
1693
1694 Alternatively you can discover which binary optimizations are enabled
1695 by @option{-O3} by using:
1696
1697 @smallexample
1698 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1699 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1700 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1701 @end smallexample
1702
1703 @item --version
1704 @opindex version
1705 Display the version number and copyrights of the invoked GCC@.
1706
1707 @item -pass-exit-codes
1708 @opindex pass-exit-codes
1709 Normally the @command{gcc} program exits with the code of 1 if any
1710 phase of the compiler returns a non-success return code. If you specify
1711 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1712 the numerically highest error produced by any phase returning an error
1713 indication. The C, C++, and Fortran front ends return 4 if an internal
1714 compiler error is encountered.
1715
1716 @item -pipe
1717 @opindex pipe
1718 Use pipes rather than temporary files for communication between the
1719 various stages of compilation. This fails to work on some systems where
1720 the assembler is unable to read from a pipe; but the GNU assembler has
1721 no trouble.
1722
1723 @item -specs=@var{file}
1724 @opindex specs
1725 Process @var{file} after the compiler reads in the standard @file{specs}
1726 file, in order to override the defaults which the @command{gcc} driver
1727 program uses when determining what switches to pass to @command{cc1},
1728 @command{cc1plus}, @command{as}, @command{ld}, etc. More than one
1729 @option{-specs=@var{file}} can be specified on the command line, and they
1730 are processed in order, from left to right. @xref{Spec Files}, for
1731 information about the format of the @var{file}.
1732
1733 @item -wrapper
1734 @opindex wrapper
1735 Invoke all subcommands under a wrapper program. The name of the
1736 wrapper program and its parameters are passed as a comma separated
1737 list.
1738
1739 @smallexample
1740 gcc -c t.c -wrapper gdb,--args
1741 @end smallexample
1742
1743 @noindent
1744 This invokes all subprograms of @command{gcc} under
1745 @samp{gdb --args}, thus the invocation of @command{cc1} is
1746 @samp{gdb --args cc1 @dots{}}.
1747
1748 @item -ffile-prefix-map=@var{old}=@var{new}
1749 @opindex ffile-prefix-map
1750 When compiling files residing in directory @file{@var{old}}, record
1751 any references to them in the result of the compilation as if the
1752 files resided in directory @file{@var{new}} instead. Specifying this
1753 option is equivalent to specifying all the individual
1754 @option{-f*-prefix-map} options. This can be used to make reproducible
1755 builds that are location independent. See also
1756 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1757
1758 @item -fplugin=@var{name}.so
1759 @opindex fplugin
1760 Load the plugin code in file @var{name}.so, assumed to be a
1761 shared object to be dlopen'd by the compiler. The base name of
1762 the shared object file is used to identify the plugin for the
1763 purposes of argument parsing (See
1764 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1765 Each plugin should define the callback functions specified in the
1766 Plugins API.
1767
1768 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1769 @opindex fplugin-arg
1770 Define an argument called @var{key} with a value of @var{value}
1771 for the plugin called @var{name}.
1772
1773 @item -fdump-ada-spec@r{[}-slim@r{]}
1774 @opindex fdump-ada-spec
1775 For C and C++ source and include files, generate corresponding Ada specs.
1776 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1777 GNAT User's Guide}, which provides detailed documentation on this feature.
1778
1779 @item -fada-spec-parent=@var{unit}
1780 @opindex fada-spec-parent
1781 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1782 Ada specs as child units of parent @var{unit}.
1783
1784 @item -fdump-go-spec=@var{file}
1785 @opindex fdump-go-spec
1786 For input files in any language, generate corresponding Go
1787 declarations in @var{file}. This generates Go @code{const},
1788 @code{type}, @code{var}, and @code{func} declarations which may be a
1789 useful way to start writing a Go interface to code written in some
1790 other language.
1791
1792 @include @value{srcdir}/../libiberty/at-file.texi
1793 @end table
1794
1795 @node Invoking G++
1796 @section Compiling C++ Programs
1797
1798 @cindex suffixes for C++ source
1799 @cindex C++ source file suffixes
1800 C++ source files conventionally use one of the suffixes @samp{.C},
1801 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1802 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1803 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1804 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1805 files with these names and compiles them as C++ programs even if you
1806 call the compiler the same way as for compiling C programs (usually
1807 with the name @command{gcc}).
1808
1809 @findex g++
1810 @findex c++
1811 However, the use of @command{gcc} does not add the C++ library.
1812 @command{g++} is a program that calls GCC and automatically specifies linking
1813 against the C++ library. It treats @samp{.c},
1814 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1815 files unless @option{-x} is used. This program is also useful when
1816 precompiling a C header file with a @samp{.h} extension for use in C++
1817 compilations. On many systems, @command{g++} is also installed with
1818 the name @command{c++}.
1819
1820 @cindex invoking @command{g++}
1821 When you compile C++ programs, you may specify many of the same
1822 command-line options that you use for compiling programs in any
1823 language; or command-line options meaningful for C and related
1824 languages; or options that are meaningful only for C++ programs.
1825 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1826 explanations of options for languages related to C@.
1827 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1828 explanations of options that are meaningful only for C++ programs.
1829
1830 @node C Dialect Options
1831 @section Options Controlling C Dialect
1832 @cindex dialect options
1833 @cindex language dialect options
1834 @cindex options, dialect
1835
1836 The following options control the dialect of C (or languages derived
1837 from C, such as C++, Objective-C and Objective-C++) that the compiler
1838 accepts:
1839
1840 @table @gcctabopt
1841 @cindex ANSI support
1842 @cindex ISO support
1843 @item -ansi
1844 @opindex ansi
1845 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1846 equivalent to @option{-std=c++98}.
1847
1848 This turns off certain features of GCC that are incompatible with ISO
1849 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1850 such as the @code{asm} and @code{typeof} keywords, and
1851 predefined macros such as @code{unix} and @code{vax} that identify the
1852 type of system you are using. It also enables the undesirable and
1853 rarely used ISO trigraph feature. For the C compiler,
1854 it disables recognition of C++ style @samp{//} comments as well as
1855 the @code{inline} keyword.
1856
1857 The alternate keywords @code{__asm__}, @code{__extension__},
1858 @code{__inline__} and @code{__typeof__} continue to work despite
1859 @option{-ansi}. You would not want to use them in an ISO C program, of
1860 course, but it is useful to put them in header files that might be included
1861 in compilations done with @option{-ansi}. Alternate predefined macros
1862 such as @code{__unix__} and @code{__vax__} are also available, with or
1863 without @option{-ansi}.
1864
1865 The @option{-ansi} option does not cause non-ISO programs to be
1866 rejected gratuitously. For that, @option{-Wpedantic} is required in
1867 addition to @option{-ansi}. @xref{Warning Options}.
1868
1869 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1870 option is used. Some header files may notice this macro and refrain
1871 from declaring certain functions or defining certain macros that the
1872 ISO standard doesn't call for; this is to avoid interfering with any
1873 programs that might use these names for other things.
1874
1875 Functions that are normally built in but do not have semantics
1876 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1877 functions when @option{-ansi} is used. @xref{Other Builtins,,Other
1878 built-in functions provided by GCC}, for details of the functions
1879 affected.
1880
1881 @item -std=
1882 @opindex std
1883 Determine the language standard. @xref{Standards,,Language Standards
1884 Supported by GCC}, for details of these standard versions. This option
1885 is currently only supported when compiling C or C++.
1886
1887 The compiler can accept several base standards, such as @samp{c90} or
1888 @samp{c++98}, and GNU dialects of those standards, such as
1889 @samp{gnu90} or @samp{gnu++98}. When a base standard is specified, the
1890 compiler accepts all programs following that standard plus those
1891 using GNU extensions that do not contradict it. For example,
1892 @option{-std=c90} turns off certain features of GCC that are
1893 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1894 keywords, but not other GNU extensions that do not have a meaning in
1895 ISO C90, such as omitting the middle term of a @code{?:}
1896 expression. On the other hand, when a GNU dialect of a standard is
1897 specified, all features supported by the compiler are enabled, even when
1898 those features change the meaning of the base standard. As a result, some
1899 strict-conforming programs may be rejected. The particular standard
1900 is used by @option{-Wpedantic} to identify which features are GNU
1901 extensions given that version of the standard. For example
1902 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1903 comments, while @option{-std=gnu99 -Wpedantic} does not.
1904
1905 A value for this option must be provided; possible values are
1906
1907 @table @samp
1908 @item c90
1909 @itemx c89
1910 @itemx iso9899:1990
1911 Support all ISO C90 programs (certain GNU extensions that conflict
1912 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1913
1914 @item iso9899:199409
1915 ISO C90 as modified in amendment 1.
1916
1917 @item c99
1918 @itemx c9x
1919 @itemx iso9899:1999
1920 @itemx iso9899:199x
1921 ISO C99. This standard is substantially completely supported, modulo
1922 bugs and floating-point issues
1923 (mainly but not entirely relating to optional C99 features from
1924 Annexes F and G). See
1925 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1926 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1927
1928 @item c11
1929 @itemx c1x
1930 @itemx iso9899:2011
1931 ISO C11, the 2011 revision of the ISO C standard. This standard is
1932 substantially completely supported, modulo bugs, floating-point issues
1933 (mainly but not entirely relating to optional C11 features from
1934 Annexes F and G) and the optional Annexes K (Bounds-checking
1935 interfaces) and L (Analyzability). The name @samp{c1x} is deprecated.
1936
1937 @item c17
1938 @itemx c18
1939 @itemx iso9899:2017
1940 @itemx iso9899:2018
1941 ISO C17, the 2017 revision of the ISO C standard
1942 (published in 2018). This standard is
1943 same as C11 except for corrections of defects (all of which are also
1944 applied with @option{-std=c11}) and a new value of
1945 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1946
1947 @item c2x
1948 The next version of the ISO C standard, still under development. The
1949 support for this version is experimental and incomplete.
1950
1951 @item gnu90
1952 @itemx gnu89
1953 GNU dialect of ISO C90 (including some C99 features).
1954
1955 @item gnu99
1956 @itemx gnu9x
1957 GNU dialect of ISO C99. The name @samp{gnu9x} is deprecated.
1958
1959 @item gnu11
1960 @itemx gnu1x
1961 GNU dialect of ISO C11.
1962 The name @samp{gnu1x} is deprecated.
1963
1964 @item gnu17
1965 @itemx gnu18
1966 GNU dialect of ISO C17. This is the default for C code.
1967
1968 @item gnu2x
1969 The next version of the ISO C standard, still under development, plus
1970 GNU extensions. The support for this version is experimental and
1971 incomplete.
1972
1973 @item c++98
1974 @itemx c++03
1975 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1976 additional defect reports. Same as @option{-ansi} for C++ code.
1977
1978 @item gnu++98
1979 @itemx gnu++03
1980 GNU dialect of @option{-std=c++98}.
1981
1982 @item c++11
1983 @itemx c++0x
1984 The 2011 ISO C++ standard plus amendments.
1985 The name @samp{c++0x} is deprecated.
1986
1987 @item gnu++11
1988 @itemx gnu++0x
1989 GNU dialect of @option{-std=c++11}.
1990 The name @samp{gnu++0x} is deprecated.
1991
1992 @item c++14
1993 @itemx c++1y
1994 The 2014 ISO C++ standard plus amendments.
1995 The name @samp{c++1y} is deprecated.
1996
1997 @item gnu++14
1998 @itemx gnu++1y
1999 GNU dialect of @option{-std=c++14}.
2000 This is the default for C++ code.
2001 The name @samp{gnu++1y} is deprecated.
2002
2003 @item c++17
2004 @itemx c++1z
2005 The 2017 ISO C++ standard plus amendments.
2006 The name @samp{c++1z} is deprecated.
2007
2008 @item gnu++17
2009 @itemx gnu++1z
2010 GNU dialect of @option{-std=c++17}.
2011 The name @samp{gnu++1z} is deprecated.
2012
2013 @item c++2a
2014 The next revision of the ISO C++ standard, tentatively planned for
2015 2020. Support is highly experimental, and will almost certainly
2016 change in incompatible ways in future releases.
2017
2018 @item gnu++2a
2019 GNU dialect of @option{-std=c++2a}. Support is highly experimental,
2020 and will almost certainly change in incompatible ways in future
2021 releases.
2022 @end table
2023
2024 @item -fgnu89-inline
2025 @opindex fgnu89-inline
2026 The option @option{-fgnu89-inline} tells GCC to use the traditional
2027 GNU semantics for @code{inline} functions when in C99 mode.
2028 @xref{Inline,,An Inline Function is As Fast As a Macro}.
2029 Using this option is roughly equivalent to adding the
2030 @code{gnu_inline} function attribute to all inline functions
2031 (@pxref{Function Attributes}).
2032
2033 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
2034 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
2035 specifies the default behavior).
2036 This option is not supported in @option{-std=c90} or
2037 @option{-std=gnu90} mode.
2038
2039 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
2040 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
2041 in effect for @code{inline} functions. @xref{Common Predefined
2042 Macros,,,cpp,The C Preprocessor}.
2043
2044 @item -fpermitted-flt-eval-methods=@var{style}
2045 @opindex fpermitted-flt-eval-methods
2046 @opindex fpermitted-flt-eval-methods=c11
2047 @opindex fpermitted-flt-eval-methods=ts-18661-3
2048 ISO/IEC TS 18661-3 defines new permissible values for
2049 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2050 a semantic type that is an interchange or extended format should be
2051 evaluated to the precision and range of that type. These new values are
2052 a superset of those permitted under C99/C11, which does not specify the
2053 meaning of other positive values of @code{FLT_EVAL_METHOD}. As such, code
2054 conforming to C11 may not have been written expecting the possibility of
2055 the new values.
2056
2057 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2058 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2059 or the extended set of values specified in ISO/IEC TS 18661-3.
2060
2061 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2062
2063 The default when in a standards compliant mode (@option{-std=c11} or similar)
2064 is @option{-fpermitted-flt-eval-methods=c11}. The default when in a GNU
2065 dialect (@option{-std=gnu11} or similar) is
2066 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2067
2068 @item -aux-info @var{filename}
2069 @opindex aux-info
2070 Output to the given filename prototyped declarations for all functions
2071 declared and/or defined in a translation unit, including those in header
2072 files. This option is silently ignored in any language other than C@.
2073
2074 Besides declarations, the file indicates, in comments, the origin of
2075 each declaration (source file and line), whether the declaration was
2076 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2077 @samp{O} for old, respectively, in the first character after the line
2078 number and the colon), and whether it came from a declaration or a
2079 definition (@samp{C} or @samp{F}, respectively, in the following
2080 character). In the case of function definitions, a K&R-style list of
2081 arguments followed by their declarations is also provided, inside
2082 comments, after the declaration.
2083
2084 @item -fallow-parameterless-variadic-functions
2085 @opindex fallow-parameterless-variadic-functions
2086 Accept variadic functions without named parameters.
2087
2088 Although it is possible to define such a function, this is not very
2089 useful as it is not possible to read the arguments. This is only
2090 supported for C as this construct is allowed by C++.
2091
2092 @item -fno-asm
2093 @opindex fno-asm
2094 @opindex fasm
2095 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2096 keyword, so that code can use these words as identifiers. You can use
2097 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2098 instead. @option{-ansi} implies @option{-fno-asm}.
2099
2100 In C++, this switch only affects the @code{typeof} keyword, since
2101 @code{asm} and @code{inline} are standard keywords. You may want to
2102 use the @option{-fno-gnu-keywords} flag instead, which has the same
2103 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2104 switch only affects the @code{asm} and @code{typeof} keywords, since
2105 @code{inline} is a standard keyword in ISO C99.
2106
2107 @item -fno-builtin
2108 @itemx -fno-builtin-@var{function}
2109 @opindex fno-builtin
2110 @opindex fbuiltin
2111 @cindex built-in functions
2112 Don't recognize built-in functions that do not begin with
2113 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
2114 functions provided by GCC}, for details of the functions affected,
2115 including those which are not built-in functions when @option{-ansi} or
2116 @option{-std} options for strict ISO C conformance are used because they
2117 do not have an ISO standard meaning.
2118
2119 GCC normally generates special code to handle certain built-in functions
2120 more efficiently; for instance, calls to @code{alloca} may become single
2121 instructions which adjust the stack directly, and calls to @code{memcpy}
2122 may become inline copy loops. The resulting code is often both smaller
2123 and faster, but since the function calls no longer appear as such, you
2124 cannot set a breakpoint on those calls, nor can you change the behavior
2125 of the functions by linking with a different library. In addition,
2126 when a function is recognized as a built-in function, GCC may use
2127 information about that function to warn about problems with calls to
2128 that function, or to generate more efficient code, even if the
2129 resulting code still contains calls to that function. For example,
2130 warnings are given with @option{-Wformat} for bad calls to
2131 @code{printf} when @code{printf} is built in and @code{strlen} is
2132 known not to modify global memory.
2133
2134 With the @option{-fno-builtin-@var{function}} option
2135 only the built-in function @var{function} is
2136 disabled. @var{function} must not begin with @samp{__builtin_}. If a
2137 function is named that is not built-in in this version of GCC, this
2138 option is ignored. There is no corresponding
2139 @option{-fbuiltin-@var{function}} option; if you wish to enable
2140 built-in functions selectively when using @option{-fno-builtin} or
2141 @option{-ffreestanding}, you may define macros such as:
2142
2143 @smallexample
2144 #define abs(n) __builtin_abs ((n))
2145 #define strcpy(d, s) __builtin_strcpy ((d), (s))
2146 @end smallexample
2147
2148 @item -fgimple
2149 @opindex fgimple
2150
2151 Enable parsing of function definitions marked with @code{__GIMPLE}.
2152 This is an experimental feature that allows unit testing of GIMPLE
2153 passes.
2154
2155 @item -fhosted
2156 @opindex fhosted
2157 @cindex hosted environment
2158
2159 Assert that compilation targets a hosted environment. This implies
2160 @option{-fbuiltin}. A hosted environment is one in which the
2161 entire standard library is available, and in which @code{main} has a return
2162 type of @code{int}. Examples are nearly everything except a kernel.
2163 This is equivalent to @option{-fno-freestanding}.
2164
2165 @item -ffreestanding
2166 @opindex ffreestanding
2167 @cindex hosted environment
2168
2169 Assert that compilation targets a freestanding environment. This
2170 implies @option{-fno-builtin}. A freestanding environment
2171 is one in which the standard library may not exist, and program startup may
2172 not necessarily be at @code{main}. The most obvious example is an OS kernel.
2173 This is equivalent to @option{-fno-hosted}.
2174
2175 @xref{Standards,,Language Standards Supported by GCC}, for details of
2176 freestanding and hosted environments.
2177
2178 @item -fopenacc
2179 @opindex fopenacc
2180 @cindex OpenACC accelerator programming
2181 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2182 @code{!$acc} in Fortran. When @option{-fopenacc} is specified, the
2183 compiler generates accelerated code according to the OpenACC Application
2184 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}. This option
2185 implies @option{-pthread}, and thus is only supported on targets that
2186 have support for @option{-pthread}.
2187
2188 @item -fopenacc-dim=@var{geom}
2189 @opindex fopenacc-dim
2190 @cindex OpenACC accelerator programming
2191 Specify default compute dimensions for parallel offload regions that do
2192 not explicitly specify. The @var{geom} value is a triple of
2193 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'. A size
2194 can be omitted, to use a target-specific default value.
2195
2196 @item -fopenmp
2197 @opindex fopenmp
2198 @cindex OpenMP parallel
2199 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2200 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
2201 compiler generates parallel code according to the OpenMP Application
2202 Program Interface v4.5 @w{@uref{https://www.openmp.org}}. This option
2203 implies @option{-pthread}, and thus is only supported on targets that
2204 have support for @option{-pthread}. @option{-fopenmp} implies
2205 @option{-fopenmp-simd}.
2206
2207 @item -fopenmp-simd
2208 @opindex fopenmp-simd
2209 @cindex OpenMP SIMD
2210 @cindex SIMD
2211 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2212 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2213 are ignored.
2214
2215 @item -fgnu-tm
2216 @opindex fgnu-tm
2217 When the option @option{-fgnu-tm} is specified, the compiler
2218 generates code for the Linux variant of Intel's current Transactional
2219 Memory ABI specification document (Revision 1.1, May 6 2009). This is
2220 an experimental feature whose interface may change in future versions
2221 of GCC, as the official specification changes. Please note that not
2222 all architectures are supported for this feature.
2223
2224 For more information on GCC's support for transactional memory,
2225 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2226 Transactional Memory Library}.
2227
2228 Note that the transactional memory feature is not supported with
2229 non-call exceptions (@option{-fnon-call-exceptions}).
2230
2231 @item -fms-extensions
2232 @opindex fms-extensions
2233 Accept some non-standard constructs used in Microsoft header files.
2234
2235 In C++ code, this allows member names in structures to be similar
2236 to previous types declarations.
2237
2238 @smallexample
2239 typedef int UOW;
2240 struct ABC @{
2241 UOW UOW;
2242 @};
2243 @end smallexample
2244
2245 Some cases of unnamed fields in structures and unions are only
2246 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
2247 fields within structs/unions}, for details.
2248
2249 Note that this option is off for all targets except for x86
2250 targets using ms-abi.
2251
2252 @item -fplan9-extensions
2253 @opindex fplan9-extensions
2254 Accept some non-standard constructs used in Plan 9 code.
2255
2256 This enables @option{-fms-extensions}, permits passing pointers to
2257 structures with anonymous fields to functions that expect pointers to
2258 elements of the type of the field, and permits referring to anonymous
2259 fields declared using a typedef. @xref{Unnamed Fields,,Unnamed
2260 struct/union fields within structs/unions}, for details. This is only
2261 supported for C, not C++.
2262
2263 @item -fcond-mismatch
2264 @opindex fcond-mismatch
2265 Allow conditional expressions with mismatched types in the second and
2266 third arguments. The value of such an expression is void. This option
2267 is not supported for C++.
2268
2269 @item -flax-vector-conversions
2270 @opindex flax-vector-conversions
2271 Allow implicit conversions between vectors with differing numbers of
2272 elements and/or incompatible element types. This option should not be
2273 used for new code.
2274
2275 @item -funsigned-char
2276 @opindex funsigned-char
2277 Let the type @code{char} be unsigned, like @code{unsigned char}.
2278
2279 Each kind of machine has a default for what @code{char} should
2280 be. It is either like @code{unsigned char} by default or like
2281 @code{signed char} by default.
2282
2283 Ideally, a portable program should always use @code{signed char} or
2284 @code{unsigned char} when it depends on the signedness of an object.
2285 But many programs have been written to use plain @code{char} and
2286 expect it to be signed, or expect it to be unsigned, depending on the
2287 machines they were written for. This option, and its inverse, let you
2288 make such a program work with the opposite default.
2289
2290 The type @code{char} is always a distinct type from each of
2291 @code{signed char} or @code{unsigned char}, even though its behavior
2292 is always just like one of those two.
2293
2294 @item -fsigned-char
2295 @opindex fsigned-char
2296 Let the type @code{char} be signed, like @code{signed char}.
2297
2298 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2299 the negative form of @option{-funsigned-char}. Likewise, the option
2300 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2301
2302 @item -fsigned-bitfields
2303 @itemx -funsigned-bitfields
2304 @itemx -fno-signed-bitfields
2305 @itemx -fno-unsigned-bitfields
2306 @opindex fsigned-bitfields
2307 @opindex funsigned-bitfields
2308 @opindex fno-signed-bitfields
2309 @opindex fno-unsigned-bitfields
2310 These options control whether a bit-field is signed or unsigned, when the
2311 declaration does not use either @code{signed} or @code{unsigned}. By
2312 default, such a bit-field is signed, because this is consistent: the
2313 basic integer types such as @code{int} are signed types.
2314
2315 @item -fsso-struct=@var{endianness}
2316 @opindex fsso-struct
2317 Set the default scalar storage order of structures and unions to the
2318 specified endianness. The accepted values are @samp{big-endian},
2319 @samp{little-endian} and @samp{native} for the native endianness of
2320 the target (the default). This option is not supported for C++.
2321
2322 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2323 code that is not binary compatible with code generated without it if the
2324 specified endianness is not the native endianness of the target.
2325 @end table
2326
2327 @node C++ Dialect Options
2328 @section Options Controlling C++ Dialect
2329
2330 @cindex compiler options, C++
2331 @cindex C++ options, command-line
2332 @cindex options, C++
2333 This section describes the command-line options that are only meaningful
2334 for C++ programs. You can also use most of the GNU compiler options
2335 regardless of what language your program is in. For example, you
2336 might compile a file @file{firstClass.C} like this:
2337
2338 @smallexample
2339 g++ -g -fstrict-enums -O -c firstClass.C
2340 @end smallexample
2341
2342 @noindent
2343 In this example, only @option{-fstrict-enums} is an option meant
2344 only for C++ programs; you can use the other options with any
2345 language supported by GCC@.
2346
2347 Some options for compiling C programs, such as @option{-std}, are also
2348 relevant for C++ programs.
2349 @xref{C Dialect Options,,Options Controlling C Dialect}.
2350
2351 Here is a list of options that are @emph{only} for compiling C++ programs:
2352
2353 @table @gcctabopt
2354
2355 @item -fabi-version=@var{n}
2356 @opindex fabi-version
2357 Use version @var{n} of the C++ ABI@. The default is version 0.
2358
2359 Version 0 refers to the version conforming most closely to
2360 the C++ ABI specification. Therefore, the ABI obtained using version 0
2361 will change in different versions of G++ as ABI bugs are fixed.
2362
2363 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2364
2365 Version 2 is the version of the C++ ABI that first appeared in G++
2366 3.4, and was the default through G++ 4.9.
2367
2368 Version 3 corrects an error in mangling a constant address as a
2369 template argument.
2370
2371 Version 4, which first appeared in G++ 4.5, implements a standard
2372 mangling for vector types.
2373
2374 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2375 attribute const/volatile on function pointer types, decltype of a
2376 plain decl, and use of a function parameter in the declaration of
2377 another parameter.
2378
2379 Version 6, which first appeared in G++ 4.7, corrects the promotion
2380 behavior of C++11 scoped enums and the mangling of template argument
2381 packs, const/static_cast, prefix ++ and --, and a class scope function
2382 used as a template argument.
2383
2384 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2385 builtin type and corrects the mangling of lambdas in default argument
2386 scope.
2387
2388 Version 8, which first appeared in G++ 4.9, corrects the substitution
2389 behavior of function types with function-cv-qualifiers.
2390
2391 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2392 @code{nullptr_t}.
2393
2394 Version 10, which first appeared in G++ 6.1, adds mangling of
2395 attributes that affect type identity, such as ia32 calling convention
2396 attributes (e.g.@: @samp{stdcall}).
2397
2398 Version 11, which first appeared in G++ 7, corrects the mangling of
2399 sizeof... expressions and operator names. For multiple entities with
2400 the same name within a function, that are declared in different scopes,
2401 the mangling now changes starting with the twelfth occurrence. It also
2402 implies @option{-fnew-inheriting-ctors}.
2403
2404 Version 12, which first appeared in G++ 8, corrects the calling
2405 conventions for empty classes on the x86_64 target and for classes
2406 with only deleted copy/move constructors. It accidentally changes the
2407 calling convention for classes with a deleted copy constructor and a
2408 trivial move constructor.
2409
2410 Version 13, which first appeared in G++ 8.2, fixes the accidental
2411 change in version 12.
2412
2413 See also @option{-Wabi}.
2414
2415 @item -fabi-compat-version=@var{n}
2416 @opindex fabi-compat-version
2417 On targets that support strong aliases, G++
2418 works around mangling changes by creating an alias with the correct
2419 mangled name when defining a symbol with an incorrect mangled name.
2420 This switch specifies which ABI version to use for the alias.
2421
2422 With @option{-fabi-version=0} (the default), this defaults to 11 (GCC 7
2423 compatibility). If another ABI version is explicitly selected, this
2424 defaults to 0. For compatibility with GCC versions 3.2 through 4.9,
2425 use @option{-fabi-compat-version=2}.
2426
2427 If this option is not provided but @option{-Wabi=@var{n}} is, that
2428 version is used for compatibility aliases. If this option is provided
2429 along with @option{-Wabi} (without the version), the version from this
2430 option is used for the warning.
2431
2432 @item -fno-access-control
2433 @opindex fno-access-control
2434 @opindex faccess-control
2435 Turn off all access checking. This switch is mainly useful for working
2436 around bugs in the access control code.
2437
2438 @item -faligned-new
2439 @opindex faligned-new
2440 Enable support for C++17 @code{new} of types that require more
2441 alignment than @code{void* ::operator new(std::size_t)} provides. A
2442 numeric argument such as @code{-faligned-new=32} can be used to
2443 specify how much alignment (in bytes) is provided by that function,
2444 but few users will need to override the default of
2445 @code{alignof(std::max_align_t)}.
2446
2447 This flag is enabled by default for @option{-std=c++17}.
2448
2449 @item -fchar8_t
2450 @itemx -fno-char8_t
2451 @opindex fchar8_t
2452 @opindex fno-char8_t
2453 Enable support for @code{char8_t} as adopted for C++2a. This includes
2454 the addition of a new @code{char8_t} fundamental type, changes to the
2455 types of UTF-8 string and character literals, new signatures for
2456 user-defined literals, associated standard library updates, and new
2457 @code{__cpp_char8_t} and @code{__cpp_lib_char8_t} feature test macros.
2458
2459 This option enables functions to be overloaded for ordinary and UTF-8
2460 strings:
2461
2462 @smallexample
2463 int f(const char *); // #1
2464 int f(const char8_t *); // #2
2465 int v1 = f("text"); // Calls #1
2466 int v2 = f(u8"text"); // Calls #2
2467 @end smallexample
2468
2469 @noindent
2470 and introduces new signatures for user-defined literals:
2471
2472 @smallexample
2473 int operator""_udl1(char8_t);
2474 int v3 = u8'x'_udl1;
2475 int operator""_udl2(const char8_t*, std::size_t);
2476 int v4 = u8"text"_udl2;
2477 template<typename T, T...> int operator""_udl3();
2478 int v5 = u8"text"_udl3;
2479 @end smallexample
2480
2481 @noindent
2482 The change to the types of UTF-8 string and character literals introduces
2483 incompatibilities with ISO C++11 and later standards. For example, the
2484 following code is well-formed under ISO C++11, but is ill-formed when
2485 @option{-fchar8_t} is specified.
2486
2487 @smallexample
2488 char ca[] = u8"xx"; // error: char-array initialized from wide
2489 // string
2490 const char *cp = u8"xx";// error: invalid conversion from
2491 // `const char8_t*' to `const char*'
2492 int f(const char*);
2493 auto v = f(u8"xx"); // error: invalid conversion from
2494 // `const char8_t*' to `const char*'
2495 std::string s@{u8"xx"@}; // error: no matching function for call to
2496 // `std::basic_string<char>::basic_string()'
2497 using namespace std::literals;
2498 s = u8"xx"s; // error: conversion from
2499 // `basic_string<char8_t>' to non-scalar
2500 // type `basic_string<char>' requested
2501 @end smallexample
2502
2503 @item -fcheck-new
2504 @opindex fcheck-new
2505 Check that the pointer returned by @code{operator new} is non-null
2506 before attempting to modify the storage allocated. This check is
2507 normally unnecessary because the C++ standard specifies that
2508 @code{operator new} only returns @code{0} if it is declared
2509 @code{throw()}, in which case the compiler always checks the
2510 return value even without this option. In all other cases, when
2511 @code{operator new} has a non-empty exception specification, memory
2512 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
2513 @samp{new (nothrow)}.
2514
2515 @item -fconcepts
2516 @opindex fconcepts
2517 Enable support for the C++ Extensions for Concepts Technical
2518 Specification, ISO 19217 (2015), which allows code like
2519
2520 @smallexample
2521 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2522 template <Addable T> T add (T a, T b) @{ return a + b; @}
2523 @end smallexample
2524
2525 @item -fconstexpr-depth=@var{n}
2526 @opindex fconstexpr-depth
2527 Set the maximum nested evaluation depth for C++11 constexpr functions
2528 to @var{n}. A limit is needed to detect endless recursion during
2529 constant expression evaluation. The minimum specified by the standard
2530 is 512.
2531
2532 @item -fconstexpr-cache-depth=@var{n}
2533 @opindex fconstexpr-cache-depth
2534 Set the maximum level of nested evaluation depth for C++11 constexpr
2535 functions that will be cached to @var{n}. This is a heuristic that
2536 trades off compilation speed (when the cache avoids repeated
2537 calculations) against memory consumption (when the cache grows very
2538 large from highly recursive evaluations). The default is 8. Very few
2539 users are likely to want to adjust it, but if your code does heavy
2540 constexpr calculations you might want to experiment to find which
2541 value works best for you.
2542
2543 @item -fconstexpr-loop-limit=@var{n}
2544 @opindex fconstexpr-loop-limit
2545 Set the maximum number of iterations for a loop in C++14 constexpr functions
2546 to @var{n}. A limit is needed to detect infinite loops during
2547 constant expression evaluation. The default is 262144 (1<<18).
2548
2549 @item -fconstexpr-ops-limit=@var{n}
2550 @opindex fconstexpr-ops-limit
2551 Set the maximum number of operations during a single constexpr evaluation.
2552 Even when number of iterations of a single loop is limited with the above limit,
2553 if there are several nested loops and each of them has many iterations but still
2554 smaller than the above limit, or if in a body of some loop or even outside
2555 of a loop too many expressions need to be evaluated, the resulting constexpr
2556 evaluation might take too long.
2557 The default is 33554432 (1<<25).
2558
2559 @item -fdeduce-init-list
2560 @opindex fdeduce-init-list
2561 Enable deduction of a template type parameter as
2562 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2563
2564 @smallexample
2565 template <class T> auto forward(T t) -> decltype (realfn (t))
2566 @{
2567 return realfn (t);
2568 @}
2569
2570 void f()
2571 @{
2572 forward(@{1,2@}); // call forward<std::initializer_list<int>>
2573 @}
2574 @end smallexample
2575
2576 This deduction was implemented as a possible extension to the
2577 originally proposed semantics for the C++11 standard, but was not part
2578 of the final standard, so it is disabled by default. This option is
2579 deprecated, and may be removed in a future version of G++.
2580
2581 @item -fno-elide-constructors
2582 @opindex fno-elide-constructors
2583 @opindex felide-constructors
2584 The C++ standard allows an implementation to omit creating a temporary
2585 that is only used to initialize another object of the same type.
2586 Specifying this option disables that optimization, and forces G++ to
2587 call the copy constructor in all cases. This option also causes G++
2588 to call trivial member functions which otherwise would be expanded inline.
2589
2590 In C++17, the compiler is required to omit these temporaries, but this
2591 option still affects trivial member functions.
2592
2593 @item -fno-enforce-eh-specs
2594 @opindex fno-enforce-eh-specs
2595 @opindex fenforce-eh-specs
2596 Don't generate code to check for violation of exception specifications
2597 at run time. This option violates the C++ standard, but may be useful
2598 for reducing code size in production builds, much like defining
2599 @code{NDEBUG}. This does not give user code permission to throw
2600 exceptions in violation of the exception specifications; the compiler
2601 still optimizes based on the specifications, so throwing an
2602 unexpected exception results in undefined behavior at run time.
2603
2604 @item -fextern-tls-init
2605 @itemx -fno-extern-tls-init
2606 @opindex fextern-tls-init
2607 @opindex fno-extern-tls-init
2608 The C++11 and OpenMP standards allow @code{thread_local} and
2609 @code{threadprivate} variables to have dynamic (runtime)
2610 initialization. To support this, any use of such a variable goes
2611 through a wrapper function that performs any necessary initialization.
2612 When the use and definition of the variable are in the same
2613 translation unit, this overhead can be optimized away, but when the
2614 use is in a different translation unit there is significant overhead
2615 even if the variable doesn't actually need dynamic initialization. If
2616 the programmer can be sure that no use of the variable in a
2617 non-defining TU needs to trigger dynamic initialization (either
2618 because the variable is statically initialized, or a use of the
2619 variable in the defining TU will be executed before any uses in
2620 another TU), they can avoid this overhead with the
2621 @option{-fno-extern-tls-init} option.
2622
2623 On targets that support symbol aliases, the default is
2624 @option{-fextern-tls-init}. On targets that do not support symbol
2625 aliases, the default is @option{-fno-extern-tls-init}.
2626
2627 @item -fno-gnu-keywords
2628 @opindex fno-gnu-keywords
2629 @opindex fgnu-keywords
2630 Do not recognize @code{typeof} as a keyword, so that code can use this
2631 word as an identifier. You can use the keyword @code{__typeof__} instead.
2632 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2633 @option{-std=c++98}, @option{-std=c++11}, etc.
2634
2635 @item -fno-implicit-templates
2636 @opindex fno-implicit-templates
2637 @opindex fimplicit-templates
2638 Never emit code for non-inline templates that are instantiated
2639 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2640 If you use this option, you must take care to structure your code to
2641 include all the necessary explicit instantiations to avoid getting
2642 undefined symbols at link time.
2643 @xref{Template Instantiation}, for more information.
2644
2645 @item -fno-implicit-inline-templates
2646 @opindex fno-implicit-inline-templates
2647 @opindex fimplicit-inline-templates
2648 Don't emit code for implicit instantiations of inline templates, either.
2649 The default is to handle inlines differently so that compiles with and
2650 without optimization need the same set of explicit instantiations.
2651
2652 @item -fno-implement-inlines
2653 @opindex fno-implement-inlines
2654 @opindex fimplement-inlines
2655 To save space, do not emit out-of-line copies of inline functions
2656 controlled by @code{#pragma implementation}. This causes linker
2657 errors if these functions are not inlined everywhere they are called.
2658
2659 @item -fms-extensions
2660 @opindex fms-extensions
2661 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2662 int and getting a pointer to member function via non-standard syntax.
2663
2664 @item -fnew-inheriting-ctors
2665 @opindex fnew-inheriting-ctors
2666 Enable the P0136 adjustment to the semantics of C++11 constructor
2667 inheritance. This is part of C++17 but also considered to be a Defect
2668 Report against C++11 and C++14. This flag is enabled by default
2669 unless @option{-fabi-version=10} or lower is specified.
2670
2671 @item -fnew-ttp-matching
2672 @opindex fnew-ttp-matching
2673 Enable the P0522 resolution to Core issue 150, template template
2674 parameters and default arguments: this allows a template with default
2675 template arguments as an argument for a template template parameter
2676 with fewer template parameters. This flag is enabled by default for
2677 @option{-std=c++17}.
2678
2679 @item -fno-nonansi-builtins
2680 @opindex fno-nonansi-builtins
2681 @opindex fnonansi-builtins
2682 Disable built-in declarations of functions that are not mandated by
2683 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
2684 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2685
2686 @item -fnothrow-opt
2687 @opindex fnothrow-opt
2688 Treat a @code{throw()} exception specification as if it were a
2689 @code{noexcept} specification to reduce or eliminate the text size
2690 overhead relative to a function with no exception specification. If
2691 the function has local variables of types with non-trivial
2692 destructors, the exception specification actually makes the
2693 function smaller because the EH cleanups for those variables can be
2694 optimized away. The semantic effect is that an exception thrown out of
2695 a function with such an exception specification results in a call
2696 to @code{terminate} rather than @code{unexpected}.
2697
2698 @item -fno-operator-names
2699 @opindex fno-operator-names
2700 @opindex foperator-names
2701 Do not treat the operator name keywords @code{and}, @code{bitand},
2702 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2703 synonyms as keywords.
2704
2705 @item -fno-optional-diags
2706 @opindex fno-optional-diags
2707 @opindex foptional-diags
2708 Disable diagnostics that the standard says a compiler does not need to
2709 issue. Currently, the only such diagnostic issued by G++ is the one for
2710 a name having multiple meanings within a class.
2711
2712 @item -fpermissive
2713 @opindex fpermissive
2714 Downgrade some diagnostics about nonconformant code from errors to
2715 warnings. Thus, using @option{-fpermissive} allows some
2716 nonconforming code to compile.
2717
2718 @item -fno-pretty-templates
2719 @opindex fno-pretty-templates
2720 @opindex fpretty-templates
2721 When an error message refers to a specialization of a function
2722 template, the compiler normally prints the signature of the
2723 template followed by the template arguments and any typedefs or
2724 typenames in the signature (e.g.@: @code{void f(T) [with T = int]}
2725 rather than @code{void f(int)}) so that it's clear which template is
2726 involved. When an error message refers to a specialization of a class
2727 template, the compiler omits any template arguments that match
2728 the default template arguments for that template. If either of these
2729 behaviors make it harder to understand the error message rather than
2730 easier, you can use @option{-fno-pretty-templates} to disable them.
2731
2732 @item -frepo
2733 @opindex frepo
2734 Enable automatic template instantiation at link time. This option also
2735 implies @option{-fno-implicit-templates}. @xref{Template
2736 Instantiation}, for more information.
2737
2738 @item -fno-rtti
2739 @opindex fno-rtti
2740 @opindex frtti
2741 Disable generation of information about every class with virtual
2742 functions for use by the C++ run-time type identification features
2743 (@code{dynamic_cast} and @code{typeid}). If you don't use those parts
2744 of the language, you can save some space by using this flag. Note that
2745 exception handling uses the same information, but G++ generates it as
2746 needed. The @code{dynamic_cast} operator can still be used for casts that
2747 do not require run-time type information, i.e.@: casts to @code{void *} or to
2748 unambiguous base classes.
2749
2750 Mixing code compiled with @option{-frtti} with that compiled with
2751 @option{-fno-rtti} may not work. For example, programs may
2752 fail to link if a class compiled with @option{-fno-rtti} is used as a base
2753 for a class compiled with @option{-frtti}.
2754
2755 @item -fsized-deallocation
2756 @opindex fsized-deallocation
2757 Enable the built-in global declarations
2758 @smallexample
2759 void operator delete (void *, std::size_t) noexcept;
2760 void operator delete[] (void *, std::size_t) noexcept;
2761 @end smallexample
2762 as introduced in C++14. This is useful for user-defined replacement
2763 deallocation functions that, for example, use the size of the object
2764 to make deallocation faster. Enabled by default under
2765 @option{-std=c++14} and above. The flag @option{-Wsized-deallocation}
2766 warns about places that might want to add a definition.
2767
2768 @item -fstrict-enums
2769 @opindex fstrict-enums
2770 Allow the compiler to optimize using the assumption that a value of
2771 enumerated type can only be one of the values of the enumeration (as
2772 defined in the C++ standard; basically, a value that can be
2773 represented in the minimum number of bits needed to represent all the
2774 enumerators). This assumption may not be valid if the program uses a
2775 cast to convert an arbitrary integer value to the enumerated type.
2776
2777 @item -fstrong-eval-order
2778 @opindex fstrong-eval-order
2779 Evaluate member access, array subscripting, and shift expressions in
2780 left-to-right order, and evaluate assignment in right-to-left order,
2781 as adopted for C++17. Enabled by default with @option{-std=c++17}.
2782 @option{-fstrong-eval-order=some} enables just the ordering of member
2783 access and shift expressions, and is the default without
2784 @option{-std=c++17}.
2785
2786 @item -ftemplate-backtrace-limit=@var{n}
2787 @opindex ftemplate-backtrace-limit
2788 Set the maximum number of template instantiation notes for a single
2789 warning or error to @var{n}. The default value is 10.
2790
2791 @item -ftemplate-depth=@var{n}
2792 @opindex ftemplate-depth
2793 Set the maximum instantiation depth for template classes to @var{n}.
2794 A limit on the template instantiation depth is needed to detect
2795 endless recursions during template class instantiation. ANSI/ISO C++
2796 conforming programs must not rely on a maximum depth greater than 17
2797 (changed to 1024 in C++11). The default value is 900, as the compiler
2798 can run out of stack space before hitting 1024 in some situations.
2799
2800 @item -fno-threadsafe-statics
2801 @opindex fno-threadsafe-statics
2802 @opindex fthreadsafe-statics
2803 Do not emit the extra code to use the routines specified in the C++
2804 ABI for thread-safe initialization of local statics. You can use this
2805 option to reduce code size slightly in code that doesn't need to be
2806 thread-safe.
2807
2808 @item -fuse-cxa-atexit
2809 @opindex fuse-cxa-atexit
2810 Register destructors for objects with static storage duration with the
2811 @code{__cxa_atexit} function rather than the @code{atexit} function.
2812 This option is required for fully standards-compliant handling of static
2813 destructors, but only works if your C library supports
2814 @code{__cxa_atexit}.
2815
2816 @item -fno-use-cxa-get-exception-ptr
2817 @opindex fno-use-cxa-get-exception-ptr
2818 @opindex fuse-cxa-get-exception-ptr
2819 Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
2820 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2821 if the runtime routine is not available.
2822
2823 @item -fvisibility-inlines-hidden
2824 @opindex fvisibility-inlines-hidden
2825 This switch declares that the user does not attempt to compare
2826 pointers to inline functions or methods where the addresses of the two functions
2827 are taken in different shared objects.
2828
2829 The effect of this is that GCC may, effectively, mark inline methods with
2830 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2831 appear in the export table of a DSO and do not require a PLT indirection
2832 when used within the DSO@. Enabling this option can have a dramatic effect
2833 on load and link times of a DSO as it massively reduces the size of the
2834 dynamic export table when the library makes heavy use of templates.
2835
2836 The behavior of this switch is not quite the same as marking the
2837 methods as hidden directly, because it does not affect static variables
2838 local to the function or cause the compiler to deduce that
2839 the function is defined in only one shared object.
2840
2841 You may mark a method as having a visibility explicitly to negate the
2842 effect of the switch for that method. For example, if you do want to
2843 compare pointers to a particular inline method, you might mark it as
2844 having default visibility. Marking the enclosing class with explicit
2845 visibility has no effect.
2846
2847 Explicitly instantiated inline methods are unaffected by this option
2848 as their linkage might otherwise cross a shared library boundary.
2849 @xref{Template Instantiation}.
2850
2851 @item -fvisibility-ms-compat
2852 @opindex fvisibility-ms-compat
2853 This flag attempts to use visibility settings to make GCC's C++
2854 linkage model compatible with that of Microsoft Visual Studio.
2855
2856 The flag makes these changes to GCC's linkage model:
2857
2858 @enumerate
2859 @item
2860 It sets the default visibility to @code{hidden}, like
2861 @option{-fvisibility=hidden}.
2862
2863 @item
2864 Types, but not their members, are not hidden by default.
2865
2866 @item
2867 The One Definition Rule is relaxed for types without explicit
2868 visibility specifications that are defined in more than one
2869 shared object: those declarations are permitted if they are
2870 permitted when this option is not used.
2871 @end enumerate
2872
2873 In new code it is better to use @option{-fvisibility=hidden} and
2874 export those classes that are intended to be externally visible.
2875 Unfortunately it is possible for code to rely, perhaps accidentally,
2876 on the Visual Studio behavior.
2877
2878 Among the consequences of these changes are that static data members
2879 of the same type with the same name but defined in different shared
2880 objects are different, so changing one does not change the other;
2881 and that pointers to function members defined in different shared
2882 objects may not compare equal. When this flag is given, it is a
2883 violation of the ODR to define types with the same name differently.
2884
2885 @item -fno-weak
2886 @opindex fno-weak
2887 @opindex fweak
2888 Do not use weak symbol support, even if it is provided by the linker.
2889 By default, G++ uses weak symbols if they are available. This
2890 option exists only for testing, and should not be used by end-users;
2891 it results in inferior code and has no benefits. This option may
2892 be removed in a future release of G++.
2893
2894 @item -nostdinc++
2895 @opindex nostdinc++
2896 Do not search for header files in the standard directories specific to
2897 C++, but do still search the other standard directories. (This option
2898 is used when building the C++ library.)
2899 @end table
2900
2901 In addition, these optimization, warning, and code generation options
2902 have meanings only for C++ programs:
2903
2904 @table @gcctabopt
2905 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2906 @opindex Wabi
2907 @opindex Wno-abi
2908 Warn when G++ it generates code that is probably not compatible with
2909 the vendor-neutral C++ ABI@. Since G++ now defaults to updating the
2910 ABI with each major release, normally @option{-Wabi} will warn only if
2911 there is a check added later in a release series for an ABI issue
2912 discovered since the initial release. @option{-Wabi} will warn about
2913 more things if an older ABI version is selected (with
2914 @option{-fabi-version=@var{n}}).
2915
2916 @option{-Wabi} can also be used with an explicit version number to
2917 warn about compatibility with a particular @option{-fabi-version}
2918 level, e.g.@: @option{-Wabi=2} to warn about changes relative to
2919 @option{-fabi-version=2}.
2920
2921 If an explicit version number is provided and
2922 @option{-fabi-compat-version} is not specified, the version number
2923 from this option is used for compatibility aliases. If no explicit
2924 version number is provided with this option, but
2925 @option{-fabi-compat-version} is specified, that version number is
2926 used for ABI warnings.
2927
2928 Although an effort has been made to warn about
2929 all such cases, there are probably some cases that are not warned about,
2930 even though G++ is generating incompatible code. There may also be
2931 cases where warnings are emitted even though the code that is generated
2932 is compatible.
2933
2934 You should rewrite your code to avoid these warnings if you are
2935 concerned about the fact that code generated by G++ may not be binary
2936 compatible with code generated by other compilers.
2937
2938 Known incompatibilities in @option{-fabi-version=2} (which was the
2939 default from GCC 3.4 to 4.9) include:
2940
2941 @itemize @bullet
2942
2943 @item
2944 A template with a non-type template parameter of reference type was
2945 mangled incorrectly:
2946 @smallexample
2947 extern int N;
2948 template <int &> struct S @{@};
2949 void n (S<N>) @{2@}
2950 @end smallexample
2951
2952 This was fixed in @option{-fabi-version=3}.
2953
2954 @item
2955 SIMD vector types declared using @code{__attribute ((vector_size))} were
2956 mangled in a non-standard way that does not allow for overloading of
2957 functions taking vectors of different sizes.
2958
2959 The mangling was changed in @option{-fabi-version=4}.
2960
2961 @item
2962 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2963 qualifiers, and @code{decltype} of a plain declaration was folded away.
2964
2965 These mangling issues were fixed in @option{-fabi-version=5}.
2966
2967 @item
2968 Scoped enumerators passed as arguments to a variadic function are
2969 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2970 On most targets this does not actually affect the parameter passing
2971 ABI, as there is no way to pass an argument smaller than @code{int}.
2972
2973 Also, the ABI changed the mangling of template argument packs,
2974 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2975 a class scope function used as a template argument.
2976
2977 These issues were corrected in @option{-fabi-version=6}.
2978
2979 @item
2980 Lambdas in default argument scope were mangled incorrectly, and the
2981 ABI changed the mangling of @code{nullptr_t}.
2982
2983 These issues were corrected in @option{-fabi-version=7}.
2984
2985 @item
2986 When mangling a function type with function-cv-qualifiers, the
2987 un-qualified function type was incorrectly treated as a substitution
2988 candidate.
2989
2990 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2991
2992 @item
2993 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2994 unaligned accesses. Note that this did not affect the ABI of a
2995 function with a @code{nullptr_t} parameter, as parameters have a
2996 minimum alignment.
2997
2998 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2999
3000 @item
3001 Target-specific attributes that affect the identity of a type, such as
3002 ia32 calling conventions on a function type (stdcall, regparm, etc.),
3003 did not affect the mangled name, leading to name collisions when
3004 function pointers were used as template arguments.
3005
3006 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
3007
3008 @end itemize
3009
3010 It also warns about psABI-related changes. The known psABI changes at this
3011 point include:
3012
3013 @itemize @bullet
3014
3015 @item
3016 For SysV/x86-64, unions with @code{long double} members are
3017 passed in memory as specified in psABI. For example:
3018
3019 @smallexample
3020 union U @{
3021 long double ld;
3022 int i;
3023 @};
3024 @end smallexample
3025
3026 @noindent
3027 @code{union U} is always passed in memory.
3028
3029 @end itemize
3030
3031 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
3032 @opindex Wabi-tag
3033 @opindex Wabi-tag
3034 Warn when a type with an ABI tag is used in a context that does not
3035 have that ABI tag. See @ref{C++ Attributes} for more information
3036 about ABI tags.
3037
3038 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
3039 @opindex Wctor-dtor-privacy
3040 @opindex Wno-ctor-dtor-privacy
3041 Warn when a class seems unusable because all the constructors or
3042 destructors in that class are private, and it has neither friends nor
3043 public static member functions. Also warn if there are no non-private
3044 methods, and there's at least one private member function that isn't
3045 a constructor or destructor.
3046
3047 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
3048 @opindex Wdelete-non-virtual-dtor
3049 @opindex Wno-delete-non-virtual-dtor
3050 Warn when @code{delete} is used to destroy an instance of a class that
3051 has virtual functions and non-virtual destructor. It is unsafe to delete
3052 an instance of a derived class through a pointer to a base class if the
3053 base class does not have a virtual destructor. This warning is enabled
3054 by @option{-Wall}.
3055
3056 @item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
3057 @opindex Wdeprecated-copy
3058 @opindex Wno-deprecated-copy
3059 Warn that the implicit declaration of a copy constructor or copy
3060 assignment operator is deprecated if the class has a user-provided
3061 copy constructor or copy assignment operator, in C++11 and up. This
3062 warning is enabled by @option{-Wextra}. With
3063 @option{-Wdeprecated-copy-dtor}, also deprecate if the class has a
3064 user-provided destructor.
3065
3066 @item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)}
3067 @opindex Winit-list-lifetime
3068 @opindex Wno-init-list-lifetime
3069 Do not warn about uses of @code{std::initializer_list} that are likely
3070 to result in dangling pointers. Since the underlying array for an
3071 @code{initializer_list} is handled like a normal C++ temporary object,
3072 it is easy to inadvertently keep a pointer to the array past the end
3073 of the array's lifetime. For example:
3074
3075 @itemize @bullet
3076 @item
3077 If a function returns a temporary @code{initializer_list}, or a local
3078 @code{initializer_list} variable, the array's lifetime ends at the end
3079 of the return statement, so the value returned has a dangling pointer.
3080
3081 @item
3082 If a new-expression creates an @code{initializer_list}, the array only
3083 lives until the end of the enclosing full-expression, so the
3084 @code{initializer_list} in the heap has a dangling pointer.
3085
3086 @item
3087 When an @code{initializer_list} variable is assigned from a
3088 brace-enclosed initializer list, the temporary array created for the
3089 right side of the assignment only lives until the end of the
3090 full-expression, so at the next statement the @code{initializer_list}
3091 variable has a dangling pointer.
3092
3093 @smallexample
3094 // li's initial underlying array lives as long as li
3095 std::initializer_list<int> li = @{ 1,2,3 @};
3096 // assignment changes li to point to a temporary array
3097 li = @{ 4, 5 @};
3098 // now the temporary is gone and li has a dangling pointer
3099 int i = li.begin()[0] // undefined behavior
3100 @end smallexample
3101
3102 @item
3103 When a list constructor stores the @code{begin} pointer from the
3104 @code{initializer_list} argument, this doesn't extend the lifetime of
3105 the array, so if a class variable is constructed from a temporary
3106 @code{initializer_list}, the pointer is left dangling by the end of
3107 the variable declaration statement.
3108
3109 @end itemize
3110
3111 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
3112 @opindex Wliteral-suffix
3113 @opindex Wno-literal-suffix
3114 Warn when a string or character literal is followed by a ud-suffix which does
3115 not begin with an underscore. As a conforming extension, GCC treats such
3116 suffixes as separate preprocessing tokens in order to maintain backwards
3117 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
3118 For example:
3119
3120 @smallexample
3121 #define __STDC_FORMAT_MACROS
3122 #include <inttypes.h>
3123 #include <stdio.h>
3124
3125 int main() @{
3126 int64_t i64 = 123;
3127 printf("My int64: %" PRId64"\n", i64);
3128 @}
3129 @end smallexample
3130
3131 In this case, @code{PRId64} is treated as a separate preprocessing token.
3132
3133 Additionally, warn when a user-defined literal operator is declared with
3134 a literal suffix identifier that doesn't begin with an underscore. Literal
3135 suffix identifiers that don't begin with an underscore are reserved for
3136 future standardization.
3137
3138 This warning is enabled by default.
3139
3140 @item -Wlto-type-mismatch
3141 @opindex Wlto-type-mismatch
3142 @opindex Wno-lto-type-mismatch
3143
3144 During the link-time optimization warn about type mismatches in
3145 global declarations from different compilation units.
3146 Requires @option{-flto} to be enabled. Enabled by default.
3147
3148 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
3149 @opindex Wnarrowing
3150 @opindex Wno-narrowing
3151 For C++11 and later standards, narrowing conversions are diagnosed by default,
3152 as required by the standard. A narrowing conversion from a constant produces
3153 an error, and a narrowing conversion from a non-constant produces a warning,
3154 but @option{-Wno-narrowing} suppresses the diagnostic.
3155 Note that this does not affect the meaning of well-formed code;
3156 narrowing conversions are still considered ill-formed in SFINAE contexts.
3157
3158 With @option{-Wnarrowing} in C++98, warn when a narrowing
3159 conversion prohibited by C++11 occurs within
3160 @samp{@{ @}}, e.g.
3161
3162 @smallexample
3163 int i = @{ 2.2 @}; // error: narrowing from double to int
3164 @end smallexample
3165
3166 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
3167
3168 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
3169 @opindex Wnoexcept
3170 @opindex Wno-noexcept
3171 Warn when a noexcept-expression evaluates to false because of a call
3172 to a function that does not have a non-throwing exception
3173 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
3174 the compiler to never throw an exception.
3175
3176 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
3177 @opindex Wnoexcept-type
3178 @opindex Wno-noexcept-type
3179 Warn if the C++17 feature making @code{noexcept} part of a function
3180 type changes the mangled name of a symbol relative to C++14. Enabled
3181 by @option{-Wabi} and @option{-Wc++17-compat}.
3182
3183 As an example:
3184
3185 @smallexample
3186 template <class T> void f(T t) @{ t(); @};
3187 void g() noexcept;
3188 void h() @{ f(g); @}
3189 @end smallexample
3190
3191 @noindent
3192 In C++14, @code{f} calls @code{f<void(*)()>}, but in
3193 C++17 it calls @code{f<void(*)()noexcept>}.
3194
3195 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
3196 @opindex Wclass-memaccess
3197 @opindex Wno-class-memaccess
3198 Warn when the destination of a call to a raw memory function such as
3199 @code{memset} or @code{memcpy} is an object of class type, and when writing
3200 into such an object might bypass the class non-trivial or deleted constructor
3201 or copy assignment, violate const-correctness or encapsulation, or corrupt
3202 virtual table pointers. Modifying the representation of such objects may
3203 violate invariants maintained by member functions of the class. For example,
3204 the call to @code{memset} below is undefined because it modifies a non-trivial
3205 class object and is, therefore, diagnosed. The safe way to either initialize
3206 or clear the storage of objects of such types is by using the appropriate
3207 constructor or assignment operator, if one is available.
3208 @smallexample
3209 std::string str = "abc";
3210 memset (&str, 0, sizeof str);
3211 @end smallexample
3212 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3213 Explicitly casting the pointer to the class object to @code{void *} or
3214 to a type that can be safely accessed by the raw memory function suppresses
3215 the warning.
3216
3217 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3218 @opindex Wnon-virtual-dtor
3219 @opindex Wno-non-virtual-dtor
3220 Warn when a class has virtual functions and an accessible non-virtual
3221 destructor itself or in an accessible polymorphic base class, in which
3222 case it is possible but unsafe to delete an instance of a derived
3223 class through a pointer to the class itself or base class. This
3224 warning is automatically enabled if @option{-Weffc++} is specified.
3225
3226 @item -Wregister @r{(C++ and Objective-C++ only)}
3227 @opindex Wregister
3228 @opindex Wno-register
3229 Warn on uses of the @code{register} storage class specifier, except
3230 when it is part of the GNU @ref{Explicit Register Variables} extension.
3231 The use of the @code{register} keyword as storage class specifier has
3232 been deprecated in C++11 and removed in C++17.
3233 Enabled by default with @option{-std=c++17}.
3234
3235 @item -Wreorder @r{(C++ and Objective-C++ only)}
3236 @opindex Wreorder
3237 @opindex Wno-reorder
3238 @cindex reordering, warning
3239 @cindex warning for reordering of member initializers
3240 Warn when the order of member initializers given in the code does not
3241 match the order in which they must be executed. For instance:
3242
3243 @smallexample
3244 struct A @{
3245 int i;
3246 int j;
3247 A(): j (0), i (1) @{ @}
3248 @};
3249 @end smallexample
3250
3251 @noindent
3252 The compiler rearranges the member initializers for @code{i}
3253 and @code{j} to match the declaration order of the members, emitting
3254 a warning to that effect. This warning is enabled by @option{-Wall}.
3255
3256 @item -Wno-pessimizing-move @r{(C++ and Objective-C++ only)}
3257 @opindex Wpessimizing-move
3258 @opindex Wno-pessimizing-move
3259 This warning warns when a call to @code{std::move} prevents copy
3260 elision. A typical scenario when copy elision can occur is when returning in
3261 a function with a class return type, when the expression being returned is the
3262 name of a non-volatile automatic object, and is not a function parameter, and
3263 has the same type as the function return type.
3264
3265 @smallexample
3266 struct T @{
3267 @dots{}
3268 @};
3269 T fn()
3270 @{
3271 T t;
3272 @dots{}
3273 return std::move (t);
3274 @}
3275 @end smallexample
3276
3277 But in this example, the @code{std::move} call prevents copy elision.
3278
3279 This warning is enabled by @option{-Wall}.
3280
3281 @item -Wno-redundant-move @r{(C++ and Objective-C++ only)}
3282 @opindex Wredundant-move
3283 @opindex Wno-redundant-move
3284 This warning warns about redundant calls to @code{std::move}; that is, when
3285 a move operation would have been performed even without the @code{std::move}
3286 call. This happens because the compiler is forced to treat the object as if
3287 it were an rvalue in certain situations such as returning a local variable,
3288 where copy elision isn't applicable. Consider:
3289
3290 @smallexample
3291 struct T @{
3292 @dots{}
3293 @};
3294 T fn(T t)
3295 @{
3296 @dots{}
3297 return std::move (t);
3298 @}
3299 @end smallexample
3300
3301 Here, the @code{std::move} call is redundant. Because G++ implements Core
3302 Issue 1579, another example is:
3303
3304 @smallexample
3305 struct T @{ // convertible to U
3306 @dots{}
3307 @};
3308 struct U @{
3309 @dots{}
3310 @};
3311 U fn()
3312 @{
3313 T t;
3314 @dots{}
3315 return std::move (t);
3316 @}
3317 @end smallexample
3318 In this example, copy elision isn't applicable because the type of the
3319 expression being returned and the function return type differ, yet G++
3320 treats the return value as if it were designated by an rvalue.
3321
3322 This warning is enabled by @option{-Wextra}.
3323
3324 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3325 @opindex fext-numeric-literals
3326 @opindex fno-ext-numeric-literals
3327 Accept imaginary, fixed-point, or machine-defined
3328 literal number suffixes as GNU extensions.
3329 When this option is turned off these suffixes are treated
3330 as C++11 user-defined literal numeric suffixes.
3331 This is on by default for all pre-C++11 dialects and all GNU dialects:
3332 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3333 @option{-std=gnu++14}.
3334 This option is off by default
3335 for ISO C++11 onwards (@option{-std=c++11}, ...).
3336 @end table
3337
3338 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3339
3340 @table @gcctabopt
3341 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3342 @opindex Weffc++
3343 @opindex Wno-effc++
3344 Warn about violations of the following style guidelines from Scott Meyers'
3345 @cite{Effective C++} series of books:
3346
3347 @itemize @bullet
3348 @item
3349 Define a copy constructor and an assignment operator for classes
3350 with dynamically-allocated memory.
3351
3352 @item
3353 Prefer initialization to assignment in constructors.
3354
3355 @item
3356 Have @code{operator=} return a reference to @code{*this}.
3357
3358 @item
3359 Don't try to return a reference when you must return an object.
3360
3361 @item
3362 Distinguish between prefix and postfix forms of increment and
3363 decrement operators.
3364
3365 @item
3366 Never overload @code{&&}, @code{||}, or @code{,}.
3367
3368 @end itemize
3369
3370 This option also enables @option{-Wnon-virtual-dtor}, which is also
3371 one of the effective C++ recommendations. However, the check is
3372 extended to warn about the lack of virtual destructor in accessible
3373 non-polymorphic bases classes too.
3374
3375 When selecting this option, be aware that the standard library
3376 headers do not obey all of these guidelines; use @samp{grep -v}
3377 to filter out those warnings.
3378
3379 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3380 @opindex Wstrict-null-sentinel
3381 @opindex Wno-strict-null-sentinel
3382 Warn about the use of an uncasted @code{NULL} as sentinel. When
3383 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3384 to @code{__null}. Although it is a null pointer constant rather than a
3385 null pointer, it is guaranteed to be of the same size as a pointer.
3386 But this use is not portable across different compilers.
3387
3388 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3389 @opindex Wno-non-template-friend
3390 @opindex Wnon-template-friend
3391 Disable warnings when non-template friend functions are declared
3392 within a template. In very old versions of GCC that predate implementation
3393 of the ISO standard, declarations such as
3394 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3395 could be interpreted as a particular specialization of a template
3396 function; the warning exists to diagnose compatibility problems,
3397 and is enabled by default.
3398
3399 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3400 @opindex Wold-style-cast
3401 @opindex Wno-old-style-cast
3402 Warn if an old-style (C-style) cast to a non-void type is used within
3403 a C++ program. The new-style casts (@code{dynamic_cast},
3404 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3405 less vulnerable to unintended effects and much easier to search for.
3406
3407 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3408 @opindex Woverloaded-virtual
3409 @opindex Wno-overloaded-virtual
3410 @cindex overloaded virtual function, warning
3411 @cindex warning for overloaded virtual function
3412 Warn when a function declaration hides virtual functions from a
3413 base class. For example, in:
3414
3415 @smallexample
3416 struct A @{
3417 virtual void f();
3418 @};
3419
3420 struct B: public A @{
3421 void f(int);
3422 @};
3423 @end smallexample
3424
3425 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3426 like:
3427
3428 @smallexample
3429 B* b;
3430 b->f();
3431 @end smallexample
3432
3433 @noindent
3434 fails to compile.
3435
3436 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3437 @opindex Wno-pmf-conversions
3438 @opindex Wpmf-conversions
3439 Disable the diagnostic for converting a bound pointer to member function
3440 to a plain pointer.
3441
3442 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3443 @opindex Wsign-promo
3444 @opindex Wno-sign-promo
3445 Warn when overload resolution chooses a promotion from unsigned or
3446 enumerated type to a signed type, over a conversion to an unsigned type of
3447 the same size. Previous versions of G++ tried to preserve
3448 unsignedness, but the standard mandates the current behavior.
3449
3450 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3451 @opindex Wtemplates
3452 @opindex Wno-templates
3453 Warn when a primary template declaration is encountered. Some coding
3454 rules disallow templates, and this may be used to enforce that rule.
3455 The warning is inactive inside a system header file, such as the STL, so
3456 one can still use the STL. One may also instantiate or specialize
3457 templates.
3458
3459 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3460 @opindex Wmultiple-inheritance
3461 @opindex Wno-multiple-inheritance
3462 Warn when a class is defined with multiple direct base classes. Some
3463 coding rules disallow multiple inheritance, and this may be used to
3464 enforce that rule. The warning is inactive inside a system header file,
3465 such as the STL, so one can still use the STL. One may also define
3466 classes that indirectly use multiple inheritance.
3467
3468 @item -Wvirtual-inheritance
3469 @opindex Wvirtual-inheritance
3470 @opindex Wno-virtual-inheritance
3471 Warn when a class is defined with a virtual direct base class. Some
3472 coding rules disallow multiple inheritance, and this may be used to
3473 enforce that rule. The warning is inactive inside a system header file,
3474 such as the STL, so one can still use the STL. One may also define
3475 classes that indirectly use virtual inheritance.
3476
3477 @item -Wnamespaces
3478 @opindex Wnamespaces
3479 @opindex Wno-namespaces
3480 Warn when a namespace definition is opened. Some coding rules disallow
3481 namespaces, and this may be used to enforce that rule. The warning is
3482 inactive inside a system header file, such as the STL, so one can still
3483 use the STL. One may also use using directives and qualified names.
3484
3485 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3486 @opindex Wterminate
3487 @opindex Wno-terminate
3488 Disable the warning about a throw-expression that will immediately
3489 result in a call to @code{terminate}.
3490
3491 @item -Wno-class-conversion @r{(C++ and Objective-C++ only)}
3492 @opindex Wno-class-conversion
3493 @opindex Wclass-conversion
3494 Disable the warning about the case when a conversion function converts an
3495 object to the same type, to a base class of that type, or to void; such
3496 a conversion function will never be called.
3497 @end table
3498
3499 @node Objective-C and Objective-C++ Dialect Options
3500 @section Options Controlling Objective-C and Objective-C++ Dialects
3501
3502 @cindex compiler options, Objective-C and Objective-C++
3503 @cindex Objective-C and Objective-C++ options, command-line
3504 @cindex options, Objective-C and Objective-C++
3505 (NOTE: This manual does not describe the Objective-C and Objective-C++
3506 languages themselves. @xref{Standards,,Language Standards
3507 Supported by GCC}, for references.)
3508
3509 This section describes the command-line options that are only meaningful
3510 for Objective-C and Objective-C++ programs. You can also use most of
3511 the language-independent GNU compiler options.
3512 For example, you might compile a file @file{some_class.m} like this:
3513
3514 @smallexample
3515 gcc -g -fgnu-runtime -O -c some_class.m
3516 @end smallexample
3517
3518 @noindent
3519 In this example, @option{-fgnu-runtime} is an option meant only for
3520 Objective-C and Objective-C++ programs; you can use the other options with
3521 any language supported by GCC@.
3522
3523 Note that since Objective-C is an extension of the C language, Objective-C
3524 compilations may also use options specific to the C front-end (e.g.,
3525 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
3526 C++-specific options (e.g., @option{-Wabi}).
3527
3528 Here is a list of options that are @emph{only} for compiling Objective-C
3529 and Objective-C++ programs:
3530
3531 @table @gcctabopt
3532 @item -fconstant-string-class=@var{class-name}
3533 @opindex fconstant-string-class
3534 Use @var{class-name} as the name of the class to instantiate for each
3535 literal string specified with the syntax @code{@@"@dots{}"}. The default
3536 class name is @code{NXConstantString} if the GNU runtime is being used, and
3537 @code{NSConstantString} if the NeXT runtime is being used (see below). The
3538 @option{-fconstant-cfstrings} option, if also present, overrides the
3539 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3540 to be laid out as constant CoreFoundation strings.
3541
3542 @item -fgnu-runtime
3543 @opindex fgnu-runtime
3544 Generate object code compatible with the standard GNU Objective-C
3545 runtime. This is the default for most types of systems.
3546
3547 @item -fnext-runtime
3548 @opindex fnext-runtime
3549 Generate output compatible with the NeXT runtime. This is the default
3550 for NeXT-based systems, including Darwin and Mac OS X@. The macro
3551 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3552 used.
3553
3554 @item -fno-nil-receivers
3555 @opindex fno-nil-receivers
3556 @opindex fnil-receivers
3557 Assume that all Objective-C message dispatches (@code{[receiver
3558 message:arg]}) in this translation unit ensure that the receiver is
3559 not @code{nil}. This allows for more efficient entry points in the
3560 runtime to be used. This option is only available in conjunction with
3561 the NeXT runtime and ABI version 0 or 1.
3562
3563 @item -fobjc-abi-version=@var{n}
3564 @opindex fobjc-abi-version
3565 Use version @var{n} of the Objective-C ABI for the selected runtime.
3566 This option is currently supported only for the NeXT runtime. In that
3567 case, Version 0 is the traditional (32-bit) ABI without support for
3568 properties and other Objective-C 2.0 additions. Version 1 is the
3569 traditional (32-bit) ABI with support for properties and other
3570 Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If
3571 nothing is specified, the default is Version 0 on 32-bit target
3572 machines, and Version 2 on 64-bit target machines.
3573
3574 @item -fobjc-call-cxx-cdtors
3575 @opindex fobjc-call-cxx-cdtors
3576 For each Objective-C class, check if any of its instance variables is a
3577 C++ object with a non-trivial default constructor. If so, synthesize a
3578 special @code{- (id) .cxx_construct} instance method which runs
3579 non-trivial default constructors on any such instance variables, in order,
3580 and then return @code{self}. Similarly, check if any instance variable
3581 is a C++ object with a non-trivial destructor, and if so, synthesize a
3582 special @code{- (void) .cxx_destruct} method which runs
3583 all such default destructors, in reverse order.
3584
3585 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3586 methods thusly generated only operate on instance variables
3587 declared in the current Objective-C class, and not those inherited
3588 from superclasses. It is the responsibility of the Objective-C
3589 runtime to invoke all such methods in an object's inheritance
3590 hierarchy. The @code{- (id) .cxx_construct} methods are invoked
3591 by the runtime immediately after a new object instance is allocated;
3592 the @code{- (void) .cxx_destruct} methods are invoked immediately
3593 before the runtime deallocates an object instance.
3594
3595 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3596 support for invoking the @code{- (id) .cxx_construct} and
3597 @code{- (void) .cxx_destruct} methods.
3598
3599 @item -fobjc-direct-dispatch
3600 @opindex fobjc-direct-dispatch
3601 Allow fast jumps to the message dispatcher. On Darwin this is
3602 accomplished via the comm page.
3603
3604 @item -fobjc-exceptions
3605 @opindex fobjc-exceptions
3606 Enable syntactic support for structured exception handling in
3607 Objective-C, similar to what is offered by C++. This option
3608 is required to use the Objective-C keywords @code{@@try},
3609 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3610 @code{@@synchronized}. This option is available with both the GNU
3611 runtime and the NeXT runtime (but not available in conjunction with
3612 the NeXT runtime on Mac OS X 10.2 and earlier).
3613
3614 @item -fobjc-gc
3615 @opindex fobjc-gc
3616 Enable garbage collection (GC) in Objective-C and Objective-C++
3617 programs. This option is only available with the NeXT runtime; the
3618 GNU runtime has a different garbage collection implementation that
3619 does not require special compiler flags.
3620
3621 @item -fobjc-nilcheck
3622 @opindex fobjc-nilcheck
3623 For the NeXT runtime with version 2 of the ABI, check for a nil
3624 receiver in method invocations before doing the actual method call.
3625 This is the default and can be disabled using
3626 @option{-fno-objc-nilcheck}. Class methods and super calls are never
3627 checked for nil in this way no matter what this flag is set to.
3628 Currently this flag does nothing when the GNU runtime, or an older
3629 version of the NeXT runtime ABI, is used.
3630
3631 @item -fobjc-std=objc1
3632 @opindex fobjc-std
3633 Conform to the language syntax of Objective-C 1.0, the language
3634 recognized by GCC 4.0. This only affects the Objective-C additions to
3635 the C/C++ language; it does not affect conformance to C/C++ standards,
3636 which is controlled by the separate C/C++ dialect option flags. When
3637 this option is used with the Objective-C or Objective-C++ compiler,
3638 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3639 This is useful if you need to make sure that your Objective-C code can
3640 be compiled with older versions of GCC@.
3641
3642 @item -freplace-objc-classes
3643 @opindex freplace-objc-classes
3644 Emit a special marker instructing @command{ld(1)} not to statically link in
3645 the resulting object file, and allow @command{dyld(1)} to load it in at
3646 run time instead. This is used in conjunction with the Fix-and-Continue
3647 debugging mode, where the object file in question may be recompiled and
3648 dynamically reloaded in the course of program execution, without the need
3649 to restart the program itself. Currently, Fix-and-Continue functionality
3650 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3651 and later.
3652
3653 @item -fzero-link
3654 @opindex fzero-link
3655 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3656 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3657 compile time) with static class references that get initialized at load time,
3658 which improves run-time performance. Specifying the @option{-fzero-link} flag
3659 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3660 to be retained. This is useful in Zero-Link debugging mode, since it allows
3661 for individual class implementations to be modified during program execution.
3662 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3663 regardless of command-line options.
3664
3665 @item -fno-local-ivars
3666 @opindex fno-local-ivars
3667 @opindex flocal-ivars
3668 By default instance variables in Objective-C can be accessed as if
3669 they were local variables from within the methods of the class they're
3670 declared in. This can lead to shadowing between instance variables
3671 and other variables declared either locally inside a class method or
3672 globally with the same name. Specifying the @option{-fno-local-ivars}
3673 flag disables this behavior thus avoiding variable shadowing issues.
3674
3675 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3676 @opindex fivar-visibility
3677 Set the default instance variable visibility to the specified option
3678 so that instance variables declared outside the scope of any access
3679 modifier directives default to the specified visibility.
3680
3681 @item -gen-decls
3682 @opindex gen-decls
3683 Dump interface declarations for all classes seen in the source file to a
3684 file named @file{@var{sourcename}.decl}.
3685
3686 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3687 @opindex Wassign-intercept
3688 @opindex Wno-assign-intercept
3689 Warn whenever an Objective-C assignment is being intercepted by the
3690 garbage collector.
3691
3692 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3693 @opindex Wno-protocol
3694 @opindex Wprotocol
3695 If a class is declared to implement a protocol, a warning is issued for
3696 every method in the protocol that is not implemented by the class. The
3697 default behavior is to issue a warning for every method not explicitly
3698 implemented in the class, even if a method implementation is inherited
3699 from the superclass. If you use the @option{-Wno-protocol} option, then
3700 methods inherited from the superclass are considered to be implemented,
3701 and no warning is issued for them.
3702
3703 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3704 @opindex Wselector
3705 @opindex Wno-selector
3706 Warn if multiple methods of different types for the same selector are
3707 found during compilation. The check is performed on the list of methods
3708 in the final stage of compilation. Additionally, a check is performed
3709 for each selector appearing in a @code{@@selector(@dots{})}
3710 expression, and a corresponding method for that selector has been found
3711 during compilation. Because these checks scan the method table only at
3712 the end of compilation, these warnings are not produced if the final
3713 stage of compilation is not reached, for example because an error is
3714 found during compilation, or because the @option{-fsyntax-only} option is
3715 being used.
3716
3717 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3718 @opindex Wstrict-selector-match
3719 @opindex Wno-strict-selector-match
3720 Warn if multiple methods with differing argument and/or return types are
3721 found for a given selector when attempting to send a message using this
3722 selector to a receiver of type @code{id} or @code{Class}. When this flag
3723 is off (which is the default behavior), the compiler omits such warnings
3724 if any differences found are confined to types that share the same size
3725 and alignment.
3726
3727 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3728 @opindex Wundeclared-selector
3729 @opindex Wno-undeclared-selector
3730 Warn if a @code{@@selector(@dots{})} expression referring to an
3731 undeclared selector is found. A selector is considered undeclared if no
3732 method with that name has been declared before the
3733 @code{@@selector(@dots{})} expression, either explicitly in an
3734 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3735 an @code{@@implementation} section. This option always performs its
3736 checks as soon as a @code{@@selector(@dots{})} expression is found,
3737 while @option{-Wselector} only performs its checks in the final stage of
3738 compilation. This also enforces the coding style convention
3739 that methods and selectors must be declared before being used.
3740
3741 @item -print-objc-runtime-info
3742 @opindex print-objc-runtime-info
3743 Generate C header describing the largest structure that is passed by
3744 value, if any.
3745
3746 @end table
3747
3748 @node Diagnostic Message Formatting Options
3749 @section Options to Control Diagnostic Messages Formatting
3750 @cindex options to control diagnostics formatting
3751 @cindex diagnostic messages
3752 @cindex message formatting
3753
3754 Traditionally, diagnostic messages have been formatted irrespective of
3755 the output device's aspect (e.g.@: its width, @dots{}). You can use the
3756 options described below
3757 to control the formatting algorithm for diagnostic messages,
3758 e.g.@: how many characters per line, how often source location
3759 information should be reported. Note that some language front ends may not
3760 honor these options.
3761
3762 @table @gcctabopt
3763 @item -fmessage-length=@var{n}
3764 @opindex fmessage-length
3765 Try to format error messages so that they fit on lines of about
3766 @var{n} characters. If @var{n} is zero, then no line-wrapping is
3767 done; each error message appears on a single line. This is the
3768 default for all front ends.
3769
3770 Note - this option also affects the display of the @samp{#error} and
3771 @samp{#warning} pre-processor directives, and the @samp{deprecated}
3772 function/type/variable attribute. It does not however affect the
3773 @samp{pragma GCC warning} and @samp{pragma GCC error} pragmas.
3774
3775 @item -fdiagnostics-show-location=once
3776 @opindex fdiagnostics-show-location
3777 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
3778 reporter to emit source location information @emph{once}; that is, in
3779 case the message is too long to fit on a single physical line and has to
3780 be wrapped, the source location won't be emitted (as prefix) again,
3781 over and over, in subsequent continuation lines. This is the default
3782 behavior.
3783
3784 @item -fdiagnostics-show-location=every-line
3785 Only meaningful in line-wrapping mode. Instructs the diagnostic
3786 messages reporter to emit the same source location information (as
3787 prefix) for physical lines that result from the process of breaking
3788 a message which is too long to fit on a single line.
3789
3790 @item -fdiagnostics-color[=@var{WHEN}]
3791 @itemx -fno-diagnostics-color
3792 @opindex fdiagnostics-color
3793 @cindex highlight, color
3794 @vindex GCC_COLORS @r{environment variable}
3795 Use color in diagnostics. @var{WHEN} is @samp{never}, @samp{always},
3796 or @samp{auto}. The default depends on how the compiler has been configured,
3797 it can be any of the above @var{WHEN} options or also @samp{never}
3798 if @env{GCC_COLORS} environment variable isn't present in the environment,
3799 and @samp{auto} otherwise.
3800 @samp{auto} means to use color only when the standard error is a terminal.
3801 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3802 aliases for @option{-fdiagnostics-color=always} and
3803 @option{-fdiagnostics-color=never}, respectively.
3804
3805 The colors are defined by the environment variable @env{GCC_COLORS}.
3806 Its value is a colon-separated list of capabilities and Select Graphic
3807 Rendition (SGR) substrings. SGR commands are interpreted by the
3808 terminal or terminal emulator. (See the section in the documentation
3809 of your text terminal for permitted values and their meanings as
3810 character attributes.) These substring values are integers in decimal
3811 representation and can be concatenated with semicolons.
3812 Common values to concatenate include
3813 @samp{1} for bold,
3814 @samp{4} for underline,
3815 @samp{5} for blink,
3816 @samp{7} for inverse,
3817 @samp{39} for default foreground color,
3818 @samp{30} to @samp{37} for foreground colors,
3819 @samp{90} to @samp{97} for 16-color mode foreground colors,
3820 @samp{38;5;0} to @samp{38;5;255}
3821 for 88-color and 256-color modes foreground colors,
3822 @samp{49} for default background color,
3823 @samp{40} to @samp{47} for background colors,
3824 @samp{100} to @samp{107} for 16-color mode background colors,
3825 and @samp{48;5;0} to @samp{48;5;255}
3826 for 88-color and 256-color modes background colors.
3827
3828 The default @env{GCC_COLORS} is
3829 @smallexample
3830 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3831 quote=01:fixit-insert=32:fixit-delete=31:\
3832 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3833 type-diff=01;32
3834 @end smallexample
3835 @noindent
3836 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3837 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3838 @samp{01} is bold, and @samp{31} is red.
3839 Setting @env{GCC_COLORS} to the empty string disables colors.
3840 Supported capabilities are as follows.
3841
3842 @table @code
3843 @item error=
3844 @vindex error GCC_COLORS @r{capability}
3845 SGR substring for error: markers.
3846
3847 @item warning=
3848 @vindex warning GCC_COLORS @r{capability}
3849 SGR substring for warning: markers.
3850
3851 @item note=
3852 @vindex note GCC_COLORS @r{capability}
3853 SGR substring for note: markers.
3854
3855 @item range1=
3856 @vindex range1 GCC_COLORS @r{capability}
3857 SGR substring for first additional range.
3858
3859 @item range2=
3860 @vindex range2 GCC_COLORS @r{capability}
3861 SGR substring for second additional range.
3862
3863 @item locus=
3864 @vindex locus GCC_COLORS @r{capability}
3865 SGR substring for location information, @samp{file:line} or
3866 @samp{file:line:column} etc.
3867
3868 @item quote=
3869 @vindex quote GCC_COLORS @r{capability}
3870 SGR substring for information printed within quotes.
3871
3872 @item fixit-insert=
3873 @vindex fixit-insert GCC_COLORS @r{capability}
3874 SGR substring for fix-it hints suggesting text to
3875 be inserted or replaced.
3876
3877 @item fixit-delete=
3878 @vindex fixit-delete GCC_COLORS @r{capability}
3879 SGR substring for fix-it hints suggesting text to
3880 be deleted.
3881
3882 @item diff-filename=
3883 @vindex diff-filename GCC_COLORS @r{capability}
3884 SGR substring for filename headers within generated patches.
3885
3886 @item diff-hunk=
3887 @vindex diff-hunk GCC_COLORS @r{capability}
3888 SGR substring for the starts of hunks within generated patches.
3889
3890 @item diff-delete=
3891 @vindex diff-delete GCC_COLORS @r{capability}
3892 SGR substring for deleted lines within generated patches.
3893
3894 @item diff-insert=
3895 @vindex diff-insert GCC_COLORS @r{capability}
3896 SGR substring for inserted lines within generated patches.
3897
3898 @item type-diff=
3899 @vindex type-diff GCC_COLORS @r{capability}
3900 SGR substring for highlighting mismatching types within template
3901 arguments in the C++ frontend.
3902 @end table
3903
3904 @item -fno-diagnostics-show-option
3905 @opindex fno-diagnostics-show-option
3906 @opindex fdiagnostics-show-option
3907 By default, each diagnostic emitted includes text indicating the
3908 command-line option that directly controls the diagnostic (if such an
3909 option is known to the diagnostic machinery). Specifying the
3910 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3911
3912 @item -fno-diagnostics-show-caret
3913 @opindex fno-diagnostics-show-caret
3914 @opindex fdiagnostics-show-caret
3915 By default, each diagnostic emitted includes the original source line
3916 and a caret @samp{^} indicating the column. This option suppresses this
3917 information. The source line is truncated to @var{n} characters, if
3918 the @option{-fmessage-length=n} option is given. When the output is done
3919 to the terminal, the width is limited to the width given by the
3920 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3921
3922 @item -fno-diagnostics-show-labels
3923 @opindex fno-diagnostics-show-labels
3924 @opindex fdiagnostics-show-labels
3925 By default, when printing source code (via @option{-fdiagnostics-show-caret}),
3926 diagnostics can label ranges of source code with pertinent information, such
3927 as the types of expressions:
3928
3929 @smallexample
3930 printf ("foo %s bar", long_i + long_j);
3931 ~^ ~~~~~~~~~~~~~~~
3932 | |
3933 char * long int
3934 @end smallexample
3935
3936 This option suppresses the printing of these labels (in the example above,
3937 the vertical bars and the ``char *'' and ``long int'' text).
3938
3939 @item -fno-diagnostics-show-line-numbers
3940 @opindex fno-diagnostics-show-line-numbers
3941 @opindex fdiagnostics-show-line-numbers
3942 By default, when printing source code (via @option{-fdiagnostics-show-caret}),
3943 a left margin is printed, showing line numbers. This option suppresses this
3944 left margin.
3945
3946 @item -fdiagnostics-minimum-margin-width=@var{width}
3947 @opindex fdiagnostics-minimum-margin-width
3948 This option controls the minimum width of the left margin printed by
3949 @option{-fdiagnostics-show-line-numbers}. It defaults to 6.
3950
3951 @item -fdiagnostics-parseable-fixits
3952 @opindex fdiagnostics-parseable-fixits
3953 Emit fix-it hints in a machine-parseable format, suitable for consumption
3954 by IDEs. For each fix-it, a line will be printed after the relevant
3955 diagnostic, starting with the string ``fix-it:''. For example:
3956
3957 @smallexample
3958 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3959 @end smallexample
3960
3961 The location is expressed as a half-open range, expressed as a count of
3962 bytes, starting at byte 1 for the initial column. In the above example,
3963 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3964 given string:
3965
3966 @smallexample
3967 00000000011111111112222222222
3968 12345678901234567890123456789
3969 gtk_widget_showall (dlg);
3970 ^^^^^^^^^^^^^^^^^^
3971 gtk_widget_show_all
3972 @end smallexample
3973
3974 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3975 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3976 (e.g. vertical tab as ``\013'').
3977
3978 An empty replacement string indicates that the given range is to be removed.
3979 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3980 be inserted at the given position.
3981
3982 @item -fdiagnostics-generate-patch
3983 @opindex fdiagnostics-generate-patch
3984 Print fix-it hints to stderr in unified diff format, after any diagnostics
3985 are printed. For example:
3986
3987 @smallexample
3988 --- test.c
3989 +++ test.c
3990 @@ -42,5 +42,5 @@
3991
3992 void show_cb(GtkDialog *dlg)
3993 @{
3994 - gtk_widget_showall(dlg);
3995 + gtk_widget_show_all(dlg);
3996 @}
3997
3998 @end smallexample
3999
4000 The diff may or may not be colorized, following the same rules
4001 as for diagnostics (see @option{-fdiagnostics-color}).
4002
4003 @item -fdiagnostics-show-template-tree
4004 @opindex fdiagnostics-show-template-tree
4005
4006 In the C++ frontend, when printing diagnostics showing mismatching
4007 template types, such as:
4008
4009 @smallexample
4010 could not convert 'std::map<int, std::vector<double> >()'
4011 from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
4012 @end smallexample
4013
4014 the @option{-fdiagnostics-show-template-tree} flag enables printing a
4015 tree-like structure showing the common and differing parts of the types,
4016 such as:
4017
4018 @smallexample
4019 map<
4020 [...],
4021 vector<
4022 [double != float]>>
4023 @end smallexample
4024
4025 The parts that differ are highlighted with color (``double'' and
4026 ``float'' in this case).
4027
4028 @item -fno-elide-type
4029 @opindex fno-elide-type
4030 @opindex felide-type
4031 By default when the C++ frontend prints diagnostics showing mismatching
4032 template types, common parts of the types are printed as ``[...]'' to
4033 simplify the error message. For example:
4034
4035 @smallexample
4036 could not convert 'std::map<int, std::vector<double> >()'
4037 from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
4038 @end smallexample
4039
4040 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
4041 This flag also affects the output of the
4042 @option{-fdiagnostics-show-template-tree} flag.
4043
4044 @item -fno-show-column
4045 @opindex fno-show-column
4046 @opindex fshow-column
4047 Do not print column numbers in diagnostics. This may be necessary if
4048 diagnostics are being scanned by a program that does not understand the
4049 column numbers, such as @command{dejagnu}.
4050
4051 @item -fdiagnostics-format=@var{FORMAT}
4052 @opindex fdiagnostics-format
4053 Select a different format for printing diagnostics.
4054 @var{FORMAT} is @samp{text} or @samp{json}.
4055 The default is @samp{text}.
4056
4057 The @samp{json} format consists of a top-level JSON array containing JSON
4058 objects representing the diagnostics.
4059
4060 The JSON is emitted as one line, without formatting; the examples below
4061 have been formatted for clarity.
4062
4063 Diagnostics can have child diagnostics. For example, this error and note:
4064
4065 @smallexample
4066 misleading-indentation.c:15:3: warning: this 'if' clause does not
4067 guard... [-Wmisleading-indentation]
4068 15 | if (flag)
4069 | ^~
4070 misleading-indentation.c:17:5: note: ...this statement, but the latter
4071 is misleadingly indented as if it were guarded by the 'if'
4072 17 | y = 2;
4073 | ^
4074 @end smallexample
4075
4076 @noindent
4077 might be printed in JSON form (after formatting) like this:
4078
4079 @smallexample
4080 [
4081 @{
4082 "kind": "warning",
4083 "locations": [
4084 @{
4085 "caret": @{
4086 "column": 3,
4087 "file": "misleading-indentation.c",
4088 "line": 15
4089 @},
4090 "finish": @{
4091 "column": 4,
4092 "file": "misleading-indentation.c",
4093 "line": 15
4094 @}
4095 @}
4096 ],
4097 "message": "this \u2018if\u2019 clause does not guard...",
4098 "option": "-Wmisleading-indentation",
4099 "children": [
4100 @{
4101 "kind": "note",
4102 "locations": [
4103 @{
4104 "caret": @{
4105 "column": 5,
4106 "file": "misleading-indentation.c",
4107 "line": 17
4108 @}
4109 @}
4110 ],
4111 "message": "...this statement, but the latter is @dots{}"
4112 @}
4113 ]
4114 @},
4115 @dots{}
4116 ]
4117 @end smallexample
4118
4119 @noindent
4120 where the @code{note} is a child of the @code{warning}.
4121
4122 A diagnostic has a @code{kind}. If this is @code{warning}, then there is
4123 an @code{option} key describing the command-line option controlling the
4124 warning.
4125
4126 A diagnostic can contain zero or more locations. Each location has up
4127 to three positions within it: a @code{caret} position and optional
4128 @code{start} and @code{finish} positions. A location can also have
4129 an optional @code{label} string. For example, this error:
4130
4131 @smallexample
4132 bad-binary-ops.c:64:23: error: invalid operands to binary + (have 'S' @{aka
4133 'struct s'@} and 'T' @{aka 'struct t'@})
4134 64 | return callee_4a () + callee_4b ();
4135 | ~~~~~~~~~~~~ ^ ~~~~~~~~~~~~
4136 | | |
4137 | | T @{aka struct t@}
4138 | S @{aka struct s@}
4139 @end smallexample
4140
4141 @noindent
4142 has three locations. Its primary location is at the ``+'' token at column
4143 23. It has two secondary locations, describing the left and right-hand sides
4144 of the expression, which have labels. It might be printed in JSON form as:
4145
4146 @smallexample
4147 @{
4148 "children": [],
4149 "kind": "error",
4150 "locations": [
4151 @{
4152 "caret": @{
4153 "column": 23, "file": "bad-binary-ops.c", "line": 64
4154 @}
4155 @},
4156 @{
4157 "caret": @{
4158 "column": 10, "file": "bad-binary-ops.c", "line": 64
4159 @},
4160 "finish": @{
4161 "column": 21, "file": "bad-binary-ops.c", "line": 64
4162 @},
4163 "label": "S @{aka struct s@}"
4164 @},
4165 @{
4166 "caret": @{
4167 "column": 25, "file": "bad-binary-ops.c", "line": 64
4168 @},
4169 "finish": @{
4170 "column": 36, "file": "bad-binary-ops.c", "line": 64
4171 @},
4172 "label": "T @{aka struct t@}"
4173 @}
4174 ],
4175 "message": "invalid operands to binary + @dots{}"
4176 @}
4177 @end smallexample
4178
4179 If a diagnostic contains fix-it hints, it has a @code{fixits} array,
4180 consisting of half-open intervals, similar to the output of
4181 @option{-fdiagnostics-parseable-fixits}. For example, this diagnostic
4182 with a replacement fix-it hint:
4183
4184 @smallexample
4185 demo.c:8:15: error: 'struct s' has no member named 'colour'; did you
4186 mean 'color'?
4187 8 | return ptr->colour;
4188 | ^~~~~~
4189 | color
4190 @end smallexample
4191
4192 @noindent
4193 might be printed in JSON form as:
4194
4195 @smallexample
4196 @{
4197 "children": [],
4198 "fixits": [
4199 @{
4200 "next": @{
4201 "column": 21,
4202 "file": "demo.c",
4203 "line": 8
4204 @},
4205 "start": @{
4206 "column": 15,
4207 "file": "demo.c",
4208 "line": 8
4209 @},
4210 "string": "color"
4211 @}
4212 ],
4213 "kind": "error",
4214 "locations": [
4215 @{
4216 "caret": @{
4217 "column": 15,
4218 "file": "demo.c",
4219 "line": 8
4220 @},
4221 "finish": @{
4222 "column": 20,
4223 "file": "demo.c",
4224 "line": 8
4225 @}
4226 @}
4227 ],
4228 "message": "\u2018struct s\u2019 has no member named @dots{}"
4229 @}
4230 @end smallexample
4231
4232 @noindent
4233 where the fix-it hint suggests replacing the text from @code{start} up
4234 to but not including @code{next} with @code{string}'s value. Deletions
4235 are expressed via an empty value for @code{string}, insertions by
4236 having @code{start} equal @code{next}.
4237
4238 @end table
4239
4240 @node Warning Options
4241 @section Options to Request or Suppress Warnings
4242 @cindex options to control warnings
4243 @cindex warning messages
4244 @cindex messages, warning
4245 @cindex suppressing warnings
4246
4247 Warnings are diagnostic messages that report constructions that
4248 are not inherently erroneous but that are risky or suggest there
4249 may have been an error.
4250
4251 The following language-independent options do not enable specific
4252 warnings but control the kinds of diagnostics produced by GCC@.
4253
4254 @table @gcctabopt
4255 @cindex syntax checking
4256 @item -fsyntax-only
4257 @opindex fsyntax-only
4258 Check the code for syntax errors, but don't do anything beyond that.
4259
4260 @item -fmax-errors=@var{n}
4261 @opindex fmax-errors
4262 Limits the maximum number of error messages to @var{n}, at which point
4263 GCC bails out rather than attempting to continue processing the source
4264 code. If @var{n} is 0 (the default), there is no limit on the number
4265 of error messages produced. If @option{-Wfatal-errors} is also
4266 specified, then @option{-Wfatal-errors} takes precedence over this
4267 option.
4268
4269 @item -w
4270 @opindex w
4271 Inhibit all warning messages.
4272
4273 @item -Werror
4274 @opindex Werror
4275 @opindex Wno-error
4276 Make all warnings into errors.
4277
4278 @item -Werror=
4279 @opindex Werror=
4280 @opindex Wno-error=
4281 Make the specified warning into an error. The specifier for a warning
4282 is appended; for example @option{-Werror=switch} turns the warnings
4283 controlled by @option{-Wswitch} into errors. This switch takes a
4284 negative form, to be used to negate @option{-Werror} for specific
4285 warnings; for example @option{-Wno-error=switch} makes
4286 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
4287 is in effect.
4288
4289 The warning message for each controllable warning includes the
4290 option that controls the warning. That option can then be used with
4291 @option{-Werror=} and @option{-Wno-error=} as described above.
4292 (Printing of the option in the warning message can be disabled using the
4293 @option{-fno-diagnostics-show-option} flag.)
4294
4295 Note that specifying @option{-Werror=}@var{foo} automatically implies
4296 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
4297 imply anything.
4298
4299 @item -Wfatal-errors
4300 @opindex Wfatal-errors
4301 @opindex Wno-fatal-errors
4302 This option causes the compiler to abort compilation on the first error
4303 occurred rather than trying to keep going and printing further error
4304 messages.
4305
4306 @end table
4307
4308 You can request many specific warnings with options beginning with
4309 @samp{-W}, for example @option{-Wimplicit} to request warnings on
4310 implicit declarations. Each of these specific warning options also
4311 has a negative form beginning @samp{-Wno-} to turn off warnings; for
4312 example, @option{-Wno-implicit}. This manual lists only one of the
4313 two forms, whichever is not the default. For further
4314 language-specific options also refer to @ref{C++ Dialect Options} and
4315 @ref{Objective-C and Objective-C++ Dialect Options}.
4316
4317 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
4318 options, such as @option{-Wunused}, which may turn on further options,
4319 such as @option{-Wunused-value}. The combined effect of positive and
4320 negative forms is that more specific options have priority over less
4321 specific ones, independently of their position in the command-line. For
4322 options of the same specificity, the last one takes effect. Options
4323 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
4324 as if they appeared at the end of the command-line.
4325
4326 When an unrecognized warning option is requested (e.g.,
4327 @option{-Wunknown-warning}), GCC emits a diagnostic stating
4328 that the option is not recognized. However, if the @option{-Wno-} form
4329 is used, the behavior is slightly different: no diagnostic is
4330 produced for @option{-Wno-unknown-warning} unless other diagnostics
4331 are being produced. This allows the use of new @option{-Wno-} options
4332 with old compilers, but if something goes wrong, the compiler
4333 warns that an unrecognized option is present.
4334
4335 @table @gcctabopt
4336 @item -Wpedantic
4337 @itemx -pedantic
4338 @opindex pedantic
4339 @opindex Wpedantic
4340 @opindex Wno-pedantic
4341 Issue all the warnings demanded by strict ISO C and ISO C++;
4342 reject all programs that use forbidden extensions, and some other
4343 programs that do not follow ISO C and ISO C++. For ISO C, follows the
4344 version of the ISO C standard specified by any @option{-std} option used.
4345
4346 Valid ISO C and ISO C++ programs should compile properly with or without
4347 this option (though a rare few require @option{-ansi} or a
4348 @option{-std} option specifying the required version of ISO C)@. However,
4349 without this option, certain GNU extensions and traditional C and C++
4350 features are supported as well. With this option, they are rejected.
4351
4352 @option{-Wpedantic} does not cause warning messages for use of the
4353 alternate keywords whose names begin and end with @samp{__}. This alternate
4354 format can also be used to disable warnings for non-ISO @samp{__intN} types,
4355 i.e. @samp{__intN__}.
4356 Pedantic warnings are also disabled in the expression that follows
4357 @code{__extension__}. However, only system header files should use
4358 these escape routes; application programs should avoid them.
4359 @xref{Alternate Keywords}.
4360
4361 Some users try to use @option{-Wpedantic} to check programs for strict ISO
4362 C conformance. They soon find that it does not do quite what they want:
4363 it finds some non-ISO practices, but not all---only those for which
4364 ISO C @emph{requires} a diagnostic, and some others for which
4365 diagnostics have been added.
4366
4367 A feature to report any failure to conform to ISO C might be useful in
4368 some instances, but would require considerable additional work and would
4369 be quite different from @option{-Wpedantic}. We don't have plans to
4370 support such a feature in the near future.
4371
4372 Where the standard specified with @option{-std} represents a GNU
4373 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
4374 corresponding @dfn{base standard}, the version of ISO C on which the GNU
4375 extended dialect is based. Warnings from @option{-Wpedantic} are given
4376 where they are required by the base standard. (It does not make sense
4377 for such warnings to be given only for features not in the specified GNU
4378 C dialect, since by definition the GNU dialects of C include all
4379 features the compiler supports with the given option, and there would be
4380 nothing to warn about.)
4381
4382 @item -pedantic-errors
4383 @opindex pedantic-errors
4384 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
4385 requires a diagnostic, in some cases where there is undefined behavior
4386 at compile-time and in some other cases that do not prevent compilation
4387 of programs that are valid according to the standard. This is not
4388 equivalent to @option{-Werror=pedantic}, since there are errors enabled
4389 by this option and not enabled by the latter and vice versa.
4390
4391 @item -Wall
4392 @opindex Wall
4393 @opindex Wno-all
4394 This enables all the warnings about constructions that some users
4395 consider questionable, and that are easy to avoid (or modify to
4396 prevent the warning), even in conjunction with macros. This also
4397 enables some language-specific warnings described in @ref{C++ Dialect
4398 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
4399
4400 @option{-Wall} turns on the following warning flags:
4401
4402 @gccoptlist{-Waddress @gol
4403 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)} @gol
4404 -Wbool-compare @gol
4405 -Wbool-operation @gol
4406 -Wc++11-compat -Wc++14-compat @gol
4407 -Wcatch-value @r{(C++ and Objective-C++ only)} @gol
4408 -Wchar-subscripts @gol
4409 -Wcomment @gol
4410 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
4411 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
4412 -Wformat @gol
4413 -Wint-in-bool-context @gol
4414 -Wimplicit @r{(C and Objective-C only)} @gol
4415 -Wimplicit-int @r{(C and Objective-C only)} @gol
4416 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
4417 -Winit-self @r{(only for C++)} @gol
4418 -Wlogical-not-parentheses @gol
4419 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} @gol
4420 -Wmaybe-uninitialized @gol
4421 -Wmemset-elt-size @gol
4422 -Wmemset-transposed-args @gol
4423 -Wmisleading-indentation @r{(only for C/C++)} @gol
4424 -Wmissing-attributes @gol
4425 -Wmissing-braces @r{(only for C/ObjC)} @gol
4426 -Wmultistatement-macros @gol
4427 -Wnarrowing @r{(only for C++)} @gol
4428 -Wnonnull @gol
4429 -Wnonnull-compare @gol
4430 -Wopenmp-simd @gol
4431 -Wparentheses @gol
4432 -Wpessimizing-move @r{(only for C++)} @gol
4433 -Wpointer-sign @gol
4434 -Wreorder @gol
4435 -Wrestrict @gol
4436 -Wreturn-type @gol
4437 -Wsequence-point @gol
4438 -Wsign-compare @r{(only in C++)} @gol
4439 -Wsizeof-pointer-div @gol
4440 -Wsizeof-pointer-memaccess @gol
4441 -Wstrict-aliasing @gol
4442 -Wstrict-overflow=1 @gol
4443 -Wswitch @gol
4444 -Wtautological-compare @gol
4445 -Wtrigraphs @gol
4446 -Wuninitialized @gol
4447 -Wunknown-pragmas @gol
4448 -Wunused-function @gol
4449 -Wunused-label @gol
4450 -Wunused-value @gol
4451 -Wunused-variable @gol
4452 -Wvolatile-register-var}
4453
4454 Note that some warning flags are not implied by @option{-Wall}. Some of
4455 them warn about constructions that users generally do not consider
4456 questionable, but which occasionally you might wish to check for;
4457 others warn about constructions that are necessary or hard to avoid in
4458 some cases, and there is no simple way to modify the code to suppress
4459 the warning. Some of them are enabled by @option{-Wextra} but many of
4460 them must be enabled individually.
4461
4462 @item -Wextra
4463 @opindex W
4464 @opindex Wextra
4465 @opindex Wno-extra
4466 This enables some extra warning flags that are not enabled by
4467 @option{-Wall}. (This option used to be called @option{-W}. The older
4468 name is still supported, but the newer name is more descriptive.)
4469
4470 @gccoptlist{-Wclobbered @gol
4471 -Wcast-function-type @gol
4472 -Wdeprecated-copy @r{(C++ only)} @gol
4473 -Wempty-body @gol
4474 -Wignored-qualifiers @gol
4475 -Wimplicit-fallthrough=3 @gol
4476 -Wmissing-field-initializers @gol
4477 -Wmissing-parameter-type @r{(C only)} @gol
4478 -Wold-style-declaration @r{(C only)} @gol
4479 -Woverride-init @gol
4480 -Wsign-compare @r{(C only)} @gol
4481 -Wredundant-move @r{(only for C++)} @gol
4482 -Wtype-limits @gol
4483 -Wuninitialized @gol
4484 -Wshift-negative-value @r{(in C++03 and in C99 and newer)} @gol
4485 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
4486 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}}
4487
4488
4489 The option @option{-Wextra} also prints warning messages for the
4490 following cases:
4491
4492 @itemize @bullet
4493
4494 @item
4495 A pointer is compared against integer zero with @code{<}, @code{<=},
4496 @code{>}, or @code{>=}.
4497
4498 @item
4499 (C++ only) An enumerator and a non-enumerator both appear in a
4500 conditional expression.
4501
4502 @item
4503 (C++ only) Ambiguous virtual bases.
4504
4505 @item
4506 (C++ only) Subscripting an array that has been declared @code{register}.
4507
4508 @item
4509 (C++ only) Taking the address of a variable that has been declared
4510 @code{register}.
4511
4512 @item
4513 (C++ only) A base class is not initialized in the copy constructor
4514 of a derived class.
4515
4516 @end itemize
4517
4518 @item -Wchar-subscripts
4519 @opindex Wchar-subscripts
4520 @opindex Wno-char-subscripts
4521 Warn if an array subscript has type @code{char}. This is a common cause
4522 of error, as programmers often forget that this type is signed on some
4523 machines.
4524 This warning is enabled by @option{-Wall}.
4525
4526 @item -Wno-coverage-mismatch
4527 @opindex Wno-coverage-mismatch
4528 @opindex Wcoverage-mismatch
4529 Warn if feedback profiles do not match when using the
4530 @option{-fprofile-use} option.
4531 If a source file is changed between compiling with @option{-fprofile-generate}
4532 and with @option{-fprofile-use}, the files with the profile feedback can fail
4533 to match the source file and GCC cannot use the profile feedback
4534 information. By default, this warning is enabled and is treated as an
4535 error. @option{-Wno-coverage-mismatch} can be used to disable the
4536 warning or @option{-Wno-error=coverage-mismatch} can be used to
4537 disable the error. Disabling the error for this warning can result in
4538 poorly optimized code and is useful only in the
4539 case of very minor changes such as bug fixes to an existing code-base.
4540 Completely disabling the warning is not recommended.
4541
4542 @item -Wno-cpp
4543 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4544
4545 Suppress warning messages emitted by @code{#warning} directives.
4546
4547 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4548 @opindex Wdouble-promotion
4549 @opindex Wno-double-promotion
4550 Give a warning when a value of type @code{float} is implicitly
4551 promoted to @code{double}. CPUs with a 32-bit ``single-precision''
4552 floating-point unit implement @code{float} in hardware, but emulate
4553 @code{double} in software. On such a machine, doing computations
4554 using @code{double} values is much more expensive because of the
4555 overhead required for software emulation.
4556
4557 It is easy to accidentally do computations with @code{double} because
4558 floating-point literals are implicitly of type @code{double}. For
4559 example, in:
4560 @smallexample
4561 @group
4562 float area(float radius)
4563 @{
4564 return 3.14159 * radius * radius;
4565 @}
4566 @end group
4567 @end smallexample
4568 the compiler performs the entire computation with @code{double}
4569 because the floating-point literal is a @code{double}.
4570
4571 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4572 @opindex Wduplicate-decl-specifier
4573 @opindex Wno-duplicate-decl-specifier
4574 Warn if a declaration has duplicate @code{const}, @code{volatile},
4575 @code{restrict} or @code{_Atomic} specifier. This warning is enabled by
4576 @option{-Wall}.
4577
4578 @item -Wformat
4579 @itemx -Wformat=@var{n}
4580 @opindex Wformat
4581 @opindex Wno-format
4582 @opindex ffreestanding
4583 @opindex fno-builtin
4584 @opindex Wformat=
4585 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4586 the arguments supplied have types appropriate to the format string
4587 specified, and that the conversions specified in the format string make
4588 sense. This includes standard functions, and others specified by format
4589 attributes (@pxref{Function Attributes}), in the @code{printf},
4590 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4591 not in the C standard) families (or other target-specific families).
4592 Which functions are checked without format attributes having been
4593 specified depends on the standard version selected, and such checks of
4594 functions without the attribute specified are disabled by
4595 @option{-ffreestanding} or @option{-fno-builtin}.
4596
4597 The formats are checked against the format features supported by GNU
4598 libc version 2.2. These include all ISO C90 and C99 features, as well
4599 as features from the Single Unix Specification and some BSD and GNU
4600 extensions. Other library implementations may not support all these
4601 features; GCC does not support warning about features that go beyond a
4602 particular library's limitations. However, if @option{-Wpedantic} is used
4603 with @option{-Wformat}, warnings are given about format features not
4604 in the selected standard version (but not for @code{strfmon} formats,
4605 since those are not in any version of the C standard). @xref{C Dialect
4606 Options,,Options Controlling C Dialect}.
4607
4608 @table @gcctabopt
4609 @item -Wformat=1
4610 @itemx -Wformat
4611 @opindex Wformat
4612 @opindex Wformat=1
4613 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4614 @option{-Wno-format} is equivalent to @option{-Wformat=0}. Since
4615 @option{-Wformat} also checks for null format arguments for several
4616 functions, @option{-Wformat} also implies @option{-Wnonnull}. Some
4617 aspects of this level of format checking can be disabled by the
4618 options: @option{-Wno-format-contains-nul},
4619 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4620 @option{-Wformat} is enabled by @option{-Wall}.
4621
4622 @item -Wno-format-contains-nul
4623 @opindex Wno-format-contains-nul
4624 @opindex Wformat-contains-nul
4625 If @option{-Wformat} is specified, do not warn about format strings that
4626 contain NUL bytes.
4627
4628 @item -Wno-format-extra-args
4629 @opindex Wno-format-extra-args
4630 @opindex Wformat-extra-args
4631 If @option{-Wformat} is specified, do not warn about excess arguments to a
4632 @code{printf} or @code{scanf} format function. The C standard specifies
4633 that such arguments are ignored.
4634
4635 Where the unused arguments lie between used arguments that are
4636 specified with @samp{$} operand number specifications, normally
4637 warnings are still given, since the implementation could not know what
4638 type to pass to @code{va_arg} to skip the unused arguments. However,
4639 in the case of @code{scanf} formats, this option suppresses the
4640 warning if the unused arguments are all pointers, since the Single
4641 Unix Specification says that such unused arguments are allowed.
4642
4643 @item -Wformat-overflow
4644 @itemx -Wformat-overflow=@var{level}
4645 @opindex Wformat-overflow
4646 @opindex Wno-format-overflow
4647 Warn about calls to formatted input/output functions such as @code{sprintf}
4648 and @code{vsprintf} that might overflow the destination buffer. When the
4649 exact number of bytes written by a format directive cannot be determined
4650 at compile-time it is estimated based on heuristics that depend on the
4651 @var{level} argument and on optimization. While enabling optimization
4652 will in most cases improve the accuracy of the warning, it may also
4653 result in false positives.
4654
4655 @table @gcctabopt
4656 @item -Wformat-overflow
4657 @itemx -Wformat-overflow=1
4658 @opindex Wformat-overflow
4659 @opindex Wno-format-overflow
4660 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4661 employs a conservative approach that warns only about calls that most
4662 likely overflow the buffer. At this level, numeric arguments to format
4663 directives with unknown values are assumed to have the value of one, and
4664 strings of unknown length to be empty. Numeric arguments that are known
4665 to be bounded to a subrange of their type, or string arguments whose output
4666 is bounded either by their directive's precision or by a finite set of
4667 string literals, are assumed to take on the value within the range that
4668 results in the most bytes on output. For example, the call to @code{sprintf}
4669 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4670 the terminating NUL character (@code{'\0'}) appended by the function
4671 to the destination buffer will be written past its end. Increasing
4672 the size of the buffer by a single byte is sufficient to avoid the
4673 warning, though it may not be sufficient to avoid the overflow.
4674
4675 @smallexample
4676 void f (int a, int b)
4677 @{
4678 char buf [13];
4679 sprintf (buf, "a = %i, b = %i\n", a, b);
4680 @}
4681 @end smallexample
4682
4683 @item -Wformat-overflow=2
4684 Level @var{2} warns also about calls that might overflow the destination
4685 buffer given an argument of sufficient length or magnitude. At level
4686 @var{2}, unknown numeric arguments are assumed to have the minimum
4687 representable value for signed types with a precision greater than 1, and
4688 the maximum representable value otherwise. Unknown string arguments whose
4689 length cannot be assumed to be bounded either by the directive's precision,
4690 or by a finite set of string literals they may evaluate to, or the character
4691 array they may point to, are assumed to be 1 character long.
4692
4693 At level @var{2}, the call in the example above is again diagnosed, but
4694 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4695 @code{%i} directive will write some of its digits beyond the end of
4696 the destination buffer. To make the call safe regardless of the values
4697 of the two variables, the size of the destination buffer must be increased
4698 to at least 34 bytes. GCC includes the minimum size of the buffer in
4699 an informational note following the warning.
4700
4701 An alternative to increasing the size of the destination buffer is to
4702 constrain the range of formatted values. The maximum length of string
4703 arguments can be bounded by specifying the precision in the format
4704 directive. When numeric arguments of format directives can be assumed
4705 to be bounded by less than the precision of their type, choosing
4706 an appropriate length modifier to the format specifier will reduce
4707 the required buffer size. For example, if @var{a} and @var{b} in the
4708 example above can be assumed to be within the precision of
4709 the @code{short int} type then using either the @code{%hi} format
4710 directive or casting the argument to @code{short} reduces the maximum
4711 required size of the buffer to 24 bytes.
4712
4713 @smallexample
4714 void f (int a, int b)
4715 @{
4716 char buf [23];
4717 sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4718 @}
4719 @end smallexample
4720 @end table
4721
4722 @item -Wno-format-zero-length
4723 @opindex Wno-format-zero-length
4724 @opindex Wformat-zero-length
4725 If @option{-Wformat} is specified, do not warn about zero-length formats.
4726 The C standard specifies that zero-length formats are allowed.
4727
4728
4729 @item -Wformat=2
4730 @opindex Wformat=2
4731 Enable @option{-Wformat} plus additional format checks. Currently
4732 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4733 -Wformat-y2k}.
4734
4735 @item -Wformat-nonliteral
4736 @opindex Wformat-nonliteral
4737 @opindex Wno-format-nonliteral
4738 If @option{-Wformat} is specified, also warn if the format string is not a
4739 string literal and so cannot be checked, unless the format function
4740 takes its format arguments as a @code{va_list}.
4741
4742 @item -Wformat-security
4743 @opindex Wformat-security
4744 @opindex Wno-format-security
4745 If @option{-Wformat} is specified, also warn about uses of format
4746 functions that represent possible security problems. At present, this
4747 warns about calls to @code{printf} and @code{scanf} functions where the
4748 format string is not a string literal and there are no format arguments,
4749 as in @code{printf (foo);}. This may be a security hole if the format
4750 string came from untrusted input and contains @samp{%n}. (This is
4751 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4752 in future warnings may be added to @option{-Wformat-security} that are not
4753 included in @option{-Wformat-nonliteral}.)
4754
4755 @item -Wformat-signedness
4756 @opindex Wformat-signedness
4757 @opindex Wno-format-signedness
4758 If @option{-Wformat} is specified, also warn if the format string
4759 requires an unsigned argument and the argument is signed and vice versa.
4760
4761 @item -Wformat-truncation
4762 @itemx -Wformat-truncation=@var{level}
4763 @opindex Wformat-truncation
4764 @opindex Wno-format-truncation
4765 Warn about calls to formatted input/output functions such as @code{snprintf}
4766 and @code{vsnprintf} that might result in output truncation. When the exact
4767 number of bytes written by a format directive cannot be determined at
4768 compile-time it is estimated based on heuristics that depend on
4769 the @var{level} argument and on optimization. While enabling optimization
4770 will in most cases improve the accuracy of the warning, it may also result
4771 in false positives. Except as noted otherwise, the option uses the same
4772 logic @option{-Wformat-overflow}.
4773
4774 @table @gcctabopt
4775 @item -Wformat-truncation
4776 @itemx -Wformat-truncation=1
4777 @opindex Wformat-truncation
4778 @opindex Wno-format-truncation
4779 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4780 employs a conservative approach that warns only about calls to bounded
4781 functions whose return value is unused and that will most likely result
4782 in output truncation.
4783
4784 @item -Wformat-truncation=2
4785 Level @var{2} warns also about calls to bounded functions whose return
4786 value is used and that might result in truncation given an argument of
4787 sufficient length or magnitude.
4788 @end table
4789
4790 @item -Wformat-y2k
4791 @opindex Wformat-y2k
4792 @opindex Wno-format-y2k
4793 If @option{-Wformat} is specified, also warn about @code{strftime}
4794 formats that may yield only a two-digit year.
4795 @end table
4796
4797 @item -Wnonnull
4798 @opindex Wnonnull
4799 @opindex Wno-nonnull
4800 Warn about passing a null pointer for arguments marked as
4801 requiring a non-null value by the @code{nonnull} function attribute.
4802
4803 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
4804 can be disabled with the @option{-Wno-nonnull} option.
4805
4806 @item -Wnonnull-compare
4807 @opindex Wnonnull-compare
4808 @opindex Wno-nonnull-compare
4809 Warn when comparing an argument marked with the @code{nonnull}
4810 function attribute against null inside the function.
4811
4812 @option{-Wnonnull-compare} is included in @option{-Wall}. It
4813 can be disabled with the @option{-Wno-nonnull-compare} option.
4814
4815 @item -Wnull-dereference
4816 @opindex Wnull-dereference
4817 @opindex Wno-null-dereference
4818 Warn if the compiler detects paths that trigger erroneous or
4819 undefined behavior due to dereferencing a null pointer. This option
4820 is only active when @option{-fdelete-null-pointer-checks} is active,
4821 which is enabled by optimizations in most targets. The precision of
4822 the warnings depends on the optimization options used.
4823
4824 @item -Winaccessible-base @r{(C++, Objective-C++ only)}
4825 @opindex Winaccessible-base
4826 @opindex Wno-inaccessible-base
4827 Warn when a base class is inaccessible in a class derived from it due to
4828 ambiguity. The warning is enabled by default. Note the warning for virtual
4829 bases is enabled by the @option{-Wextra} option.
4830 @smallexample
4831 @group
4832 struct A @{ int a; @};
4833
4834 struct B : A @{ @};
4835
4836 struct C : B, A @{ @};
4837 @end group
4838 @end smallexample
4839
4840 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4841 @opindex Winit-self
4842 @opindex Wno-init-self
4843 Warn about uninitialized variables that are initialized with themselves.
4844 Note this option can only be used with the @option{-Wuninitialized} option.
4845
4846 For example, GCC warns about @code{i} being uninitialized in the
4847 following snippet only when @option{-Winit-self} has been specified:
4848 @smallexample
4849 @group
4850 int f()
4851 @{
4852 int i = i;
4853 return i;
4854 @}
4855 @end group
4856 @end smallexample
4857
4858 This warning is enabled by @option{-Wall} in C++.
4859
4860 @item -Wimplicit-int @r{(C and Objective-C only)}
4861 @opindex Wimplicit-int
4862 @opindex Wno-implicit-int
4863 Warn when a declaration does not specify a type.
4864 This warning is enabled by @option{-Wall}.
4865
4866 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4867 @opindex Wimplicit-function-declaration
4868 @opindex Wno-implicit-function-declaration
4869 Give a warning whenever a function is used before being declared. In
4870 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4871 enabled by default and it is made into an error by
4872 @option{-pedantic-errors}. This warning is also enabled by
4873 @option{-Wall}.
4874
4875 @item -Wimplicit @r{(C and Objective-C only)}
4876 @opindex Wimplicit
4877 @opindex Wno-implicit
4878 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4879 This warning is enabled by @option{-Wall}.
4880
4881 @item -Wimplicit-fallthrough
4882 @opindex Wimplicit-fallthrough
4883 @opindex Wno-implicit-fallthrough
4884 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4885 and @option{-Wno-implicit-fallthrough} is the same as
4886 @option{-Wimplicit-fallthrough=0}.
4887
4888 @item -Wimplicit-fallthrough=@var{n}
4889 @opindex Wimplicit-fallthrough=
4890 Warn when a switch case falls through. For example:
4891
4892 @smallexample
4893 @group
4894 switch (cond)
4895 @{
4896 case 1:
4897 a = 1;
4898 break;
4899 case 2:
4900 a = 2;
4901 case 3:
4902 a = 3;
4903 break;
4904 @}
4905 @end group
4906 @end smallexample
4907
4908 This warning does not warn when the last statement of a case cannot
4909 fall through, e.g. when there is a return statement or a call to function
4910 declared with the noreturn attribute. @option{-Wimplicit-fallthrough=}
4911 also takes into account control flow statements, such as ifs, and only
4912 warns when appropriate. E.g.@:
4913
4914 @smallexample
4915 @group
4916 switch (cond)
4917 @{
4918 case 1:
4919 if (i > 3) @{
4920 bar (5);
4921 break;
4922 @} else if (i < 1) @{
4923 bar (0);
4924 @} else
4925 return;
4926 default:
4927 @dots{}
4928 @}
4929 @end group
4930 @end smallexample
4931
4932 Since there are occasions where a switch case fall through is desirable,
4933 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4934 to be used along with a null statement to suppress this warning that
4935 would normally occur:
4936
4937 @smallexample
4938 @group
4939 switch (cond)
4940 @{
4941 case 1:
4942 bar (0);
4943 __attribute__ ((fallthrough));
4944 default:
4945 @dots{}
4946 @}
4947 @end group
4948 @end smallexample
4949
4950 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4951 warning using @code{[[fallthrough]];} instead of the GNU attribute. In C++11
4952 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4953 Instead of these attributes, it is also possible to add a fallthrough comment
4954 to silence the warning. The whole body of the C or C++ style comment should
4955 match the given regular expressions listed below. The option argument @var{n}
4956 specifies what kind of comments are accepted:
4957
4958 @itemize @bullet
4959
4960 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4961
4962 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4963 expression, any comment is used as fallthrough comment.
4964
4965 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4966 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4967
4968 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4969 following regular expressions:
4970
4971 @itemize @bullet
4972
4973 @item @code{-fallthrough}
4974
4975 @item @code{@@fallthrough@@}
4976
4977 @item @code{lint -fallthrough[ \t]*}
4978
4979 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4980
4981 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4982
4983 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4984
4985 @end itemize
4986
4987 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4988 following regular expressions:
4989
4990 @itemize @bullet
4991
4992 @item @code{-fallthrough}
4993
4994 @item @code{@@fallthrough@@}
4995
4996 @item @code{lint -fallthrough[ \t]*}
4997
4998 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4999
5000 @end itemize
5001
5002 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
5003 fallthrough comments, only attributes disable the warning.
5004
5005 @end itemize
5006
5007 The comment needs to be followed after optional whitespace and other comments
5008 by @code{case} or @code{default} keywords or by a user label that precedes some
5009 @code{case} or @code{default} label.
5010
5011 @smallexample
5012 @group
5013 switch (cond)
5014 @{
5015 case 1:
5016 bar (0);
5017 /* FALLTHRU */
5018 default:
5019 @dots{}
5020 @}
5021 @end group
5022 @end smallexample
5023
5024 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
5025
5026 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
5027 @opindex Wif-not-aligned
5028 @opindex Wno-if-not-aligned
5029 Control if warning triggered by the @code{warn_if_not_aligned} attribute
5030 should be issued. This is enabled by default.
5031 Use @option{-Wno-if-not-aligned} to disable it.
5032
5033 @item -Wignored-qualifiers @r{(C and C++ only)}
5034 @opindex Wignored-qualifiers
5035 @opindex Wno-ignored-qualifiers
5036 Warn if the return type of a function has a type qualifier
5037 such as @code{const}. For ISO C such a type qualifier has no effect,
5038 since the value returned by a function is not an lvalue.
5039 For C++, the warning is only emitted for scalar types or @code{void}.
5040 ISO C prohibits qualified @code{void} return types on function
5041 definitions, so such return types always receive a warning
5042 even without this option.
5043
5044 This warning is also enabled by @option{-Wextra}.
5045
5046 @item -Wignored-attributes @r{(C and C++ only)}
5047 @opindex Wignored-attributes
5048 @opindex Wno-ignored-attributes
5049 Warn when an attribute is ignored. This is different from the
5050 @option{-Wattributes} option in that it warns whenever the compiler decides
5051 to drop an attribute, not that the attribute is either unknown, used in a
5052 wrong place, etc. This warning is enabled by default.
5053
5054 @item -Wmain
5055 @opindex Wmain
5056 @opindex Wno-main
5057 Warn if the type of @code{main} is suspicious. @code{main} should be
5058 a function with external linkage, returning int, taking either zero
5059 arguments, two, or three arguments of appropriate types. This warning
5060 is enabled by default in C++ and is enabled by either @option{-Wall}
5061 or @option{-Wpedantic}.
5062
5063 @item -Wmisleading-indentation @r{(C and C++ only)}
5064 @opindex Wmisleading-indentation
5065 @opindex Wno-misleading-indentation
5066 Warn when the indentation of the code does not reflect the block structure.
5067 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
5068 @code{for} clauses with a guarded statement that does not use braces,
5069 followed by an unguarded statement with the same indentation.
5070
5071 In the following example, the call to ``bar'' is misleadingly indented as
5072 if it were guarded by the ``if'' conditional.
5073
5074 @smallexample
5075 if (some_condition ())
5076 foo ();
5077 bar (); /* Gotcha: this is not guarded by the "if". */
5078 @end smallexample
5079
5080 In the case of mixed tabs and spaces, the warning uses the
5081 @option{-ftabstop=} option to determine if the statements line up
5082 (defaulting to 8).
5083
5084 The warning is not issued for code involving multiline preprocessor logic
5085 such as the following example.
5086
5087 @smallexample
5088 if (flagA)
5089 foo (0);
5090 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
5091 if (flagB)
5092 #endif
5093 foo (1);
5094 @end smallexample
5095
5096 The warning is not issued after a @code{#line} directive, since this
5097 typically indicates autogenerated code, and no assumptions can be made
5098 about the layout of the file that the directive references.
5099
5100 This warning is enabled by @option{-Wall} in C and C++.
5101
5102 @item -Wmissing-attributes
5103 @opindex Wmissing-attributes
5104 @opindex Wno-missing-attributes
5105 Warn when a declaration of a function is missing one or more attributes
5106 that a related function is declared with and whose absence may adversely
5107 affect the correctness or efficiency of generated code. For example,
5108 the warning is issued for declarations of aliases that use attributes
5109 to specify less restrictive requirements than those of their targets.
5110 This typically represents a potential optimization opportunity.
5111 By contrast, the @option{-Wattribute-alias=2} option controls warnings
5112 issued when the alias is more restrictive than the target, which could
5113 lead to incorrect code generation.
5114 Attributes considered include @code{alloc_align}, @code{alloc_size},
5115 @code{cold}, @code{const}, @code{hot}, @code{leaf}, @code{malloc},
5116 @code{nonnull}, @code{noreturn}, @code{nothrow}, @code{pure},
5117 @code{returns_nonnull}, and @code{returns_twice}.
5118
5119 In C++, the warning is issued when an explicit specialization of a primary
5120 template declared with attribute @code{alloc_align}, @code{alloc_size},
5121 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
5122 or @code{nonnull} is declared without it. Attributes @code{deprecated},
5123 @code{error}, and @code{warning} suppress the warning.
5124 (@pxref{Function Attributes}).
5125
5126 You can use the @code{copy} attribute to apply the same
5127 set of attributes to a declaration as that on another declaration without
5128 explicitly enumerating the attributes. This attribute can be applied
5129 to declarations of functions (@pxref{Common Function Attributes}),
5130 variables (@pxref{Common Variable Attributes}), or types
5131 (@pxref{Common Type Attributes}).
5132
5133 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
5134
5135 For example, since the declaration of the primary function template
5136 below makes use of both attribute @code{malloc} and @code{alloc_size}
5137 the declaration of the explicit specialization of the template is
5138 diagnosed because it is missing one of the attributes.
5139
5140 @smallexample
5141 template <class T>
5142 T* __attribute__ ((malloc, alloc_size (1)))
5143 allocate (size_t);
5144
5145 template <>
5146 void* __attribute__ ((malloc)) // missing alloc_size
5147 allocate<void> (size_t);
5148 @end smallexample
5149
5150 @item -Wmissing-braces
5151 @opindex Wmissing-braces
5152 @opindex Wno-missing-braces
5153 Warn if an aggregate or union initializer is not fully bracketed. In
5154 the following example, the initializer for @code{a} is not fully
5155 bracketed, but that for @code{b} is fully bracketed. This warning is
5156 enabled by @option{-Wall} in C.
5157
5158 @smallexample
5159 int a[2][2] = @{ 0, 1, 2, 3 @};
5160 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
5161 @end smallexample
5162
5163 This warning is enabled by @option{-Wall}.
5164
5165 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
5166 @opindex Wmissing-include-dirs
5167 @opindex Wno-missing-include-dirs
5168 Warn if a user-supplied include directory does not exist.
5169
5170 @item -Wmissing-profile
5171 @opindex Wmissing-profile
5172 @opindex Wno-missing-profile
5173 Warn if feedback profiles are missing when using the
5174 @option{-fprofile-use} option.
5175 This option diagnoses those cases where a new function or a new file is added
5176 to the user code between compiling with @option{-fprofile-generate} and with
5177 @option{-fprofile-use}, without regenerating the profiles. In these cases, the
5178 profile feedback data files do not contain any profile feedback information for
5179 the newly added function or file respectively. Also, in the case when profile
5180 count data (.gcda) files are removed, GCC cannot use any profile feedback
5181 information. In all these cases, warnings are issued to inform the user that a
5182 profile generation step is due. @option{-Wno-missing-profile} can be used to
5183 disable the warning. Ignoring the warning can result in poorly optimized code.
5184 Completely disabling the warning is not recommended and should be done only
5185 when non-existent profile data is justified.
5186
5187 @item -Wmultistatement-macros
5188 @opindex Wmultistatement-macros
5189 @opindex Wno-multistatement-macros
5190 Warn about unsafe multiple statement macros that appear to be guarded
5191 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
5192 @code{while}, in which only the first statement is actually guarded after
5193 the macro is expanded.
5194
5195 For example:
5196
5197 @smallexample
5198 #define DOIT x++; y++
5199 if (c)
5200 DOIT;
5201 @end smallexample
5202
5203 will increment @code{y} unconditionally, not just when @code{c} holds.
5204 The can usually be fixed by wrapping the macro in a do-while loop:
5205 @smallexample
5206 #define DOIT do @{ x++; y++; @} while (0)
5207 if (c)
5208 DOIT;
5209 @end smallexample
5210
5211 This warning is enabled by @option{-Wall} in C and C++.
5212
5213 @item -Wparentheses
5214 @opindex Wparentheses
5215 @opindex Wno-parentheses
5216 Warn if parentheses are omitted in certain contexts, such
5217 as when there is an assignment in a context where a truth value
5218 is expected, or when operators are nested whose precedence people
5219 often get confused about.
5220
5221 Also warn if a comparison like @code{x<=y<=z} appears; this is
5222 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
5223 interpretation from that of ordinary mathematical notation.
5224
5225 Also warn for dangerous uses of the GNU extension to
5226 @code{?:} with omitted middle operand. When the condition
5227 in the @code{?}: operator is a boolean expression, the omitted value is
5228 always 1. Often programmers expect it to be a value computed
5229 inside the conditional expression instead.
5230
5231 For C++ this also warns for some cases of unnecessary parentheses in
5232 declarations, which can indicate an attempt at a function call instead
5233 of a declaration:
5234 @smallexample
5235 @{
5236 // Declares a local variable called mymutex.
5237 std::unique_lock<std::mutex> (mymutex);
5238 // User meant std::unique_lock<std::mutex> lock (mymutex);
5239 @}
5240 @end smallexample
5241
5242 This warning is enabled by @option{-Wall}.
5243
5244 @item -Wsequence-point
5245 @opindex Wsequence-point
5246 @opindex Wno-sequence-point
5247 Warn about code that may have undefined semantics because of violations
5248 of sequence point rules in the C and C++ standards.
5249
5250 The C and C++ standards define the order in which expressions in a C/C++
5251 program are evaluated in terms of @dfn{sequence points}, which represent
5252 a partial ordering between the execution of parts of the program: those
5253 executed before the sequence point, and those executed after it. These
5254 occur after the evaluation of a full expression (one which is not part
5255 of a larger expression), after the evaluation of the first operand of a
5256 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
5257 function is called (but after the evaluation of its arguments and the
5258 expression denoting the called function), and in certain other places.
5259 Other than as expressed by the sequence point rules, the order of
5260 evaluation of subexpressions of an expression is not specified. All
5261 these rules describe only a partial order rather than a total order,
5262 since, for example, if two functions are called within one expression
5263 with no sequence point between them, the order in which the functions
5264 are called is not specified. However, the standards committee have
5265 ruled that function calls do not overlap.
5266
5267 It is not specified when between sequence points modifications to the
5268 values of objects take effect. Programs whose behavior depends on this
5269 have undefined behavior; the C and C++ standards specify that ``Between
5270 the previous and next sequence point an object shall have its stored
5271 value modified at most once by the evaluation of an expression.
5272 Furthermore, the prior value shall be read only to determine the value
5273 to be stored.''. If a program breaks these rules, the results on any
5274 particular implementation are entirely unpredictable.
5275
5276 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
5277 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
5278 diagnosed by this option, and it may give an occasional false positive
5279 result, but in general it has been found fairly effective at detecting
5280 this sort of problem in programs.
5281
5282 The C++17 standard will define the order of evaluation of operands in
5283 more cases: in particular it requires that the right-hand side of an
5284 assignment be evaluated before the left-hand side, so the above
5285 examples are no longer undefined. But this warning will still warn
5286 about them, to help people avoid writing code that is undefined in C
5287 and earlier revisions of C++.
5288
5289 The standard is worded confusingly, therefore there is some debate
5290 over the precise meaning of the sequence point rules in subtle cases.
5291 Links to discussions of the problem, including proposed formal
5292 definitions, may be found on the GCC readings page, at
5293 @uref{http://gcc.gnu.org/@/readings.html}.
5294
5295 This warning is enabled by @option{-Wall} for C and C++.
5296
5297 @item -Wno-return-local-addr
5298 @opindex Wno-return-local-addr
5299 @opindex Wreturn-local-addr
5300 Do not warn about returning a pointer (or in C++, a reference) to a
5301 variable that goes out of scope after the function returns.
5302
5303 @item -Wreturn-type
5304 @opindex Wreturn-type
5305 @opindex Wno-return-type
5306 Warn whenever a function is defined with a return type that defaults
5307 to @code{int}. Also warn about any @code{return} statement with no
5308 return value in a function whose return type is not @code{void}
5309 (falling off the end of the function body is considered returning
5310 without a value).
5311
5312 For C only, warn about a @code{return} statement with an expression in a
5313 function whose return type is @code{void}, unless the expression type is
5314 also @code{void}. As a GNU extension, the latter case is accepted
5315 without a warning unless @option{-Wpedantic} is used. Attempting
5316 to use the return value of a non-@code{void} function other than @code{main}
5317 that flows off the end by reaching the closing curly brace that terminates
5318 the function is undefined.
5319
5320 Unlike in C, in C++, flowing off the end of a non-@code{void} function other
5321 than @code{main} results in undefined behavior even when the value of
5322 the function is not used.
5323
5324 This warning is enabled by default in C++ and by @option{-Wall} otherwise.
5325
5326 @item -Wshift-count-negative
5327 @opindex Wshift-count-negative
5328 @opindex Wno-shift-count-negative
5329 Warn if shift count is negative. This warning is enabled by default.
5330
5331 @item -Wshift-count-overflow
5332 @opindex Wshift-count-overflow
5333 @opindex Wno-shift-count-overflow
5334 Warn if shift count >= width of type. This warning is enabled by default.
5335
5336 @item -Wshift-negative-value
5337 @opindex Wshift-negative-value
5338 @opindex Wno-shift-negative-value
5339 Warn if left shifting a negative value. This warning is enabled by
5340 @option{-Wextra} in C99 and C++11 modes (and newer).
5341
5342 @item -Wshift-overflow
5343 @itemx -Wshift-overflow=@var{n}
5344 @opindex Wshift-overflow
5345 @opindex Wno-shift-overflow
5346 Warn about left shift overflows. This warning is enabled by
5347 default in C99 and C++11 modes (and newer).
5348
5349 @table @gcctabopt
5350 @item -Wshift-overflow=1
5351 This is the warning level of @option{-Wshift-overflow} and is enabled
5352 by default in C99 and C++11 modes (and newer). This warning level does
5353 not warn about left-shifting 1 into the sign bit. (However, in C, such
5354 an overflow is still rejected in contexts where an integer constant expression
5355 is required.) No warning is emitted in C++2A mode (and newer), as signed left
5356 shifts always wrap.
5357
5358 @item -Wshift-overflow=2
5359 This warning level also warns about left-shifting 1 into the sign bit,
5360 unless C++14 mode (or newer) is active.
5361 @end table
5362
5363 @item -Wswitch
5364 @opindex Wswitch
5365 @opindex Wno-switch
5366 Warn whenever a @code{switch} statement has an index of enumerated type
5367 and lacks a @code{case} for one or more of the named codes of that
5368 enumeration. (The presence of a @code{default} label prevents this
5369 warning.) @code{case} labels outside the enumeration range also
5370 provoke warnings when this option is used (even if there is a
5371 @code{default} label).
5372 This warning is enabled by @option{-Wall}.
5373
5374 @item -Wswitch-default
5375 @opindex Wswitch-default
5376 @opindex Wno-switch-default
5377 Warn whenever a @code{switch} statement does not have a @code{default}
5378 case.
5379
5380 @item -Wswitch-enum
5381 @opindex Wswitch-enum
5382 @opindex Wno-switch-enum
5383 Warn whenever a @code{switch} statement has an index of enumerated type
5384 and lacks a @code{case} for one or more of the named codes of that
5385 enumeration. @code{case} labels outside the enumeration range also
5386 provoke warnings when this option is used. The only difference
5387 between @option{-Wswitch} and this option is that this option gives a
5388 warning about an omitted enumeration code even if there is a
5389 @code{default} label.
5390
5391 @item -Wswitch-bool
5392 @opindex Wswitch-bool
5393 @opindex Wno-switch-bool
5394 Warn whenever a @code{switch} statement has an index of boolean type
5395 and the case values are outside the range of a boolean type.
5396 It is possible to suppress this warning by casting the controlling
5397 expression to a type other than @code{bool}. For example:
5398 @smallexample
5399 @group
5400 switch ((int) (a == 4))
5401 @{
5402 @dots{}
5403 @}
5404 @end group
5405 @end smallexample
5406 This warning is enabled by default for C and C++ programs.
5407
5408 @item -Wswitch-outside-range
5409 @opindex Wswitch-outside-range
5410 @opindex Wno-switch-outside-range
5411 Warn whenever a @code{switch} case has a value that is outside of its
5412 respective type range. This warning is enabled by default for
5413 C and C++ programs.
5414
5415 @item -Wswitch-unreachable
5416 @opindex Wswitch-unreachable
5417 @opindex Wno-switch-unreachable
5418 Warn whenever a @code{switch} statement contains statements between the
5419 controlling expression and the first case label, which will never be
5420 executed. For example:
5421 @smallexample
5422 @group
5423 switch (cond)
5424 @{
5425 i = 15;
5426 @dots{}
5427 case 5:
5428 @dots{}
5429 @}
5430 @end group
5431 @end smallexample
5432 @option{-Wswitch-unreachable} does not warn if the statement between the
5433 controlling expression and the first case label is just a declaration:
5434 @smallexample
5435 @group
5436 switch (cond)
5437 @{
5438 int i;
5439 @dots{}
5440 case 5:
5441 i = 5;
5442 @dots{}
5443 @}
5444 @end group
5445 @end smallexample
5446 This warning is enabled by default for C and C++ programs.
5447
5448 @item -Wsync-nand @r{(C and C++ only)}
5449 @opindex Wsync-nand
5450 @opindex Wno-sync-nand
5451 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
5452 built-in functions are used. These functions changed semantics in GCC 4.4.
5453
5454 @item -Wunused-but-set-parameter
5455 @opindex Wunused-but-set-parameter
5456 @opindex Wno-unused-but-set-parameter
5457 Warn whenever a function parameter is assigned to, but otherwise unused
5458 (aside from its declaration).
5459
5460 To suppress this warning use the @code{unused} attribute
5461 (@pxref{Variable Attributes}).
5462
5463 This warning is also enabled by @option{-Wunused} together with
5464 @option{-Wextra}.
5465
5466 @item -Wunused-but-set-variable
5467 @opindex Wunused-but-set-variable
5468 @opindex Wno-unused-but-set-variable
5469 Warn whenever a local variable is assigned to, but otherwise unused
5470 (aside from its declaration).
5471 This warning is enabled by @option{-Wall}.
5472
5473 To suppress this warning use the @code{unused} attribute
5474 (@pxref{Variable Attributes}).
5475
5476 This warning is also enabled by @option{-Wunused}, which is enabled
5477 by @option{-Wall}.
5478
5479 @item -Wunused-function
5480 @opindex Wunused-function
5481 @opindex Wno-unused-function
5482 Warn whenever a static function is declared but not defined or a
5483 non-inline static function is unused.
5484 This warning is enabled by @option{-Wall}.
5485
5486 @item -Wunused-label
5487 @opindex Wunused-label
5488 @opindex Wno-unused-label
5489 Warn whenever a label is declared but not used.
5490 This warning is enabled by @option{-Wall}.
5491
5492 To suppress this warning use the @code{unused} attribute
5493 (@pxref{Variable Attributes}).
5494
5495 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
5496 @opindex Wunused-local-typedefs
5497 @opindex Wno-unused-local-typedefs
5498 Warn when a typedef locally defined in a function is not used.
5499 This warning is enabled by @option{-Wall}.
5500
5501 @item -Wunused-parameter
5502 @opindex Wunused-parameter
5503 @opindex Wno-unused-parameter
5504 Warn whenever a function parameter is unused aside from its declaration.
5505
5506 To suppress this warning use the @code{unused} attribute
5507 (@pxref{Variable Attributes}).
5508
5509 @item -Wno-unused-result
5510 @opindex Wunused-result
5511 @opindex Wno-unused-result
5512 Do not warn if a caller of a function marked with attribute
5513 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
5514 its return value. The default is @option{-Wunused-result}.
5515
5516 @item -Wunused-variable
5517 @opindex Wunused-variable
5518 @opindex Wno-unused-variable
5519 Warn whenever a local or static variable is unused aside from its
5520 declaration. This option implies @option{-Wunused-const-variable=1} for C,
5521 but not for C++. This warning is enabled by @option{-Wall}.
5522
5523 To suppress this warning use the @code{unused} attribute
5524 (@pxref{Variable Attributes}).
5525
5526 @item -Wunused-const-variable
5527 @itemx -Wunused-const-variable=@var{n}
5528 @opindex Wunused-const-variable
5529 @opindex Wno-unused-const-variable
5530 Warn whenever a constant static variable is unused aside from its declaration.
5531 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
5532 for C, but not for C++. In C this declares variable storage, but in C++ this
5533 is not an error since const variables take the place of @code{#define}s.
5534
5535 To suppress this warning use the @code{unused} attribute
5536 (@pxref{Variable Attributes}).
5537
5538 @table @gcctabopt
5539 @item -Wunused-const-variable=1
5540 This is the warning level that is enabled by @option{-Wunused-variable} for
5541 C. It warns only about unused static const variables defined in the main
5542 compilation unit, but not about static const variables declared in any
5543 header included.
5544
5545 @item -Wunused-const-variable=2
5546 This warning level also warns for unused constant static variables in
5547 headers (excluding system headers). This is the warning level of
5548 @option{-Wunused-const-variable} and must be explicitly requested since
5549 in C++ this isn't an error and in C it might be harder to clean up all
5550 headers included.
5551 @end table
5552
5553 @item -Wunused-value
5554 @opindex Wunused-value
5555 @opindex Wno-unused-value
5556 Warn whenever a statement computes a result that is explicitly not
5557 used. To suppress this warning cast the unused expression to
5558 @code{void}. This includes an expression-statement or the left-hand
5559 side of a comma expression that contains no side effects. For example,
5560 an expression such as @code{x[i,j]} causes a warning, while
5561 @code{x[(void)i,j]} does not.
5562
5563 This warning is enabled by @option{-Wall}.
5564
5565 @item -Wunused
5566 @opindex Wunused
5567 @opindex Wno-unused
5568 All the above @option{-Wunused} options combined.
5569
5570 In order to get a warning about an unused function parameter, you must
5571 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5572 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5573
5574 @item -Wuninitialized
5575 @opindex Wuninitialized
5576 @opindex Wno-uninitialized
5577 Warn if an automatic variable is used without first being initialized
5578 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5579 warn if a non-static reference or non-static @code{const} member
5580 appears in a class without constructors.
5581
5582 If you want to warn about code that uses the uninitialized value of the
5583 variable in its own initializer, use the @option{-Winit-self} option.
5584
5585 These warnings occur for individual uninitialized or clobbered
5586 elements of structure, union or array variables as well as for
5587 variables that are uninitialized or clobbered as a whole. They do
5588 not occur for variables or elements declared @code{volatile}. Because
5589 these warnings depend on optimization, the exact variables or elements
5590 for which there are warnings depends on the precise optimization
5591 options and version of GCC used.
5592
5593 Note that there may be no warning about a variable that is used only
5594 to compute a value that itself is never used, because such
5595 computations may be deleted by data flow analysis before the warnings
5596 are printed.
5597
5598 @item -Winvalid-memory-model
5599 @opindex Winvalid-memory-model
5600 @opindex Wno-invalid-memory-model
5601 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5602 and the C11 atomic generic functions with a memory consistency argument
5603 that is either invalid for the operation or outside the range of values
5604 of the @code{memory_order} enumeration. For example, since the
5605 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5606 defined for the relaxed, release, and sequentially consistent memory
5607 orders the following code is diagnosed:
5608
5609 @smallexample
5610 void store (int *i)
5611 @{
5612 __atomic_store_n (i, 0, memory_order_consume);
5613 @}
5614 @end smallexample
5615
5616 @option{-Winvalid-memory-model} is enabled by default.
5617
5618 @item -Wmaybe-uninitialized
5619 @opindex Wmaybe-uninitialized
5620 @opindex Wno-maybe-uninitialized
5621 For an automatic (i.e.@: local) variable, if there exists a path from the
5622 function entry to a use of the variable that is initialized, but there exist
5623 some other paths for which the variable is not initialized, the compiler
5624 emits a warning if it cannot prove the uninitialized paths are not
5625 executed at run time.
5626
5627 These warnings are only possible in optimizing compilation, because otherwise
5628 GCC does not keep track of the state of variables.
5629
5630 These warnings are made optional because GCC may not be able to determine when
5631 the code is correct in spite of appearing to have an error. Here is one
5632 example of how this can happen:
5633
5634 @smallexample
5635 @group
5636 @{
5637 int x;
5638 switch (y)
5639 @{
5640 case 1: x = 1;
5641 break;
5642 case 2: x = 4;
5643 break;
5644 case 3: x = 5;
5645 @}
5646 foo (x);
5647 @}
5648 @end group
5649 @end smallexample
5650
5651 @noindent
5652 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5653 always initialized, but GCC doesn't know this. To suppress the
5654 warning, you need to provide a default case with assert(0) or
5655 similar code.
5656
5657 @cindex @code{longjmp} warnings
5658 This option also warns when a non-volatile automatic variable might be
5659 changed by a call to @code{longjmp}.
5660 The compiler sees only the calls to @code{setjmp}. It cannot know
5661 where @code{longjmp} will be called; in fact, a signal handler could
5662 call it at any point in the code. As a result, you may get a warning
5663 even when there is in fact no problem because @code{longjmp} cannot
5664 in fact be called at the place that would cause a problem.
5665
5666 Some spurious warnings can be avoided if you declare all the functions
5667 you use that never return as @code{noreturn}. @xref{Function
5668 Attributes}.
5669
5670 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5671
5672 @item -Wunknown-pragmas
5673 @opindex Wunknown-pragmas
5674 @opindex Wno-unknown-pragmas
5675 @cindex warning for unknown pragmas
5676 @cindex unknown pragmas, warning
5677 @cindex pragmas, warning of unknown
5678 Warn when a @code{#pragma} directive is encountered that is not understood by
5679 GCC@. If this command-line option is used, warnings are even issued
5680 for unknown pragmas in system header files. This is not the case if
5681 the warnings are only enabled by the @option{-Wall} command-line option.
5682
5683 @item -Wno-pragmas
5684 @opindex Wno-pragmas
5685 @opindex Wpragmas
5686 Do not warn about misuses of pragmas, such as incorrect parameters,
5687 invalid syntax, or conflicts between pragmas. See also
5688 @option{-Wunknown-pragmas}.
5689
5690 @item -Wno-prio-ctor-dtor
5691 @opindex Wno-prio-ctor-dtor
5692 @opindex Wprio-ctor-dtor
5693 Do not warn if a priority from 0 to 100 is used for constructor or destructor.
5694 The use of constructor and destructor attributes allow you to assign a
5695 priority to the constructor/destructor to control its order of execution
5696 before @code{main} is called or after it returns. The priority values must be
5697 greater than 100 as the compiler reserves priority values between 0--100 for
5698 the implementation.
5699
5700 @item -Wstrict-aliasing
5701 @opindex Wstrict-aliasing
5702 @opindex Wno-strict-aliasing
5703 This option is only active when @option{-fstrict-aliasing} is active.
5704 It warns about code that might break the strict aliasing rules that the
5705 compiler is using for optimization. The warning does not catch all
5706 cases, but does attempt to catch the more common pitfalls. It is
5707 included in @option{-Wall}.
5708 It is equivalent to @option{-Wstrict-aliasing=3}
5709
5710 @item -Wstrict-aliasing=n
5711 @opindex Wstrict-aliasing=n
5712 This option is only active when @option{-fstrict-aliasing} is active.
5713 It warns about code that might break the strict aliasing rules that the
5714 compiler is using for optimization.
5715 Higher levels correspond to higher accuracy (fewer false positives).
5716 Higher levels also correspond to more effort, similar to the way @option{-O}
5717 works.
5718 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5719
5720 Level 1: Most aggressive, quick, least accurate.
5721 Possibly useful when higher levels
5722 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5723 false negatives. However, it has many false positives.
5724 Warns for all pointer conversions between possibly incompatible types,
5725 even if never dereferenced. Runs in the front end only.
5726
5727 Level 2: Aggressive, quick, not too precise.
5728 May still have many false positives (not as many as level 1 though),
5729 and few false negatives (but possibly more than level 1).
5730 Unlike level 1, it only warns when an address is taken. Warns about
5731 incomplete types. Runs in the front end only.
5732
5733 Level 3 (default for @option{-Wstrict-aliasing}):
5734 Should have very few false positives and few false
5735 negatives. Slightly slower than levels 1 or 2 when optimization is enabled.
5736 Takes care of the common pun+dereference pattern in the front end:
5737 @code{*(int*)&some_float}.
5738 If optimization is enabled, it also runs in the back end, where it deals
5739 with multiple statement cases using flow-sensitive points-to information.
5740 Only warns when the converted pointer is dereferenced.
5741 Does not warn about incomplete types.
5742
5743 @item -Wstrict-overflow
5744 @itemx -Wstrict-overflow=@var{n}
5745 @opindex Wstrict-overflow
5746 @opindex Wno-strict-overflow
5747 This option is only active when signed overflow is undefined.
5748 It warns about cases where the compiler optimizes based on the
5749 assumption that signed overflow does not occur. Note that it does not
5750 warn about all cases where the code might overflow: it only warns
5751 about cases where the compiler implements some optimization. Thus
5752 this warning depends on the optimization level.
5753
5754 An optimization that assumes that signed overflow does not occur is
5755 perfectly safe if the values of the variables involved are such that
5756 overflow never does, in fact, occur. Therefore this warning can
5757 easily give a false positive: a warning about code that is not
5758 actually a problem. To help focus on important issues, several
5759 warning levels are defined. No warnings are issued for the use of
5760 undefined signed overflow when estimating how many iterations a loop
5761 requires, in particular when determining whether a loop will be
5762 executed at all.
5763
5764 @table @gcctabopt
5765 @item -Wstrict-overflow=1
5766 Warn about cases that are both questionable and easy to avoid. For
5767 example the compiler simplifies
5768 @code{x + 1 > x} to @code{1}. This level of
5769 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5770 are not, and must be explicitly requested.
5771
5772 @item -Wstrict-overflow=2
5773 Also warn about other cases where a comparison is simplified to a
5774 constant. For example: @code{abs (x) >= 0}. This can only be
5775 simplified when signed integer overflow is undefined, because
5776 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5777 zero. @option{-Wstrict-overflow} (with no level) is the same as
5778 @option{-Wstrict-overflow=2}.
5779
5780 @item -Wstrict-overflow=3
5781 Also warn about other cases where a comparison is simplified. For
5782 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5783
5784 @item -Wstrict-overflow=4
5785 Also warn about other simplifications not covered by the above cases.
5786 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5787
5788 @item -Wstrict-overflow=5
5789 Also warn about cases where the compiler reduces the magnitude of a
5790 constant involved in a comparison. For example: @code{x + 2 > y} is
5791 simplified to @code{x + 1 >= y}. This is reported only at the
5792 highest warning level because this simplification applies to many
5793 comparisons, so this warning level gives a very large number of
5794 false positives.
5795 @end table
5796
5797 @item -Wstringop-overflow
5798 @itemx -Wstringop-overflow=@var{type}
5799 @opindex Wstringop-overflow
5800 @opindex Wno-stringop-overflow
5801 Warn for calls to string manipulation functions such as @code{memcpy} and
5802 @code{strcpy} that are determined to overflow the destination buffer. The
5803 optional argument is one greater than the type of Object Size Checking to
5804 perform to determine the size of the destination. @xref{Object Size Checking}.
5805 The argument is meaningful only for functions that operate on character arrays
5806 but not for raw memory functions like @code{memcpy} which always make use
5807 of Object Size type-0. The option also warns for calls that specify a size
5808 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5809 The option produces the best results with optimization enabled but can detect
5810 a small subset of simple buffer overflows even without optimization in
5811 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5812 correspond to the standard functions. In any case, the option warns about
5813 just a subset of buffer overflows detected by the corresponding overflow
5814 checking built-ins. For example, the option will issue a warning for
5815 the @code{strcpy} call below because it copies at least 5 characters
5816 (the string @code{"blue"} including the terminating NUL) into the buffer
5817 of size 4.
5818
5819 @smallexample
5820 enum Color @{ blue, purple, yellow @};
5821 const char* f (enum Color clr)
5822 @{
5823 static char buf [4];
5824 const char *str;
5825 switch (clr)
5826 @{
5827 case blue: str = "blue"; break;
5828 case purple: str = "purple"; break;
5829 case yellow: str = "yellow"; break;
5830 @}
5831
5832 return strcpy (buf, str); // warning here
5833 @}
5834 @end smallexample
5835
5836 Option @option{-Wstringop-overflow=2} is enabled by default.
5837
5838 @table @gcctabopt
5839 @item -Wstringop-overflow
5840 @itemx -Wstringop-overflow=1
5841 @opindex Wstringop-overflow
5842 @opindex Wno-stringop-overflow
5843 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5844 to determine the sizes of destination objects. This is the default setting
5845 of the option. At this setting the option will not warn for writes past
5846 the end of subobjects of larger objects accessed by pointers unless the
5847 size of the largest surrounding object is known. When the destination may
5848 be one of several objects it is assumed to be the largest one of them. On
5849 Linux systems, when optimization is enabled at this setting the option warns
5850 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5851 a non-zero value.
5852
5853 @item -Wstringop-overflow=2
5854 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5855 to determine the sizes of destination objects. At this setting the option
5856 will warn about overflows when writing to members of the largest complete
5857 objects whose exact size is known. It will, however, not warn for excessive
5858 writes to the same members of unknown objects referenced by pointers since
5859 they may point to arrays containing unknown numbers of elements.
5860
5861 @item -Wstringop-overflow=3
5862 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5863 to determine the sizes of destination objects. At this setting the option
5864 warns about overflowing the smallest object or data member. This is the
5865 most restrictive setting of the option that may result in warnings for safe
5866 code.
5867
5868 @item -Wstringop-overflow=4
5869 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5870 to determine the sizes of destination objects. At this setting the option
5871 will warn about overflowing any data members, and when the destination is
5872 one of several objects it uses the size of the largest of them to decide
5873 whether to issue a warning. Similarly to @option{-Wstringop-overflow=3} this
5874 setting of the option may result in warnings for benign code.
5875 @end table
5876
5877 @item -Wstringop-truncation
5878 @opindex Wstringop-truncation
5879 @opindex Wno-stringop-truncation
5880 Warn for calls to bounded string manipulation functions such as @code{strncat},
5881 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5882 or leave the destination unchanged.
5883
5884 In the following example, the call to @code{strncat} specifies a bound that
5885 is less than the length of the source string. As a result, the copy of
5886 the source will be truncated and so the call is diagnosed. To avoid the
5887 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5888
5889 @smallexample
5890 void append (char *buf, size_t bufsize)
5891 @{
5892 strncat (buf, ".txt", 3);
5893 @}
5894 @end smallexample
5895
5896 As another example, the following call to @code{strncpy} results in copying
5897 to @code{d} just the characters preceding the terminating NUL, without
5898 appending the NUL to the end. Assuming the result of @code{strncpy} is
5899 necessarily a NUL-terminated string is a common mistake, and so the call
5900 is diagnosed. To avoid the warning when the result is not expected to be
5901 NUL-terminated, call @code{memcpy} instead.
5902
5903 @smallexample
5904 void copy (char *d, const char *s)
5905 @{
5906 strncpy (d, s, strlen (s));
5907 @}
5908 @end smallexample
5909
5910 In the following example, the call to @code{strncpy} specifies the size
5911 of the destination buffer as the bound. If the length of the source
5912 string is equal to or greater than this size the result of the copy will
5913 not be NUL-terminated. Therefore, the call is also diagnosed. To avoid
5914 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5915 element of the buffer to @code{NUL}.
5916
5917 @smallexample
5918 void copy (const char *s)
5919 @{
5920 char buf[80];
5921 strncpy (buf, s, sizeof buf);
5922 @dots{}
5923 @}
5924 @end smallexample
5925
5926 In situations where a character array is intended to store a sequence
5927 of bytes with no terminating @code{NUL} such an array may be annotated
5928 with attribute @code{nonstring} to avoid this warning. Such arrays,
5929 however, are not suitable arguments to functions that expect
5930 @code{NUL}-terminated strings. To help detect accidental misuses of
5931 such arrays GCC issues warnings unless it can prove that the use is
5932 safe. @xref{Common Variable Attributes}.
5933
5934 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5935 @opindex Wsuggest-attribute=
5936 @opindex Wno-suggest-attribute=
5937 Warn for cases where adding an attribute may be beneficial. The
5938 attributes currently supported are listed below.
5939
5940 @table @gcctabopt
5941 @item -Wsuggest-attribute=pure
5942 @itemx -Wsuggest-attribute=const
5943 @itemx -Wsuggest-attribute=noreturn
5944 @itemx -Wmissing-noreturn
5945 @itemx -Wsuggest-attribute=malloc
5946 @opindex Wsuggest-attribute=pure
5947 @opindex Wno-suggest-attribute=pure
5948 @opindex Wsuggest-attribute=const
5949 @opindex Wno-suggest-attribute=const
5950 @opindex Wsuggest-attribute=noreturn
5951 @opindex Wno-suggest-attribute=noreturn
5952 @opindex Wmissing-noreturn
5953 @opindex Wno-missing-noreturn
5954 @opindex Wsuggest-attribute=malloc
5955 @opindex Wno-suggest-attribute=malloc
5956
5957 Warn about functions that might be candidates for attributes
5958 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5959 only warns for functions visible in other compilation units or (in the case of
5960 @code{pure} and @code{const}) if it cannot prove that the function returns
5961 normally. A function returns normally if it doesn't contain an infinite loop or
5962 return abnormally by throwing, calling @code{abort} or trapping. This analysis
5963 requires option @option{-fipa-pure-const}, which is enabled by default at
5964 @option{-O} and higher. Higher optimization levels improve the accuracy
5965 of the analysis.
5966
5967 @item -Wsuggest-attribute=format
5968 @itemx -Wmissing-format-attribute
5969 @opindex Wsuggest-attribute=format
5970 @opindex Wmissing-format-attribute
5971 @opindex Wno-suggest-attribute=format
5972 @opindex Wno-missing-format-attribute
5973 @opindex Wformat
5974 @opindex Wno-format
5975
5976 Warn about function pointers that might be candidates for @code{format}
5977 attributes. Note these are only possible candidates, not absolute ones.
5978 GCC guesses that function pointers with @code{format} attributes that
5979 are used in assignment, initialization, parameter passing or return
5980 statements should have a corresponding @code{format} attribute in the
5981 resulting type. I.e.@: the left-hand side of the assignment or
5982 initialization, the type of the parameter variable, or the return type
5983 of the containing function respectively should also have a @code{format}
5984 attribute to avoid the warning.
5985
5986 GCC also warns about function definitions that might be
5987 candidates for @code{format} attributes. Again, these are only
5988 possible candidates. GCC guesses that @code{format} attributes
5989 might be appropriate for any function that calls a function like
5990 @code{vprintf} or @code{vscanf}, but this might not always be the
5991 case, and some functions for which @code{format} attributes are
5992 appropriate may not be detected.
5993
5994 @item -Wsuggest-attribute=cold
5995 @opindex Wsuggest-attribute=cold
5996 @opindex Wno-suggest-attribute=cold
5997
5998 Warn about functions that might be candidates for @code{cold} attribute. This
5999 is based on static detection and generally will only warn about functions which
6000 always leads to a call to another @code{cold} function such as wrappers of
6001 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
6002 @end table
6003
6004 @item -Wsuggest-final-types
6005 @opindex Wno-suggest-final-types
6006 @opindex Wsuggest-final-types
6007 Warn about types with virtual methods where code quality would be improved
6008 if the type were declared with the C++11 @code{final} specifier,
6009 or, if possible,
6010 declared in an anonymous namespace. This allows GCC to more aggressively
6011 devirtualize the polymorphic calls. This warning is more effective with
6012 link-time optimization,
6013 where the information about the class hierarchy graph is
6014 more complete.
6015
6016 @item -Wsuggest-final-methods
6017 @opindex Wno-suggest-final-methods
6018 @opindex Wsuggest-final-methods
6019 Warn about virtual methods where code quality would be improved if the method
6020 were declared with the C++11 @code{final} specifier,
6021 or, if possible, its type were
6022 declared in an anonymous namespace or with the @code{final} specifier.
6023 This warning is
6024 more effective with link-time optimization, where the information about the
6025 class hierarchy graph is more complete. It is recommended to first consider
6026 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
6027 annotations.
6028
6029 @item -Wsuggest-override
6030 Warn about overriding virtual functions that are not marked with the override
6031 keyword.
6032
6033 @item -Walloc-zero
6034 @opindex Wno-alloc-zero
6035 @opindex Walloc-zero
6036 Warn about calls to allocation functions decorated with attribute
6037 @code{alloc_size} that specify zero bytes, including those to the built-in
6038 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
6039 @code{malloc}, and @code{realloc}. Because the behavior of these functions
6040 when called with a zero size differs among implementations (and in the case
6041 of @code{realloc} has been deprecated) relying on it may result in subtle
6042 portability bugs and should be avoided.
6043
6044 @item -Walloc-size-larger-than=@var{byte-size}
6045 @opindex Walloc-size-larger-than=
6046 @opindex Wno-alloc-size-larger-than
6047 Warn about calls to functions decorated with attribute @code{alloc_size}
6048 that attempt to allocate objects larger than the specified number of bytes,
6049 or where the result of the size computation in an integer type with infinite
6050 precision would exceed the value of @samp{PTRDIFF_MAX} on the target.
6051 @option{-Walloc-size-larger-than=}@samp{PTRDIFF_MAX} is enabled by default.
6052 Warnings controlled by the option can be disabled either by specifying
6053 @var{byte-size} of @samp{SIZE_MAX} or more or by
6054 @option{-Wno-alloc-size-larger-than}.
6055 @xref{Function Attributes}.
6056
6057 @item -Wno-alloc-size-larger-than
6058 @opindex Wno-alloc-size-larger-than
6059 Disable @option{-Walloc-size-larger-than=} warnings. The option is
6060 equivalent to @option{-Walloc-size-larger-than=}@samp{SIZE_MAX} or
6061 larger.
6062
6063 @item -Walloca
6064 @opindex Wno-alloca
6065 @opindex Walloca
6066 This option warns on all uses of @code{alloca} in the source.
6067
6068 @item -Walloca-larger-than=@var{byte-size}
6069 @opindex Walloca-larger-than=
6070 @opindex Wno-alloca-larger-than
6071 This option warns on calls to @code{alloca} with an integer argument whose
6072 value is either zero, or that is not bounded by a controlling predicate
6073 that limits its value to at most @var{byte-size}. It also warns for calls
6074 to @code{alloca} where the bound value is unknown. Arguments of non-integer
6075 types are considered unbounded even if they appear to be constrained to
6076 the expected range.
6077
6078 For example, a bounded case of @code{alloca} could be:
6079
6080 @smallexample
6081 void func (size_t n)
6082 @{
6083 void *p;
6084 if (n <= 1000)
6085 p = alloca (n);
6086 else
6087 p = malloc (n);
6088 f (p);
6089 @}
6090 @end smallexample
6091
6092 In the above example, passing @code{-Walloca-larger-than=1000} would not
6093 issue a warning because the call to @code{alloca} is known to be at most
6094 1000 bytes. However, if @code{-Walloca-larger-than=500} were passed,
6095 the compiler would emit a warning.
6096
6097 Unbounded uses, on the other hand, are uses of @code{alloca} with no
6098 controlling predicate constraining its integer argument. For example:
6099
6100 @smallexample
6101 void func ()
6102 @{
6103 void *p = alloca (n);
6104 f (p);
6105 @}
6106 @end smallexample
6107
6108 If @code{-Walloca-larger-than=500} were passed, the above would trigger
6109 a warning, but this time because of the lack of bounds checking.
6110
6111 Note, that even seemingly correct code involving signed integers could
6112 cause a warning:
6113
6114 @smallexample
6115 void func (signed int n)
6116 @{
6117 if (n < 500)
6118 @{
6119 p = alloca (n);
6120 f (p);
6121 @}
6122 @}
6123 @end smallexample
6124
6125 In the above example, @var{n} could be negative, causing a larger than
6126 expected argument to be implicitly cast into the @code{alloca} call.
6127
6128 This option also warns when @code{alloca} is used in a loop.
6129
6130 @option{-Walloca-larger-than=}@samp{PTRDIFF_MAX} is enabled by default
6131 but is usually only effective when @option{-ftree-vrp} is active (default
6132 for @option{-O2} and above).
6133
6134 See also @option{-Wvla-larger-than=}@samp{byte-size}.
6135
6136 @item -Wno-alloca-larger-than
6137 @opindex Wno-alloca-larger-than
6138 Disable @option{-Walloca-larger-than=} warnings. The option is
6139 equivalent to @option{-Walloca-larger-than=}@samp{SIZE_MAX} or larger.
6140
6141 @item -Warray-bounds
6142 @itemx -Warray-bounds=@var{n}
6143 @opindex Wno-array-bounds
6144 @opindex Warray-bounds
6145 This option is only active when @option{-ftree-vrp} is active
6146 (default for @option{-O2} and above). It warns about subscripts to arrays
6147 that are always out of bounds. This warning is enabled by @option{-Wall}.
6148
6149 @table @gcctabopt
6150 @item -Warray-bounds=1
6151 This is the warning level of @option{-Warray-bounds} and is enabled
6152 by @option{-Wall}; higher levels are not, and must be explicitly requested.
6153
6154 @item -Warray-bounds=2
6155 This warning level also warns about out of bounds access for
6156 arrays at the end of a struct and for arrays accessed through
6157 pointers. This warning level may give a larger number of
6158 false positives and is deactivated by default.
6159 @end table
6160
6161 @item -Wattribute-alias=@var{n}
6162 @itemx -Wno-attribute-alias
6163 @opindex Wattribute-alias
6164 @opindex Wno-attribute-alias
6165 Warn about declarations using the @code{alias} and similar attributes whose
6166 target is incompatible with the type of the alias.
6167 @xref{Function Attributes,,Declaring Attributes of Functions}.
6168
6169 @table @gcctabopt
6170 @item -Wattribute-alias=1
6171 The default warning level of the @option{-Wattribute-alias} option diagnoses
6172 incompatibilities between the type of the alias declaration and that of its
6173 target. Such incompatibilities are typically indicative of bugs.
6174
6175 @item -Wattribute-alias=2
6176
6177 At this level @option{-Wattribute-alias} also diagnoses cases where
6178 the attributes of the alias declaration are more restrictive than the
6179 attributes applied to its target. These mismatches can potentially
6180 result in incorrect code generation. In other cases they may be
6181 benign and could be resolved simply by adding the missing attribute to
6182 the target. For comparison, see the @option{-Wmissing-attributes}
6183 option, which controls diagnostics when the alias declaration is less
6184 restrictive than the target, rather than more restrictive.
6185
6186 Attributes considered include @code{alloc_align}, @code{alloc_size},
6187 @code{cold}, @code{const}, @code{hot}, @code{leaf}, @code{malloc},
6188 @code{nonnull}, @code{noreturn}, @code{nothrow}, @code{pure},
6189 @code{returns_nonnull}, and @code{returns_twice}.
6190 @end table
6191
6192 @option{-Wattribute-alias} is equivalent to @option{-Wattribute-alias=1}.
6193 This is the default. You can disable these warnings with either
6194 @option{-Wno-attribute-alias} or @option{-Wattribute-alias=0}.
6195
6196 @item -Wbool-compare
6197 @opindex Wno-bool-compare
6198 @opindex Wbool-compare
6199 Warn about boolean expression compared with an integer value different from
6200 @code{true}/@code{false}. For instance, the following comparison is
6201 always false:
6202 @smallexample
6203 int n = 5;
6204 @dots{}
6205 if ((n > 1) == 2) @{ @dots{} @}
6206 @end smallexample
6207 This warning is enabled by @option{-Wall}.
6208
6209 @item -Wbool-operation
6210 @opindex Wno-bool-operation
6211 @opindex Wbool-operation
6212 Warn about suspicious operations on expressions of a boolean type. For
6213 instance, bitwise negation of a boolean is very likely a bug in the program.
6214 For C, this warning also warns about incrementing or decrementing a boolean,
6215 which rarely makes sense. (In C++, decrementing a boolean is always invalid.
6216 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
6217
6218 This warning is enabled by @option{-Wall}.
6219
6220 @item -Wduplicated-branches
6221 @opindex Wno-duplicated-branches
6222 @opindex Wduplicated-branches
6223 Warn when an if-else has identical branches. This warning detects cases like
6224 @smallexample
6225 if (p != NULL)
6226 return 0;
6227 else
6228 return 0;
6229 @end smallexample
6230 It doesn't warn when both branches contain just a null statement. This warning
6231 also warn for conditional operators:
6232 @smallexample
6233 int i = x ? *p : *p;
6234 @end smallexample
6235
6236 @item -Wduplicated-cond
6237 @opindex Wno-duplicated-cond
6238 @opindex Wduplicated-cond
6239 Warn about duplicated conditions in an if-else-if chain. For instance,
6240 warn for the following code:
6241 @smallexample
6242 if (p->q != NULL) @{ @dots{} @}
6243 else if (p->q != NULL) @{ @dots{} @}
6244 @end smallexample
6245
6246 @item -Wframe-address
6247 @opindex Wno-frame-address
6248 @opindex Wframe-address
6249 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
6250 is called with an argument greater than 0. Such calls may return indeterminate
6251 values or crash the program. The warning is included in @option{-Wall}.
6252
6253 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
6254 @opindex Wno-discarded-qualifiers
6255 @opindex Wdiscarded-qualifiers
6256 Do not warn if type qualifiers on pointers are being discarded.
6257 Typically, the compiler warns if a @code{const char *} variable is
6258 passed to a function that takes a @code{char *} parameter. This option
6259 can be used to suppress such a warning.
6260
6261 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
6262 @opindex Wno-discarded-array-qualifiers
6263 @opindex Wdiscarded-array-qualifiers
6264 Do not warn if type qualifiers on arrays which are pointer targets
6265 are being discarded. Typically, the compiler warns if a
6266 @code{const int (*)[]} variable is passed to a function that
6267 takes a @code{int (*)[]} parameter. This option can be used to
6268 suppress such a warning.
6269
6270 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
6271 @opindex Wno-incompatible-pointer-types
6272 @opindex Wincompatible-pointer-types
6273 Do not warn when there is a conversion between pointers that have incompatible
6274 types. This warning is for cases not covered by @option{-Wno-pointer-sign},
6275 which warns for pointer argument passing or assignment with different
6276 signedness.
6277
6278 @item -Wno-int-conversion @r{(C and Objective-C only)}
6279 @opindex Wno-int-conversion
6280 @opindex Wint-conversion
6281 Do not warn about incompatible integer to pointer and pointer to integer
6282 conversions. This warning is about implicit conversions; for explicit
6283 conversions the warnings @option{-Wno-int-to-pointer-cast} and
6284 @option{-Wno-pointer-to-int-cast} may be used.
6285
6286 @item -Wno-div-by-zero
6287 @opindex Wno-div-by-zero
6288 @opindex Wdiv-by-zero
6289 Do not warn about compile-time integer division by zero. Floating-point
6290 division by zero is not warned about, as it can be a legitimate way of
6291 obtaining infinities and NaNs.
6292
6293 @item -Wsystem-headers
6294 @opindex Wsystem-headers
6295 @opindex Wno-system-headers
6296 @cindex warnings from system headers
6297 @cindex system headers, warnings from
6298 Print warning messages for constructs found in system header files.
6299 Warnings from system headers are normally suppressed, on the assumption
6300 that they usually do not indicate real problems and would only make the
6301 compiler output harder to read. Using this command-line option tells
6302 GCC to emit warnings from system headers as if they occurred in user
6303 code. However, note that using @option{-Wall} in conjunction with this
6304 option does @emph{not} warn about unknown pragmas in system
6305 headers---for that, @option{-Wunknown-pragmas} must also be used.
6306
6307 @item -Wtautological-compare
6308 @opindex Wtautological-compare
6309 @opindex Wno-tautological-compare
6310 Warn if a self-comparison always evaluates to true or false. This
6311 warning detects various mistakes such as:
6312 @smallexample
6313 int i = 1;
6314 @dots{}
6315 if (i > i) @{ @dots{} @}
6316 @end smallexample
6317
6318 This warning also warns about bitwise comparisons that always evaluate
6319 to true or false, for instance:
6320 @smallexample
6321 if ((a & 16) == 10) @{ @dots{} @}
6322 @end smallexample
6323 will always be false.
6324
6325 This warning is enabled by @option{-Wall}.
6326
6327 @item -Wtrampolines
6328 @opindex Wtrampolines
6329 @opindex Wno-trampolines
6330 Warn about trampolines generated for pointers to nested functions.
6331 A trampoline is a small piece of data or code that is created at run
6332 time on the stack when the address of a nested function is taken, and is
6333 used to call the nested function indirectly. For some targets, it is
6334 made up of data only and thus requires no special treatment. But, for
6335 most targets, it is made up of code and thus requires the stack to be
6336 made executable in order for the program to work properly.
6337
6338 @item -Wfloat-equal
6339 @opindex Wfloat-equal
6340 @opindex Wno-float-equal
6341 Warn if floating-point values are used in equality comparisons.
6342
6343 The idea behind this is that sometimes it is convenient (for the
6344 programmer) to consider floating-point values as approximations to
6345 infinitely precise real numbers. If you are doing this, then you need
6346 to compute (by analyzing the code, or in some other way) the maximum or
6347 likely maximum error that the computation introduces, and allow for it
6348 when performing comparisons (and when producing output, but that's a
6349 different problem). In particular, instead of testing for equality, you
6350 should check to see whether the two values have ranges that overlap; and
6351 this is done with the relational operators, so equality comparisons are
6352 probably mistaken.
6353
6354 @item -Wtraditional @r{(C and Objective-C only)}
6355 @opindex Wtraditional
6356 @opindex Wno-traditional
6357 Warn about certain constructs that behave differently in traditional and
6358 ISO C@. Also warn about ISO C constructs that have no traditional C
6359 equivalent, and/or problematic constructs that should be avoided.
6360
6361 @itemize @bullet
6362 @item
6363 Macro parameters that appear within string literals in the macro body.
6364 In traditional C macro replacement takes place within string literals,
6365 but in ISO C it does not.
6366
6367 @item
6368 In traditional C, some preprocessor directives did not exist.
6369 Traditional preprocessors only considered a line to be a directive
6370 if the @samp{#} appeared in column 1 on the line. Therefore
6371 @option{-Wtraditional} warns about directives that traditional C
6372 understands but ignores because the @samp{#} does not appear as the
6373 first character on the line. It also suggests you hide directives like
6374 @code{#pragma} not understood by traditional C by indenting them. Some
6375 traditional implementations do not recognize @code{#elif}, so this option
6376 suggests avoiding it altogether.
6377
6378 @item
6379 A function-like macro that appears without arguments.
6380
6381 @item
6382 The unary plus operator.
6383
6384 @item
6385 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
6386 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
6387 constants.) Note, these suffixes appear in macros defined in the system
6388 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
6389 Use of these macros in user code might normally lead to spurious
6390 warnings, however GCC's integrated preprocessor has enough context to
6391 avoid warning in these cases.
6392
6393 @item
6394 A function declared external in one block and then used after the end of
6395 the block.
6396
6397 @item
6398 A @code{switch} statement has an operand of type @code{long}.
6399
6400 @item
6401 A non-@code{static} function declaration follows a @code{static} one.
6402 This construct is not accepted by some traditional C compilers.
6403
6404 @item
6405 The ISO type of an integer constant has a different width or
6406 signedness from its traditional type. This warning is only issued if
6407 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
6408 typically represent bit patterns, are not warned about.
6409
6410 @item
6411 Usage of ISO string concatenation is detected.
6412
6413 @item
6414 Initialization of automatic aggregates.
6415
6416 @item
6417 Identifier conflicts with labels. Traditional C lacks a separate
6418 namespace for labels.
6419
6420 @item
6421 Initialization of unions. If the initializer is zero, the warning is
6422 omitted. This is done under the assumption that the zero initializer in
6423 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
6424 initializer warnings and relies on default initialization to zero in the
6425 traditional C case.
6426
6427 @item
6428 Conversions by prototypes between fixed/floating-point values and vice
6429 versa. The absence of these prototypes when compiling with traditional
6430 C causes serious problems. This is a subset of the possible
6431 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
6432
6433 @item
6434 Use of ISO C style function definitions. This warning intentionally is
6435 @emph{not} issued for prototype declarations or variadic functions
6436 because these ISO C features appear in your code when using
6437 libiberty's traditional C compatibility macros, @code{PARAMS} and
6438 @code{VPARAMS}. This warning is also bypassed for nested functions
6439 because that feature is already a GCC extension and thus not relevant to
6440 traditional C compatibility.
6441 @end itemize
6442
6443 @item -Wtraditional-conversion @r{(C and Objective-C only)}
6444 @opindex Wtraditional-conversion
6445 @opindex Wno-traditional-conversion
6446 Warn if a prototype causes a type conversion that is different from what
6447 would happen to the same argument in the absence of a prototype. This
6448 includes conversions of fixed point to floating and vice versa, and
6449 conversions changing the width or signedness of a fixed-point argument
6450 except when the same as the default promotion.
6451
6452 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
6453 @opindex Wdeclaration-after-statement
6454 @opindex Wno-declaration-after-statement
6455 Warn when a declaration is found after a statement in a block. This
6456 construct, known from C++, was introduced with ISO C99 and is by default
6457 allowed in GCC@. It is not supported by ISO C90. @xref{Mixed Declarations}.
6458
6459 @item -Wshadow
6460 @opindex Wshadow
6461 @opindex Wno-shadow
6462 Warn whenever a local variable or type declaration shadows another
6463 variable, parameter, type, class member (in C++), or instance variable
6464 (in Objective-C) or whenever a built-in function is shadowed. Note
6465 that in C++, the compiler warns if a local variable shadows an
6466 explicit typedef, but not if it shadows a struct/class/enum.
6467 Same as @option{-Wshadow=global}.
6468
6469 @item -Wno-shadow-ivar @r{(Objective-C only)}
6470 @opindex Wno-shadow-ivar
6471 @opindex Wshadow-ivar
6472 Do not warn whenever a local variable shadows an instance variable in an
6473 Objective-C method.
6474
6475 @item -Wshadow=global
6476 @opindex Wshadow=local
6477 The default for @option{-Wshadow}. Warns for any (global) shadowing.
6478
6479 @item -Wshadow=local
6480 @opindex Wshadow=local
6481 Warn when a local variable shadows another local variable or parameter.
6482 This warning is enabled by @option{-Wshadow=global}.
6483
6484 @item -Wshadow=compatible-local
6485 @opindex Wshadow=compatible-local
6486 Warn when a local variable shadows another local variable or parameter
6487 whose type is compatible with that of the shadowing variable. In C++,
6488 type compatibility here means the type of the shadowing variable can be
6489 converted to that of the shadowed variable. The creation of this flag
6490 (in addition to @option{-Wshadow=local}) is based on the idea that when
6491 a local variable shadows another one of incompatible type, it is most
6492 likely intentional, not a bug or typo, as shown in the following example:
6493
6494 @smallexample
6495 @group
6496 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
6497 @{
6498 for (int i = 0; i < N; ++i)
6499 @{
6500 ...
6501 @}
6502 ...
6503 @}
6504 @end group
6505 @end smallexample
6506
6507 Since the two variable @code{i} in the example above have incompatible types,
6508 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
6509 Because their types are incompatible, if a programmer accidentally uses one
6510 in place of the other, type checking will catch that and emit an error or
6511 warning. So not warning (about shadowing) in this case will not lead to
6512 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
6513 possibly reduce the number of warnings triggered by intentional shadowing.
6514
6515 This warning is enabled by @option{-Wshadow=local}.
6516
6517 @item -Wlarger-than=@var{byte-size}
6518 @opindex Wlarger-than=
6519 @opindex Wlarger-than-@var{byte-size}
6520 Warn whenever an object is defined whose size exceeds @var{byte-size}.
6521 @option{-Wlarger-than=}@samp{PTRDIFF_MAX} is enabled by default.
6522 Warnings controlled by the option can be disabled either by specifying
6523 @var{byte-size} of @samp{SIZE_MAX} or more or by
6524 @option{-Wno-larger-than}.
6525
6526 @item -Wno-larger-than
6527 @opindex Wno-larger-than
6528 Disable @option{-Wlarger-than=} warnings. The option is equivalent
6529 to @option{-Wlarger-than=}@samp{SIZE_MAX} or larger.
6530
6531 @item -Wframe-larger-than=@var{byte-size}
6532 @opindex Wframe-larger-than=
6533 @opindex Wno-frame-larger-than
6534 Warn if the size of a function frame exceeds @var{byte-size}.
6535 The computation done to determine the stack frame size is approximate
6536 and not conservative.
6537 The actual requirements may be somewhat greater than @var{byte-size}
6538 even if you do not get a warning. In addition, any space allocated
6539 via @code{alloca}, variable-length arrays, or related constructs
6540 is not included by the compiler when determining
6541 whether or not to issue a warning.
6542 @option{-Wframe-larger-than=}@samp{PTRDIFF_MAX} is enabled by default.
6543 Warnings controlled by the option can be disabled either by specifying
6544 @var{byte-size} of @samp{SIZE_MAX} or more or by
6545 @option{-Wno-frame-larger-than}.
6546
6547 @item -Wno-frame-larger-than
6548 @opindex Wno-frame-larger-than
6549 Disable @option{-Wframe-larger-than=} warnings. The option is equivalent
6550 to @option{-Wframe-larger-than=}@samp{SIZE_MAX} or larger.
6551
6552 @item -Wno-free-nonheap-object
6553 @opindex Wno-free-nonheap-object
6554 @opindex Wfree-nonheap-object
6555 Do not warn when attempting to free an object that was not allocated
6556 on the heap.
6557
6558 @item -Wstack-usage=@var{byte-size}
6559 @opindex Wstack-usage
6560 @opindex Wno-stack-usage
6561 Warn if the stack usage of a function might exceed @var{byte-size}.
6562 The computation done to determine the stack usage is conservative.
6563 Any space allocated via @code{alloca}, variable-length arrays, or related
6564 constructs is included by the compiler when determining whether or not to
6565 issue a warning.
6566
6567 The message is in keeping with the output of @option{-fstack-usage}.
6568
6569 @itemize
6570 @item
6571 If the stack usage is fully static but exceeds the specified amount, it's:
6572
6573 @smallexample
6574 warning: stack usage is 1120 bytes
6575 @end smallexample
6576 @item
6577 If the stack usage is (partly) dynamic but bounded, it's:
6578
6579 @smallexample
6580 warning: stack usage might be 1648 bytes
6581 @end smallexample
6582 @item
6583 If the stack usage is (partly) dynamic and not bounded, it's:
6584
6585 @smallexample
6586 warning: stack usage might be unbounded
6587 @end smallexample
6588 @end itemize
6589
6590 @option{-Wstack-usage=}@samp{PTRDIFF_MAX} is enabled by default.
6591 Warnings controlled by the option can be disabled either by specifying
6592 @var{byte-size} of @samp{SIZE_MAX} or more or by
6593 @option{-Wno-stack-usage}.
6594
6595 @item -Wno-stack-usage
6596 @opindex Wno-stack-usage
6597 Disable @option{-Wstack-usage=} warnings. The option is equivalent
6598 to @option{-Wstack-usage=}@samp{SIZE_MAX} or larger.
6599
6600 @item -Wunsafe-loop-optimizations
6601 @opindex Wunsafe-loop-optimizations
6602 @opindex Wno-unsafe-loop-optimizations
6603 Warn if the loop cannot be optimized because the compiler cannot
6604 assume anything on the bounds of the loop indices. With
6605 @option{-funsafe-loop-optimizations} warn if the compiler makes
6606 such assumptions.
6607
6608 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
6609 @opindex Wno-pedantic-ms-format
6610 @opindex Wpedantic-ms-format
6611 When used in combination with @option{-Wformat}
6612 and @option{-pedantic} without GNU extensions, this option
6613 disables the warnings about non-ISO @code{printf} / @code{scanf} format
6614 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
6615 which depend on the MS runtime.
6616
6617 @item -Waligned-new
6618 @opindex Waligned-new
6619 @opindex Wno-aligned-new
6620 Warn about a new-expression of a type that requires greater alignment
6621 than the @code{alignof(std::max_align_t)} but uses an allocation
6622 function without an explicit alignment parameter. This option is
6623 enabled by @option{-Wall}.
6624
6625 Normally this only warns about global allocation functions, but
6626 @option{-Waligned-new=all} also warns about class member allocation
6627 functions.
6628
6629 @item -Wplacement-new
6630 @itemx -Wplacement-new=@var{n}
6631 @opindex Wplacement-new
6632 @opindex Wno-placement-new
6633 Warn about placement new expressions with undefined behavior, such as
6634 constructing an object in a buffer that is smaller than the type of
6635 the object. For example, the placement new expression below is diagnosed
6636 because it attempts to construct an array of 64 integers in a buffer only
6637 64 bytes large.
6638 @smallexample
6639 char buf [64];
6640 new (buf) int[64];
6641 @end smallexample
6642 This warning is enabled by default.
6643
6644 @table @gcctabopt
6645 @item -Wplacement-new=1
6646 This is the default warning level of @option{-Wplacement-new}. At this
6647 level the warning is not issued for some strictly undefined constructs that
6648 GCC allows as extensions for compatibility with legacy code. For example,
6649 the following @code{new} expression is not diagnosed at this level even
6650 though it has undefined behavior according to the C++ standard because
6651 it writes past the end of the one-element array.
6652 @smallexample
6653 struct S @{ int n, a[1]; @};
6654 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
6655 new (s->a)int [32]();
6656 @end smallexample
6657
6658 @item -Wplacement-new=2
6659 At this level, in addition to diagnosing all the same constructs as at level
6660 1, a diagnostic is also issued for placement new expressions that construct
6661 an object in the last member of structure whose type is an array of a single
6662 element and whose size is less than the size of the object being constructed.
6663 While the previous example would be diagnosed, the following construct makes
6664 use of the flexible member array extension to avoid the warning at level 2.
6665 @smallexample
6666 struct S @{ int n, a[]; @};
6667 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6668 new (s->a)int [32]();
6669 @end smallexample
6670
6671 @end table
6672
6673 @item -Wpointer-arith
6674 @opindex Wpointer-arith
6675 @opindex Wno-pointer-arith
6676 Warn about anything that depends on the ``size of'' a function type or
6677 of @code{void}. GNU C assigns these types a size of 1, for
6678 convenience in calculations with @code{void *} pointers and pointers
6679 to functions. In C++, warn also when an arithmetic operation involves
6680 @code{NULL}. This warning is also enabled by @option{-Wpedantic}.
6681
6682 @item -Wpointer-compare
6683 @opindex Wpointer-compare
6684 @opindex Wno-pointer-compare
6685 Warn if a pointer is compared with a zero character constant. This usually
6686 means that the pointer was meant to be dereferenced. For example:
6687
6688 @smallexample
6689 const char *p = foo ();
6690 if (p == '\0')
6691 return 42;
6692 @end smallexample
6693
6694 Note that the code above is invalid in C++11.
6695
6696 This warning is enabled by default.
6697
6698 @item -Wtype-limits
6699 @opindex Wtype-limits
6700 @opindex Wno-type-limits
6701 Warn if a comparison is always true or always false due to the limited
6702 range of the data type, but do not warn for constant expressions. For
6703 example, warn if an unsigned variable is compared against zero with
6704 @code{<} or @code{>=}. This warning is also enabled by
6705 @option{-Wextra}.
6706
6707 @item -Wabsolute-value @r{(C and Objective-C only)}
6708 @opindex Wabsolute-value
6709 @opindex Wno-absolute-value
6710 Warn for calls to standard functions that compute the absolute value
6711 of an argument when a more appropriate standard function is available.
6712 For example, calling @code{abs(3.14)} triggers the warning because the
6713 appropriate function to call to compute the absolute value of a double
6714 argument is @code{fabs}. The option also triggers warnings when the
6715 argument in a call to such a function has an unsigned type. This
6716 warning can be suppressed with an explicit type cast and it is also
6717 enabled by @option{-Wextra}.
6718
6719 @include cppwarnopts.texi
6720
6721 @item -Wbad-function-cast @r{(C and Objective-C only)}
6722 @opindex Wbad-function-cast
6723 @opindex Wno-bad-function-cast
6724 Warn when a function call is cast to a non-matching type.
6725 For example, warn if a call to a function returning an integer type
6726 is cast to a pointer type.
6727
6728 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6729 @opindex Wc90-c99-compat
6730 @opindex Wno-c90-c99-compat
6731 Warn about features not present in ISO C90, but present in ISO C99.
6732 For instance, warn about use of variable length arrays, @code{long long}
6733 type, @code{bool} type, compound literals, designated initializers, and so
6734 on. This option is independent of the standards mode. Warnings are disabled
6735 in the expression that follows @code{__extension__}.
6736
6737 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6738 @opindex Wc99-c11-compat
6739 @opindex Wno-c99-c11-compat
6740 Warn about features not present in ISO C99, but present in ISO C11.
6741 For instance, warn about use of anonymous structures and unions,
6742 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6743 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6744 and so on. This option is independent of the standards mode. Warnings are
6745 disabled in the expression that follows @code{__extension__}.
6746
6747 @item -Wc++-compat @r{(C and Objective-C only)}
6748 @opindex Wc++-compat
6749 @opindex Wno-c++-compat
6750 Warn about ISO C constructs that are outside of the common subset of
6751 ISO C and ISO C++, e.g.@: request for implicit conversion from
6752 @code{void *} to a pointer to non-@code{void} type.
6753
6754 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6755 @opindex Wc++11-compat
6756 @opindex Wno-c++11-compat
6757 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6758 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6759 in ISO C++ 2011. This warning turns on @option{-Wnarrowing} and is
6760 enabled by @option{-Wall}.
6761
6762 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6763 @opindex Wc++14-compat
6764 @opindex Wno-c++14-compat
6765 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6766 and ISO C++ 2014. This warning is enabled by @option{-Wall}.
6767
6768 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6769 @opindex Wc++17-compat
6770 @opindex Wno-c++17-compat
6771 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6772 and ISO C++ 2017. This warning is enabled by @option{-Wall}.
6773
6774 @item -Wcast-qual
6775 @opindex Wcast-qual
6776 @opindex Wno-cast-qual
6777 Warn whenever a pointer is cast so as to remove a type qualifier from
6778 the target type. For example, warn if a @code{const char *} is cast
6779 to an ordinary @code{char *}.
6780
6781 Also warn when making a cast that introduces a type qualifier in an
6782 unsafe way. For example, casting @code{char **} to @code{const char **}
6783 is unsafe, as in this example:
6784
6785 @smallexample
6786 /* p is char ** value. */
6787 const char **q = (const char **) p;
6788 /* Assignment of readonly string to const char * is OK. */
6789 *q = "string";
6790 /* Now char** pointer points to read-only memory. */
6791 **p = 'b';
6792 @end smallexample
6793
6794 @item -Wcast-align
6795 @opindex Wcast-align
6796 @opindex Wno-cast-align
6797 Warn whenever a pointer is cast such that the required alignment of the
6798 target is increased. For example, warn if a @code{char *} is cast to
6799 an @code{int *} on machines where integers can only be accessed at
6800 two- or four-byte boundaries.
6801
6802 @item -Wcast-align=strict
6803 @opindex Wcast-align=strict
6804 Warn whenever a pointer is cast such that the required alignment of the
6805 target is increased. For example, warn if a @code{char *} is cast to
6806 an @code{int *} regardless of the target machine.
6807
6808 @item -Wcast-function-type
6809 @opindex Wcast-function-type
6810 @opindex Wno-cast-function-type
6811 Warn when a function pointer is cast to an incompatible function pointer.
6812 In a cast involving function types with a variable argument list only
6813 the types of initial arguments that are provided are considered.
6814 Any parameter of pointer-type matches any other pointer-type. Any benign
6815 differences in integral types are ignored, like @code{int} vs.@: @code{long}
6816 on ILP32 targets. Likewise type qualifiers are ignored. The function
6817 type @code{void (*) (void)} is special and matches everything, which can
6818 be used to suppress this warning.
6819 In a cast involving pointer to member types this warning warns whenever
6820 the type cast is changing the pointer to member type.
6821 This warning is enabled by @option{-Wextra}.
6822
6823 @item -Wwrite-strings
6824 @opindex Wwrite-strings
6825 @opindex Wno-write-strings
6826 When compiling C, give string constants the type @code{const
6827 char[@var{length}]} so that copying the address of one into a
6828 non-@code{const} @code{char *} pointer produces a warning. These
6829 warnings help you find at compile time code that can try to write
6830 into a string constant, but only if you have been very careful about
6831 using @code{const} in declarations and prototypes. Otherwise, it is
6832 just a nuisance. This is why we did not make @option{-Wall} request
6833 these warnings.
6834
6835 When compiling C++, warn about the deprecated conversion from string
6836 literals to @code{char *}. This warning is enabled by default for C++
6837 programs.
6838
6839 @item -Wcatch-value
6840 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6841 @opindex Wcatch-value
6842 @opindex Wno-catch-value
6843 Warn about catch handlers that do not catch via reference.
6844 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6845 warn about polymorphic class types that are caught by value.
6846 With @option{-Wcatch-value=2} warn about all class types that are caught
6847 by value. With @option{-Wcatch-value=3} warn about all types that are
6848 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6849
6850 @item -Wclobbered
6851 @opindex Wclobbered
6852 @opindex Wno-clobbered
6853 Warn for variables that might be changed by @code{longjmp} or
6854 @code{vfork}. This warning is also enabled by @option{-Wextra}.
6855
6856 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6857 @opindex Wconditionally-supported
6858 @opindex Wno-conditionally-supported
6859 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6860
6861 @item -Wconversion
6862 @opindex Wconversion
6863 @opindex Wno-conversion
6864 Warn for implicit conversions that may alter a value. This includes
6865 conversions between real and integer, like @code{abs (x)} when
6866 @code{x} is @code{double}; conversions between signed and unsigned,
6867 like @code{unsigned ui = -1}; and conversions to smaller types, like
6868 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6869 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6870 changed by the conversion like in @code{abs (2.0)}. Warnings about
6871 conversions between signed and unsigned integers can be disabled by
6872 using @option{-Wno-sign-conversion}.
6873
6874 For C++, also warn for confusing overload resolution for user-defined
6875 conversions; and conversions that never use a type conversion
6876 operator: conversions to @code{void}, the same type, a base class or a
6877 reference to them. Warnings about conversions between signed and
6878 unsigned integers are disabled by default in C++ unless
6879 @option{-Wsign-conversion} is explicitly enabled.
6880
6881 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6882 @opindex Wconversion-null
6883 @opindex Wno-conversion-null
6884 Do not warn for conversions between @code{NULL} and non-pointer
6885 types. @option{-Wconversion-null} is enabled by default.
6886
6887 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6888 @opindex Wzero-as-null-pointer-constant
6889 @opindex Wno-zero-as-null-pointer-constant
6890 Warn when a literal @samp{0} is used as null pointer constant. This can
6891 be useful to facilitate the conversion to @code{nullptr} in C++11.
6892
6893 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6894 @opindex Wsubobject-linkage
6895 @opindex Wno-subobject-linkage
6896 Warn if a class type has a base or a field whose type uses the anonymous
6897 namespace or depends on a type with no linkage. If a type A depends on
6898 a type B with no or internal linkage, defining it in multiple
6899 translation units would be an ODR violation because the meaning of B
6900 is different in each translation unit. If A only appears in a single
6901 translation unit, the best way to silence the warning is to give it
6902 internal linkage by putting it in an anonymous namespace as well. The
6903 compiler doesn't give this warning for types defined in the main .C
6904 file, as those are unlikely to have multiple definitions.
6905 @option{-Wsubobject-linkage} is enabled by default.
6906
6907 @item -Wdangling-else
6908 @opindex Wdangling-else
6909 @opindex Wno-dangling-else
6910 Warn about constructions where there may be confusion to which
6911 @code{if} statement an @code{else} branch belongs. Here is an example of
6912 such a case:
6913
6914 @smallexample
6915 @group
6916 @{
6917 if (a)
6918 if (b)
6919 foo ();
6920 else
6921 bar ();
6922 @}
6923 @end group
6924 @end smallexample
6925
6926 In C/C++, every @code{else} branch belongs to the innermost possible
6927 @code{if} statement, which in this example is @code{if (b)}. This is
6928 often not what the programmer expected, as illustrated in the above
6929 example by indentation the programmer chose. When there is the
6930 potential for this confusion, GCC issues a warning when this flag
6931 is specified. To eliminate the warning, add explicit braces around
6932 the innermost @code{if} statement so there is no way the @code{else}
6933 can belong to the enclosing @code{if}. The resulting code
6934 looks like this:
6935
6936 @smallexample
6937 @group
6938 @{
6939 if (a)
6940 @{
6941 if (b)
6942 foo ();
6943 else
6944 bar ();
6945 @}
6946 @}
6947 @end group
6948 @end smallexample
6949
6950 This warning is enabled by @option{-Wparentheses}.
6951
6952 @item -Wdate-time
6953 @opindex Wdate-time
6954 @opindex Wno-date-time
6955 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6956 are encountered as they might prevent bit-wise-identical reproducible
6957 compilations.
6958
6959 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6960 @opindex Wdelete-incomplete
6961 @opindex Wno-delete-incomplete
6962 Warn when deleting a pointer to incomplete type, which may cause
6963 undefined behavior at runtime. This warning is enabled by default.
6964
6965 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6966 @opindex Wuseless-cast
6967 @opindex Wno-useless-cast
6968 Warn when an expression is casted to its own type.
6969
6970 @item -Wempty-body
6971 @opindex Wempty-body
6972 @opindex Wno-empty-body
6973 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6974 while} statement. This warning is also enabled by @option{-Wextra}.
6975
6976 @item -Wenum-compare
6977 @opindex Wenum-compare
6978 @opindex Wno-enum-compare
6979 Warn about a comparison between values of different enumerated types.
6980 In C++ enumerated type mismatches in conditional expressions are also
6981 diagnosed and the warning is enabled by default. In C this warning is
6982 enabled by @option{-Wall}.
6983
6984 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6985 @opindex Wextra-semi
6986 @opindex Wno-extra-semi
6987 Warn about redundant semicolon after in-class function definition.
6988
6989 @item -Wjump-misses-init @r{(C, Objective-C only)}
6990 @opindex Wjump-misses-init
6991 @opindex Wno-jump-misses-init
6992 Warn if a @code{goto} statement or a @code{switch} statement jumps
6993 forward across the initialization of a variable, or jumps backward to a
6994 label after the variable has been initialized. This only warns about
6995 variables that are initialized when they are declared. This warning is
6996 only supported for C and Objective-C; in C++ this sort of branch is an
6997 error in any case.
6998
6999 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It
7000 can be disabled with the @option{-Wno-jump-misses-init} option.
7001
7002 @item -Wsign-compare
7003 @opindex Wsign-compare
7004 @opindex Wno-sign-compare
7005 @cindex warning for comparison of signed and unsigned values
7006 @cindex comparison of signed and unsigned values, warning
7007 @cindex signed and unsigned values, comparison warning
7008 Warn when a comparison between signed and unsigned values could produce
7009 an incorrect result when the signed value is converted to unsigned.
7010 In C++, this warning is also enabled by @option{-Wall}. In C, it is
7011 also enabled by @option{-Wextra}.
7012
7013 @item -Wsign-conversion
7014 @opindex Wsign-conversion
7015 @opindex Wno-sign-conversion
7016 Warn for implicit conversions that may change the sign of an integer
7017 value, like assigning a signed integer expression to an unsigned
7018 integer variable. An explicit cast silences the warning. In C, this
7019 option is enabled also by @option{-Wconversion}.
7020
7021 @item -Wfloat-conversion
7022 @opindex Wfloat-conversion
7023 @opindex Wno-float-conversion
7024 Warn for implicit conversions that reduce the precision of a real value.
7025 This includes conversions from real to integer, and from higher precision
7026 real to lower precision real values. This option is also enabled by
7027 @option{-Wconversion}.
7028
7029 @item -Wno-scalar-storage-order
7030 @opindex Wno-scalar-storage-order
7031 @opindex Wscalar-storage-order
7032 Do not warn on suspicious constructs involving reverse scalar storage order.
7033
7034 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
7035 @opindex Wsized-deallocation
7036 @opindex Wno-sized-deallocation
7037 Warn about a definition of an unsized deallocation function
7038 @smallexample
7039 void operator delete (void *) noexcept;
7040 void operator delete[] (void *) noexcept;
7041 @end smallexample
7042 without a definition of the corresponding sized deallocation function
7043 @smallexample
7044 void operator delete (void *, std::size_t) noexcept;
7045 void operator delete[] (void *, std::size_t) noexcept;
7046 @end smallexample
7047 or vice versa. Enabled by @option{-Wextra} along with
7048 @option{-fsized-deallocation}.
7049
7050 @item -Wsizeof-pointer-div
7051 @opindex Wsizeof-pointer-div
7052 @opindex Wno-sizeof-pointer-div
7053 Warn for suspicious divisions of two sizeof expressions that divide
7054 the pointer size by the element size, which is the usual way to compute
7055 the array size but won't work out correctly with pointers. This warning
7056 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
7057 not an array, but a pointer. This warning is enabled by @option{-Wall}.
7058
7059 @item -Wsizeof-pointer-memaccess
7060 @opindex Wsizeof-pointer-memaccess
7061 @opindex Wno-sizeof-pointer-memaccess
7062 Warn for suspicious length parameters to certain string and memory built-in
7063 functions if the argument uses @code{sizeof}. This warning triggers for
7064 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
7065 an array, but a pointer, and suggests a possible fix, or about
7066 @code{memcpy (&foo, ptr, sizeof (&foo));}. @option{-Wsizeof-pointer-memaccess}
7067 also warns about calls to bounded string copy functions like @code{strncat}
7068 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
7069 the source array. For example, in the following function the call to
7070 @code{strncat} specifies the size of the source string as the bound. That
7071 is almost certainly a mistake and so the call is diagnosed.
7072 @smallexample
7073 void make_file (const char *name)
7074 @{
7075 char path[PATH_MAX];
7076 strncpy (path, name, sizeof path - 1);
7077 strncat (path, ".text", sizeof ".text");
7078 @dots{}
7079 @}
7080 @end smallexample
7081
7082 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
7083
7084 @item -Wsizeof-array-argument
7085 @opindex Wsizeof-array-argument
7086 @opindex Wno-sizeof-array-argument
7087 Warn when the @code{sizeof} operator is applied to a parameter that is
7088 declared as an array in a function definition. This warning is enabled by
7089 default for C and C++ programs.
7090
7091 @item -Wmemset-elt-size
7092 @opindex Wmemset-elt-size
7093 @opindex Wno-memset-elt-size
7094 Warn for suspicious calls to the @code{memset} built-in function, if the
7095 first argument references an array, and the third argument is a number
7096 equal to the number of elements, but not equal to the size of the array
7097 in memory. This indicates that the user has omitted a multiplication by
7098 the element size. This warning is enabled by @option{-Wall}.
7099
7100 @item -Wmemset-transposed-args
7101 @opindex Wmemset-transposed-args
7102 @opindex Wno-memset-transposed-args
7103 Warn for suspicious calls to the @code{memset} built-in function where
7104 the second argument is not zero and the third argument is zero. For
7105 example, the call @code{memset (buf, sizeof buf, 0)} is diagnosed because
7106 @code{memset (buf, 0, sizeof buf)} was meant instead. The diagnostic
7107 is only emitted if the third argument is a literal zero. Otherwise, if
7108 it is an expression that is folded to zero, or a cast of zero to some
7109 type, it is far less likely that the arguments have been mistakenly
7110 transposed and no warning is emitted. This warning is enabled
7111 by @option{-Wall}.
7112
7113 @item -Waddress
7114 @opindex Waddress
7115 @opindex Wno-address
7116 Warn about suspicious uses of memory addresses. These include using
7117 the address of a function in a conditional expression, such as
7118 @code{void func(void); if (func)}, and comparisons against the memory
7119 address of a string literal, such as @code{if (x == "abc")}. Such
7120 uses typically indicate a programmer error: the address of a function
7121 always evaluates to true, so their use in a conditional usually
7122 indicate that the programmer forgot the parentheses in a function
7123 call; and comparisons against string literals result in unspecified
7124 behavior and are not portable in C, so they usually indicate that the
7125 programmer intended to use @code{strcmp}. This warning is enabled by
7126 @option{-Wall}.
7127
7128 @item -Waddress-of-packed-member
7129 @opindex Waddress-of-packed-member
7130 @opindex Wno-address-of-packed-member
7131 Warn when the address of packed member of struct or union is taken,
7132 which usually results in an unaligned pointer value. This is
7133 enabled by default.
7134
7135 @item -Wlogical-op
7136 @opindex Wlogical-op
7137 @opindex Wno-logical-op
7138 Warn about suspicious uses of logical operators in expressions.
7139 This includes using logical operators in contexts where a
7140 bit-wise operator is likely to be expected. Also warns when
7141 the operands of a logical operator are the same:
7142 @smallexample
7143 extern int a;
7144 if (a < 0 && a < 0) @{ @dots{} @}
7145 @end smallexample
7146
7147 @item -Wlogical-not-parentheses
7148 @opindex Wlogical-not-parentheses
7149 @opindex Wno-logical-not-parentheses
7150 Warn about logical not used on the left hand side operand of a comparison.
7151 This option does not warn if the right operand is considered to be a boolean
7152 expression. Its purpose is to detect suspicious code like the following:
7153 @smallexample
7154 int a;
7155 @dots{}
7156 if (!a > 1) @{ @dots{} @}
7157 @end smallexample
7158
7159 It is possible to suppress the warning by wrapping the LHS into
7160 parentheses:
7161 @smallexample
7162 if ((!a) > 1) @{ @dots{} @}
7163 @end smallexample
7164
7165 This warning is enabled by @option{-Wall}.
7166
7167 @item -Waggregate-return
7168 @opindex Waggregate-return
7169 @opindex Wno-aggregate-return
7170 Warn if any functions that return structures or unions are defined or
7171 called. (In languages where you can return an array, this also elicits
7172 a warning.)
7173
7174 @item -Wno-aggressive-loop-optimizations
7175 @opindex Wno-aggressive-loop-optimizations
7176 @opindex Waggressive-loop-optimizations
7177 Warn if in a loop with constant number of iterations the compiler detects
7178 undefined behavior in some statement during one or more of the iterations.
7179
7180 @item -Wno-attributes
7181 @opindex Wno-attributes
7182 @opindex Wattributes
7183 Do not warn if an unexpected @code{__attribute__} is used, such as
7184 unrecognized attributes, function attributes applied to variables,
7185 etc. This does not stop errors for incorrect use of supported
7186 attributes.
7187
7188 @item -Wno-builtin-declaration-mismatch
7189 @opindex Wno-builtin-declaration-mismatch
7190 @opindex Wbuiltin-declaration-mismatch
7191 Warn if a built-in function is declared with an incompatible signature
7192 or as a non-function, or when a built-in function declared with a type
7193 that does not include a prototype is called with arguments whose promoted
7194 types do not match those expected by the function. When @option{-Wextra}
7195 is specified, also warn when a built-in function that takes arguments is
7196 declared without a prototype. The @option{-Wno-builtin-declaration-mismatch}
7197 warning is enabled by default. To avoid the warning include the appropriate
7198 header to bring the prototypes of built-in functions into scope.
7199
7200 For example, the call to @code{memset} below is diagnosed by the warning
7201 because the function expects a value of type @code{size_t} as its argument
7202 but the type of @code{32} is @code{int}. With @option{-Wextra},
7203 the declaration of the function is diagnosed as well.
7204 @smallexample
7205 extern void* memset ();
7206 void f (void *d)
7207 @{
7208 memset (d, '\0', 32);
7209 @}
7210 @end smallexample
7211
7212 @item -Wno-builtin-macro-redefined
7213 @opindex Wno-builtin-macro-redefined
7214 @opindex Wbuiltin-macro-redefined
7215 Do not warn if certain built-in macros are redefined. This suppresses
7216 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
7217 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
7218
7219 @item -Wstrict-prototypes @r{(C and Objective-C only)}
7220 @opindex Wstrict-prototypes
7221 @opindex Wno-strict-prototypes
7222 Warn if a function is declared or defined without specifying the
7223 argument types. (An old-style function definition is permitted without
7224 a warning if preceded by a declaration that specifies the argument
7225 types.)
7226
7227 @item -Wold-style-declaration @r{(C and Objective-C only)}
7228 @opindex Wold-style-declaration
7229 @opindex Wno-old-style-declaration
7230 Warn for obsolescent usages, according to the C Standard, in a
7231 declaration. For example, warn if storage-class specifiers like
7232 @code{static} are not the first things in a declaration. This warning
7233 is also enabled by @option{-Wextra}.
7234
7235 @item -Wold-style-definition @r{(C and Objective-C only)}
7236 @opindex Wold-style-definition
7237 @opindex Wno-old-style-definition
7238 Warn if an old-style function definition is used. A warning is given
7239 even if there is a previous prototype.
7240
7241 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
7242 @opindex Wmissing-parameter-type
7243 @opindex Wno-missing-parameter-type
7244 A function parameter is declared without a type specifier in K&R-style
7245 functions:
7246
7247 @smallexample
7248 void foo(bar) @{ @}
7249 @end smallexample
7250
7251 This warning is also enabled by @option{-Wextra}.
7252
7253 @item -Wmissing-prototypes @r{(C and Objective-C only)}
7254 @opindex Wmissing-prototypes
7255 @opindex Wno-missing-prototypes
7256 Warn if a global function is defined without a previous prototype
7257 declaration. This warning is issued even if the definition itself
7258 provides a prototype. Use this option to detect global functions
7259 that do not have a matching prototype declaration in a header file.
7260 This option is not valid for C++ because all function declarations
7261 provide prototypes and a non-matching declaration declares an
7262 overload rather than conflict with an earlier declaration.
7263 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
7264
7265 @item -Wmissing-declarations
7266 @opindex Wmissing-declarations
7267 @opindex Wno-missing-declarations
7268 Warn if a global function is defined without a previous declaration.
7269 Do so even if the definition itself provides a prototype.
7270 Use this option to detect global functions that are not declared in
7271 header files. In C, no warnings are issued for functions with previous
7272 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
7273 missing prototypes. In C++, no warnings are issued for function templates,
7274 or for inline functions, or for functions in anonymous namespaces.
7275
7276 @item -Wmissing-field-initializers
7277 @opindex Wmissing-field-initializers
7278 @opindex Wno-missing-field-initializers
7279 @opindex W
7280 @opindex Wextra
7281 @opindex Wno-extra
7282 Warn if a structure's initializer has some fields missing. For
7283 example, the following code causes such a warning, because
7284 @code{x.h} is implicitly zero:
7285
7286 @smallexample
7287 struct s @{ int f, g, h; @};
7288 struct s x = @{ 3, 4 @};
7289 @end smallexample
7290
7291 This option does not warn about designated initializers, so the following
7292 modification does not trigger a warning:
7293
7294 @smallexample
7295 struct s @{ int f, g, h; @};
7296 struct s x = @{ .f = 3, .g = 4 @};
7297 @end smallexample
7298
7299 In C this option does not warn about the universal zero initializer
7300 @samp{@{ 0 @}}:
7301
7302 @smallexample
7303 struct s @{ int f, g, h; @};
7304 struct s x = @{ 0 @};
7305 @end smallexample
7306
7307 Likewise, in C++ this option does not warn about the empty @{ @}
7308 initializer, for example:
7309
7310 @smallexample
7311 struct s @{ int f, g, h; @};
7312 s x = @{ @};
7313 @end smallexample
7314
7315 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
7316 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
7317
7318 @item -Wno-multichar
7319 @opindex Wno-multichar
7320 @opindex Wmultichar
7321 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
7322 Usually they indicate a typo in the user's code, as they have
7323 implementation-defined values, and should not be used in portable code.
7324
7325 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
7326 @opindex Wnormalized=
7327 @opindex Wnormalized
7328 @opindex Wno-normalized
7329 @cindex NFC
7330 @cindex NFKC
7331 @cindex character set, input normalization
7332 In ISO C and ISO C++, two identifiers are different if they are
7333 different sequences of characters. However, sometimes when characters
7334 outside the basic ASCII character set are used, you can have two
7335 different character sequences that look the same. To avoid confusion,
7336 the ISO 10646 standard sets out some @dfn{normalization rules} which
7337 when applied ensure that two sequences that look the same are turned into
7338 the same sequence. GCC can warn you if you are using identifiers that
7339 have not been normalized; this option controls that warning.
7340
7341 There are four levels of warning supported by GCC@. The default is
7342 @option{-Wnormalized=nfc}, which warns about any identifier that is
7343 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
7344 recommended form for most uses. It is equivalent to
7345 @option{-Wnormalized}.
7346
7347 Unfortunately, there are some characters allowed in identifiers by
7348 ISO C and ISO C++ that, when turned into NFC, are not allowed in
7349 identifiers. That is, there's no way to use these symbols in portable
7350 ISO C or C++ and have all your identifiers in NFC@.
7351 @option{-Wnormalized=id} suppresses the warning for these characters.
7352 It is hoped that future versions of the standards involved will correct
7353 this, which is why this option is not the default.
7354
7355 You can switch the warning off for all characters by writing
7356 @option{-Wnormalized=none} or @option{-Wno-normalized}. You should
7357 only do this if you are using some other normalization scheme (like
7358 ``D''), because otherwise you can easily create bugs that are
7359 literally impossible to see.
7360
7361 Some characters in ISO 10646 have distinct meanings but look identical
7362 in some fonts or display methodologies, especially once formatting has
7363 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
7364 LETTER N'', displays just like a regular @code{n} that has been
7365 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
7366 normalization scheme to convert all these into a standard form as
7367 well, and GCC warns if your code is not in NFKC if you use
7368 @option{-Wnormalized=nfkc}. This warning is comparable to warning
7369 about every identifier that contains the letter O because it might be
7370 confused with the digit 0, and so is not the default, but may be
7371 useful as a local coding convention if the programming environment
7372 cannot be fixed to display these characters distinctly.
7373
7374 @item -Wno-attribute-warning
7375 @opindex Wno-attribute-warning
7376 @opindex Wattribute-warning
7377 Do not warn about usage of functions (@pxref{Function Attributes})
7378 declared with @code{warning} attribute. By default, this warning is
7379 enabled. @option{-Wno-attribute-warning} can be used to disable the
7380 warning or @option{-Wno-error=attribute-warning} can be used to
7381 disable the error when compiled with @option{-Werror} flag.
7382
7383 @item -Wno-deprecated
7384 @opindex Wno-deprecated
7385 @opindex Wdeprecated
7386 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
7387
7388 @item -Wno-deprecated-declarations
7389 @opindex Wno-deprecated-declarations
7390 @opindex Wdeprecated-declarations
7391 Do not warn about uses of functions (@pxref{Function Attributes}),
7392 variables (@pxref{Variable Attributes}), and types (@pxref{Type
7393 Attributes}) marked as deprecated by using the @code{deprecated}
7394 attribute.
7395
7396 @item -Wno-overflow
7397 @opindex Wno-overflow
7398 @opindex Woverflow
7399 Do not warn about compile-time overflow in constant expressions.
7400
7401 @item -Wno-odr
7402 @opindex Wno-odr
7403 @opindex Wodr
7404 Warn about One Definition Rule violations during link-time optimization.
7405 Enabled by default.
7406
7407 @item -Wopenmp-simd
7408 @opindex Wopenmp-simd
7409 @opindex Wno-openmp-simd
7410 Warn if the vectorizer cost model overrides the OpenMP
7411 simd directive set by user. The @option{-fsimd-cost-model=unlimited}
7412 option can be used to relax the cost model.
7413
7414 @item -Woverride-init @r{(C and Objective-C only)}
7415 @opindex Woverride-init
7416 @opindex Wno-override-init
7417 @opindex W
7418 @opindex Wextra
7419 @opindex Wno-extra
7420 Warn if an initialized field without side effects is overridden when
7421 using designated initializers (@pxref{Designated Inits, , Designated
7422 Initializers}).
7423
7424 This warning is included in @option{-Wextra}. To get other
7425 @option{-Wextra} warnings without this one, use @option{-Wextra
7426 -Wno-override-init}.
7427
7428 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
7429 @opindex Woverride-init-side-effects
7430 @opindex Wno-override-init-side-effects
7431 Warn if an initialized field with side effects is overridden when
7432 using designated initializers (@pxref{Designated Inits, , Designated
7433 Initializers}). This warning is enabled by default.
7434
7435 @item -Wpacked
7436 @opindex Wpacked
7437 @opindex Wno-packed
7438 Warn if a structure is given the packed attribute, but the packed
7439 attribute has no effect on the layout or size of the structure.
7440 Such structures may be mis-aligned for little benefit. For
7441 instance, in this code, the variable @code{f.x} in @code{struct bar}
7442 is misaligned even though @code{struct bar} does not itself
7443 have the packed attribute:
7444
7445 @smallexample
7446 @group
7447 struct foo @{
7448 int x;
7449 char a, b, c, d;
7450 @} __attribute__((packed));
7451 struct bar @{
7452 char z;
7453 struct foo f;
7454 @};
7455 @end group
7456 @end smallexample
7457
7458 @item -Wpacked-bitfield-compat
7459 @opindex Wpacked-bitfield-compat
7460 @opindex Wno-packed-bitfield-compat
7461 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
7462 on bit-fields of type @code{char}. This has been fixed in GCC 4.4 but
7463 the change can lead to differences in the structure layout. GCC
7464 informs you when the offset of such a field has changed in GCC 4.4.
7465 For example there is no longer a 4-bit padding between field @code{a}
7466 and @code{b} in this structure:
7467
7468 @smallexample
7469 struct foo
7470 @{
7471 char a:4;
7472 char b:8;
7473 @} __attribute__ ((packed));
7474 @end smallexample
7475
7476 This warning is enabled by default. Use
7477 @option{-Wno-packed-bitfield-compat} to disable this warning.
7478
7479 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
7480 @opindex Wpacked-not-aligned
7481 @opindex Wno-packed-not-aligned
7482 Warn if a structure field with explicitly specified alignment in a
7483 packed struct or union is misaligned. For example, a warning will
7484 be issued on @code{struct S}, like, @code{warning: alignment 1 of
7485 'struct S' is less than 8}, in this code:
7486
7487 @smallexample
7488 @group
7489 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
7490 struct __attribute__ ((packed)) S @{
7491 struct S8 s8;
7492 @};
7493 @end group
7494 @end smallexample
7495
7496 This warning is enabled by @option{-Wall}.
7497
7498 @item -Wpadded
7499 @opindex Wpadded
7500 @opindex Wno-padded
7501 Warn if padding is included in a structure, either to align an element
7502 of the structure or to align the whole structure. Sometimes when this
7503 happens it is possible to rearrange the fields of the structure to
7504 reduce the padding and so make the structure smaller.
7505
7506 @item -Wredundant-decls
7507 @opindex Wredundant-decls
7508 @opindex Wno-redundant-decls
7509 Warn if anything is declared more than once in the same scope, even in
7510 cases where multiple declaration is valid and changes nothing.
7511
7512 @item -Wno-restrict
7513 @opindex Wrestrict
7514 @opindex Wno-restrict
7515 Warn when an object referenced by a @code{restrict}-qualified parameter
7516 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
7517 argument, or when copies between such objects overlap. For example,
7518 the call to the @code{strcpy} function below attempts to truncate the string
7519 by replacing its initial characters with the last four. However, because
7520 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
7521 the call is diagnosed.
7522
7523 @smallexample
7524 void foo (void)
7525 @{
7526 char a[] = "abcd1234";
7527 strcpy (a, a + 4);
7528 @dots{}
7529 @}
7530 @end smallexample
7531 The @option{-Wrestrict} option detects some instances of simple overlap
7532 even without optimization but works best at @option{-O2} and above. It
7533 is included in @option{-Wall}.
7534
7535 @item -Wnested-externs @r{(C and Objective-C only)}
7536 @opindex Wnested-externs
7537 @opindex Wno-nested-externs
7538 Warn if an @code{extern} declaration is encountered within a function.
7539
7540 @item -Wno-inherited-variadic-ctor
7541 @opindex Winherited-variadic-ctor
7542 @opindex Wno-inherited-variadic-ctor
7543 Suppress warnings about use of C++11 inheriting constructors when the
7544 base class inherited from has a C variadic constructor; the warning is
7545 on by default because the ellipsis is not inherited.
7546
7547 @item -Winline
7548 @opindex Winline
7549 @opindex Wno-inline
7550 Warn if a function that is declared as inline cannot be inlined.
7551 Even with this option, the compiler does not warn about failures to
7552 inline functions declared in system headers.
7553
7554 The compiler uses a variety of heuristics to determine whether or not
7555 to inline a function. For example, the compiler takes into account
7556 the size of the function being inlined and the amount of inlining
7557 that has already been done in the current function. Therefore,
7558 seemingly insignificant changes in the source program can cause the
7559 warnings produced by @option{-Winline} to appear or disappear.
7560
7561 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
7562 @opindex Wno-invalid-offsetof
7563 @opindex Winvalid-offsetof
7564 Suppress warnings from applying the @code{offsetof} macro to a non-POD
7565 type. According to the 2014 ISO C++ standard, applying @code{offsetof}
7566 to a non-standard-layout type is undefined. In existing C++ implementations,
7567 however, @code{offsetof} typically gives meaningful results.
7568 This flag is for users who are aware that they are
7569 writing nonportable code and who have deliberately chosen to ignore the
7570 warning about it.
7571
7572 The restrictions on @code{offsetof} may be relaxed in a future version
7573 of the C++ standard.
7574
7575 @item -Wint-in-bool-context
7576 @opindex Wint-in-bool-context
7577 @opindex Wno-int-in-bool-context
7578 Warn for suspicious use of integer values where boolean values are expected,
7579 such as conditional expressions (?:) using non-boolean integer constants in
7580 boolean context, like @code{if (a <= b ? 2 : 3)}. Or left shifting of signed
7581 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}. Likewise
7582 for all kinds of multiplications regardless of the data type.
7583 This warning is enabled by @option{-Wall}.
7584
7585 @item -Wno-int-to-pointer-cast
7586 @opindex Wno-int-to-pointer-cast
7587 @opindex Wint-to-pointer-cast
7588 Suppress warnings from casts to pointer type of an integer of a
7589 different size. In C++, casting to a pointer type of smaller size is
7590 an error. @option{Wint-to-pointer-cast} is enabled by default.
7591
7592
7593 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
7594 @opindex Wno-pointer-to-int-cast
7595 @opindex Wpointer-to-int-cast
7596 Suppress warnings from casts from a pointer to an integer type of a
7597 different size.
7598
7599 @item -Winvalid-pch
7600 @opindex Winvalid-pch
7601 @opindex Wno-invalid-pch
7602 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
7603 the search path but cannot be used.
7604
7605 @item -Wlong-long
7606 @opindex Wlong-long
7607 @opindex Wno-long-long
7608 Warn if @code{long long} type is used. This is enabled by either
7609 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
7610 modes. To inhibit the warning messages, use @option{-Wno-long-long}.
7611
7612 @item -Wvariadic-macros
7613 @opindex Wvariadic-macros
7614 @opindex Wno-variadic-macros
7615 Warn if variadic macros are used in ISO C90 mode, or if the GNU
7616 alternate syntax is used in ISO C99 mode. This is enabled by either
7617 @option{-Wpedantic} or @option{-Wtraditional}. To inhibit the warning
7618 messages, use @option{-Wno-variadic-macros}.
7619
7620 @item -Wvarargs
7621 @opindex Wvarargs
7622 @opindex Wno-varargs
7623 Warn upon questionable usage of the macros used to handle variable
7624 arguments like @code{va_start}. This is default. To inhibit the
7625 warning messages, use @option{-Wno-varargs}.
7626
7627 @item -Wvector-operation-performance
7628 @opindex Wvector-operation-performance
7629 @opindex Wno-vector-operation-performance
7630 Warn if vector operation is not implemented via SIMD capabilities of the
7631 architecture. Mainly useful for the performance tuning.
7632 Vector operation can be implemented @code{piecewise}, which means that the
7633 scalar operation is performed on every vector element;
7634 @code{in parallel}, which means that the vector operation is implemented
7635 using scalars of wider type, which normally is more performance efficient;
7636 and @code{as a single scalar}, which means that vector fits into a
7637 scalar type.
7638
7639 @item -Wno-virtual-move-assign
7640 @opindex Wvirtual-move-assign
7641 @opindex Wno-virtual-move-assign
7642 Suppress warnings about inheriting from a virtual base with a
7643 non-trivial C++11 move assignment operator. This is dangerous because
7644 if the virtual base is reachable along more than one path, it is
7645 moved multiple times, which can mean both objects end up in the
7646 moved-from state. If the move assignment operator is written to avoid
7647 moving from a moved-from object, this warning can be disabled.
7648
7649 @item -Wvla
7650 @opindex Wvla
7651 @opindex Wno-vla
7652 Warn if a variable-length array is used in the code.
7653 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
7654 the variable-length array.
7655
7656 @item -Wvla-larger-than=@var{byte-size}
7657 @opindex Wvla-larger-than=
7658 @opindex Wno-vla-larger-than
7659 If this option is used, the compiler will warn for declarations of
7660 variable-length arrays whose size is either unbounded, or bounded
7661 by an argument that allows the array size to exceed @var{byte-size}
7662 bytes. This is similar to how @option{-Walloca-larger-than=}@var{byte-size}
7663 works, but with variable-length arrays.
7664
7665 Note that GCC may optimize small variable-length arrays of a known
7666 value into plain arrays, so this warning may not get triggered for
7667 such arrays.
7668
7669 @option{-Wvla-larger-than=}@samp{PTRDIFF_MAX} is enabled by default but
7670 is typically only effective when @option{-ftree-vrp} is active (default
7671 for @option{-O2} and above).
7672
7673 See also @option{-Walloca-larger-than=@var{byte-size}}.
7674
7675 @item -Wno-vla-larger-than
7676 @opindex Wno-vla-larger-than
7677 Disable @option{-Wvla-larger-than=} warnings. The option is equivalent
7678 to @option{-Wvla-larger-than=}@samp{SIZE_MAX} or larger.
7679
7680 @item -Wvolatile-register-var
7681 @opindex Wvolatile-register-var
7682 @opindex Wno-volatile-register-var
7683 Warn if a register variable is declared volatile. The volatile
7684 modifier does not inhibit all optimizations that may eliminate reads
7685 and/or writes to register variables. This warning is enabled by
7686 @option{-Wall}.
7687
7688 @item -Wdisabled-optimization
7689 @opindex Wdisabled-optimization
7690 @opindex Wno-disabled-optimization
7691 Warn if a requested optimization pass is disabled. This warning does
7692 not generally indicate that there is anything wrong with your code; it
7693 merely indicates that GCC's optimizers are unable to handle the code
7694 effectively. Often, the problem is that your code is too big or too
7695 complex; GCC refuses to optimize programs when the optimization
7696 itself is likely to take inordinate amounts of time.
7697
7698 @item -Wpointer-sign @r{(C and Objective-C only)}
7699 @opindex Wpointer-sign
7700 @opindex Wno-pointer-sign
7701 Warn for pointer argument passing or assignment with different signedness.
7702 This option is only supported for C and Objective-C@. It is implied by
7703 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
7704 @option{-Wno-pointer-sign}.
7705
7706 @item -Wstack-protector
7707 @opindex Wstack-protector
7708 @opindex Wno-stack-protector
7709 This option is only active when @option{-fstack-protector} is active. It
7710 warns about functions that are not protected against stack smashing.
7711
7712 @item -Woverlength-strings
7713 @opindex Woverlength-strings
7714 @opindex Wno-overlength-strings
7715 Warn about string constants that are longer than the ``minimum
7716 maximum'' length specified in the C standard. Modern compilers
7717 generally allow string constants that are much longer than the
7718 standard's minimum limit, but very portable programs should avoid
7719 using longer strings.
7720
7721 The limit applies @emph{after} string constant concatenation, and does
7722 not count the trailing NUL@. In C90, the limit was 509 characters; in
7723 C99, it was raised to 4095. C++98 does not specify a normative
7724 minimum maximum, so we do not diagnose overlength strings in C++@.
7725
7726 This option is implied by @option{-Wpedantic}, and can be disabled with
7727 @option{-Wno-overlength-strings}.
7728
7729 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7730 @opindex Wunsuffixed-float-constants
7731 @opindex Wno-unsuffixed-float-constants
7732
7733 Issue a warning for any floating constant that does not have
7734 a suffix. When used together with @option{-Wsystem-headers} it
7735 warns about such constants in system header files. This can be useful
7736 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7737 from the decimal floating-point extension to C99.
7738
7739 @item -Wno-designated-init @r{(C and Objective-C only)}
7740 Suppress warnings when a positional initializer is used to initialize
7741 a structure that has been marked with the @code{designated_init}
7742 attribute.
7743
7744 @item -Whsa
7745 Issue a warning when HSAIL cannot be emitted for the compiled function or
7746 OpenMP construct.
7747
7748 @end table
7749
7750 @node Debugging Options
7751 @section Options for Debugging Your Program
7752 @cindex options, debugging
7753 @cindex debugging information options
7754
7755 To tell GCC to emit extra information for use by a debugger, in almost
7756 all cases you need only to add @option{-g} to your other options.
7757
7758 GCC allows you to use @option{-g} with
7759 @option{-O}. The shortcuts taken by optimized code may occasionally
7760 be surprising: some variables you declared may not exist
7761 at all; flow of control may briefly move where you did not expect it;
7762 some statements may not be executed because they compute constant
7763 results or their values are already at hand; some statements may
7764 execute in different places because they have been moved out of loops.
7765 Nevertheless it is possible to debug optimized output. This makes
7766 it reasonable to use the optimizer for programs that might have bugs.
7767
7768 If you are not using some other optimization option, consider
7769 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.
7770 With no @option{-O} option at all, some compiler passes that collect
7771 information useful for debugging do not run at all, so that
7772 @option{-Og} may result in a better debugging experience.
7773
7774 @table @gcctabopt
7775 @item -g
7776 @opindex g
7777 Produce debugging information in the operating system's native format
7778 (stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
7779 information.
7780
7781 On most systems that use stabs format, @option{-g} enables use of extra
7782 debugging information that only GDB can use; this extra information
7783 makes debugging work better in GDB but probably makes other debuggers
7784 crash or
7785 refuse to read the program. If you want to control for certain whether
7786 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7787 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7788
7789 @item -ggdb
7790 @opindex ggdb
7791 Produce debugging information for use by GDB@. This means to use the
7792 most expressive format available (DWARF, stabs, or the native format
7793 if neither of those are supported), including GDB extensions if at all
7794 possible.
7795
7796 @item -gdwarf
7797 @itemx -gdwarf-@var{version}
7798 @opindex gdwarf
7799 Produce debugging information in DWARF format (if that is supported).
7800 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7801 for most targets is 4. DWARF Version 5 is only experimental.
7802
7803 Note that with DWARF Version 2, some ports require and always
7804 use some non-conflicting DWARF 3 extensions in the unwind tables.
7805
7806 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7807 for maximum benefit.
7808
7809 GCC no longer supports DWARF Version 1, which is substantially
7810 different than Version 2 and later. For historical reasons, some
7811 other DWARF-related options such as
7812 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7813 in their names, but apply to all currently-supported versions of DWARF.
7814
7815 @item -gstabs
7816 @opindex gstabs
7817 Produce debugging information in stabs format (if that is supported),
7818 without GDB extensions. This is the format used by DBX on most BSD
7819 systems. On MIPS, Alpha and System V Release 4 systems this option
7820 produces stabs debugging output that is not understood by DBX@.
7821 On System V Release 4 systems this option requires the GNU assembler.
7822
7823 @item -gstabs+
7824 @opindex gstabs+
7825 Produce debugging information in stabs format (if that is supported),
7826 using GNU extensions understood only by the GNU debugger (GDB)@. The
7827 use of these extensions is likely to make other debuggers crash or
7828 refuse to read the program.
7829
7830 @item -gxcoff
7831 @opindex gxcoff
7832 Produce debugging information in XCOFF format (if that is supported).
7833 This is the format used by the DBX debugger on IBM RS/6000 systems.
7834
7835 @item -gxcoff+
7836 @opindex gxcoff+
7837 Produce debugging information in XCOFF format (if that is supported),
7838 using GNU extensions understood only by the GNU debugger (GDB)@. The
7839 use of these extensions is likely to make other debuggers crash or
7840 refuse to read the program, and may cause assemblers other than the GNU
7841 assembler (GAS) to fail with an error.
7842
7843 @item -gvms
7844 @opindex gvms
7845 Produce debugging information in Alpha/VMS debug format (if that is
7846 supported). This is the format used by DEBUG on Alpha/VMS systems.
7847
7848 @item -g@var{level}
7849 @itemx -ggdb@var{level}
7850 @itemx -gstabs@var{level}
7851 @itemx -gxcoff@var{level}
7852 @itemx -gvms@var{level}
7853 Request debugging information and also use @var{level} to specify how
7854 much information. The default level is 2.
7855
7856 Level 0 produces no debug information at all. Thus, @option{-g0} negates
7857 @option{-g}.
7858
7859 Level 1 produces minimal information, enough for making backtraces in
7860 parts of the program that you don't plan to debug. This includes
7861 descriptions of functions and external variables, and line number
7862 tables, but no information about local variables.
7863
7864 Level 3 includes extra information, such as all the macro definitions
7865 present in the program. Some debuggers support macro expansion when
7866 you use @option{-g3}.
7867
7868 If you use multiple @option{-g} options, with or without level numbers,
7869 the last such option is the one that is effective.
7870
7871 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7872 confusion with @option{-gdwarf-@var{level}}.
7873 Instead use an additional @option{-g@var{level}} option to change the
7874 debug level for DWARF.
7875
7876 @item -fno-eliminate-unused-debug-symbols
7877 @opindex feliminate-unused-debug-symbols
7878 @opindex fno-eliminate-unused-debug-symbols
7879 By default, no debug information is produced for symbols that are not actually
7880 used. Use this option if you want debug information for all symbols.
7881
7882 @item -femit-class-debug-always
7883 @opindex femit-class-debug-always
7884 Instead of emitting debugging information for a C++ class in only one
7885 object file, emit it in all object files using the class. This option
7886 should be used only with debuggers that are unable to handle the way GCC
7887 normally emits debugging information for classes because using this
7888 option increases the size of debugging information by as much as a
7889 factor of two.
7890
7891 @item -fno-merge-debug-strings
7892 @opindex fmerge-debug-strings
7893 @opindex fno-merge-debug-strings
7894 Direct the linker to not merge together strings in the debugging
7895 information that are identical in different object files. Merging is
7896 not supported by all assemblers or linkers. Merging decreases the size
7897 of the debug information in the output file at the cost of increasing
7898 link processing time. Merging is enabled by default.
7899
7900 @item -fdebug-prefix-map=@var{old}=@var{new}
7901 @opindex fdebug-prefix-map
7902 When compiling files residing in directory @file{@var{old}}, record
7903 debugging information describing them as if the files resided in
7904 directory @file{@var{new}} instead. This can be used to replace a
7905 build-time path with an install-time path in the debug info. It can
7906 also be used to change an absolute path to a relative path by using
7907 @file{.} for @var{new}. This can give more reproducible builds, which
7908 are location independent, but may require an extra command to tell GDB
7909 where to find the source files. See also @option{-ffile-prefix-map}.
7910
7911 @item -fvar-tracking
7912 @opindex fvar-tracking
7913 Run variable tracking pass. It computes where variables are stored at each
7914 position in code. Better debugging information is then generated
7915 (if the debugging information format supports this information).
7916
7917 It is enabled by default when compiling with optimization (@option{-Os},
7918 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7919 the debug info format supports it.
7920
7921 @item -fvar-tracking-assignments
7922 @opindex fvar-tracking-assignments
7923 @opindex fno-var-tracking-assignments
7924 Annotate assignments to user variables early in the compilation and
7925 attempt to carry the annotations over throughout the compilation all the
7926 way to the end, in an attempt to improve debug information while
7927 optimizing. Use of @option{-gdwarf-4} is recommended along with it.
7928
7929 It can be enabled even if var-tracking is disabled, in which case
7930 annotations are created and maintained, but discarded at the end.
7931 By default, this flag is enabled together with @option{-fvar-tracking},
7932 except when selective scheduling is enabled.
7933
7934 @item -gsplit-dwarf
7935 @opindex gsplit-dwarf
7936 Separate as much DWARF debugging information as possible into a
7937 separate output file with the extension @file{.dwo}. This option allows
7938 the build system to avoid linking files with debug information. To
7939 be useful, this option requires a debugger capable of reading @file{.dwo}
7940 files.
7941
7942 @item -gdescribe-dies
7943 @opindex gdescribe-dies
7944 Add description attributes to some DWARF DIEs that have no name attribute,
7945 such as artificial variables, external references and call site
7946 parameter DIEs.
7947
7948 @item -gpubnames
7949 @opindex gpubnames
7950 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7951
7952 @item -ggnu-pubnames
7953 @opindex ggnu-pubnames
7954 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7955 suitable for conversion into a GDB@ index. This option is only useful
7956 with a linker that can produce GDB@ index version 7.
7957
7958 @item -fdebug-types-section
7959 @opindex fdebug-types-section
7960 @opindex fno-debug-types-section
7961 When using DWARF Version 4 or higher, type DIEs can be put into
7962 their own @code{.debug_types} section instead of making them part of the
7963 @code{.debug_info} section. It is more efficient to put them in a separate
7964 comdat section since the linker can then remove duplicates.
7965 But not all DWARF consumers support @code{.debug_types} sections yet
7966 and on some objects @code{.debug_types} produces larger instead of smaller
7967 debugging information.
7968
7969 @item -grecord-gcc-switches
7970 @itemx -gno-record-gcc-switches
7971 @opindex grecord-gcc-switches
7972 @opindex gno-record-gcc-switches
7973 This switch causes the command-line options used to invoke the
7974 compiler that may affect code generation to be appended to the
7975 DW_AT_producer attribute in DWARF debugging information. The options
7976 are concatenated with spaces separating them from each other and from
7977 the compiler version.
7978 It is enabled by default.
7979 See also @option{-frecord-gcc-switches} for another
7980 way of storing compiler options into the object file.
7981
7982 @item -gstrict-dwarf
7983 @opindex gstrict-dwarf
7984 Disallow using extensions of later DWARF standard version than selected
7985 with @option{-gdwarf-@var{version}}. On most targets using non-conflicting
7986 DWARF extensions from later standard versions is allowed.
7987
7988 @item -gno-strict-dwarf
7989 @opindex gno-strict-dwarf
7990 Allow using extensions of later DWARF standard version than selected with
7991 @option{-gdwarf-@var{version}}.
7992
7993 @item -gas-loc-support
7994 @opindex gas-loc-support
7995 Inform the compiler that the assembler supports @code{.loc} directives.
7996 It may then use them for the assembler to generate DWARF2+ line number
7997 tables.
7998
7999 This is generally desirable, because assembler-generated line-number
8000 tables are a lot more compact than those the compiler can generate
8001 itself.
8002
8003 This option will be enabled by default if, at GCC configure time, the
8004 assembler was found to support such directives.
8005
8006 @item -gno-as-loc-support
8007 @opindex gno-as-loc-support
8008 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
8009 line number tables are to be generated.
8010
8011 @item -gas-locview-support
8012 @opindex gas-locview-support
8013 Inform the compiler that the assembler supports @code{view} assignment
8014 and reset assertion checking in @code{.loc} directives.
8015
8016 This option will be enabled by default if, at GCC configure time, the
8017 assembler was found to support them.
8018
8019 @item -gno-as-locview-support
8020 Force GCC to assign view numbers internally, if
8021 @option{-gvariable-location-views} are explicitly requested.
8022
8023 @item -gcolumn-info
8024 @itemx -gno-column-info
8025 @opindex gcolumn-info
8026 @opindex gno-column-info
8027 Emit location column information into DWARF debugging information, rather
8028 than just file and line.
8029 This option is enabled by default.
8030
8031 @item -gstatement-frontiers
8032 @itemx -gno-statement-frontiers
8033 @opindex gstatement-frontiers
8034 @opindex gno-statement-frontiers
8035 This option causes GCC to create markers in the internal representation
8036 at the beginning of statements, and to keep them roughly in place
8037 throughout compilation, using them to guide the output of @code{is_stmt}
8038 markers in the line number table. This is enabled by default when
8039 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
8040 @dots{}), and outputting DWARF 2 debug information at the normal level.
8041
8042 @item -gvariable-location-views
8043 @itemx -gvariable-location-views=incompat5
8044 @itemx -gno-variable-location-views
8045 @opindex gvariable-location-views
8046 @opindex gvariable-location-views=incompat5
8047 @opindex gno-variable-location-views
8048 Augment variable location lists with progressive view numbers implied
8049 from the line number table. This enables debug information consumers to
8050 inspect state at certain points of the program, even if no instructions
8051 associated with the corresponding source locations are present at that
8052 point. If the assembler lacks support for view numbers in line number
8053 tables, this will cause the compiler to emit the line number table,
8054 which generally makes them somewhat less compact. The augmented line
8055 number tables and location lists are fully backward-compatible, so they
8056 can be consumed by debug information consumers that are not aware of
8057 these augmentations, but they won't derive any benefit from them either.
8058
8059 This is enabled by default when outputting DWARF 2 debug information at
8060 the normal level, as long as there is assembler support,
8061 @option{-fvar-tracking-assignments} is enabled and
8062 @option{-gstrict-dwarf} is not. When assembler support is not
8063 available, this may still be enabled, but it will force GCC to output
8064 internal line number tables, and if
8065 @option{-ginternal-reset-location-views} is not enabled, that will most
8066 certainly lead to silently mismatching location views.
8067
8068 There is a proposed representation for view numbers that is not backward
8069 compatible with the location list format introduced in DWARF 5, that can
8070 be enabled with @option{-gvariable-location-views=incompat5}. This
8071 option may be removed in the future, is only provided as a reference
8072 implementation of the proposed representation. Debug information
8073 consumers are not expected to support this extended format, and they
8074 would be rendered unable to decode location lists using it.
8075
8076 @item -ginternal-reset-location-views
8077 @itemx -gnointernal-reset-location-views
8078 @opindex ginternal-reset-location-views
8079 @opindex gno-internal-reset-location-views
8080 Attempt to determine location views that can be omitted from location
8081 view lists. This requires the compiler to have very accurate insn
8082 length estimates, which isn't always the case, and it may cause
8083 incorrect view lists to be generated silently when using an assembler
8084 that does not support location view lists. The GNU assembler will flag
8085 any such error as a @code{view number mismatch}. This is only enabled
8086 on ports that define a reliable estimation function.
8087
8088 @item -ginline-points
8089 @itemx -gno-inline-points
8090 @opindex ginline-points
8091 @opindex gno-inline-points
8092 Generate extended debug information for inlined functions. Location
8093 view tracking markers are inserted at inlined entry points, so that
8094 address and view numbers can be computed and output in debug
8095 information. This can be enabled independently of location views, in
8096 which case the view numbers won't be output, but it can only be enabled
8097 along with statement frontiers, and it is only enabled by default if
8098 location views are enabled.
8099
8100 @item -gz@r{[}=@var{type}@r{]}
8101 @opindex gz
8102 Produce compressed debug sections in DWARF format, if that is supported.
8103 If @var{type} is not given, the default type depends on the capabilities
8104 of the assembler and linker used. @var{type} may be one of
8105 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
8106 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
8107 compression in traditional GNU format). If the linker doesn't support
8108 writing compressed debug sections, the option is rejected. Otherwise,
8109 if the assembler does not support them, @option{-gz} is silently ignored
8110 when producing object files.
8111
8112 @item -femit-struct-debug-baseonly
8113 @opindex femit-struct-debug-baseonly
8114 Emit debug information for struct-like types
8115 only when the base name of the compilation source file
8116 matches the base name of file in which the struct is defined.
8117
8118 This option substantially reduces the size of debugging information,
8119 but at significant potential loss in type information to the debugger.
8120 See @option{-femit-struct-debug-reduced} for a less aggressive option.
8121 See @option{-femit-struct-debug-detailed} for more detailed control.
8122
8123 This option works only with DWARF debug output.
8124
8125 @item -femit-struct-debug-reduced
8126 @opindex femit-struct-debug-reduced
8127 Emit debug information for struct-like types
8128 only when the base name of the compilation source file
8129 matches the base name of file in which the type is defined,
8130 unless the struct is a template or defined in a system header.
8131
8132 This option significantly reduces the size of debugging information,
8133 with some potential loss in type information to the debugger.
8134 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
8135 See @option{-femit-struct-debug-detailed} for more detailed control.
8136
8137 This option works only with DWARF debug output.
8138
8139 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
8140 @opindex femit-struct-debug-detailed
8141 Specify the struct-like types
8142 for which the compiler generates debug information.
8143 The intent is to reduce duplicate struct debug information
8144 between different object files within the same program.
8145
8146 This option is a detailed version of
8147 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
8148 which serves for most needs.
8149
8150 A specification has the syntax@*
8151 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
8152
8153 The optional first word limits the specification to
8154 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
8155 A struct type is used directly when it is the type of a variable, member.
8156 Indirect uses arise through pointers to structs.
8157 That is, when use of an incomplete struct is valid, the use is indirect.
8158 An example is
8159 @samp{struct one direct; struct two * indirect;}.
8160
8161 The optional second word limits the specification to
8162 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
8163 Generic structs are a bit complicated to explain.
8164 For C++, these are non-explicit specializations of template classes,
8165 or non-template classes within the above.
8166 Other programming languages have generics,
8167 but @option{-femit-struct-debug-detailed} does not yet implement them.
8168
8169 The third word specifies the source files for those
8170 structs for which the compiler should emit debug information.
8171 The values @samp{none} and @samp{any} have the normal meaning.
8172 The value @samp{base} means that
8173 the base of name of the file in which the type declaration appears
8174 must match the base of the name of the main compilation file.
8175 In practice, this means that when compiling @file{foo.c}, debug information
8176 is generated for types declared in that file and @file{foo.h},
8177 but not other header files.
8178 The value @samp{sys} means those types satisfying @samp{base}
8179 or declared in system or compiler headers.
8180
8181 You may need to experiment to determine the best settings for your application.
8182
8183 The default is @option{-femit-struct-debug-detailed=all}.
8184
8185 This option works only with DWARF debug output.
8186
8187 @item -fno-dwarf2-cfi-asm
8188 @opindex fdwarf2-cfi-asm
8189 @opindex fno-dwarf2-cfi-asm
8190 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
8191 instead of using GAS @code{.cfi_*} directives.
8192
8193 @item -fno-eliminate-unused-debug-types
8194 @opindex feliminate-unused-debug-types
8195 @opindex fno-eliminate-unused-debug-types
8196 Normally, when producing DWARF output, GCC avoids producing debug symbol
8197 output for types that are nowhere used in the source file being compiled.
8198 Sometimes it is useful to have GCC emit debugging
8199 information for all types declared in a compilation
8200 unit, regardless of whether or not they are actually used
8201 in that compilation unit, for example
8202 if, in the debugger, you want to cast a value to a type that is
8203 not actually used in your program (but is declared). More often,
8204 however, this results in a significant amount of wasted space.
8205 @end table
8206
8207 @node Optimize Options
8208 @section Options That Control Optimization
8209 @cindex optimize options
8210 @cindex options, optimization
8211
8212 These options control various sorts of optimizations.
8213
8214 Without any optimization option, the compiler's goal is to reduce the
8215 cost of compilation and to make debugging produce the expected
8216 results. Statements are independent: if you stop the program with a
8217 breakpoint between statements, you can then assign a new value to any
8218 variable or change the program counter to any other statement in the
8219 function and get exactly the results you expect from the source
8220 code.
8221
8222 Turning on optimization flags makes the compiler attempt to improve
8223 the performance and/or code size at the expense of compilation time
8224 and possibly the ability to debug the program.
8225
8226 The compiler performs optimization based on the knowledge it has of the
8227 program. Compiling multiple files at once to a single output file mode allows
8228 the compiler to use information gained from all of the files when compiling
8229 each of them.
8230
8231 Not all optimizations are controlled directly by a flag. Only
8232 optimizations that have a flag are listed in this section.
8233
8234 Most optimizations are completely disabled at @option{-O0} or if an
8235 @option{-O} level is not set on the command line, even if individual
8236 optimization flags are specified. Similarly, @option{-Og} suppresses
8237 many optimization passes.
8238
8239 Depending on the target and how GCC was configured, a slightly different
8240 set of optimizations may be enabled at each @option{-O} level than
8241 those listed here. You can invoke GCC with @option{-Q --help=optimizers}
8242 to find out the exact set of optimizations that are enabled at each level.
8243 @xref{Overall Options}, for examples.
8244
8245 @table @gcctabopt
8246 @item -O
8247 @itemx -O1
8248 @opindex O
8249 @opindex O1
8250 Optimize. Optimizing compilation takes somewhat more time, and a lot
8251 more memory for a large function.
8252
8253 With @option{-O}, the compiler tries to reduce code size and execution
8254 time, without performing any optimizations that take a great deal of
8255 compilation time.
8256
8257 @c Note that in addition to the default_options_table list in opts.c,
8258 @c several optimization flags default to true but control optimization
8259 @c passes that are explicitly disabled at -O0.
8260
8261 @option{-O} turns on the following optimization flags:
8262
8263 @c Please keep the following list alphabetized.
8264 @gccoptlist{-fauto-inc-dec @gol
8265 -fbranch-count-reg @gol
8266 -fcombine-stack-adjustments @gol
8267 -fcompare-elim @gol
8268 -fcprop-registers @gol
8269 -fdce @gol
8270 -fdefer-pop @gol
8271 -fdelayed-branch @gol
8272 -fdse @gol
8273 -fforward-propagate @gol
8274 -fguess-branch-probability @gol
8275 -fif-conversion @gol
8276 -fif-conversion2 @gol
8277 -finline-functions-called-once @gol
8278 -fipa-profile @gol
8279 -fipa-pure-const @gol
8280 -fipa-reference @gol
8281 -fipa-reference-addressable @gol
8282 -fmerge-constants @gol
8283 -fmove-loop-invariants @gol
8284 -fomit-frame-pointer @gol
8285 -freorder-blocks @gol
8286 -fshrink-wrap @gol
8287 -fshrink-wrap-separate @gol
8288 -fsplit-wide-types @gol
8289 -fssa-backprop @gol
8290 -fssa-phiopt @gol
8291 -ftree-bit-ccp @gol
8292 -ftree-ccp @gol
8293 -ftree-ch @gol
8294 -ftree-coalesce-vars @gol
8295 -ftree-copy-prop @gol
8296 -ftree-dce @gol
8297 -ftree-dominator-opts @gol
8298 -ftree-dse @gol
8299 -ftree-forwprop @gol
8300 -ftree-fre @gol
8301 -ftree-phiprop @gol
8302 -ftree-pta @gol
8303 -ftree-scev-cprop @gol
8304 -ftree-sink @gol
8305 -ftree-slsr @gol
8306 -ftree-sra @gol
8307 -ftree-ter @gol
8308 -funit-at-a-time}
8309
8310 @item -O2
8311 @opindex O2
8312 Optimize even more. GCC performs nearly all supported optimizations
8313 that do not involve a space-speed tradeoff.
8314 As compared to @option{-O}, this option increases both compilation time
8315 and the performance of the generated code.
8316
8317 @option{-O2} turns on all optimization flags specified by @option{-O}. It
8318 also turns on the following optimization flags:
8319
8320 @c Please keep the following list alphabetized!
8321 @gccoptlist{-falign-functions -falign-jumps @gol
8322 -falign-labels -falign-loops @gol
8323 -fcaller-saves @gol
8324 -fcode-hoisting @gol
8325 -fcrossjumping @gol
8326 -fcse-follow-jumps -fcse-skip-blocks @gol
8327 -fdelete-null-pointer-checks @gol
8328 -fdevirtualize -fdevirtualize-speculatively @gol
8329 -fexpensive-optimizations @gol
8330 -ffinite-loops @gol
8331 -fgcse -fgcse-lm @gol
8332 -fhoist-adjacent-loads @gol
8333 -finline-small-functions @gol
8334 -findirect-inlining @gol
8335 -fipa-bit-cp -fipa-cp -fipa-icf @gol
8336 -fipa-ra -fipa-sra -fipa-vrp @gol
8337 -fisolate-erroneous-paths-dereference @gol
8338 -flra-remat @gol
8339 -foptimize-sibling-calls @gol
8340 -foptimize-strlen @gol
8341 -fpartial-inlining @gol
8342 -fpeephole2 @gol
8343 -freorder-blocks-algorithm=stc @gol
8344 -freorder-blocks-and-partition -freorder-functions @gol
8345 -frerun-cse-after-loop @gol
8346 -fschedule-insns -fschedule-insns2 @gol
8347 -fsched-interblock -fsched-spec @gol
8348 -fstore-merging @gol
8349 -fstrict-aliasing @gol
8350 -fthread-jumps @gol
8351 -ftree-builtin-call-dce @gol
8352 -ftree-pre @gol
8353 -ftree-switch-conversion -ftree-tail-merge @gol
8354 -ftree-vrp}
8355
8356 Please note the warning under @option{-fgcse} about
8357 invoking @option{-O2} on programs that use computed gotos.
8358
8359 @item -O3
8360 @opindex O3
8361 Optimize yet more. @option{-O3} turns on all optimizations specified
8362 by @option{-O2} and also turns on the following optimization flags:
8363
8364 @c Please keep the following list alphabetized!
8365 @gccoptlist{-fgcse-after-reload @gol
8366 -finline-functions @gol
8367 -fipa-cp-clone
8368 -floop-interchange @gol
8369 -floop-unroll-and-jam @gol
8370 -fpeel-loops @gol
8371 -fpredictive-commoning @gol
8372 -fsplit-paths @gol
8373 -ftree-loop-distribute-patterns @gol
8374 -ftree-loop-distribution @gol
8375 -ftree-loop-vectorize @gol
8376 -ftree-partial-pre @gol
8377 -ftree-slp-vectorize @gol
8378 -funswitch-loops @gol
8379 -fvect-cost-model @gol
8380 -fversion-loops-for-strides}
8381
8382 @item -O0
8383 @opindex O0
8384 Reduce compilation time and make debugging produce the expected
8385 results. This is the default.
8386
8387 @item -Os
8388 @opindex Os
8389 Optimize for size. @option{-Os} enables all @option{-O2} optimizations
8390 except those that often increase code size:
8391
8392 @gccoptlist{-falign-functions -falign-jumps @gol
8393 -falign-labels -falign-loops @gol
8394 -fprefetch-loop-arrays -freorder-blocks-algorithm=stc}
8395
8396 It also enables @option{-finline-functions}, causes the compiler to tune for
8397 code size rather than execution speed, and performs further optimizations
8398 designed to reduce code size.
8399
8400 @item -Ofast
8401 @opindex Ofast
8402 Disregard strict standards compliance. @option{-Ofast} enables all
8403 @option{-O3} optimizations. It also enables optimizations that are not
8404 valid for all standard-compliant programs.
8405 It turns on @option{-ffast-math} and the Fortran-specific
8406 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
8407 specified, and @option{-fno-protect-parens}.
8408
8409 @item -Og
8410 @opindex Og
8411 Optimize debugging experience. @option{-Og} should be the optimization
8412 level of choice for the standard edit-compile-debug cycle, offering
8413 a reasonable level of optimization while maintaining fast compilation
8414 and a good debugging experience. It is a better choice than @option{-O0}
8415 for producing debuggable code because some compiler passes
8416 that collect debug information are disabled at @option{-O0}.
8417
8418 Like @option{-O0}, @option{-Og} completely disables a number of
8419 optimization passes so that individual options controlling them have
8420 no effect. Otherwise @option{-Og} enables all @option{-O1}
8421 optimization flags except for those that may interfere with debugging:
8422
8423 @gccoptlist{-fbranch-count-reg -fdelayed-branch @gol
8424 -fif-conversion -fif-conversion2 @gol
8425 -finline-functions-called-once @gol
8426 -fmove-loop-invariants -fssa-phiopt @gol
8427 -ftree-bit-ccp -ftree-pta -ftree-sra}
8428
8429 @end table
8430
8431 If you use multiple @option{-O} options, with or without level numbers,
8432 the last such option is the one that is effective.
8433
8434 Options of the form @option{-f@var{flag}} specify machine-independent
8435 flags. Most flags have both positive and negative forms; the negative
8436 form of @option{-ffoo} is @option{-fno-foo}. In the table
8437 below, only one of the forms is listed---the one you typically
8438 use. You can figure out the other form by either removing @samp{no-}
8439 or adding it.
8440
8441 The following options control specific optimizations. They are either
8442 activated by @option{-O} options or are related to ones that are. You
8443 can use the following flags in the rare cases when ``fine-tuning'' of
8444 optimizations to be performed is desired.
8445
8446 @table @gcctabopt
8447 @item -fno-defer-pop
8448 @opindex fno-defer-pop
8449 @opindex fdefer-pop
8450 For machines that must pop arguments after a function call, always pop
8451 the arguments as soon as each function returns.
8452 At levels @option{-O1} and higher, @option{-fdefer-pop} is the default;
8453 this allows the compiler to let arguments accumulate on the stack for several
8454 function calls and pop them all at once.
8455
8456 @item -fforward-propagate
8457 @opindex fforward-propagate
8458 Perform a forward propagation pass on RTL@. The pass tries to combine two
8459 instructions and checks if the result can be simplified. If loop unrolling
8460 is active, two passes are performed and the second is scheduled after
8461 loop unrolling.
8462
8463 This option is enabled by default at optimization levels @option{-O},
8464 @option{-O2}, @option{-O3}, @option{-Os}.
8465
8466 @item -ffp-contract=@var{style}
8467 @opindex ffp-contract
8468 @option{-ffp-contract=off} disables floating-point expression contraction.
8469 @option{-ffp-contract=fast} enables floating-point expression contraction
8470 such as forming of fused multiply-add operations if the target has
8471 native support for them.
8472 @option{-ffp-contract=on} enables floating-point expression contraction
8473 if allowed by the language standard. This is currently not implemented
8474 and treated equal to @option{-ffp-contract=off}.
8475
8476 The default is @option{-ffp-contract=fast}.
8477
8478 @item -fomit-frame-pointer
8479 @opindex fomit-frame-pointer
8480 Omit the frame pointer in functions that don't need one. This avoids the
8481 instructions to save, set up and restore the frame pointer; on many targets
8482 it also makes an extra register available.
8483
8484 On some targets this flag has no effect because the standard calling sequence
8485 always uses a frame pointer, so it cannot be omitted.
8486
8487 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
8488 is used in all functions. Several targets always omit the frame pointer in
8489 leaf functions.
8490
8491 Enabled by default at @option{-O} and higher.
8492
8493 @item -foptimize-sibling-calls
8494 @opindex foptimize-sibling-calls
8495 Optimize sibling and tail recursive calls.
8496
8497 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8498
8499 @item -foptimize-strlen
8500 @opindex foptimize-strlen
8501 Optimize various standard C string functions (e.g.@: @code{strlen},
8502 @code{strchr} or @code{strcpy}) and
8503 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
8504
8505 Enabled at levels @option{-O2}, @option{-O3}.
8506
8507 @item -fno-inline
8508 @opindex fno-inline
8509 @opindex finline
8510 Do not expand any functions inline apart from those marked with
8511 the @code{always_inline} attribute. This is the default when not
8512 optimizing.
8513
8514 Single functions can be exempted from inlining by marking them
8515 with the @code{noinline} attribute.
8516
8517 @item -finline-small-functions
8518 @opindex finline-small-functions
8519 Integrate functions into their callers when their body is smaller than expected
8520 function call code (so overall size of program gets smaller). The compiler
8521 heuristically decides which functions are simple enough to be worth integrating
8522 in this way. This inlining applies to all functions, even those not declared
8523 inline.
8524
8525 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8526
8527 @item -findirect-inlining
8528 @opindex findirect-inlining
8529 Inline also indirect calls that are discovered to be known at compile
8530 time thanks to previous inlining. This option has any effect only
8531 when inlining itself is turned on by the @option{-finline-functions}
8532 or @option{-finline-small-functions} options.
8533
8534 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8535
8536 @item -finline-functions
8537 @opindex finline-functions
8538 Consider all functions for inlining, even if they are not declared inline.
8539 The compiler heuristically decides which functions are worth integrating
8540 in this way.
8541
8542 If all calls to a given function are integrated, and the function is
8543 declared @code{static}, then the function is normally not output as
8544 assembler code in its own right.
8545
8546 Enabled at levels @option{-O3}, @option{-Os}. Also enabled
8547 by @option{-fprofile-use} and @option{-fauto-profile}.
8548
8549 @item -finline-functions-called-once
8550 @opindex finline-functions-called-once
8551 Consider all @code{static} functions called once for inlining into their
8552 caller even if they are not marked @code{inline}. If a call to a given
8553 function is integrated, then the function is not output as assembler code
8554 in its own right.
8555
8556 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os},
8557 but not @option{-Og}.
8558
8559 @item -fearly-inlining
8560 @opindex fearly-inlining
8561 Inline functions marked by @code{always_inline} and functions whose body seems
8562 smaller than the function call overhead early before doing
8563 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
8564 makes profiling significantly cheaper and usually inlining faster on programs
8565 having large chains of nested wrapper functions.
8566
8567 Enabled by default.
8568
8569 @item -fipa-sra
8570 @opindex fipa-sra
8571 Perform interprocedural scalar replacement of aggregates, removal of
8572 unused parameters and replacement of parameters passed by reference
8573 by parameters passed by value.
8574
8575 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
8576
8577 @item -finline-limit=@var{n}
8578 @opindex finline-limit
8579 By default, GCC limits the size of functions that can be inlined. This flag
8580 allows coarse control of this limit. @var{n} is the size of functions that
8581 can be inlined in number of pseudo instructions.
8582
8583 Inlining is actually controlled by a number of parameters, which may be
8584 specified individually by using @option{--param @var{name}=@var{value}}.
8585 The @option{-finline-limit=@var{n}} option sets some of these parameters
8586 as follows:
8587
8588 @table @gcctabopt
8589 @item max-inline-insns-single
8590 is set to @var{n}/2.
8591 @item max-inline-insns-auto
8592 is set to @var{n}/2.
8593 @end table
8594
8595 See below for a documentation of the individual
8596 parameters controlling inlining and for the defaults of these parameters.
8597
8598 @emph{Note:} there may be no value to @option{-finline-limit} that results
8599 in default behavior.
8600
8601 @emph{Note:} pseudo instruction represents, in this particular context, an
8602 abstract measurement of function's size. In no way does it represent a count
8603 of assembly instructions and as such its exact meaning might change from one
8604 release to an another.
8605
8606 @item -fno-keep-inline-dllexport
8607 @opindex fno-keep-inline-dllexport
8608 @opindex fkeep-inline-dllexport
8609 This is a more fine-grained version of @option{-fkeep-inline-functions},
8610 which applies only to functions that are declared using the @code{dllexport}
8611 attribute or declspec. @xref{Function Attributes,,Declaring Attributes of
8612 Functions}.
8613
8614 @item -fkeep-inline-functions
8615 @opindex fkeep-inline-functions
8616 In C, emit @code{static} functions that are declared @code{inline}
8617 into the object file, even if the function has been inlined into all
8618 of its callers. This switch does not affect functions using the
8619 @code{extern inline} extension in GNU C90@. In C++, emit any and all
8620 inline functions into the object file.
8621
8622 @item -fkeep-static-functions
8623 @opindex fkeep-static-functions
8624 Emit @code{static} functions into the object file, even if the function
8625 is never used.
8626
8627 @item -fkeep-static-consts
8628 @opindex fkeep-static-consts
8629 Emit variables declared @code{static const} when optimization isn't turned
8630 on, even if the variables aren't referenced.
8631
8632 GCC enables this option by default. If you want to force the compiler to
8633 check if a variable is referenced, regardless of whether or not
8634 optimization is turned on, use the @option{-fno-keep-static-consts} option.
8635
8636 @item -fmerge-constants
8637 @opindex fmerge-constants
8638 Attempt to merge identical constants (string constants and floating-point
8639 constants) across compilation units.
8640
8641 This option is the default for optimized compilation if the assembler and
8642 linker support it. Use @option{-fno-merge-constants} to inhibit this
8643 behavior.
8644
8645 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8646
8647 @item -fmerge-all-constants
8648 @opindex fmerge-all-constants
8649 Attempt to merge identical constants and identical variables.
8650
8651 This option implies @option{-fmerge-constants}. In addition to
8652 @option{-fmerge-constants} this considers e.g.@: even constant initialized
8653 arrays or initialized constant variables with integral or floating-point
8654 types. Languages like C or C++ require each variable, including multiple
8655 instances of the same variable in recursive calls, to have distinct locations,
8656 so using this option results in non-conforming
8657 behavior.
8658
8659 @item -fmodulo-sched
8660 @opindex fmodulo-sched
8661 Perform swing modulo scheduling immediately before the first scheduling
8662 pass. This pass looks at innermost loops and reorders their
8663 instructions by overlapping different iterations.
8664
8665 @item -fmodulo-sched-allow-regmoves
8666 @opindex fmodulo-sched-allow-regmoves
8667 Perform more aggressive SMS-based modulo scheduling with register moves
8668 allowed. By setting this flag certain anti-dependences edges are
8669 deleted, which triggers the generation of reg-moves based on the
8670 life-range analysis. This option is effective only with
8671 @option{-fmodulo-sched} enabled.
8672
8673 @item -fno-branch-count-reg
8674 @opindex fno-branch-count-reg
8675 @opindex fbranch-count-reg
8676 Disable the optimization pass that scans for opportunities to use
8677 ``decrement and branch'' instructions on a count register instead of
8678 instruction sequences that decrement a register, compare it against zero, and
8679 then branch based upon the result. This option is only meaningful on
8680 architectures that support such instructions, which include x86, PowerPC,
8681 IA-64 and S/390. Note that the @option{-fno-branch-count-reg} option
8682 doesn't remove the decrement and branch instructions from the generated
8683 instruction stream introduced by other optimization passes.
8684
8685 The default is @option{-fbranch-count-reg} at @option{-O1} and higher,
8686 except for @option{-Og}.
8687
8688 @item -fno-function-cse
8689 @opindex fno-function-cse
8690 @opindex ffunction-cse
8691 Do not put function addresses in registers; make each instruction that
8692 calls a constant function contain the function's address explicitly.
8693
8694 This option results in less efficient code, but some strange hacks
8695 that alter the assembler output may be confused by the optimizations
8696 performed when this option is not used.
8697
8698 The default is @option{-ffunction-cse}
8699
8700 @item -fno-zero-initialized-in-bss
8701 @opindex fno-zero-initialized-in-bss
8702 @opindex fzero-initialized-in-bss
8703 If the target supports a BSS section, GCC by default puts variables that
8704 are initialized to zero into BSS@. This can save space in the resulting
8705 code.
8706
8707 This option turns off this behavior because some programs explicitly
8708 rely on variables going to the data section---e.g., so that the
8709 resulting executable can find the beginning of that section and/or make
8710 assumptions based on that.
8711
8712 The default is @option{-fzero-initialized-in-bss}.
8713
8714 @item -fthread-jumps
8715 @opindex fthread-jumps
8716 Perform optimizations that check to see if a jump branches to a
8717 location where another comparison subsumed by the first is found. If
8718 so, the first branch is redirected to either the destination of the
8719 second branch or a point immediately following it, depending on whether
8720 the condition is known to be true or false.
8721
8722 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8723
8724 @item -fsplit-wide-types
8725 @opindex fsplit-wide-types
8726 When using a type that occupies multiple registers, such as @code{long
8727 long} on a 32-bit system, split the registers apart and allocate them
8728 independently. This normally generates better code for those types,
8729 but may make debugging more difficult.
8730
8731 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8732 @option{-Os}.
8733
8734 @item -fsplit-wide-types-early
8735 @opindex fsplit-wide-types-early
8736 Fully split wide types early, instead of very late.
8737 This option has no effect unless @option{-fsplit-wide-types} is turned on.
8738
8739 This is the default on some targets.
8740
8741 @item -fcse-follow-jumps
8742 @opindex fcse-follow-jumps
8743 In common subexpression elimination (CSE), scan through jump instructions
8744 when the target of the jump is not reached by any other path. For
8745 example, when CSE encounters an @code{if} statement with an
8746 @code{else} clause, CSE follows the jump when the condition
8747 tested is false.
8748
8749 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8750
8751 @item -fcse-skip-blocks
8752 @opindex fcse-skip-blocks
8753 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8754 follow jumps that conditionally skip over blocks. When CSE
8755 encounters a simple @code{if} statement with no else clause,
8756 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8757 body of the @code{if}.
8758
8759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8760
8761 @item -frerun-cse-after-loop
8762 @opindex frerun-cse-after-loop
8763 Re-run common subexpression elimination after loop optimizations are
8764 performed.
8765
8766 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8767
8768 @item -fgcse
8769 @opindex fgcse
8770 Perform a global common subexpression elimination pass.
8771 This pass also performs global constant and copy propagation.
8772
8773 @emph{Note:} When compiling a program using computed gotos, a GCC
8774 extension, you may get better run-time performance if you disable
8775 the global common subexpression elimination pass by adding
8776 @option{-fno-gcse} to the command line.
8777
8778 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8779
8780 @item -fgcse-lm
8781 @opindex fgcse-lm
8782 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8783 attempts to move loads that are only killed by stores into themselves. This
8784 allows a loop containing a load/store sequence to be changed to a load outside
8785 the loop, and a copy/store within the loop.
8786
8787 Enabled by default when @option{-fgcse} is enabled.
8788
8789 @item -fgcse-sm
8790 @opindex fgcse-sm
8791 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8792 global common subexpression elimination. This pass attempts to move
8793 stores out of loops. When used in conjunction with @option{-fgcse-lm},
8794 loops containing a load/store sequence can be changed to a load before
8795 the loop and a store after the loop.
8796
8797 Not enabled at any optimization level.
8798
8799 @item -fgcse-las
8800 @opindex fgcse-las
8801 When @option{-fgcse-las} is enabled, the global common subexpression
8802 elimination pass eliminates redundant loads that come after stores to the
8803 same memory location (both partial and full redundancies).
8804
8805 Not enabled at any optimization level.
8806
8807 @item -fgcse-after-reload
8808 @opindex fgcse-after-reload
8809 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8810 pass is performed after reload. The purpose of this pass is to clean up
8811 redundant spilling.
8812
8813 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
8814
8815 @item -faggressive-loop-optimizations
8816 @opindex faggressive-loop-optimizations
8817 This option tells the loop optimizer to use language constraints to
8818 derive bounds for the number of iterations of a loop. This assumes that
8819 loop code does not invoke undefined behavior by for example causing signed
8820 integer overflows or out-of-bound array accesses. The bounds for the
8821 number of iterations of a loop are used to guide loop unrolling and peeling
8822 and loop exit test optimizations.
8823 This option is enabled by default.
8824
8825 @item -funconstrained-commons
8826 @opindex funconstrained-commons
8827 This option tells the compiler that variables declared in common blocks
8828 (e.g.@: Fortran) may later be overridden with longer trailing arrays. This
8829 prevents certain optimizations that depend on knowing the array bounds.
8830
8831 @item -fcrossjumping
8832 @opindex fcrossjumping
8833 Perform cross-jumping transformation.
8834 This transformation unifies equivalent code and saves code size. The
8835 resulting code may or may not perform better than without cross-jumping.
8836
8837 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8838
8839 @item -fauto-inc-dec
8840 @opindex fauto-inc-dec
8841 Combine increments or decrements of addresses with memory accesses.
8842 This pass is always skipped on architectures that do not have
8843 instructions to support this. Enabled by default at @option{-O} and
8844 higher on architectures that support this.
8845
8846 @item -fdce
8847 @opindex fdce
8848 Perform dead code elimination (DCE) on RTL@.
8849 Enabled by default at @option{-O} and higher.
8850
8851 @item -fdse
8852 @opindex fdse
8853 Perform dead store elimination (DSE) on RTL@.
8854 Enabled by default at @option{-O} and higher.
8855
8856 @item -fif-conversion
8857 @opindex fif-conversion
8858 Attempt to transform conditional jumps into branch-less equivalents. This
8859 includes use of conditional moves, min, max, set flags and abs instructions, and
8860 some tricks doable by standard arithmetics. The use of conditional execution
8861 on chips where it is available is controlled by @option{-fif-conversion2}.
8862
8863 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}, but
8864 not with @option{-Og}.
8865
8866 @item -fif-conversion2
8867 @opindex fif-conversion2
8868 Use conditional execution (where available) to transform conditional jumps into
8869 branch-less equivalents.
8870
8871 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}, but
8872 not with @option{-Og}.
8873
8874 @item -fdeclone-ctor-dtor
8875 @opindex fdeclone-ctor-dtor
8876 The C++ ABI requires multiple entry points for constructors and
8877 destructors: one for a base subobject, one for a complete object, and
8878 one for a virtual destructor that calls operator delete afterwards.
8879 For a hierarchy with virtual bases, the base and complete variants are
8880 clones, which means two copies of the function. With this option, the
8881 base and complete variants are changed to be thunks that call a common
8882 implementation.
8883
8884 Enabled by @option{-Os}.
8885
8886 @item -fdelete-null-pointer-checks
8887 @opindex fdelete-null-pointer-checks
8888 Assume that programs cannot safely dereference null pointers, and that
8889 no code or data element resides at address zero.
8890 This option enables simple constant
8891 folding optimizations at all optimization levels. In addition, other
8892 optimization passes in GCC use this flag to control global dataflow
8893 analyses that eliminate useless checks for null pointers; these assume
8894 that a memory access to address zero always results in a trap, so
8895 that if a pointer is checked after it has already been dereferenced,
8896 it cannot be null.
8897
8898 Note however that in some environments this assumption is not true.
8899 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8900 for programs that depend on that behavior.
8901
8902 This option is enabled by default on most targets. On Nios II ELF, it
8903 defaults to off. On AVR, CR16, and MSP430, this option is completely disabled.
8904
8905 Passes that use the dataflow information
8906 are enabled independently at different optimization levels.
8907
8908 @item -fdevirtualize
8909 @opindex fdevirtualize
8910 Attempt to convert calls to virtual functions to direct calls. This
8911 is done both within a procedure and interprocedurally as part of
8912 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8913 propagation (@option{-fipa-cp}).
8914 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8915
8916 @item -fdevirtualize-speculatively
8917 @opindex fdevirtualize-speculatively
8918 Attempt to convert calls to virtual functions to speculative direct calls.
8919 Based on the analysis of the type inheritance graph, determine for a given call
8920 the set of likely targets. If the set is small, preferably of size 1, change
8921 the call into a conditional deciding between direct and indirect calls. The
8922 speculative calls enable more optimizations, such as inlining. When they seem
8923 useless after further optimization, they are converted back into original form.
8924
8925 @item -fdevirtualize-at-ltrans
8926 @opindex fdevirtualize-at-ltrans
8927 Stream extra information needed for aggressive devirtualization when running
8928 the link-time optimizer in local transformation mode.
8929 This option enables more devirtualization but
8930 significantly increases the size of streamed data. For this reason it is
8931 disabled by default.
8932
8933 @item -fexpensive-optimizations
8934 @opindex fexpensive-optimizations
8935 Perform a number of minor optimizations that are relatively expensive.
8936
8937 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8938
8939 @item -free
8940 @opindex free
8941 Attempt to remove redundant extension instructions. This is especially
8942 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8943 registers after writing to their lower 32-bit half.
8944
8945 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8946 @option{-O3}, @option{-Os}.
8947
8948 @item -fno-lifetime-dse
8949 @opindex fno-lifetime-dse
8950 @opindex flifetime-dse
8951 In C++ the value of an object is only affected by changes within its
8952 lifetime: when the constructor begins, the object has an indeterminate
8953 value, and any changes during the lifetime of the object are dead when
8954 the object is destroyed. Normally dead store elimination will take
8955 advantage of this; if your code relies on the value of the object
8956 storage persisting beyond the lifetime of the object, you can use this
8957 flag to disable this optimization. To preserve stores before the
8958 constructor starts (e.g.@: because your operator new clears the object
8959 storage) but still treat the object as dead after the destructor you,
8960 can use @option{-flifetime-dse=1}. The default behavior can be
8961 explicitly selected with @option{-flifetime-dse=2}.
8962 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8963
8964 @item -flive-range-shrinkage
8965 @opindex flive-range-shrinkage
8966 Attempt to decrease register pressure through register live range
8967 shrinkage. This is helpful for fast processors with small or moderate
8968 size register sets.
8969
8970 @item -fira-algorithm=@var{algorithm}
8971 @opindex fira-algorithm
8972 Use the specified coloring algorithm for the integrated register
8973 allocator. The @var{algorithm} argument can be @samp{priority}, which
8974 specifies Chow's priority coloring, or @samp{CB}, which specifies
8975 Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented
8976 for all architectures, but for those targets that do support it, it is
8977 the default because it generates better code.
8978
8979 @item -fira-region=@var{region}
8980 @opindex fira-region
8981 Use specified regions for the integrated register allocator. The
8982 @var{region} argument should be one of the following:
8983
8984 @table @samp
8985
8986 @item all
8987 Use all loops as register allocation regions.
8988 This can give the best results for machines with a small and/or
8989 irregular register set.
8990
8991 @item mixed
8992 Use all loops except for loops with small register pressure
8993 as the regions. This value usually gives
8994 the best results in most cases and for most architectures,
8995 and is enabled by default when compiling with optimization for speed
8996 (@option{-O}, @option{-O2}, @dots{}).
8997
8998 @item one
8999 Use all functions as a single region.
9000 This typically results in the smallest code size, and is enabled by default for
9001 @option{-Os} or @option{-O0}.
9002
9003 @end table
9004
9005 @item -fira-hoist-pressure
9006 @opindex fira-hoist-pressure
9007 Use IRA to evaluate register pressure in the code hoisting pass for
9008 decisions to hoist expressions. This option usually results in smaller
9009 code, but it can slow the compiler down.
9010
9011 This option is enabled at level @option{-Os} for all targets.
9012
9013 @item -fira-loop-pressure
9014 @opindex fira-loop-pressure
9015 Use IRA to evaluate register pressure in loops for decisions to move
9016 loop invariants. This option usually results in generation
9017 of faster and smaller code on machines with large register files (>= 32
9018 registers), but it can slow the compiler down.
9019
9020 This option is enabled at level @option{-O3} for some targets.
9021
9022 @item -fno-ira-share-save-slots
9023 @opindex fno-ira-share-save-slots
9024 @opindex fira-share-save-slots
9025 Disable sharing of stack slots used for saving call-used hard
9026 registers living through a call. Each hard register gets a
9027 separate stack slot, and as a result function stack frames are
9028 larger.
9029
9030 @item -fno-ira-share-spill-slots
9031 @opindex fno-ira-share-spill-slots
9032 @opindex fira-share-spill-slots
9033 Disable sharing of stack slots allocated for pseudo-registers. Each
9034 pseudo-register that does not get a hard register gets a separate
9035 stack slot, and as a result function stack frames are larger.
9036
9037 @item -flra-remat
9038 @opindex flra-remat
9039 Enable CFG-sensitive rematerialization in LRA. Instead of loading
9040 values of spilled pseudos, LRA tries to rematerialize (recalculate)
9041 values if it is profitable.
9042
9043 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9044
9045 @item -fdelayed-branch
9046 @opindex fdelayed-branch
9047 If supported for the target machine, attempt to reorder instructions
9048 to exploit instruction slots available after delayed branch
9049 instructions.
9050
9051 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os},
9052 but not at @option{-Og}.
9053
9054 @item -fschedule-insns
9055 @opindex fschedule-insns
9056 If supported for the target machine, attempt to reorder instructions to
9057 eliminate execution stalls due to required data being unavailable. This
9058 helps machines that have slow floating point or memory load instructions
9059 by allowing other instructions to be issued until the result of the load
9060 or floating-point instruction is required.
9061
9062 Enabled at levels @option{-O2}, @option{-O3}.
9063
9064 @item -fschedule-insns2
9065 @opindex fschedule-insns2
9066 Similar to @option{-fschedule-insns}, but requests an additional pass of
9067 instruction scheduling after register allocation has been done. This is
9068 especially useful on machines with a relatively small number of
9069 registers and where memory load instructions take more than one cycle.
9070
9071 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9072
9073 @item -fno-sched-interblock
9074 @opindex fno-sched-interblock
9075 @opindex fsched-interblock
9076 Disable instruction scheduling across basic blocks, which
9077 is normally enabled when scheduling before register allocation, i.e.@:
9078 with @option{-fschedule-insns} or at @option{-O2} or higher.
9079
9080 @item -fno-sched-spec
9081 @opindex fno-sched-spec
9082 @opindex fsched-spec
9083 Disable speculative motion of non-load instructions, which
9084 is normally enabled when scheduling before register allocation, i.e.@:
9085 with @option{-fschedule-insns} or at @option{-O2} or higher.
9086
9087 @item -fsched-pressure
9088 @opindex fsched-pressure
9089 Enable register pressure sensitive insn scheduling before register
9090 allocation. This only makes sense when scheduling before register
9091 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
9092 @option{-O2} or higher. Usage of this option can improve the
9093 generated code and decrease its size by preventing register pressure
9094 increase above the number of available hard registers and subsequent
9095 spills in register allocation.
9096
9097 @item -fsched-spec-load
9098 @opindex fsched-spec-load
9099 Allow speculative motion of some load instructions. This only makes
9100 sense when scheduling before register allocation, i.e.@: with
9101 @option{-fschedule-insns} or at @option{-O2} or higher.
9102
9103 @item -fsched-spec-load-dangerous
9104 @opindex fsched-spec-load-dangerous
9105 Allow speculative motion of more load instructions. This only makes
9106 sense when scheduling before register allocation, i.e.@: with
9107 @option{-fschedule-insns} or at @option{-O2} or higher.
9108
9109 @item -fsched-stalled-insns
9110 @itemx -fsched-stalled-insns=@var{n}
9111 @opindex fsched-stalled-insns
9112 Define how many insns (if any) can be moved prematurely from the queue
9113 of stalled insns into the ready list during the second scheduling pass.
9114 @option{-fno-sched-stalled-insns} means that no insns are moved
9115 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
9116 on how many queued insns can be moved prematurely.
9117 @option{-fsched-stalled-insns} without a value is equivalent to
9118 @option{-fsched-stalled-insns=1}.
9119
9120 @item -fsched-stalled-insns-dep
9121 @itemx -fsched-stalled-insns-dep=@var{n}
9122 @opindex fsched-stalled-insns-dep
9123 Define how many insn groups (cycles) are examined for a dependency
9124 on a stalled insn that is a candidate for premature removal from the queue
9125 of stalled insns. This has an effect only during the second scheduling pass,
9126 and only if @option{-fsched-stalled-insns} is used.
9127 @option{-fno-sched-stalled-insns-dep} is equivalent to
9128 @option{-fsched-stalled-insns-dep=0}.
9129 @option{-fsched-stalled-insns-dep} without a value is equivalent to
9130 @option{-fsched-stalled-insns-dep=1}.
9131
9132 @item -fsched2-use-superblocks
9133 @opindex fsched2-use-superblocks
9134 When scheduling after register allocation, use superblock scheduling.
9135 This allows motion across basic block boundaries,
9136 resulting in faster schedules. This option is experimental, as not all machine
9137 descriptions used by GCC model the CPU closely enough to avoid unreliable
9138 results from the algorithm.
9139
9140 This only makes sense when scheduling after register allocation, i.e.@: with
9141 @option{-fschedule-insns2} or at @option{-O2} or higher.
9142
9143 @item -fsched-group-heuristic
9144 @opindex fsched-group-heuristic
9145 Enable the group heuristic in the scheduler. This heuristic favors
9146 the instruction that belongs to a schedule group. This is enabled
9147 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
9148 or @option{-fschedule-insns2} or at @option{-O2} or higher.
9149
9150 @item -fsched-critical-path-heuristic
9151 @opindex fsched-critical-path-heuristic
9152 Enable the critical-path heuristic in the scheduler. This heuristic favors
9153 instructions on the critical path. This is enabled by default when
9154 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
9155 or @option{-fschedule-insns2} or at @option{-O2} or higher.
9156
9157 @item -fsched-spec-insn-heuristic
9158 @opindex fsched-spec-insn-heuristic
9159 Enable the speculative instruction heuristic in the scheduler. This
9160 heuristic favors speculative instructions with greater dependency weakness.
9161 This is enabled by default when scheduling is enabled, i.e.@:
9162 with @option{-fschedule-insns} or @option{-fschedule-insns2}
9163 or at @option{-O2} or higher.
9164
9165 @item -fsched-rank-heuristic
9166 @opindex fsched-rank-heuristic
9167 Enable the rank heuristic in the scheduler. This heuristic favors
9168 the instruction belonging to a basic block with greater size or frequency.
9169 This is enabled by default when scheduling is enabled, i.e.@:
9170 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
9171 at @option{-O2} or higher.
9172
9173 @item -fsched-last-insn-heuristic
9174 @opindex fsched-last-insn-heuristic
9175 Enable the last-instruction heuristic in the scheduler. This heuristic
9176 favors the instruction that is less dependent on the last instruction
9177 scheduled. This is enabled by default when scheduling is enabled,
9178 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
9179 at @option{-O2} or higher.
9180
9181 @item -fsched-dep-count-heuristic
9182 @opindex fsched-dep-count-heuristic
9183 Enable the dependent-count heuristic in the scheduler. This heuristic
9184 favors the instruction that has more instructions depending on it.
9185 This is enabled by default when scheduling is enabled, i.e.@:
9186 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
9187 at @option{-O2} or higher.
9188
9189 @item -freschedule-modulo-scheduled-loops
9190 @opindex freschedule-modulo-scheduled-loops
9191 Modulo scheduling is performed before traditional scheduling. If a loop
9192 is modulo scheduled, later scheduling passes may change its schedule.
9193 Use this option to control that behavior.
9194
9195 @item -fselective-scheduling
9196 @opindex fselective-scheduling
9197 Schedule instructions using selective scheduling algorithm. Selective
9198 scheduling runs instead of the first scheduler pass.
9199
9200 @item -fselective-scheduling2
9201 @opindex fselective-scheduling2
9202 Schedule instructions using selective scheduling algorithm. Selective
9203 scheduling runs instead of the second scheduler pass.
9204
9205 @item -fsel-sched-pipelining
9206 @opindex fsel-sched-pipelining
9207 Enable software pipelining of innermost loops during selective scheduling.
9208 This option has no effect unless one of @option{-fselective-scheduling} or
9209 @option{-fselective-scheduling2} is turned on.
9210
9211 @item -fsel-sched-pipelining-outer-loops
9212 @opindex fsel-sched-pipelining-outer-loops
9213 When pipelining loops during selective scheduling, also pipeline outer loops.
9214 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
9215
9216 @item -fsemantic-interposition
9217 @opindex fsemantic-interposition
9218 Some object formats, like ELF, allow interposing of symbols by the
9219 dynamic linker.
9220 This means that for symbols exported from the DSO, the compiler cannot perform
9221 interprocedural propagation, inlining and other optimizations in anticipation
9222 that the function or variable in question may change. While this feature is
9223 useful, for example, to rewrite memory allocation functions by a debugging
9224 implementation, it is expensive in the terms of code quality.
9225 With @option{-fno-semantic-interposition} the compiler assumes that
9226 if interposition happens for functions the overwriting function will have
9227 precisely the same semantics (and side effects).
9228 Similarly if interposition happens
9229 for variables, the constructor of the variable will be the same. The flag
9230 has no effect for functions explicitly declared inline
9231 (where it is never allowed for interposition to change semantics)
9232 and for symbols explicitly declared weak.
9233
9234 @item -fshrink-wrap
9235 @opindex fshrink-wrap
9236 Emit function prologues only before parts of the function that need it,
9237 rather than at the top of the function. This flag is enabled by default at
9238 @option{-O} and higher.
9239
9240 @item -fshrink-wrap-separate
9241 @opindex fshrink-wrap-separate
9242 Shrink-wrap separate parts of the prologue and epilogue separately, so that
9243 those parts are only executed when needed.
9244 This option is on by default, but has no effect unless @option{-fshrink-wrap}
9245 is also turned on and the target supports this.
9246
9247 @item -fcaller-saves
9248 @opindex fcaller-saves
9249 Enable allocation of values to registers that are clobbered by
9250 function calls, by emitting extra instructions to save and restore the
9251 registers around such calls. Such allocation is done only when it
9252 seems to result in better code.
9253
9254 This option is always enabled by default on certain machines, usually
9255 those which have no call-preserved registers to use instead.
9256
9257 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9258
9259 @item -fcombine-stack-adjustments
9260 @opindex fcombine-stack-adjustments
9261 Tracks stack adjustments (pushes and pops) and stack memory references
9262 and then tries to find ways to combine them.
9263
9264 Enabled by default at @option{-O1} and higher.
9265
9266 @item -fipa-ra
9267 @opindex fipa-ra
9268 Use caller save registers for allocation if those registers are not used by
9269 any called function. In that case it is not necessary to save and restore
9270 them around calls. This is only possible if called functions are part of
9271 same compilation unit as current function and they are compiled before it.
9272
9273 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
9274 is disabled if generated code will be instrumented for profiling
9275 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
9276 exactly (this happens on targets that do not expose prologues
9277 and epilogues in RTL).
9278
9279 @item -fconserve-stack
9280 @opindex fconserve-stack
9281 Attempt to minimize stack usage. The compiler attempts to use less
9282 stack space, even if that makes the program slower. This option
9283 implies setting the @option{large-stack-frame} parameter to 100
9284 and the @option{large-stack-frame-growth} parameter to 400.
9285
9286 @item -ftree-reassoc
9287 @opindex ftree-reassoc
9288 Perform reassociation on trees. This flag is enabled by default
9289 at @option{-O} and higher.
9290
9291 @item -fcode-hoisting
9292 @opindex fcode-hoisting
9293 Perform code hoisting. Code hoisting tries to move the
9294 evaluation of expressions executed on all paths to the function exit
9295 as early as possible. This is especially useful as a code size
9296 optimization, but it often helps for code speed as well.
9297 This flag is enabled by default at @option{-O2} and higher.
9298
9299 @item -ftree-pre
9300 @opindex ftree-pre
9301 Perform partial redundancy elimination (PRE) on trees. This flag is
9302 enabled by default at @option{-O2} and @option{-O3}.
9303
9304 @item -ftree-partial-pre
9305 @opindex ftree-partial-pre
9306 Make partial redundancy elimination (PRE) more aggressive. This flag is
9307 enabled by default at @option{-O3}.
9308
9309 @item -ftree-forwprop
9310 @opindex ftree-forwprop
9311 Perform forward propagation on trees. This flag is enabled by default
9312 at @option{-O} and higher.
9313
9314 @item -ftree-fre
9315 @opindex ftree-fre
9316 Perform full redundancy elimination (FRE) on trees. The difference
9317 between FRE and PRE is that FRE only considers expressions
9318 that are computed on all paths leading to the redundant computation.
9319 This analysis is faster than PRE, though it exposes fewer redundancies.
9320 This flag is enabled by default at @option{-O} and higher.
9321
9322 @item -ftree-phiprop
9323 @opindex ftree-phiprop
9324 Perform hoisting of loads from conditional pointers on trees. This
9325 pass is enabled by default at @option{-O} and higher.
9326
9327 @item -fhoist-adjacent-loads
9328 @opindex fhoist-adjacent-loads
9329 Speculatively hoist loads from both branches of an if-then-else if the
9330 loads are from adjacent locations in the same structure and the target
9331 architecture has a conditional move instruction. This flag is enabled
9332 by default at @option{-O2} and higher.
9333
9334 @item -ftree-copy-prop
9335 @opindex ftree-copy-prop
9336 Perform copy propagation on trees. This pass eliminates unnecessary
9337 copy operations. This flag is enabled by default at @option{-O} and
9338 higher.
9339
9340 @item -fipa-pure-const
9341 @opindex fipa-pure-const
9342 Discover which functions are pure or constant.
9343 Enabled by default at @option{-O} and higher.
9344
9345 @item -fipa-reference
9346 @opindex fipa-reference
9347 Discover which static variables do not escape the
9348 compilation unit.
9349 Enabled by default at @option{-O} and higher.
9350
9351 @item -fipa-reference-addressable
9352 @opindex fipa-reference-addressable
9353 Discover read-only, write-only and non-addressable static variables.
9354 Enabled by default at @option{-O} and higher.
9355
9356 @item -fipa-stack-alignment
9357 @opindex fipa-stack-alignment
9358 Reduce stack alignment on call sites if possible.
9359 Enabled by default.
9360
9361 @item -fipa-pta
9362 @opindex fipa-pta
9363 Perform interprocedural pointer analysis and interprocedural modification
9364 and reference analysis. This option can cause excessive memory and
9365 compile-time usage on large compilation units. It is not enabled by
9366 default at any optimization level.
9367
9368 @item -fipa-profile
9369 @opindex fipa-profile
9370 Perform interprocedural profile propagation. The functions called only from
9371 cold functions are marked as cold. Also functions executed once (such as
9372 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
9373 functions and loop less parts of functions executed once are then optimized for
9374 size.
9375 Enabled by default at @option{-O} and higher.
9376
9377 @item -fipa-cp
9378 @opindex fipa-cp
9379 Perform interprocedural constant propagation.
9380 This optimization analyzes the program to determine when values passed
9381 to functions are constants and then optimizes accordingly.
9382 This optimization can substantially increase performance
9383 if the application has constants passed to functions.
9384 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
9385 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9386
9387 @item -fipa-cp-clone
9388 @opindex fipa-cp-clone
9389 Perform function cloning to make interprocedural constant propagation stronger.
9390 When enabled, interprocedural constant propagation performs function cloning
9391 when externally visible function can be called with constant arguments.
9392 Because this optimization can create multiple copies of functions,
9393 it may significantly increase code size
9394 (see @option{--param ipcp-unit-growth=@var{value}}).
9395 This flag is enabled by default at @option{-O3}.
9396 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9397
9398 @item -fipa-bit-cp
9399 @opindex fipa-bit-cp
9400 When enabled, perform interprocedural bitwise constant
9401 propagation. This flag is enabled by default at @option{-O2} and
9402 by @option{-fprofile-use} and @option{-fauto-profile}.
9403 It requires that @option{-fipa-cp} is enabled.
9404
9405 @item -fipa-vrp
9406 @opindex fipa-vrp
9407 When enabled, perform interprocedural propagation of value
9408 ranges. This flag is enabled by default at @option{-O2}. It requires
9409 that @option{-fipa-cp} is enabled.
9410
9411 @item -fipa-icf
9412 @opindex fipa-icf
9413 Perform Identical Code Folding for functions and read-only variables.
9414 The optimization reduces code size and may disturb unwind stacks by replacing
9415 a function by equivalent one with a different name. The optimization works
9416 more effectively with link-time optimization enabled.
9417
9418 Although the behavior is similar to the Gold Linker's ICF optimization, GCC ICF
9419 works on different levels and thus the optimizations are not same - there are
9420 equivalences that are found only by GCC and equivalences found only by Gold.
9421
9422 This flag is enabled by default at @option{-O2} and @option{-Os}.
9423
9424 @item -flive-patching=@var{level}
9425 @opindex flive-patching
9426 Control GCC's optimizations to produce output suitable for live-patching.
9427
9428 If the compiler's optimization uses a function's body or information extracted
9429 from its body to optimize/change another function, the latter is called an
9430 impacted function of the former. If a function is patched, its impacted
9431 functions should be patched too.
9432
9433 The impacted functions are determined by the compiler's interprocedural
9434 optimizations. For example, a caller is impacted when inlining a function
9435 into its caller,
9436 cloning a function and changing its caller to call this new clone,
9437 or extracting a function's pureness/constness information to optimize
9438 its direct or indirect callers, etc.
9439
9440 Usually, the more IPA optimizations enabled, the larger the number of
9441 impacted functions for each function. In order to control the number of
9442 impacted functions and more easily compute the list of impacted function,
9443 IPA optimizations can be partially enabled at two different levels.
9444
9445 The @var{level} argument should be one of the following:
9446
9447 @table @samp
9448
9449 @item inline-clone
9450
9451 Only enable inlining and cloning optimizations, which includes inlining,
9452 cloning, interprocedural scalar replacement of aggregates and partial inlining.
9453 As a result, when patching a function, all its callers and its clones'
9454 callers are impacted, therefore need to be patched as well.
9455
9456 @option{-flive-patching=inline-clone} disables the following optimization flags:
9457 @gccoptlist{-fwhole-program -fipa-pta -fipa-reference -fipa-ra @gol
9458 -fipa-icf -fipa-icf-functions -fipa-icf-variables @gol
9459 -fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable @gol
9460 -fipa-stack-alignment}
9461
9462 @item inline-only-static
9463
9464 Only enable inlining of static functions.
9465 As a result, when patching a static function, all its callers are impacted
9466 and so need to be patched as well.
9467
9468 In addition to all the flags that @option{-flive-patching=inline-clone}
9469 disables,
9470 @option{-flive-patching=inline-only-static} disables the following additional
9471 optimization flags:
9472 @gccoptlist{-fipa-cp-clone -fipa-sra -fpartial-inlining -fipa-cp}
9473
9474 @end table
9475
9476 When @option{-flive-patching} is specified without any value, the default value
9477 is @var{inline-clone}.
9478
9479 This flag is disabled by default.
9480
9481 Note that @option{-flive-patching} is not supported with link-time optimization
9482 (@option{-flto}).
9483
9484 @item -fisolate-erroneous-paths-dereference
9485 @opindex fisolate-erroneous-paths-dereference
9486 Detect paths that trigger erroneous or undefined behavior due to
9487 dereferencing a null pointer. Isolate those paths from the main control
9488 flow and turn the statement with erroneous or undefined behavior into a trap.
9489 This flag is enabled by default at @option{-O2} and higher and depends on
9490 @option{-fdelete-null-pointer-checks} also being enabled.
9491
9492 @item -fisolate-erroneous-paths-attribute
9493 @opindex fisolate-erroneous-paths-attribute
9494 Detect paths that trigger erroneous or undefined behavior due to a null value
9495 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
9496 attribute. Isolate those paths from the main control flow and turn the
9497 statement with erroneous or undefined behavior into a trap. This is not
9498 currently enabled, but may be enabled by @option{-O2} in the future.
9499
9500 @item -ftree-sink
9501 @opindex ftree-sink
9502 Perform forward store motion on trees. This flag is
9503 enabled by default at @option{-O} and higher.
9504
9505 @item -ftree-bit-ccp
9506 @opindex ftree-bit-ccp
9507 Perform sparse conditional bit constant propagation on trees and propagate
9508 pointer alignment information.
9509 This pass only operates on local scalar variables and is enabled by default
9510 at @option{-O1} and higher, except for @option{-Og}.
9511 It requires that @option{-ftree-ccp} is enabled.
9512
9513 @item -ftree-ccp
9514 @opindex ftree-ccp
9515 Perform sparse conditional constant propagation (CCP) on trees. This
9516 pass only operates on local scalar variables and is enabled by default
9517 at @option{-O} and higher.
9518
9519 @item -fssa-backprop
9520 @opindex fssa-backprop
9521 Propagate information about uses of a value up the definition chain
9522 in order to simplify the definitions. For example, this pass strips
9523 sign operations if the sign of a value never matters. The flag is
9524 enabled by default at @option{-O} and higher.
9525
9526 @item -fssa-phiopt
9527 @opindex fssa-phiopt
9528 Perform pattern matching on SSA PHI nodes to optimize conditional
9529 code. This pass is enabled by default at @option{-O1} and higher,
9530 except for @option{-Og}.
9531
9532 @item -ftree-switch-conversion
9533 @opindex ftree-switch-conversion
9534 Perform conversion of simple initializations in a switch to
9535 initializations from a scalar array. This flag is enabled by default
9536 at @option{-O2} and higher.
9537
9538 @item -ftree-tail-merge
9539 @opindex ftree-tail-merge
9540 Look for identical code sequences. When found, replace one with a jump to the
9541 other. This optimization is known as tail merging or cross jumping. This flag
9542 is enabled by default at @option{-O2} and higher. The compilation time
9543 in this pass can
9544 be limited using @option{max-tail-merge-comparisons} parameter and
9545 @option{max-tail-merge-iterations} parameter.
9546
9547 @item -ftree-dce
9548 @opindex ftree-dce
9549 Perform dead code elimination (DCE) on trees. This flag is enabled by
9550 default at @option{-O} and higher.
9551
9552 @item -ftree-builtin-call-dce
9553 @opindex ftree-builtin-call-dce
9554 Perform conditional dead code elimination (DCE) for calls to built-in functions
9555 that may set @code{errno} but are otherwise free of side effects. This flag is
9556 enabled by default at @option{-O2} and higher if @option{-Os} is not also
9557 specified.
9558
9559 @item -ffinite-loops
9560 @opindex ffinite-loops
9561 @opindex fno-finite-loops
9562 Assume that a loop with an exit will eventually take the exit and not loop
9563 indefinitely. This allows the compiler to remove loops that otherwise have
9564 no side-effects, not considering eventual endless looping as such.
9565
9566 This option is enabled by default at @option{-O2}.
9567
9568 @item -ftree-dominator-opts
9569 @opindex ftree-dominator-opts
9570 Perform a variety of simple scalar cleanups (constant/copy
9571 propagation, redundancy elimination, range propagation and expression
9572 simplification) based on a dominator tree traversal. This also
9573 performs jump threading (to reduce jumps to jumps). This flag is
9574 enabled by default at @option{-O} and higher.
9575
9576 @item -ftree-dse
9577 @opindex ftree-dse
9578 Perform dead store elimination (DSE) on trees. A dead store is a store into
9579 a memory location that is later overwritten by another store without
9580 any intervening loads. In this case the earlier store can be deleted. This
9581 flag is enabled by default at @option{-O} and higher.
9582
9583 @item -ftree-ch
9584 @opindex ftree-ch
9585 Perform loop header copying on trees. This is beneficial since it increases
9586 effectiveness of code motion optimizations. It also saves one jump. This flag
9587 is enabled by default at @option{-O} and higher. It is not enabled
9588 for @option{-Os}, since it usually increases code size.
9589
9590 @item -ftree-loop-optimize
9591 @opindex ftree-loop-optimize
9592 Perform loop optimizations on trees. This flag is enabled by default
9593 at @option{-O} and higher.
9594
9595 @item -ftree-loop-linear
9596 @itemx -floop-strip-mine
9597 @itemx -floop-block
9598 @opindex ftree-loop-linear
9599 @opindex floop-strip-mine
9600 @opindex floop-block
9601 Perform loop nest optimizations. Same as
9602 @option{-floop-nest-optimize}. To use this code transformation, GCC has
9603 to be configured with @option{--with-isl} to enable the Graphite loop
9604 transformation infrastructure.
9605
9606 @item -fgraphite-identity
9607 @opindex fgraphite-identity
9608 Enable the identity transformation for graphite. For every SCoP we generate
9609 the polyhedral representation and transform it back to gimple. Using
9610 @option{-fgraphite-identity} we can check the costs or benefits of the
9611 GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations
9612 are also performed by the code generator isl, like index splitting and
9613 dead code elimination in loops.
9614
9615 @item -floop-nest-optimize
9616 @opindex floop-nest-optimize
9617 Enable the isl based loop nest optimizer. This is a generic loop nest
9618 optimizer based on the Pluto optimization algorithms. It calculates a loop
9619 structure optimized for data-locality and parallelism. This option
9620 is experimental.
9621
9622 @item -floop-parallelize-all
9623 @opindex floop-parallelize-all
9624 Use the Graphite data dependence analysis to identify loops that can
9625 be parallelized. Parallelize all the loops that can be analyzed to
9626 not contain loop carried dependences without checking that it is
9627 profitable to parallelize the loops.
9628
9629 @item -ftree-coalesce-vars
9630 @opindex ftree-coalesce-vars
9631 While transforming the program out of the SSA representation, attempt to
9632 reduce copying by coalescing versions of different user-defined
9633 variables, instead of just compiler temporaries. This may severely
9634 limit the ability to debug an optimized program compiled with
9635 @option{-fno-var-tracking-assignments}. In the negated form, this flag
9636 prevents SSA coalescing of user variables. This option is enabled by
9637 default if optimization is enabled, and it does very little otherwise.
9638
9639 @item -ftree-loop-if-convert
9640 @opindex ftree-loop-if-convert
9641 Attempt to transform conditional jumps in the innermost loops to
9642 branch-less equivalents. The intent is to remove control-flow from
9643 the innermost loops in order to improve the ability of the
9644 vectorization pass to handle these loops. This is enabled by default
9645 if vectorization is enabled.
9646
9647 @item -ftree-loop-distribution
9648 @opindex ftree-loop-distribution
9649 Perform loop distribution. This flag can improve cache performance on
9650 big loop bodies and allow further loop optimizations, like
9651 parallelization or vectorization, to take place. For example, the loop
9652 @smallexample
9653 DO I = 1, N
9654 A(I) = B(I) + C
9655 D(I) = E(I) * F
9656 ENDDO
9657 @end smallexample
9658 is transformed to
9659 @smallexample
9660 DO I = 1, N
9661 A(I) = B(I) + C
9662 ENDDO
9663 DO I = 1, N
9664 D(I) = E(I) * F
9665 ENDDO
9666 @end smallexample
9667 This flag is enabled by default at @option{-O3}.
9668 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9669
9670 @item -ftree-loop-distribute-patterns
9671 @opindex ftree-loop-distribute-patterns
9672 Perform loop distribution of patterns that can be code generated with
9673 calls to a library. This flag is enabled by default at @option{-O3}, and
9674 by @option{-fprofile-use} and @option{-fauto-profile}.
9675
9676 This pass distributes the initialization loops and generates a call to
9677 memset zero. For example, the loop
9678 @smallexample
9679 DO I = 1, N
9680 A(I) = 0
9681 B(I) = A(I) + I
9682 ENDDO
9683 @end smallexample
9684 is transformed to
9685 @smallexample
9686 DO I = 1, N
9687 A(I) = 0
9688 ENDDO
9689 DO I = 1, N
9690 B(I) = A(I) + I
9691 ENDDO
9692 @end smallexample
9693 and the initialization loop is transformed into a call to memset zero.
9694 This flag is enabled by default at @option{-O3}.
9695 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9696
9697 @item -floop-interchange
9698 @opindex floop-interchange
9699 Perform loop interchange outside of graphite. This flag can improve cache
9700 performance on loop nest and allow further loop optimizations, like
9701 vectorization, to take place. For example, the loop
9702 @smallexample
9703 for (int i = 0; i < N; i++)
9704 for (int j = 0; j < N; j++)
9705 for (int k = 0; k < N; k++)
9706 c[i][j] = c[i][j] + a[i][k]*b[k][j];
9707 @end smallexample
9708 is transformed to
9709 @smallexample
9710 for (int i = 0; i < N; i++)
9711 for (int k = 0; k < N; k++)
9712 for (int j = 0; j < N; j++)
9713 c[i][j] = c[i][j] + a[i][k]*b[k][j];
9714 @end smallexample
9715 This flag is enabled by default at @option{-O3}.
9716 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9717
9718 @item -floop-unroll-and-jam
9719 @opindex floop-unroll-and-jam
9720 Apply unroll and jam transformations on feasible loops. In a loop
9721 nest this unrolls the outer loop by some factor and fuses the resulting
9722 multiple inner loops. This flag is enabled by default at @option{-O3}.
9723 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9724
9725 @item -ftree-loop-im
9726 @opindex ftree-loop-im
9727 Perform loop invariant motion on trees. This pass moves only invariants that
9728 are hard to handle at RTL level (function calls, operations that expand to
9729 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
9730 operands of conditions that are invariant out of the loop, so that we can use
9731 just trivial invariantness analysis in loop unswitching. The pass also includes
9732 store motion.
9733
9734 @item -ftree-loop-ivcanon
9735 @opindex ftree-loop-ivcanon
9736 Create a canonical counter for number of iterations in loops for which
9737 determining number of iterations requires complicated analysis. Later
9738 optimizations then may determine the number easily. Useful especially
9739 in connection with unrolling.
9740
9741 @item -ftree-scev-cprop
9742 @opindex ftree-scev-cprop
9743 Perform final value replacement. If a variable is modified in a loop
9744 in such a way that its value when exiting the loop can be determined using
9745 only its initial value and the number of loop iterations, replace uses of
9746 the final value by such a computation, provided it is sufficiently cheap.
9747 This reduces data dependencies and may allow further simplifications.
9748 Enabled by default at @option{-O} and higher.
9749
9750 @item -fivopts
9751 @opindex fivopts
9752 Perform induction variable optimizations (strength reduction, induction
9753 variable merging and induction variable elimination) on trees.
9754
9755 @item -ftree-parallelize-loops=n
9756 @opindex ftree-parallelize-loops
9757 Parallelize loops, i.e., split their iteration space to run in n threads.
9758 This is only possible for loops whose iterations are independent
9759 and can be arbitrarily reordered. The optimization is only
9760 profitable on multiprocessor machines, for loops that are CPU-intensive,
9761 rather than constrained e.g.@: by memory bandwidth. This option
9762 implies @option{-pthread}, and thus is only supported on targets
9763 that have support for @option{-pthread}.
9764
9765 @item -ftree-pta
9766 @opindex ftree-pta
9767 Perform function-local points-to analysis on trees. This flag is
9768 enabled by default at @option{-O1} and higher, except for @option{-Og}.
9769
9770 @item -ftree-sra
9771 @opindex ftree-sra
9772 Perform scalar replacement of aggregates. This pass replaces structure
9773 references with scalars to prevent committing structures to memory too
9774 early. This flag is enabled by default at @option{-O1} and higher,
9775 except for @option{-Og}.
9776
9777 @item -fstore-merging
9778 @opindex fstore-merging
9779 Perform merging of narrow stores to consecutive memory addresses. This pass
9780 merges contiguous stores of immediate values narrower than a word into fewer
9781 wider stores to reduce the number of instructions. This is enabled by default
9782 at @option{-O2} and higher as well as @option{-Os}.
9783
9784 @item -ftree-ter
9785 @opindex ftree-ter
9786 Perform temporary expression replacement during the SSA->normal phase. Single
9787 use/single def temporaries are replaced at their use location with their
9788 defining expression. This results in non-GIMPLE code, but gives the expanders
9789 much more complex trees to work on resulting in better RTL generation. This is
9790 enabled by default at @option{-O} and higher.
9791
9792 @item -ftree-slsr
9793 @opindex ftree-slsr
9794 Perform straight-line strength reduction on trees. This recognizes related
9795 expressions involving multiplications and replaces them by less expensive
9796 calculations when possible. This is enabled by default at @option{-O} and
9797 higher.
9798
9799 @item -ftree-vectorize
9800 @opindex ftree-vectorize
9801 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
9802 and @option{-ftree-slp-vectorize} if not explicitly specified.
9803
9804 @item -ftree-loop-vectorize
9805 @opindex ftree-loop-vectorize
9806 Perform loop vectorization on trees. This flag is enabled by default at
9807 @option{-O3} and by @option{-ftree-vectorize}, @option{-fprofile-use},
9808 and @option{-fauto-profile}.
9809
9810 @item -ftree-slp-vectorize
9811 @opindex ftree-slp-vectorize
9812 Perform basic block vectorization on trees. This flag is enabled by default at
9813 @option{-O3} and by @option{-ftree-vectorize}, @option{-fprofile-use},
9814 and @option{-fauto-profile}.
9815
9816 @item -fvect-cost-model=@var{model}
9817 @opindex fvect-cost-model
9818 Alter the cost model used for vectorization. The @var{model} argument
9819 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
9820 With the @samp{unlimited} model the vectorized code-path is assumed
9821 to be profitable while with the @samp{dynamic} model a runtime check
9822 guards the vectorized code-path to enable it only for iteration
9823 counts that will likely execute faster than when executing the original
9824 scalar loop. The @samp{cheap} model disables vectorization of
9825 loops where doing so would be cost prohibitive for example due to
9826 required runtime checks for data dependence or alignment but otherwise
9827 is equal to the @samp{dynamic} model.
9828 The default cost model depends on other optimization flags and is
9829 either @samp{dynamic} or @samp{cheap}.
9830
9831 @item -fsimd-cost-model=@var{model}
9832 @opindex fsimd-cost-model
9833 Alter the cost model used for vectorization of loops marked with the OpenMP
9834 simd directive. The @var{model} argument should be one of
9835 @samp{unlimited}, @samp{dynamic}, @samp{cheap}. All values of @var{model}
9836 have the same meaning as described in @option{-fvect-cost-model} and by
9837 default a cost model defined with @option{-fvect-cost-model} is used.
9838
9839 @item -ftree-vrp
9840 @opindex ftree-vrp
9841 Perform Value Range Propagation on trees. This is similar to the
9842 constant propagation pass, but instead of values, ranges of values are
9843 propagated. This allows the optimizers to remove unnecessary range
9844 checks like array bound checks and null pointer checks. This is
9845 enabled by default at @option{-O2} and higher. Null pointer check
9846 elimination is only done if @option{-fdelete-null-pointer-checks} is
9847 enabled.
9848
9849 @item -fsplit-paths
9850 @opindex fsplit-paths
9851 Split paths leading to loop backedges. This can improve dead code
9852 elimination and common subexpression elimination. This is enabled by
9853 default at @option{-O3} and above.
9854
9855 @item -fsplit-ivs-in-unroller
9856 @opindex fsplit-ivs-in-unroller
9857 Enables expression of values of induction variables in later iterations
9858 of the unrolled loop using the value in the first iteration. This breaks
9859 long dependency chains, thus improving efficiency of the scheduling passes.
9860
9861 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9862 same effect. However, that is not reliable in cases where the loop body
9863 is more complicated than a single basic block. It also does not work at all
9864 on some architectures due to restrictions in the CSE pass.
9865
9866 This optimization is enabled by default.
9867
9868 @item -fvariable-expansion-in-unroller
9869 @opindex fvariable-expansion-in-unroller
9870 With this option, the compiler creates multiple copies of some
9871 local variables when unrolling a loop, which can result in superior code.
9872
9873 This optimization is enabled by default for PowerPC targets, but disabled
9874 by default otherwise.
9875
9876 @item -fpartial-inlining
9877 @opindex fpartial-inlining
9878 Inline parts of functions. This option has any effect only
9879 when inlining itself is turned on by the @option{-finline-functions}
9880 or @option{-finline-small-functions} options.
9881
9882 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9883
9884 @item -fpredictive-commoning
9885 @opindex fpredictive-commoning
9886 Perform predictive commoning optimization, i.e., reusing computations
9887 (especially memory loads and stores) performed in previous
9888 iterations of loops.
9889
9890 This option is enabled at level @option{-O3}.
9891 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
9892
9893 @item -fprefetch-loop-arrays
9894 @opindex fprefetch-loop-arrays
9895 If supported by the target machine, generate instructions to prefetch
9896 memory to improve the performance of loops that access large arrays.
9897
9898 This option may generate better or worse code; results are highly
9899 dependent on the structure of loops within the source code.
9900
9901 Disabled at level @option{-Os}.
9902
9903 @item -fno-printf-return-value
9904 @opindex fno-printf-return-value
9905 @opindex fprintf-return-value
9906 Do not substitute constants for known return value of formatted output
9907 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9908 @code{vsnprintf} (but not @code{printf} of @code{fprintf}). This
9909 transformation allows GCC to optimize or even eliminate branches based
9910 on the known return value of these functions called with arguments that
9911 are either constant, or whose values are known to be in a range that
9912 makes determining the exact return value possible. For example, when
9913 @option{-fprintf-return-value} is in effect, both the branch and the
9914 body of the @code{if} statement (but not the call to @code{snprint})
9915 can be optimized away when @code{i} is a 32-bit or smaller integer
9916 because the return value is guaranteed to be at most 8.
9917
9918 @smallexample
9919 char buf[9];
9920 if (snprintf (buf, "%08x", i) >= sizeof buf)
9921 @dots{}
9922 @end smallexample
9923
9924 The @option{-fprintf-return-value} option relies on other optimizations
9925 and yields best results with @option{-O2} and above. It works in tandem
9926 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9927 options. The @option{-fprintf-return-value} option is enabled by default.
9928
9929 @item -fno-peephole
9930 @itemx -fno-peephole2
9931 @opindex fno-peephole
9932 @opindex fpeephole
9933 @opindex fno-peephole2
9934 @opindex fpeephole2
9935 Disable any machine-specific peephole optimizations. The difference
9936 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9937 are implemented in the compiler; some targets use one, some use the
9938 other, a few use both.
9939
9940 @option{-fpeephole} is enabled by default.
9941 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9942
9943 @item -fno-guess-branch-probability
9944 @opindex fno-guess-branch-probability
9945 @opindex fguess-branch-probability
9946 Do not guess branch probabilities using heuristics.
9947
9948 GCC uses heuristics to guess branch probabilities if they are
9949 not provided by profiling feedback (@option{-fprofile-arcs}). These
9950 heuristics are based on the control flow graph. If some branch probabilities
9951 are specified by @code{__builtin_expect}, then the heuristics are
9952 used to guess branch probabilities for the rest of the control flow graph,
9953 taking the @code{__builtin_expect} info into account. The interactions
9954 between the heuristics and @code{__builtin_expect} can be complex, and in
9955 some cases, it may be useful to disable the heuristics so that the effects
9956 of @code{__builtin_expect} are easier to understand.
9957
9958 It is also possible to specify expected probability of the expression
9959 with @code{__builtin_expect_with_probability} built-in function.
9960
9961 The default is @option{-fguess-branch-probability} at levels
9962 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9963
9964 @item -freorder-blocks
9965 @opindex freorder-blocks
9966 Reorder basic blocks in the compiled function in order to reduce number of
9967 taken branches and improve code locality.
9968
9969 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9970
9971 @item -freorder-blocks-algorithm=@var{algorithm}
9972 @opindex freorder-blocks-algorithm
9973 Use the specified algorithm for basic block reordering. The
9974 @var{algorithm} argument can be @samp{simple}, which does not increase
9975 code size (except sometimes due to secondary effects like alignment),
9976 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9977 put all often executed code together, minimizing the number of branches
9978 executed by making extra copies of code.
9979
9980 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9981 @samp{stc} at levels @option{-O2}, @option{-O3}.
9982
9983 @item -freorder-blocks-and-partition
9984 @opindex freorder-blocks-and-partition
9985 In addition to reordering basic blocks in the compiled function, in order
9986 to reduce number of taken branches, partitions hot and cold basic blocks
9987 into separate sections of the assembly and @file{.o} files, to improve
9988 paging and cache locality performance.
9989
9990 This optimization is automatically turned off in the presence of
9991 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9992 section attribute and on any architecture that does not support named
9993 sections. When @option{-fsplit-stack} is used this option is not
9994 enabled by default (to avoid linker errors), but may be enabled
9995 explicitly (if using a working linker).
9996
9997 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9998
9999 @item -freorder-functions
10000 @opindex freorder-functions
10001 Reorder functions in the object file in order to
10002 improve code locality. This is implemented by using special
10003 subsections @code{.text.hot} for most frequently executed functions and
10004 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
10005 the linker so object file format must support named sections and linker must
10006 place them in a reasonable way.
10007
10008 This option isn't effective unless you either provide profile feedback
10009 (see @option{-fprofile-arcs} for details) or manually annotate functions with
10010 @code{hot} or @code{cold} attributes (@pxref{Common Function Attributes}).
10011
10012 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10013
10014 @item -fstrict-aliasing
10015 @opindex fstrict-aliasing
10016 Allow the compiler to assume the strictest aliasing rules applicable to
10017 the language being compiled. For C (and C++), this activates
10018 optimizations based on the type of expressions. In particular, an
10019 object of one type is assumed never to reside at the same address as an
10020 object of a different type, unless the types are almost the same. For
10021 example, an @code{unsigned int} can alias an @code{int}, but not a
10022 @code{void*} or a @code{double}. A character type may alias any other
10023 type.
10024
10025 @anchor{Type-punning}Pay special attention to code like this:
10026 @smallexample
10027 union a_union @{
10028 int i;
10029 double d;
10030 @};
10031
10032 int f() @{
10033 union a_union t;
10034 t.d = 3.0;
10035 return t.i;
10036 @}
10037 @end smallexample
10038 The practice of reading from a different union member than the one most
10039 recently written to (called ``type-punning'') is common. Even with
10040 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
10041 is accessed through the union type. So, the code above works as
10042 expected. @xref{Structures unions enumerations and bit-fields
10043 implementation}. However, this code might not:
10044 @smallexample
10045 int f() @{
10046 union a_union t;
10047 int* ip;
10048 t.d = 3.0;
10049 ip = &t.i;
10050 return *ip;
10051 @}
10052 @end smallexample
10053
10054 Similarly, access by taking the address, casting the resulting pointer
10055 and dereferencing the result has undefined behavior, even if the cast
10056 uses a union type, e.g.:
10057 @smallexample
10058 int f() @{
10059 double d = 3.0;
10060 return ((union a_union *) &d)->i;
10061 @}
10062 @end smallexample
10063
10064 The @option{-fstrict-aliasing} option is enabled at levels
10065 @option{-O2}, @option{-O3}, @option{-Os}.
10066
10067 @item -falign-functions
10068 @itemx -falign-functions=@var{n}
10069 @itemx -falign-functions=@var{n}:@var{m}
10070 @itemx -falign-functions=@var{n}:@var{m}:@var{n2}
10071 @itemx -falign-functions=@var{n}:@var{m}:@var{n2}:@var{m2}
10072 @opindex falign-functions
10073 Align the start of functions to the next power-of-two greater than
10074 @var{n}, skipping up to @var{m}-1 bytes. This ensures that at least
10075 the first @var{m} bytes of the function can be fetched by the CPU
10076 without crossing an @var{n}-byte alignment boundary.
10077
10078 If @var{m} is not specified, it defaults to @var{n}.
10079
10080 Examples: @option{-falign-functions=32} aligns functions to the next
10081 32-byte boundary, @option{-falign-functions=24} aligns to the next
10082 32-byte boundary only if this can be done by skipping 23 bytes or less,
10083 @option{-falign-functions=32:7} aligns to the next
10084 32-byte boundary only if this can be done by skipping 6 bytes or less.
10085
10086 The second pair of @var{n2}:@var{m2} values allows you to specify
10087 a secondary alignment: @option{-falign-functions=64:7:32:3} aligns to
10088 the next 64-byte boundary if this can be done by skipping 6 bytes or less,
10089 otherwise aligns to the next 32-byte boundary if this can be done
10090 by skipping 2 bytes or less.
10091 If @var{m2} is not specified, it defaults to @var{n2}.
10092
10093 Some assemblers only support this flag when @var{n} is a power of two;
10094 in that case, it is rounded up.
10095
10096 @option{-fno-align-functions} and @option{-falign-functions=1} are
10097 equivalent and mean that functions are not aligned.
10098
10099 If @var{n} is not specified or is zero, use a machine-dependent default.
10100 The maximum allowed @var{n} option value is 65536.
10101
10102 Enabled at levels @option{-O2}, @option{-O3}.
10103
10104 @item -flimit-function-alignment
10105 If this option is enabled, the compiler tries to avoid unnecessarily
10106 overaligning functions. It attempts to instruct the assembler to align
10107 by the amount specified by @option{-falign-functions}, but not to
10108 skip more bytes than the size of the function.
10109
10110 @item -falign-labels
10111 @itemx -falign-labels=@var{n}
10112 @itemx -falign-labels=@var{n}:@var{m}
10113 @itemx -falign-labels=@var{n}:@var{m}:@var{n2}
10114 @itemx -falign-labels=@var{n}:@var{m}:@var{n2}:@var{m2}
10115 @opindex falign-labels
10116 Align all branch targets to a power-of-two boundary.
10117
10118 Parameters of this option are analogous to the @option{-falign-functions} option.
10119 @option{-fno-align-labels} and @option{-falign-labels=1} are
10120 equivalent and mean that labels are not aligned.
10121
10122 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
10123 are greater than this value, then their values are used instead.
10124
10125 If @var{n} is not specified or is zero, use a machine-dependent default
10126 which is very likely to be @samp{1}, meaning no alignment.
10127 The maximum allowed @var{n} option value is 65536.
10128
10129 Enabled at levels @option{-O2}, @option{-O3}.
10130
10131 @item -falign-loops
10132 @itemx -falign-loops=@var{n}
10133 @itemx -falign-loops=@var{n}:@var{m}
10134 @itemx -falign-loops=@var{n}:@var{m}:@var{n2}
10135 @itemx -falign-loops=@var{n}:@var{m}:@var{n2}:@var{m2}
10136 @opindex falign-loops
10137 Align loops to a power-of-two boundary. If the loops are executed
10138 many times, this makes up for any execution of the dummy padding
10139 instructions.
10140
10141 Parameters of this option are analogous to the @option{-falign-functions} option.
10142 @option{-fno-align-loops} and @option{-falign-loops=1} are
10143 equivalent and mean that loops are not aligned.
10144 The maximum allowed @var{n} option value is 65536.
10145
10146 If @var{n} is not specified or is zero, use a machine-dependent default.
10147
10148 Enabled at levels @option{-O2}, @option{-O3}.
10149
10150 @item -falign-jumps
10151 @itemx -falign-jumps=@var{n}
10152 @itemx -falign-jumps=@var{n}:@var{m}
10153 @itemx -falign-jumps=@var{n}:@var{m}:@var{n2}
10154 @itemx -falign-jumps=@var{n}:@var{m}:@var{n2}:@var{m2}
10155 @opindex falign-jumps
10156 Align branch targets to a power-of-two boundary, for branch targets
10157 where the targets can only be reached by jumping. In this case,
10158 no dummy operations need be executed.
10159
10160 Parameters of this option are analogous to the @option{-falign-functions} option.
10161 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
10162 equivalent and mean that loops are not aligned.
10163
10164 If @var{n} is not specified or is zero, use a machine-dependent default.
10165 The maximum allowed @var{n} option value is 65536.
10166
10167 Enabled at levels @option{-O2}, @option{-O3}.
10168
10169 @item -funit-at-a-time
10170 @opindex funit-at-a-time
10171 This option is left for compatibility reasons. @option{-funit-at-a-time}
10172 has no effect, while @option{-fno-unit-at-a-time} implies
10173 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
10174
10175 Enabled by default.
10176
10177 @item -fno-toplevel-reorder
10178 @opindex fno-toplevel-reorder
10179 @opindex ftoplevel-reorder
10180 Do not reorder top-level functions, variables, and @code{asm}
10181 statements. Output them in the same order that they appear in the
10182 input file. When this option is used, unreferenced static variables
10183 are not removed. This option is intended to support existing code
10184 that relies on a particular ordering. For new code, it is better to
10185 use attributes when possible.
10186
10187 @option{-ftoplevel-reorder} is the default at @option{-O1} and higher, and
10188 also at @option{-O0} if @option{-fsection-anchors} is explicitly requested.
10189 Additionally @option{-fno-toplevel-reorder} implies
10190 @option{-fno-section-anchors}.
10191
10192 @item -fweb
10193 @opindex fweb
10194 Constructs webs as commonly used for register allocation purposes and assign
10195 each web individual pseudo register. This allows the register allocation pass
10196 to operate on pseudos directly, but also strengthens several other optimization
10197 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
10198 however, make debugging impossible, since variables no longer stay in a
10199 ``home register''.
10200
10201 Enabled by default with @option{-funroll-loops}.
10202
10203 @item -fwhole-program
10204 @opindex fwhole-program
10205 Assume that the current compilation unit represents the whole program being
10206 compiled. All public functions and variables with the exception of @code{main}
10207 and those merged by attribute @code{externally_visible} become static functions
10208 and in effect are optimized more aggressively by interprocedural optimizers.
10209
10210 This option should not be used in combination with @option{-flto}.
10211 Instead relying on a linker plugin should provide safer and more precise
10212 information.
10213
10214 @item -flto[=@var{n}]
10215 @opindex flto
10216 This option runs the standard link-time optimizer. When invoked
10217 with source code, it generates GIMPLE (one of GCC's internal
10218 representations) and writes it to special ELF sections in the object
10219 file. When the object files are linked together, all the function
10220 bodies are read from these ELF sections and instantiated as if they
10221 had been part of the same translation unit.
10222
10223 To use the link-time optimizer, @option{-flto} and optimization
10224 options should be specified at compile time and during the final link.
10225 It is recommended that you compile all the files participating in the
10226 same link with the same options and also specify those options at
10227 link time.
10228 For example:
10229
10230 @smallexample
10231 gcc -c -O2 -flto foo.c
10232 gcc -c -O2 -flto bar.c
10233 gcc -o myprog -flto -O2 foo.o bar.o
10234 @end smallexample
10235
10236 The first two invocations to GCC save a bytecode representation
10237 of GIMPLE into special ELF sections inside @file{foo.o} and
10238 @file{bar.o}. The final invocation reads the GIMPLE bytecode from
10239 @file{foo.o} and @file{bar.o}, merges the two files into a single
10240 internal image, and compiles the result as usual. Since both
10241 @file{foo.o} and @file{bar.o} are merged into a single image, this
10242 causes all the interprocedural analyses and optimizations in GCC to
10243 work across the two files as if they were a single one. This means,
10244 for example, that the inliner is able to inline functions in
10245 @file{bar.o} into functions in @file{foo.o} and vice-versa.
10246
10247 Another (simpler) way to enable link-time optimization is:
10248
10249 @smallexample
10250 gcc -o myprog -flto -O2 foo.c bar.c
10251 @end smallexample
10252
10253 The above generates bytecode for @file{foo.c} and @file{bar.c},
10254 merges them together into a single GIMPLE representation and optimizes
10255 them as usual to produce @file{myprog}.
10256
10257 The important thing to keep in mind is that to enable link-time
10258 optimizations you need to use the GCC driver to perform the link step.
10259 GCC automatically performs link-time optimization if any of the
10260 objects involved were compiled with the @option{-flto} command-line option.
10261 You can always override
10262 the automatic decision to do link-time optimization
10263 by passing @option{-fno-lto} to the link command.
10264
10265 To make whole program optimization effective, it is necessary to make
10266 certain whole program assumptions. The compiler needs to know
10267 what functions and variables can be accessed by libraries and runtime
10268 outside of the link-time optimized unit. When supported by the linker,
10269 the linker plugin (see @option{-fuse-linker-plugin}) passes information
10270 to the compiler about used and externally visible symbols. When
10271 the linker plugin is not available, @option{-fwhole-program} should be
10272 used to allow the compiler to make these assumptions, which leads
10273 to more aggressive optimization decisions.
10274
10275 When a file is compiled with @option{-flto} without
10276 @option{-fuse-linker-plugin}, the generated object file is larger than
10277 a regular object file because it contains GIMPLE bytecodes and the usual
10278 final code (see @option{-ffat-lto-objects}. This means that
10279 object files with LTO information can be linked as normal object
10280 files; if @option{-fno-lto} is passed to the linker, no
10281 interprocedural optimizations are applied. Note that when
10282 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
10283 but you cannot perform a regular, non-LTO link on them.
10284
10285 When producing the final binary, GCC only
10286 applies link-time optimizations to those files that contain bytecode.
10287 Therefore, you can mix and match object files and libraries with
10288 GIMPLE bytecodes and final object code. GCC automatically selects
10289 which files to optimize in LTO mode and which files to link without
10290 further processing.
10291
10292 Generally, options specified at link time override those
10293 specified at compile time, although in some cases GCC attempts to infer
10294 link-time options from the settings used to compile the input files.
10295
10296 If you do not specify an optimization level option @option{-O} at
10297 link time, then GCC uses the highest optimization level
10298 used when compiling the object files. Note that it is generally
10299 ineffective to specify an optimization level option only at link time and
10300 not at compile time, for two reasons. First, compiling without
10301 optimization suppresses compiler passes that gather information
10302 needed for effective optimization at link time. Second, some early
10303 optimization passes can be performed only at compile time and
10304 not at link time.
10305
10306 There are some code generation flags preserved by GCC when
10307 generating bytecodes, as they need to be used during the final link.
10308 Currently, the following options and their settings are taken from
10309 the first object file that explicitly specifies them:
10310 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
10311 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
10312 and all the @option{-m} target flags.
10313
10314 Certain ABI-changing flags are required to match in all compilation units,
10315 and trying to override this at link time with a conflicting value
10316 is ignored. This includes options such as @option{-freg-struct-return}
10317 and @option{-fpcc-struct-return}.
10318
10319 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
10320 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
10321 are passed through to the link stage and merged conservatively for
10322 conflicting translation units. Specifically
10323 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
10324 precedence; and for example @option{-ffp-contract=off} takes precedence
10325 over @option{-ffp-contract=fast}. You can override them at link time.
10326
10327 If LTO encounters objects with C linkage declared with incompatible
10328 types in separate translation units to be linked together (undefined
10329 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
10330 issued. The behavior is still undefined at run time. Similar
10331 diagnostics may be raised for other languages.
10332
10333 Another feature of LTO is that it is possible to apply interprocedural
10334 optimizations on files written in different languages:
10335
10336 @smallexample
10337 gcc -c -flto foo.c
10338 g++ -c -flto bar.cc
10339 gfortran -c -flto baz.f90
10340 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
10341 @end smallexample
10342
10343 Notice that the final link is done with @command{g++} to get the C++
10344 runtime libraries and @option{-lgfortran} is added to get the Fortran
10345 runtime libraries. In general, when mixing languages in LTO mode, you
10346 should use the same link command options as when mixing languages in a
10347 regular (non-LTO) compilation.
10348
10349 If object files containing GIMPLE bytecode are stored in a library archive, say
10350 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
10351 are using a linker with plugin support. To create static libraries suitable
10352 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
10353 and @command{ranlib};
10354 to show the symbols of object files with GIMPLE bytecode, use
10355 @command{gcc-nm}. Those commands require that @command{ar}, @command{ranlib}
10356 and @command{nm} have been compiled with plugin support. At link time, use the
10357 flag @option{-fuse-linker-plugin} to ensure that the library participates in
10358 the LTO optimization process:
10359
10360 @smallexample
10361 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
10362 @end smallexample
10363
10364 With the linker plugin enabled, the linker extracts the needed
10365 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
10366 to make them part of the aggregated GIMPLE image to be optimized.
10367
10368 If you are not using a linker with plugin support and/or do not
10369 enable the linker plugin, then the objects inside @file{libfoo.a}
10370 are extracted and linked as usual, but they do not participate
10371 in the LTO optimization process. In order to make a static library suitable
10372 for both LTO optimization and usual linkage, compile its object files with
10373 @option{-flto} @option{-ffat-lto-objects}.
10374
10375 Link-time optimizations do not require the presence of the whole program to
10376 operate. If the program does not require any symbols to be exported, it is
10377 possible to combine @option{-flto} and @option{-fwhole-program} to allow
10378 the interprocedural optimizers to use more aggressive assumptions which may
10379 lead to improved optimization opportunities.
10380 Use of @option{-fwhole-program} is not needed when linker plugin is
10381 active (see @option{-fuse-linker-plugin}).
10382
10383 The current implementation of LTO makes no
10384 attempt to generate bytecode that is portable between different
10385 types of hosts. The bytecode files are versioned and there is a
10386 strict version check, so bytecode files generated in one version of
10387 GCC do not work with an older or newer version of GCC.
10388
10389 Link-time optimization does not work well with generation of debugging
10390 information on systems other than those using a combination of ELF and
10391 DWARF.
10392
10393 If you specify the optional @var{n}, the optimization and code
10394 generation done at link time is executed in parallel using @var{n}
10395 parallel jobs by utilizing an installed @command{make} program. The
10396 environment variable @env{MAKE} may be used to override the program
10397 used. The default value for @var{n} is 1.
10398
10399 You can also specify @option{-flto=jobserver} to use GNU make's
10400 job server mode to determine the number of parallel jobs. This
10401 is useful when the Makefile calling GCC is already executing in parallel.
10402 You must prepend a @samp{+} to the command recipe in the parent Makefile
10403 for this to work. This option likely only works if @env{MAKE} is
10404 GNU make.
10405
10406 @item -flto-partition=@var{alg}
10407 @opindex flto-partition
10408 Specify the partitioning algorithm used by the link-time optimizer.
10409 The value is either @samp{1to1} to specify a partitioning mirroring
10410 the original source files or @samp{balanced} to specify partitioning
10411 into equally sized chunks (whenever possible) or @samp{max} to create
10412 new partition for every symbol where possible. Specifying @samp{none}
10413 as an algorithm disables partitioning and streaming completely.
10414 The default value is @samp{balanced}. While @samp{1to1} can be used
10415 as an workaround for various code ordering issues, the @samp{max}
10416 partitioning is intended for internal testing only.
10417 The value @samp{one} specifies that exactly one partition should be
10418 used while the value @samp{none} bypasses partitioning and executes
10419 the link-time optimization step directly from the WPA phase.
10420
10421 @item -flto-compression-level=@var{n}
10422 @opindex flto-compression-level
10423 This option specifies the level of compression used for intermediate
10424 language written to LTO object files, and is only meaningful in
10425 conjunction with LTO mode (@option{-flto}). Valid
10426 values are 0 (no compression) to 9 (maximum compression). Values
10427 outside this range are clamped to either 0 or 9. If the option is not
10428 given, a default balanced compression setting is used.
10429
10430 @item -fuse-linker-plugin
10431 @opindex fuse-linker-plugin
10432 Enables the use of a linker plugin during link-time optimization. This
10433 option relies on plugin support in the linker, which is available in gold
10434 or in GNU ld 2.21 or newer.
10435
10436 This option enables the extraction of object files with GIMPLE bytecode out
10437 of library archives. This improves the quality of optimization by exposing
10438 more code to the link-time optimizer. This information specifies what
10439 symbols can be accessed externally (by non-LTO object or during dynamic
10440 linking). Resulting code quality improvements on binaries (and shared
10441 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
10442 See @option{-flto} for a description of the effect of this flag and how to
10443 use it.
10444
10445 This option is enabled by default when LTO support in GCC is enabled
10446 and GCC was configured for use with
10447 a linker supporting plugins (GNU ld 2.21 or newer or gold).
10448
10449 @item -ffat-lto-objects
10450 @opindex ffat-lto-objects
10451 Fat LTO objects are object files that contain both the intermediate language
10452 and the object code. This makes them usable for both LTO linking and normal
10453 linking. This option is effective only when compiling with @option{-flto}
10454 and is ignored at link time.
10455
10456 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
10457 requires the complete toolchain to be aware of LTO. It requires a linker with
10458 linker plugin support for basic functionality. Additionally,
10459 @command{nm}, @command{ar} and @command{ranlib}
10460 need to support linker plugins to allow a full-featured build environment
10461 (capable of building static libraries etc). GCC provides the @command{gcc-ar},
10462 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
10463 to these tools. With non fat LTO makefiles need to be modified to use them.
10464
10465 Note that modern binutils provide plugin auto-load mechanism.
10466 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
10467 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
10468 @command{gcc-ranlib}).
10469
10470 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
10471 support.
10472
10473 @item -fcompare-elim
10474 @opindex fcompare-elim
10475 After register allocation and post-register allocation instruction splitting,
10476 identify arithmetic instructions that compute processor flags similar to a
10477 comparison operation based on that arithmetic. If possible, eliminate the
10478 explicit comparison operation.
10479
10480 This pass only applies to certain targets that cannot explicitly represent
10481 the comparison operation before register allocation is complete.
10482
10483 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
10484
10485 @item -fcprop-registers
10486 @opindex fcprop-registers
10487 After register allocation and post-register allocation instruction splitting,
10488 perform a copy-propagation pass to try to reduce scheduling dependencies
10489 and occasionally eliminate the copy.
10490
10491 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
10492
10493 @item -fprofile-correction
10494 @opindex fprofile-correction
10495 Profiles collected using an instrumented binary for multi-threaded programs may
10496 be inconsistent due to missed counter updates. When this option is specified,
10497 GCC uses heuristics to correct or smooth out such inconsistencies. By
10498 default, GCC emits an error message when an inconsistent profile is detected.
10499
10500 This option is enabled by @option{-fauto-profile}.
10501
10502 @item -fprofile-use
10503 @itemx -fprofile-use=@var{path}
10504 @opindex fprofile-use
10505 Enable profile feedback-directed optimizations,
10506 and the following optimizations, many of which
10507 are generally profitable only with profile feedback available:
10508
10509 @gccoptlist{-fbranch-probabilities -fprofile-values @gol
10510 -funroll-loops -fpeel-loops -ftracer -fvpt @gol
10511 -finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp @gol
10512 -fpredictive-commoning -fsplit-loops -funswitch-loops @gol
10513 -fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize @gol
10514 -fvect-cost-model=dynamic -ftree-loop-distribute-patterns @gol
10515 -fprofile-reorder-functions}
10516
10517 Before you can use this option, you must first generate profiling information.
10518 @xref{Instrumentation Options}, for information about the
10519 @option{-fprofile-generate} option.
10520
10521 By default, GCC emits an error message if the feedback profiles do not
10522 match the source code. This error can be turned into a warning by using
10523 @option{-Wno-error=coverage-mismatch}. Note this may result in poorly
10524 optimized code. Additionally, by default, GCC also emits a warning message if
10525 the feedback profiles do not exist (see @option{-Wmissing-profile}).
10526
10527 If @var{path} is specified, GCC looks at the @var{path} to find
10528 the profile feedback data files. See @option{-fprofile-dir}.
10529
10530 @item -fauto-profile
10531 @itemx -fauto-profile=@var{path}
10532 @opindex fauto-profile
10533 Enable sampling-based feedback-directed optimizations,
10534 and the following optimizations,
10535 many of which are generally profitable only with profile feedback available:
10536
10537 @gccoptlist{-fbranch-probabilities -fprofile-values @gol
10538 -funroll-loops -fpeel-loops -ftracer -fvpt @gol
10539 -finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp @gol
10540 -fpredictive-commoning -fsplit-loops -funswitch-loops @gol
10541 -fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize @gol
10542 -fvect-cost-model=dynamic -ftree-loop-distribute-patterns @gol
10543 -fprofile-correction}
10544
10545 @var{path} is the name of a file containing AutoFDO profile information.
10546 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
10547
10548 Producing an AutoFDO profile data file requires running your program
10549 with the @command{perf} utility on a supported GNU/Linux target system.
10550 For more information, see @uref{https://perf.wiki.kernel.org/}.
10551
10552 E.g.
10553 @smallexample
10554 perf record -e br_inst_retired:near_taken -b -o perf.data \
10555 -- your_program
10556 @end smallexample
10557
10558 Then use the @command{create_gcov} tool to convert the raw profile data
10559 to a format that can be used by GCC.@ You must also supply the
10560 unstripped binary for your program to this tool.
10561 See @uref{https://github.com/google/autofdo}.
10562
10563 E.g.
10564 @smallexample
10565 create_gcov --binary=your_program.unstripped --profile=perf.data \
10566 --gcov=profile.afdo
10567 @end smallexample
10568 @end table
10569
10570 The following options control compiler behavior regarding floating-point
10571 arithmetic. These options trade off between speed and
10572 correctness. All must be specifically enabled.
10573
10574 @table @gcctabopt
10575 @item -ffloat-store
10576 @opindex ffloat-store
10577 Do not store floating-point variables in registers, and inhibit other
10578 options that might change whether a floating-point value is taken from a
10579 register or memory.
10580
10581 @cindex floating-point precision
10582 This option prevents undesirable excess precision on machines such as
10583 the 68000 where the floating registers (of the 68881) keep more
10584 precision than a @code{double} is supposed to have. Similarly for the
10585 x86 architecture. For most programs, the excess precision does only
10586 good, but a few programs rely on the precise definition of IEEE floating
10587 point. Use @option{-ffloat-store} for such programs, after modifying
10588 them to store all pertinent intermediate computations into variables.
10589
10590 @item -fexcess-precision=@var{style}
10591 @opindex fexcess-precision
10592 This option allows further control over excess precision on machines
10593 where floating-point operations occur in a format with more precision or
10594 range than the IEEE standard and interchange floating-point types. By
10595 default, @option{-fexcess-precision=fast} is in effect; this means that
10596 operations may be carried out in a wider precision than the types specified
10597 in the source if that would result in faster code, and it is unpredictable
10598 when rounding to the types specified in the source code takes place.
10599 When compiling C, if @option{-fexcess-precision=standard} is specified then
10600 excess precision follows the rules specified in ISO C99; in particular,
10601 both casts and assignments cause values to be rounded to their
10602 semantic types (whereas @option{-ffloat-store} only affects
10603 assignments). This option is enabled by default for C if a strict
10604 conformance option such as @option{-std=c99} is used.
10605 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
10606 regardless of whether a strict conformance option is used.
10607
10608 @opindex mfpmath
10609 @option{-fexcess-precision=standard} is not implemented for languages
10610 other than C. On the x86, it has no effect if @option{-mfpmath=sse}
10611 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
10612 semantics apply without excess precision, and in the latter, rounding
10613 is unpredictable.
10614
10615 @item -ffast-math
10616 @opindex ffast-math
10617 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
10618 @option{-ffinite-math-only}, @option{-fno-rounding-math},
10619 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
10620 @option{-fexcess-precision=fast}.
10621
10622 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
10623
10624 This option is not turned on by any @option{-O} option besides
10625 @option{-Ofast} since it can result in incorrect output for programs
10626 that depend on an exact implementation of IEEE or ISO rules/specifications
10627 for math functions. It may, however, yield faster code for programs
10628 that do not require the guarantees of these specifications.
10629
10630 @item -fno-math-errno
10631 @opindex fno-math-errno
10632 @opindex fmath-errno
10633 Do not set @code{errno} after calling math functions that are executed
10634 with a single instruction, e.g., @code{sqrt}. A program that relies on
10635 IEEE exceptions for math error handling may want to use this flag
10636 for speed while maintaining IEEE arithmetic compatibility.
10637
10638 This option is not turned on by any @option{-O} option since
10639 it can result in incorrect output for programs that depend on
10640 an exact implementation of IEEE or ISO rules/specifications for
10641 math functions. It may, however, yield faster code for programs
10642 that do not require the guarantees of these specifications.
10643
10644 The default is @option{-fmath-errno}.
10645
10646 On Darwin systems, the math library never sets @code{errno}. There is
10647 therefore no reason for the compiler to consider the possibility that
10648 it might, and @option{-fno-math-errno} is the default.
10649
10650 @item -funsafe-math-optimizations
10651 @opindex funsafe-math-optimizations
10652
10653 Allow optimizations for floating-point arithmetic that (a) assume
10654 that arguments and results are valid and (b) may violate IEEE or
10655 ANSI standards. When used at link time, it may include libraries
10656 or startup files that change the default FPU control word or other
10657 similar optimizations.
10658
10659 This option is not turned on by any @option{-O} option since
10660 it can result in incorrect output for programs that depend on
10661 an exact implementation of IEEE or ISO rules/specifications for
10662 math functions. It may, however, yield faster code for programs
10663 that do not require the guarantees of these specifications.
10664 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
10665 @option{-fassociative-math} and @option{-freciprocal-math}.
10666
10667 The default is @option{-fno-unsafe-math-optimizations}.
10668
10669 @item -fassociative-math
10670 @opindex fassociative-math
10671
10672 Allow re-association of operands in series of floating-point operations.
10673 This violates the ISO C and C++ language standard by possibly changing
10674 computation result. NOTE: re-ordering may change the sign of zero as
10675 well as ignore NaNs and inhibit or create underflow or overflow (and
10676 thus cannot be used on code that relies on rounding behavior like
10677 @code{(x + 2**52) - 2**52}. May also reorder floating-point comparisons
10678 and thus may not be used when ordered comparisons are required.
10679 This option requires that both @option{-fno-signed-zeros} and
10680 @option{-fno-trapping-math} be in effect. Moreover, it doesn't make
10681 much sense with @option{-frounding-math}. For Fortran the option
10682 is automatically enabled when both @option{-fno-signed-zeros} and
10683 @option{-fno-trapping-math} are in effect.
10684
10685 The default is @option{-fno-associative-math}.
10686
10687 @item -freciprocal-math
10688 @opindex freciprocal-math
10689
10690 Allow the reciprocal of a value to be used instead of dividing by
10691 the value if this enables optimizations. For example @code{x / y}
10692 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
10693 is subject to common subexpression elimination. Note that this loses
10694 precision and increases the number of flops operating on the value.
10695
10696 The default is @option{-fno-reciprocal-math}.
10697
10698 @item -ffinite-math-only
10699 @opindex ffinite-math-only
10700 Allow optimizations for floating-point arithmetic that assume
10701 that arguments and results are not NaNs or +-Infs.
10702
10703 This option is not turned on by any @option{-O} option since
10704 it can result in incorrect output for programs that depend on
10705 an exact implementation of IEEE or ISO rules/specifications for
10706 math functions. It may, however, yield faster code for programs
10707 that do not require the guarantees of these specifications.
10708
10709 The default is @option{-fno-finite-math-only}.
10710
10711 @item -fno-signed-zeros
10712 @opindex fno-signed-zeros
10713 @opindex fsigned-zeros
10714 Allow optimizations for floating-point arithmetic that ignore the
10715 signedness of zero. IEEE arithmetic specifies the behavior of
10716 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
10717 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
10718 This option implies that the sign of a zero result isn't significant.
10719
10720 The default is @option{-fsigned-zeros}.
10721
10722 @item -fno-trapping-math
10723 @opindex fno-trapping-math
10724 @opindex ftrapping-math
10725 Compile code assuming that floating-point operations cannot generate
10726 user-visible traps. These traps include division by zero, overflow,
10727 underflow, inexact result and invalid operation. This option requires
10728 that @option{-fno-signaling-nans} be in effect. Setting this option may
10729 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
10730
10731 This option should never be turned on by any @option{-O} option since
10732 it can result in incorrect output for programs that depend on
10733 an exact implementation of IEEE or ISO rules/specifications for
10734 math functions.
10735
10736 The default is @option{-ftrapping-math}.
10737
10738 @item -frounding-math
10739 @opindex frounding-math
10740 Disable transformations and optimizations that assume default floating-point
10741 rounding behavior. This is round-to-zero for all floating point
10742 to integer conversions, and round-to-nearest for all other arithmetic
10743 truncations. This option should be specified for programs that change
10744 the FP rounding mode dynamically, or that may be executed with a
10745 non-default rounding mode. This option disables constant folding of
10746 floating-point expressions at compile time (which may be affected by
10747 rounding mode) and arithmetic transformations that are unsafe in the
10748 presence of sign-dependent rounding modes.
10749
10750 The default is @option{-fno-rounding-math}.
10751
10752 This option is experimental and does not currently guarantee to
10753 disable all GCC optimizations that are affected by rounding mode.
10754 Future versions of GCC may provide finer control of this setting
10755 using C99's @code{FENV_ACCESS} pragma. This command-line option
10756 will be used to specify the default state for @code{FENV_ACCESS}.
10757
10758 @item -fsignaling-nans
10759 @opindex fsignaling-nans
10760 Compile code assuming that IEEE signaling NaNs may generate user-visible
10761 traps during floating-point operations. Setting this option disables
10762 optimizations that may change the number of exceptions visible with
10763 signaling NaNs. This option implies @option{-ftrapping-math}.
10764
10765 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
10766 be defined.
10767
10768 The default is @option{-fno-signaling-nans}.
10769
10770 This option is experimental and does not currently guarantee to
10771 disable all GCC optimizations that affect signaling NaN behavior.
10772
10773 @item -fno-fp-int-builtin-inexact
10774 @opindex fno-fp-int-builtin-inexact
10775 @opindex ffp-int-builtin-inexact
10776 Do not allow the built-in functions @code{ceil}, @code{floor},
10777 @code{round} and @code{trunc}, and their @code{float} and @code{long
10778 double} variants, to generate code that raises the ``inexact''
10779 floating-point exception for noninteger arguments. ISO C99 and C11
10780 allow these functions to raise the ``inexact'' exception, but ISO/IEC
10781 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
10782 functions to do so.
10783
10784 The default is @option{-ffp-int-builtin-inexact}, allowing the
10785 exception to be raised. This option does nothing unless
10786 @option{-ftrapping-math} is in effect.
10787
10788 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
10789 generate a call to a library function then the ``inexact'' exception
10790 may be raised if the library implementation does not follow TS 18661.
10791
10792 @item -fsingle-precision-constant
10793 @opindex fsingle-precision-constant
10794 Treat floating-point constants as single precision instead of
10795 implicitly converting them to double-precision constants.
10796
10797 @item -fcx-limited-range
10798 @opindex fcx-limited-range
10799 When enabled, this option states that a range reduction step is not
10800 needed when performing complex division. Also, there is no checking
10801 whether the result of a complex multiplication or division is @code{NaN
10802 + I*NaN}, with an attempt to rescue the situation in that case. The
10803 default is @option{-fno-cx-limited-range}, but is enabled by
10804 @option{-ffast-math}.
10805
10806 This option controls the default setting of the ISO C99
10807 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
10808 all languages.
10809
10810 @item -fcx-fortran-rules
10811 @opindex fcx-fortran-rules
10812 Complex multiplication and division follow Fortran rules. Range
10813 reduction is done as part of complex division, but there is no checking
10814 whether the result of a complex multiplication or division is @code{NaN
10815 + I*NaN}, with an attempt to rescue the situation in that case.
10816
10817 The default is @option{-fno-cx-fortran-rules}.
10818
10819 @end table
10820
10821 The following options control optimizations that may improve
10822 performance, but are not enabled by any @option{-O} options. This
10823 section includes experimental options that may produce broken code.
10824
10825 @table @gcctabopt
10826 @item -fbranch-probabilities
10827 @opindex fbranch-probabilities
10828 After running a program compiled with @option{-fprofile-arcs}
10829 (@pxref{Instrumentation Options}),
10830 you can compile it a second time using
10831 @option{-fbranch-probabilities}, to improve optimizations based on
10832 the number of times each branch was taken. When a program
10833 compiled with @option{-fprofile-arcs} exits, it saves arc execution
10834 counts to a file called @file{@var{sourcename}.gcda} for each source
10835 file. The information in this data file is very dependent on the
10836 structure of the generated code, so you must use the same source code
10837 and the same optimization options for both compilations.
10838
10839 With @option{-fbranch-probabilities}, GCC puts a
10840 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
10841 These can be used to improve optimization. Currently, they are only
10842 used in one place: in @file{reorg.c}, instead of guessing which path a
10843 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
10844 exactly determine which path is taken more often.
10845
10846 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10847
10848 @item -fprofile-values
10849 @opindex fprofile-values
10850 If combined with @option{-fprofile-arcs}, it adds code so that some
10851 data about values of expressions in the program is gathered.
10852
10853 With @option{-fbranch-probabilities}, it reads back the data gathered
10854 from profiling values of expressions for usage in optimizations.
10855
10856 Enabled by @option{-fprofile-generate}, @option{-fprofile-use}, and
10857 @option{-fauto-profile}.
10858
10859 @item -fprofile-reorder-functions
10860 @opindex fprofile-reorder-functions
10861 Function reordering based on profile instrumentation collects
10862 first time of execution of a function and orders these functions
10863 in ascending order.
10864
10865 Enabled with @option{-fprofile-use}.
10866
10867 @item -fvpt
10868 @opindex fvpt
10869 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10870 to add code to gather information about values of expressions.
10871
10872 With @option{-fbranch-probabilities}, it reads back the data gathered
10873 and actually performs the optimizations based on them.
10874 Currently the optimizations include specialization of division operations
10875 using the knowledge about the value of the denominator.
10876
10877 Enabled with @option{-fprofile-use} and @option{-fauto-profile}.
10878
10879 @item -frename-registers
10880 @opindex frename-registers
10881 Attempt to avoid false dependencies in scheduled code by making use
10882 of registers left over after register allocation. This optimization
10883 most benefits processors with lots of registers. Depending on the
10884 debug information format adopted by the target, however, it can
10885 make debugging impossible, since variables no longer stay in
10886 a ``home register''.
10887
10888 Enabled by default with @option{-funroll-loops}.
10889
10890 @item -fschedule-fusion
10891 @opindex fschedule-fusion
10892 Performs a target dependent pass over the instruction stream to schedule
10893 instructions of same type together because target machine can execute them
10894 more efficiently if they are adjacent to each other in the instruction flow.
10895
10896 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10897
10898 @item -ftracer
10899 @opindex ftracer
10900 Perform tail duplication to enlarge superblock size. This transformation
10901 simplifies the control flow of the function allowing other optimizations to do
10902 a better job.
10903
10904 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10905
10906 @item -funroll-loops
10907 @opindex funroll-loops
10908 Unroll loops whose number of iterations can be determined at compile time or
10909 upon entry to the loop. @option{-funroll-loops} implies
10910 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10911 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10912 a small constant number of iterations). This option makes code larger, and may
10913 or may not make it run faster.
10914
10915 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10916
10917 @item -funroll-all-loops
10918 @opindex funroll-all-loops
10919 Unroll all loops, even if their number of iterations is uncertain when
10920 the loop is entered. This usually makes programs run more slowly.
10921 @option{-funroll-all-loops} implies the same options as
10922 @option{-funroll-loops}.
10923
10924 @item -fpeel-loops
10925 @opindex fpeel-loops
10926 Peels loops for which there is enough information that they do not
10927 roll much (from profile feedback or static analysis). It also turns on
10928 complete loop peeling (i.e.@: complete removal of loops with small constant
10929 number of iterations).
10930
10931 Enabled by @option{-O3}, @option{-fprofile-use}, and @option{-fauto-profile}.
10932
10933 @item -fmove-loop-invariants
10934 @opindex fmove-loop-invariants
10935 Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
10936 at level @option{-O1} and higher, except for @option{-Og}.
10937
10938 @item -fsplit-loops
10939 @opindex fsplit-loops
10940 Split a loop into two if it contains a condition that's always true
10941 for one side of the iteration space and false for the other.
10942
10943 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10944
10945 @item -funswitch-loops
10946 @opindex funswitch-loops
10947 Move branches with loop invariant conditions out of the loop, with duplicates
10948 of the loop on both branches (modified according to result of the condition).
10949
10950 Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10951
10952 @item -fversion-loops-for-strides
10953 @opindex fversion-loops-for-strides
10954 If a loop iterates over an array with a variable stride, create another
10955 version of the loop that assumes the stride is always one. For example:
10956
10957 @smallexample
10958 for (int i = 0; i < n; ++i)
10959 x[i * stride] = @dots{};
10960 @end smallexample
10961
10962 becomes:
10963
10964 @smallexample
10965 if (stride == 1)
10966 for (int i = 0; i < n; ++i)
10967 x[i] = @dots{};
10968 else
10969 for (int i = 0; i < n; ++i)
10970 x[i * stride] = @dots{};
10971 @end smallexample
10972
10973 This is particularly useful for assumed-shape arrays in Fortran where
10974 (for example) it allows better vectorization assuming contiguous accesses.
10975 This flag is enabled by default at @option{-O3}.
10976 It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
10977
10978 @item -ffunction-sections
10979 @itemx -fdata-sections
10980 @opindex ffunction-sections
10981 @opindex fdata-sections
10982 Place each function or data item into its own section in the output
10983 file if the target supports arbitrary sections. The name of the
10984 function or the name of the data item determines the section's name
10985 in the output file.
10986
10987 Use these options on systems where the linker can perform optimizations to
10988 improve locality of reference in the instruction space. Most systems using the
10989 ELF object format have linkers with such optimizations. On AIX, the linker
10990 rearranges sections (CSECTs) based on the call graph. The performance impact
10991 varies.
10992
10993 Together with a linker garbage collection (linker @option{--gc-sections}
10994 option) these options may lead to smaller statically-linked executables (after
10995 stripping).
10996
10997 On ELF/DWARF systems these options do not degenerate the quality of the debug
10998 information. There could be issues with other object files/debug info formats.
10999
11000 Only use these options when there are significant benefits from doing so. When
11001 you specify these options, the assembler and linker create larger object and
11002 executable files and are also slower. These options affect code generation.
11003 They prevent optimizations by the compiler and assembler using relative
11004 locations inside a translation unit since the locations are unknown until
11005 link time. An example of such an optimization is relaxing calls to short call
11006 instructions.
11007
11008 @item -fbranch-target-load-optimize
11009 @opindex fbranch-target-load-optimize
11010 Perform branch target register load optimization before prologue / epilogue
11011 threading.
11012 The use of target registers can typically be exposed only during reload,
11013 thus hoisting loads out of loops and doing inter-block scheduling needs
11014 a separate optimization pass.
11015
11016 @item -fbranch-target-load-optimize2
11017 @opindex fbranch-target-load-optimize2
11018 Perform branch target register load optimization after prologue / epilogue
11019 threading.
11020
11021 @item -fbtr-bb-exclusive
11022 @opindex fbtr-bb-exclusive
11023 When performing branch target register load optimization, don't reuse
11024 branch target registers within any basic block.
11025
11026 @item -fstdarg-opt
11027 @opindex fstdarg-opt
11028 Optimize the prologue of variadic argument functions with respect to usage of
11029 those arguments.
11030
11031 @item -fsection-anchors
11032 @opindex fsection-anchors
11033 Try to reduce the number of symbolic address calculations by using
11034 shared ``anchor'' symbols to address nearby objects. This transformation
11035 can help to reduce the number of GOT entries and GOT accesses on some
11036 targets.
11037
11038 For example, the implementation of the following function @code{foo}:
11039
11040 @smallexample
11041 static int a, b, c;
11042 int foo (void) @{ return a + b + c; @}
11043 @end smallexample
11044
11045 @noindent
11046 usually calculates the addresses of all three variables, but if you
11047 compile it with @option{-fsection-anchors}, it accesses the variables
11048 from a common anchor point instead. The effect is similar to the
11049 following pseudocode (which isn't valid C):
11050
11051 @smallexample
11052 int foo (void)
11053 @{
11054 register int *xr = &x;
11055 return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
11056 @}
11057 @end smallexample
11058
11059 Not all targets support this option.
11060
11061 @item --param @var{name}=@var{value}
11062 @opindex param
11063 In some places, GCC uses various constants to control the amount of
11064 optimization that is done. For example, GCC does not inline functions
11065 that contain more than a certain number of instructions. You can
11066 control some of these constants on the command line using the
11067 @option{--param} option.
11068
11069 The names of specific parameters, and the meaning of the values, are
11070 tied to the internals of the compiler, and are subject to change
11071 without notice in future releases.
11072
11073 In order to get minimal, maximal and default value of a parameter,
11074 one can use @option{--help=param -Q} options.
11075
11076 In each case, the @var{value} is an integer. The allowable choices for
11077 @var{name} are:
11078
11079 @table @gcctabopt
11080 @item predictable-branch-outcome
11081 When branch is predicted to be taken with probability lower than this threshold
11082 (in percent), then it is considered well predictable.
11083
11084 @item max-rtl-if-conversion-insns
11085 RTL if-conversion tries to remove conditional branches around a block and
11086 replace them with conditionally executed instructions. This parameter
11087 gives the maximum number of instructions in a block which should be
11088 considered for if-conversion. The compiler will
11089 also use other heuristics to decide whether if-conversion is likely to be
11090 profitable.
11091
11092 @item max-rtl-if-conversion-predictable-cost
11093 @itemx max-rtl-if-conversion-unpredictable-cost
11094 RTL if-conversion will try to remove conditional branches around a block
11095 and replace them with conditionally executed instructions. These parameters
11096 give the maximum permissible cost for the sequence that would be generated
11097 by if-conversion depending on whether the branch is statically determined
11098 to be predictable or not. The units for this parameter are the same as
11099 those for the GCC internal seq_cost metric. The compiler will try to
11100 provide a reasonable default for this parameter using the BRANCH_COST
11101 target macro.
11102
11103 @item max-crossjump-edges
11104 The maximum number of incoming edges to consider for cross-jumping.
11105 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
11106 the number of edges incoming to each block. Increasing values mean
11107 more aggressive optimization, making the compilation time increase with
11108 probably small improvement in executable size.
11109
11110 @item min-crossjump-insns
11111 The minimum number of instructions that must be matched at the end
11112 of two blocks before cross-jumping is performed on them. This
11113 value is ignored in the case where all instructions in the block being
11114 cross-jumped from are matched.
11115
11116 @item max-grow-copy-bb-insns
11117 The maximum code size expansion factor when copying basic blocks
11118 instead of jumping. The expansion is relative to a jump instruction.
11119
11120 @item max-goto-duplication-insns
11121 The maximum number of instructions to duplicate to a block that jumps
11122 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
11123 passes, GCC factors computed gotos early in the compilation process,
11124 and unfactors them as late as possible. Only computed jumps at the
11125 end of a basic blocks with no more than max-goto-duplication-insns are
11126 unfactored.
11127
11128 @item max-delay-slot-insn-search
11129 The maximum number of instructions to consider when looking for an
11130 instruction to fill a delay slot. If more than this arbitrary number of
11131 instructions are searched, the time savings from filling the delay slot
11132 are minimal, so stop searching. Increasing values mean more
11133 aggressive optimization, making the compilation time increase with probably
11134 small improvement in execution time.
11135
11136 @item max-delay-slot-live-search
11137 When trying to fill delay slots, the maximum number of instructions to
11138 consider when searching for a block with valid live register
11139 information. Increasing this arbitrarily chosen value means more
11140 aggressive optimization, increasing the compilation time. This parameter
11141 should be removed when the delay slot code is rewritten to maintain the
11142 control-flow graph.
11143
11144 @item max-gcse-memory
11145 The approximate maximum amount of memory that can be allocated in
11146 order to perform the global common subexpression elimination
11147 optimization. If more memory than specified is required, the
11148 optimization is not done.
11149
11150 @item max-gcse-insertion-ratio
11151 If the ratio of expression insertions to deletions is larger than this value
11152 for any expression, then RTL PRE inserts or removes the expression and thus
11153 leaves partially redundant computations in the instruction stream.
11154
11155 @item max-pending-list-length
11156 The maximum number of pending dependencies scheduling allows
11157 before flushing the current state and starting over. Large functions
11158 with few branches or calls can create excessively large lists which
11159 needlessly consume memory and resources.
11160
11161 @item max-modulo-backtrack-attempts
11162 The maximum number of backtrack attempts the scheduler should make
11163 when modulo scheduling a loop. Larger values can exponentially increase
11164 compilation time.
11165
11166 @item max-inline-insns-single
11167 Several parameters control the tree inliner used in GCC@.
11168 This number sets the maximum number of instructions (counted in GCC's
11169 internal representation) in a single function that the tree inliner
11170 considers for inlining. This only affects functions declared
11171 inline and methods implemented in a class declaration (C++).
11172
11173 @item max-inline-insns-auto
11174 When you use @option{-finline-functions} (included in @option{-O3}),
11175 a lot of functions that would otherwise not be considered for inlining
11176 by the compiler are investigated. To those functions, a different
11177 (more restrictive) limit compared to functions declared inline can
11178 be applied.
11179
11180 @item max-inline-insns-small
11181 This is bound applied to calls which are considered relevant with
11182 @option{-finline-small-functions}.
11183
11184 @item max-inline-insns-size
11185 This is bound applied to calls which are optimized for size. Small growth
11186 may be desirable to anticipate optimization oppurtunities exposed by inlining.
11187
11188 @item uninlined-function-insns
11189 Number of instructions accounted by inliner for function overhead such as
11190 function prologue and epilogue.
11191
11192 @item uninlined-function-time
11193 Extra time accounted by inliner for function overhead such as time needed to
11194 execute function prologue and epilogue
11195
11196 @item uninlined-thunk-insns
11197 @item uninlined-thunk-time
11198 Same as @option{--param uninlined-function-insns} and
11199 @option{--param uninlined-function-time} but applied to function thunks
11200
11201 @item inline-min-speedup
11202 When estimated performance improvement of caller + callee runtime exceeds this
11203 threshold (in percent), the function can be inlined regardless of the limit on
11204 @option{--param max-inline-insns-single} and @option{--param
11205 max-inline-insns-auto}.
11206
11207 @item large-function-insns
11208 The limit specifying really large functions. For functions larger than this
11209 limit after inlining, inlining is constrained by
11210 @option{--param large-function-growth}. This parameter is useful primarily
11211 to avoid extreme compilation time caused by non-linear algorithms used by the
11212 back end.
11213
11214 @item large-function-growth
11215 Specifies maximal growth of large function caused by inlining in percents.
11216 For example, parameter value 100 limits large function growth to 2.0 times
11217 the original size.
11218
11219 @item large-unit-insns
11220 The limit specifying large translation unit. Growth caused by inlining of
11221 units larger than this limit is limited by @option{--param inline-unit-growth}.
11222 For small units this might be too tight.
11223 For example, consider a unit consisting of function A
11224 that is inline and B that just calls A three times. If B is small relative to
11225 A, the growth of unit is 300\% and yet such inlining is very sane. For very
11226 large units consisting of small inlineable functions, however, the overall unit
11227 growth limit is needed to avoid exponential explosion of code size. Thus for
11228 smaller units, the size is increased to @option{--param large-unit-insns}
11229 before applying @option{--param inline-unit-growth}.
11230
11231 @item inline-unit-growth
11232 Specifies maximal overall growth of the compilation unit caused by inlining.
11233 For example, parameter value 20 limits unit growth to 1.2 times the original
11234 size. Cold functions (either marked cold via an attribute or by profile
11235 feedback) are not accounted into the unit size.
11236
11237 @item ipcp-unit-growth
11238 Specifies maximal overall growth of the compilation unit caused by
11239 interprocedural constant propagation. For example, parameter value 10 limits
11240 unit growth to 1.1 times the original size.
11241
11242 @item large-stack-frame
11243 The limit specifying large stack frames. While inlining the algorithm is trying
11244 to not grow past this limit too much.
11245
11246 @item large-stack-frame-growth
11247 Specifies maximal growth of large stack frames caused by inlining in percents.
11248 For example, parameter value 1000 limits large stack frame growth to 11 times
11249 the original size.
11250
11251 @item max-inline-insns-recursive
11252 @itemx max-inline-insns-recursive-auto
11253 Specifies the maximum number of instructions an out-of-line copy of a
11254 self-recursive inline
11255 function can grow into by performing recursive inlining.
11256
11257 @option{--param max-inline-insns-recursive} applies to functions
11258 declared inline.
11259 For functions not declared inline, recursive inlining
11260 happens only when @option{-finline-functions} (included in @option{-O3}) is
11261 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.
11262
11263 @item max-inline-recursive-depth
11264 @itemx max-inline-recursive-depth-auto
11265 Specifies the maximum recursion depth used for recursive inlining.
11266
11267 @option{--param max-inline-recursive-depth} applies to functions
11268 declared inline. For functions not declared inline, recursive inlining
11269 happens only when @option{-finline-functions} (included in @option{-O3}) is
11270 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.
11271
11272 @item min-inline-recursive-probability
11273 Recursive inlining is profitable only for function having deep recursion
11274 in average and can hurt for function having little recursion depth by
11275 increasing the prologue size or complexity of function body to other
11276 optimizers.
11277
11278 When profile feedback is available (see @option{-fprofile-generate}) the actual
11279 recursion depth can be guessed from the probability that function recurses
11280 via a given call expression. This parameter limits inlining only to call
11281 expressions whose probability exceeds the given threshold (in percents).
11282
11283 @item early-inlining-insns
11284 Specify growth that the early inliner can make. In effect it increases
11285 the amount of inlining for code having a large abstraction penalty.
11286
11287 @item max-early-inliner-iterations
11288 Limit of iterations of the early inliner. This basically bounds
11289 the number of nested indirect calls the early inliner can resolve.
11290 Deeper chains are still handled by late inlining.
11291
11292 @item comdat-sharing-probability
11293 Probability (in percent) that C++ inline function with comdat visibility
11294 are shared across multiple compilation units.
11295
11296 @item profile-func-internal-id
11297 A parameter to control whether to use function internal id in profile
11298 database lookup. If the value is 0, the compiler uses an id that
11299 is based on function assembler name and filename, which makes old profile
11300 data more tolerant to source changes such as function reordering etc.
11301
11302 @item min-vect-loop-bound
11303 The minimum number of iterations under which loops are not vectorized
11304 when @option{-ftree-vectorize} is used. The number of iterations after
11305 vectorization needs to be greater than the value specified by this option
11306 to allow vectorization.
11307
11308 @item gcse-cost-distance-ratio
11309 Scaling factor in calculation of maximum distance an expression
11310 can be moved by GCSE optimizations. This is currently supported only in the
11311 code hoisting pass. The bigger the ratio, the more aggressive code hoisting
11312 is with simple expressions, i.e., the expressions that have cost
11313 less than @option{gcse-unrestricted-cost}. Specifying 0 disables
11314 hoisting of simple expressions.
11315
11316 @item gcse-unrestricted-cost
11317 Cost, roughly measured as the cost of a single typical machine
11318 instruction, at which GCSE optimizations do not constrain
11319 the distance an expression can travel. This is currently
11320 supported only in the code hoisting pass. The lesser the cost,
11321 the more aggressive code hoisting is. Specifying 0
11322 allows all expressions to travel unrestricted distances.
11323
11324 @item max-hoist-depth
11325 The depth of search in the dominator tree for expressions to hoist.
11326 This is used to avoid quadratic behavior in hoisting algorithm.
11327 The value of 0 does not limit on the search, but may slow down compilation
11328 of huge functions.
11329
11330 @item max-tail-merge-comparisons
11331 The maximum amount of similar bbs to compare a bb with. This is used to
11332 avoid quadratic behavior in tree tail merging.
11333
11334 @item max-tail-merge-iterations
11335 The maximum amount of iterations of the pass over the function. This is used to
11336 limit compilation time in tree tail merging.
11337
11338 @item store-merging-allow-unaligned
11339 Allow the store merging pass to introduce unaligned stores if it is legal to
11340 do so.
11341
11342 @item max-stores-to-merge
11343 The maximum number of stores to attempt to merge into wider stores in the store
11344 merging pass.
11345
11346 @item max-unrolled-insns
11347 The maximum number of instructions that a loop may have to be unrolled.
11348 If a loop is unrolled, this parameter also determines how many times
11349 the loop code is unrolled.
11350
11351 @item max-average-unrolled-insns
11352 The maximum number of instructions biased by probabilities of their execution
11353 that a loop may have to be unrolled. If a loop is unrolled,
11354 this parameter also determines how many times the loop code is unrolled.
11355
11356 @item max-unroll-times
11357 The maximum number of unrollings of a single loop.
11358
11359 @item max-peeled-insns
11360 The maximum number of instructions that a loop may have to be peeled.
11361 If a loop is peeled, this parameter also determines how many times
11362 the loop code is peeled.
11363
11364 @item max-peel-times
11365 The maximum number of peelings of a single loop.
11366
11367 @item max-peel-branches
11368 The maximum number of branches on the hot path through the peeled sequence.
11369
11370 @item max-completely-peeled-insns
11371 The maximum number of insns of a completely peeled loop.
11372
11373 @item max-completely-peel-times
11374 The maximum number of iterations of a loop to be suitable for complete peeling.
11375
11376 @item max-completely-peel-loop-nest-depth
11377 The maximum depth of a loop nest suitable for complete peeling.
11378
11379 @item max-unswitch-insns
11380 The maximum number of insns of an unswitched loop.
11381
11382 @item max-unswitch-level
11383 The maximum number of branches unswitched in a single loop.
11384
11385 @item lim-expensive
11386 The minimum cost of an expensive expression in the loop invariant motion.
11387
11388 @item iv-consider-all-candidates-bound
11389 Bound on number of candidates for induction variables, below which
11390 all candidates are considered for each use in induction variable
11391 optimizations. If there are more candidates than this,
11392 only the most relevant ones are considered to avoid quadratic time complexity.
11393
11394 @item iv-max-considered-uses
11395 The induction variable optimizations give up on loops that contain more
11396 induction variable uses.
11397
11398 @item iv-always-prune-cand-set-bound
11399 If the number of candidates in the set is smaller than this value,
11400 always try to remove unnecessary ivs from the set
11401 when adding a new one.
11402
11403 @item avg-loop-niter
11404 Average number of iterations of a loop.
11405
11406 @item dse-max-object-size
11407 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
11408 Larger values may result in larger compilation times.
11409
11410 @item dse-max-alias-queries-per-store
11411 Maximum number of queries into the alias oracle per store.
11412 Larger values result in larger compilation times and may result in more
11413 removed dead stores.
11414
11415 @item scev-max-expr-size
11416 Bound on size of expressions used in the scalar evolutions analyzer.
11417 Large expressions slow the analyzer.
11418
11419 @item scev-max-expr-complexity
11420 Bound on the complexity of the expressions in the scalar evolutions analyzer.
11421 Complex expressions slow the analyzer.
11422
11423 @item max-tree-if-conversion-phi-args
11424 Maximum number of arguments in a PHI supported by TREE if conversion
11425 unless the loop is marked with simd pragma.
11426
11427 @item vect-max-version-for-alignment-checks
11428 The maximum number of run-time checks that can be performed when
11429 doing loop versioning for alignment in the vectorizer.
11430
11431 @item vect-max-version-for-alias-checks
11432 The maximum number of run-time checks that can be performed when
11433 doing loop versioning for alias in the vectorizer.
11434
11435 @item vect-max-peeling-for-alignment
11436 The maximum number of loop peels to enhance access alignment
11437 for vectorizer. Value -1 means no limit.
11438
11439 @item max-iterations-to-track
11440 The maximum number of iterations of a loop the brute-force algorithm
11441 for analysis of the number of iterations of the loop tries to evaluate.
11442
11443 @item hot-bb-count-ws-permille
11444 A basic block profile count is considered hot if it contributes to
11445 the given permillage (i.e.@: 0...1000) of the entire profiled execution.
11446
11447 @item hot-bb-frequency-fraction
11448 Select fraction of the entry block frequency of executions of basic block in
11449 function given basic block needs to have to be considered hot.
11450
11451 @item max-predicted-iterations
11452 The maximum number of loop iterations we predict statically. This is useful
11453 in cases where a function contains a single loop with known bound and
11454 another loop with unknown bound.
11455 The known number of iterations is predicted correctly, while
11456 the unknown number of iterations average to roughly 10. This means that the
11457 loop without bounds appears artificially cold relative to the other one.
11458
11459 @item builtin-expect-probability
11460 Control the probability of the expression having the specified value. This
11461 parameter takes a percentage (i.e.@: 0 ... 100) as input.
11462
11463 @item builtin-string-cmp-inline-length
11464 The maximum length of a constant string for a builtin string cmp call
11465 eligible for inlining.
11466
11467 @item align-threshold
11468
11469 Select fraction of the maximal frequency of executions of a basic block in
11470 a function to align the basic block.
11471
11472 @item align-loop-iterations
11473
11474 A loop expected to iterate at least the selected number of iterations is
11475 aligned.
11476
11477 @item tracer-dynamic-coverage
11478 @itemx tracer-dynamic-coverage-feedback
11479
11480 This value is used to limit superblock formation once the given percentage of
11481 executed instructions is covered. This limits unnecessary code size
11482 expansion.
11483
11484 The @option{tracer-dynamic-coverage-feedback} parameter
11485 is used only when profile
11486 feedback is available. The real profiles (as opposed to statically estimated
11487 ones) are much less balanced allowing the threshold to be larger value.
11488
11489 @item tracer-max-code-growth
11490 Stop tail duplication once code growth has reached given percentage. This is
11491 a rather artificial limit, as most of the duplicates are eliminated later in
11492 cross jumping, so it may be set to much higher values than is the desired code
11493 growth.
11494
11495 @item tracer-min-branch-ratio
11496
11497 Stop reverse growth when the reverse probability of best edge is less than this
11498 threshold (in percent).
11499
11500 @item tracer-min-branch-probability
11501 @itemx tracer-min-branch-probability-feedback
11502
11503 Stop forward growth if the best edge has probability lower than this
11504 threshold.
11505
11506 Similarly to @option{tracer-dynamic-coverage} two parameters are
11507 provided. @option{tracer-min-branch-probability-feedback} is used for
11508 compilation with profile feedback and @option{tracer-min-branch-probability}
11509 compilation without. The value for compilation with profile feedback
11510 needs to be more conservative (higher) in order to make tracer
11511 effective.
11512
11513 @item stack-clash-protection-guard-size
11514 Specify the size of the operating system provided stack guard as
11515 2 raised to @var{num} bytes. Higher values may reduce the
11516 number of explicit probes, but a value larger than the operating system
11517 provided guard will leave code vulnerable to stack clash style attacks.
11518
11519 @item stack-clash-protection-probe-interval
11520 Stack clash protection involves probing stack space as it is allocated. This
11521 param controls the maximum distance between probes into the stack as 2 raised
11522 to @var{num} bytes. Higher values may reduce the number of explicit probes, but a value
11523 larger than the operating system provided guard will leave code vulnerable to
11524 stack clash style attacks.
11525
11526 @item max-cse-path-length
11527
11528 The maximum number of basic blocks on path that CSE considers.
11529
11530 @item max-cse-insns
11531 The maximum number of instructions CSE processes before flushing.
11532
11533 @item ggc-min-expand
11534
11535 GCC uses a garbage collector to manage its own memory allocation. This
11536 parameter specifies the minimum percentage by which the garbage
11537 collector's heap should be allowed to expand between collections.
11538 Tuning this may improve compilation speed; it has no effect on code
11539 generation.
11540
11541 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
11542 RAM >= 1GB@. If @code{getrlimit} is available, the notion of ``RAM'' is
11543 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
11544 GCC is not able to calculate RAM on a particular platform, the lower
11545 bound of 30% is used. Setting this parameter and
11546 @option{ggc-min-heapsize} to zero causes a full collection to occur at
11547 every opportunity. This is extremely slow, but can be useful for
11548 debugging.
11549
11550 @item ggc-min-heapsize
11551
11552 Minimum size of the garbage collector's heap before it begins bothering
11553 to collect garbage. The first collection occurs after the heap expands
11554 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
11555 tuning this may improve compilation speed, and has no effect on code
11556 generation.
11557
11558 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
11559 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
11560 with a lower bound of 4096 (four megabytes) and an upper bound of
11561 131072 (128 megabytes). If GCC is not able to calculate RAM on a
11562 particular platform, the lower bound is used. Setting this parameter
11563 very large effectively disables garbage collection. Setting this
11564 parameter and @option{ggc-min-expand} to zero causes a full collection
11565 to occur at every opportunity.
11566
11567 @item max-reload-search-insns
11568 The maximum number of instruction reload should look backward for equivalent
11569 register. Increasing values mean more aggressive optimization, making the
11570 compilation time increase with probably slightly better performance.
11571
11572 @item max-cselib-memory-locations
11573 The maximum number of memory locations cselib should take into account.
11574 Increasing values mean more aggressive optimization, making the compilation time
11575 increase with probably slightly better performance.
11576
11577 @item max-sched-ready-insns
11578 The maximum number of instructions ready to be issued the scheduler should
11579 consider at any given time during the first scheduling pass. Increasing
11580 values mean more thorough searches, making the compilation time increase
11581 with probably little benefit.
11582
11583 @item max-sched-region-blocks
11584 The maximum number of blocks in a region to be considered for
11585 interblock scheduling.
11586
11587 @item max-pipeline-region-blocks
11588 The maximum number of blocks in a region to be considered for
11589 pipelining in the selective scheduler.
11590
11591 @item max-sched-region-insns
11592 The maximum number of insns in a region to be considered for
11593 interblock scheduling.
11594
11595 @item max-pipeline-region-insns
11596 The maximum number of insns in a region to be considered for
11597 pipelining in the selective scheduler.
11598
11599 @item min-spec-prob
11600 The minimum probability (in percents) of reaching a source block
11601 for interblock speculative scheduling.
11602
11603 @item max-sched-extend-regions-iters
11604 The maximum number of iterations through CFG to extend regions.
11605 A value of 0 disables region extensions.
11606
11607 @item max-sched-insn-conflict-delay
11608 The maximum conflict delay for an insn to be considered for speculative motion.
11609
11610 @item sched-spec-prob-cutoff
11611 The minimal probability of speculation success (in percents), so that
11612 speculative insns are scheduled.
11613
11614 @item sched-state-edge-prob-cutoff
11615 The minimum probability an edge must have for the scheduler to save its
11616 state across it.
11617
11618 @item sched-mem-true-dep-cost
11619 Minimal distance (in CPU cycles) between store and load targeting same
11620 memory locations.
11621
11622 @item selsched-max-lookahead
11623 The maximum size of the lookahead window of selective scheduling. It is a
11624 depth of search for available instructions.
11625
11626 @item selsched-max-sched-times
11627 The maximum number of times that an instruction is scheduled during
11628 selective scheduling. This is the limit on the number of iterations
11629 through which the instruction may be pipelined.
11630
11631 @item selsched-insns-to-rename
11632 The maximum number of best instructions in the ready list that are considered
11633 for renaming in the selective scheduler.
11634
11635 @item sms-min-sc
11636 The minimum value of stage count that swing modulo scheduler
11637 generates.
11638
11639 @item max-last-value-rtl
11640 The maximum size measured as number of RTLs that can be recorded in an expression
11641 in combiner for a pseudo register as last known value of that register.
11642
11643 @item max-combine-insns
11644 The maximum number of instructions the RTL combiner tries to combine.
11645
11646 @item integer-share-limit
11647 Small integer constants can use a shared data structure, reducing the
11648 compiler's memory usage and increasing its speed. This sets the maximum
11649 value of a shared integer constant.
11650
11651 @item ssp-buffer-size
11652 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
11653 protection when @option{-fstack-protection} is used.
11654
11655 @item min-size-for-stack-sharing
11656 The minimum size of variables taking part in stack slot sharing when not
11657 optimizing.
11658
11659 @item max-jump-thread-duplication-stmts
11660 Maximum number of statements allowed in a block that needs to be
11661 duplicated when threading jumps.
11662
11663 @item max-fields-for-field-sensitive
11664 Maximum number of fields in a structure treated in
11665 a field sensitive manner during pointer analysis.
11666
11667 @item prefetch-latency
11668 Estimate on average number of instructions that are executed before
11669 prefetch finishes. The distance prefetched ahead is proportional
11670 to this constant. Increasing this number may also lead to less
11671 streams being prefetched (see @option{simultaneous-prefetches}).
11672
11673 @item simultaneous-prefetches
11674 Maximum number of prefetches that can run at the same time.
11675
11676 @item l1-cache-line-size
11677 The size of cache line in L1 data cache, in bytes.
11678
11679 @item l1-cache-size
11680 The size of L1 data cache, in kilobytes.
11681
11682 @item l2-cache-size
11683 The size of L2 data cache, in kilobytes.
11684
11685 @item prefetch-dynamic-strides
11686 Whether the loop array prefetch pass should issue software prefetch hints
11687 for strides that are non-constant. In some cases this may be
11688 beneficial, though the fact the stride is non-constant may make it
11689 hard to predict when there is clear benefit to issuing these hints.
11690
11691 Set to 1 if the prefetch hints should be issued for non-constant
11692 strides. Set to 0 if prefetch hints should be issued only for strides that
11693 are known to be constant and below @option{prefetch-minimum-stride}.
11694
11695 @item prefetch-minimum-stride
11696 Minimum constant stride, in bytes, to start using prefetch hints for. If
11697 the stride is less than this threshold, prefetch hints will not be issued.
11698
11699 This setting is useful for processors that have hardware prefetchers, in
11700 which case there may be conflicts between the hardware prefetchers and
11701 the software prefetchers. If the hardware prefetchers have a maximum
11702 stride they can handle, it should be used here to improve the use of
11703 software prefetchers.
11704
11705 A value of -1 means we don't have a threshold and therefore
11706 prefetch hints can be issued for any constant stride.
11707
11708 This setting is only useful for strides that are known and constant.
11709
11710 @item loop-interchange-max-num-stmts
11711 The maximum number of stmts in a loop to be interchanged.
11712
11713 @item loop-interchange-stride-ratio
11714 The minimum ratio between stride of two loops for interchange to be profitable.
11715
11716 @item min-insn-to-prefetch-ratio
11717 The minimum ratio between the number of instructions and the
11718 number of prefetches to enable prefetching in a loop.
11719
11720 @item prefetch-min-insn-to-mem-ratio
11721 The minimum ratio between the number of instructions and the
11722 number of memory references to enable prefetching in a loop.
11723
11724 @item use-canonical-types
11725 Whether the compiler should use the ``canonical'' type system.
11726 Should always be 1, which uses a more efficient internal
11727 mechanism for comparing types in C++ and Objective-C++. However, if
11728 bugs in the canonical type system are causing compilation failures,
11729 set this value to 0 to disable canonical types.
11730
11731 @item switch-conversion-max-branch-ratio
11732 Switch initialization conversion refuses to create arrays that are
11733 bigger than @option{switch-conversion-max-branch-ratio} times the number of
11734 branches in the switch.
11735
11736 @item max-partial-antic-length
11737 Maximum length of the partial antic set computed during the tree
11738 partial redundancy elimination optimization (@option{-ftree-pre}) when
11739 optimizing at @option{-O3} and above. For some sorts of source code
11740 the enhanced partial redundancy elimination optimization can run away,
11741 consuming all of the memory available on the host machine. This
11742 parameter sets a limit on the length of the sets that are computed,
11743 which prevents the runaway behavior. Setting a value of 0 for
11744 this parameter allows an unlimited set length.
11745
11746 @item rpo-vn-max-loop-depth
11747 Maximum loop depth that is value-numbered optimistically.
11748 When the limit hits the innermost
11749 @var{rpo-vn-max-loop-depth} loops and the outermost loop in the
11750 loop nest are value-numbered optimistically and the remaining ones not.
11751
11752 @item sccvn-max-alias-queries-per-access
11753 Maximum number of alias-oracle queries we perform when looking for
11754 redundancies for loads and stores. If this limit is hit the search
11755 is aborted and the load or store is not considered redundant. The
11756 number of queries is algorithmically limited to the number of
11757 stores on all paths from the load to the function entry.
11758
11759 @item ira-max-loops-num
11760 IRA uses regional register allocation by default. If a function
11761 contains more loops than the number given by this parameter, only at most
11762 the given number of the most frequently-executed loops form regions
11763 for regional register allocation.
11764
11765 @item ira-max-conflict-table-size
11766 Although IRA uses a sophisticated algorithm to compress the conflict
11767 table, the table can still require excessive amounts of memory for
11768 huge functions. If the conflict table for a function could be more
11769 than the size in MB given by this parameter, the register allocator
11770 instead uses a faster, simpler, and lower-quality
11771 algorithm that does not require building a pseudo-register conflict table.
11772
11773 @item ira-loop-reserved-regs
11774 IRA can be used to evaluate more accurate register pressure in loops
11775 for decisions to move loop invariants (see @option{-O3}). The number
11776 of available registers reserved for some other purposes is given
11777 by this parameter. Default of the parameter
11778 is the best found from numerous experiments.
11779
11780 @item lra-inheritance-ebb-probability-cutoff
11781 LRA tries to reuse values reloaded in registers in subsequent insns.
11782 This optimization is called inheritance. EBB is used as a region to
11783 do this optimization. The parameter defines a minimal fall-through
11784 edge probability in percentage used to add BB to inheritance EBB in
11785 LRA. The default value was chosen
11786 from numerous runs of SPEC2000 on x86-64.
11787
11788 @item loop-invariant-max-bbs-in-loop
11789 Loop invariant motion can be very expensive, both in compilation time and
11790 in amount of needed compile-time memory, with very large loops. Loops
11791 with more basic blocks than this parameter won't have loop invariant
11792 motion optimization performed on them.
11793
11794 @item loop-max-datarefs-for-datadeps
11795 Building data dependencies is expensive for very large loops. This
11796 parameter limits the number of data references in loops that are
11797 considered for data dependence analysis. These large loops are no
11798 handled by the optimizations using loop data dependencies.
11799
11800 @item max-vartrack-size
11801 Sets a maximum number of hash table slots to use during variable
11802 tracking dataflow analysis of any function. If this limit is exceeded
11803 with variable tracking at assignments enabled, analysis for that
11804 function is retried without it, after removing all debug insns from
11805 the function. If the limit is exceeded even without debug insns, var
11806 tracking analysis is completely disabled for the function. Setting
11807 the parameter to zero makes it unlimited.
11808
11809 @item max-vartrack-expr-depth
11810 Sets a maximum number of recursion levels when attempting to map
11811 variable names or debug temporaries to value expressions. This trades
11812 compilation time for more complete debug information. If this is set too
11813 low, value expressions that are available and could be represented in
11814 debug information may end up not being used; setting this higher may
11815 enable the compiler to find more complex debug expressions, but compile
11816 time and memory use may grow.
11817
11818 @item max-debug-marker-count
11819 Sets a threshold on the number of debug markers (e.g.@: begin stmt
11820 markers) to avoid complexity explosion at inlining or expanding to RTL.
11821 If a function has more such gimple stmts than the set limit, such stmts
11822 will be dropped from the inlined copy of a function, and from its RTL
11823 expansion.
11824
11825 @item min-nondebug-insn-uid
11826 Use uids starting at this parameter for nondebug insns. The range below
11827 the parameter is reserved exclusively for debug insns created by
11828 @option{-fvar-tracking-assignments}, but debug insns may get
11829 (non-overlapping) uids above it if the reserved range is exhausted.
11830
11831 @item ipa-sra-ptr-growth-factor
11832 IPA-SRA replaces a pointer to an aggregate with one or more new
11833 parameters only when their cumulative size is less or equal to
11834 @option{ipa-sra-ptr-growth-factor} times the size of the original
11835 pointer parameter.
11836
11837 @item sra-max-scalarization-size-Ospeed
11838 @itemx sra-max-scalarization-size-Osize
11839 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
11840 replace scalar parts of aggregates with uses of independent scalar
11841 variables. These parameters control the maximum size, in storage units,
11842 of aggregate which is considered for replacement when compiling for
11843 speed
11844 (@option{sra-max-scalarization-size-Ospeed}) or size
11845 (@option{sra-max-scalarization-size-Osize}) respectively.
11846
11847 @item tm-max-aggregate-size
11848 When making copies of thread-local variables in a transaction, this
11849 parameter specifies the size in bytes after which variables are
11850 saved with the logging functions as opposed to save/restore code
11851 sequence pairs. This option only applies when using
11852 @option{-fgnu-tm}.
11853
11854 @item graphite-max-nb-scop-params
11855 To avoid exponential effects in the Graphite loop transforms, the
11856 number of parameters in a Static Control Part (SCoP) is bounded.
11857 A value of zero can be used to lift
11858 the bound. A variable whose value is unknown at compilation time and
11859 defined outside a SCoP is a parameter of the SCoP.
11860
11861 @item loop-block-tile-size
11862 Loop blocking or strip mining transforms, enabled with
11863 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
11864 loop in the loop nest by a given number of iterations. The strip
11865 length can be changed using the @option{loop-block-tile-size}
11866 parameter.
11867
11868 @item ipa-cp-value-list-size
11869 IPA-CP attempts to track all possible values and types passed to a function's
11870 parameter in order to propagate them and perform devirtualization.
11871 @option{ipa-cp-value-list-size} is the maximum number of values and types it
11872 stores per one formal parameter of a function.
11873
11874 @item ipa-cp-eval-threshold
11875 IPA-CP calculates its own score of cloning profitability heuristics
11876 and performs those cloning opportunities with scores that exceed
11877 @option{ipa-cp-eval-threshold}.
11878
11879 @item ipa-cp-recursion-penalty
11880 Percentage penalty the recursive functions will receive when they
11881 are evaluated for cloning.
11882
11883 @item ipa-cp-single-call-penalty
11884 Percentage penalty functions containing a single call to another
11885 function will receive when they are evaluated for cloning.
11886
11887 @item ipa-max-agg-items
11888 IPA-CP is also capable to propagate a number of scalar values passed
11889 in an aggregate. @option{ipa-max-agg-items} controls the maximum
11890 number of such values per one parameter.
11891
11892 @item ipa-cp-loop-hint-bonus
11893 When IPA-CP determines that a cloning candidate would make the number
11894 of iterations of a loop known, it adds a bonus of
11895 @option{ipa-cp-loop-hint-bonus} to the profitability score of
11896 the candidate.
11897
11898 @item ipa-cp-array-index-hint-bonus
11899 When IPA-CP determines that a cloning candidate would make the index of
11900 an array access known, it adds a bonus of
11901 @option{ipa-cp-array-index-hint-bonus} to the profitability
11902 score of the candidate.
11903
11904 @item ipa-max-aa-steps
11905 During its analysis of function bodies, IPA-CP employs alias analysis
11906 in order to track values pointed to by function parameters. In order
11907 not spend too much time analyzing huge functions, it gives up and
11908 consider all memory clobbered after examining
11909 @option{ipa-max-aa-steps} statements modifying memory.
11910
11911 @item lto-partitions
11912 Specify desired number of partitions produced during WHOPR compilation.
11913 The number of partitions should exceed the number of CPUs used for compilation.
11914
11915 @item lto-min-partition
11916 Size of minimal partition for WHOPR (in estimated instructions).
11917 This prevents expenses of splitting very small programs into too many
11918 partitions.
11919
11920 @item lto-max-partition
11921 Size of max partition for WHOPR (in estimated instructions).
11922 to provide an upper bound for individual size of partition.
11923 Meant to be used only with balanced partitioning.
11924
11925 @item lto-max-streaming-parallelism
11926 Maximal number of parallel processes used for LTO streaming.
11927
11928 @item cxx-max-namespaces-for-diagnostic-help
11929 The maximum number of namespaces to consult for suggestions when C++
11930 name lookup fails for an identifier.
11931
11932 @item sink-frequency-threshold
11933 The maximum relative execution frequency (in percents) of the target block
11934 relative to a statement's original block to allow statement sinking of a
11935 statement. Larger numbers result in more aggressive statement sinking.
11936 A small positive adjustment is applied for
11937 statements with memory operands as those are even more profitable so sink.
11938
11939 @item max-stores-to-sink
11940 The maximum number of conditional store pairs that can be sunk. Set to 0
11941 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11942 (@option{-ftree-loop-if-convert}) is disabled.
11943
11944 @item allow-store-data-races
11945 Allow optimizers to introduce new data races on stores.
11946 Set to 1 to allow, otherwise to 0.
11947
11948 @item case-values-threshold
11949 The smallest number of different values for which it is best to use a
11950 jump-table instead of a tree of conditional branches. If the value is
11951 0, use the default for the machine.
11952
11953 @item jump-table-max-growth-ratio-for-size
11954 The maximum code size growth ratio when expanding
11955 into a jump table (in percent). The parameter is used when
11956 optimizing for size.
11957
11958 @item jump-table-max-growth-ratio-for-speed
11959 The maximum code size growth ratio when expanding
11960 into a jump table (in percent). The parameter is used when
11961 optimizing for speed.
11962
11963 @item tree-reassoc-width
11964 Set the maximum number of instructions executed in parallel in
11965 reassociated tree. This parameter overrides target dependent
11966 heuristics used by default if has non zero value.
11967
11968 @item sched-pressure-algorithm
11969 Choose between the two available implementations of
11970 @option{-fsched-pressure}. Algorithm 1 is the original implementation
11971 and is the more likely to prevent instructions from being reordered.
11972 Algorithm 2 was designed to be a compromise between the relatively
11973 conservative approach taken by algorithm 1 and the rather aggressive
11974 approach taken by the default scheduler. It relies more heavily on
11975 having a regular register file and accurate register pressure classes.
11976 See @file{haifa-sched.c} in the GCC sources for more details.
11977
11978 The default choice depends on the target.
11979
11980 @item max-slsr-cand-scan
11981 Set the maximum number of existing candidates that are considered when
11982 seeking a basis for a new straight-line strength reduction candidate.
11983
11984 @item asan-globals
11985 Enable buffer overflow detection for global objects. This kind
11986 of protection is enabled by default if you are using
11987 @option{-fsanitize=address} option.
11988 To disable global objects protection use @option{--param asan-globals=0}.
11989
11990 @item asan-stack
11991 Enable buffer overflow detection for stack objects. This kind of
11992 protection is enabled by default when using @option{-fsanitize=address}.
11993 To disable stack protection use @option{--param asan-stack=0} option.
11994
11995 @item asan-instrument-reads
11996 Enable buffer overflow detection for memory reads. This kind of
11997 protection is enabled by default when using @option{-fsanitize=address}.
11998 To disable memory reads protection use
11999 @option{--param asan-instrument-reads=0}.
12000
12001 @item asan-instrument-writes
12002 Enable buffer overflow detection for memory writes. This kind of
12003 protection is enabled by default when using @option{-fsanitize=address}.
12004 To disable memory writes protection use
12005 @option{--param asan-instrument-writes=0} option.
12006
12007 @item asan-memintrin
12008 Enable detection for built-in functions. This kind of protection
12009 is enabled by default when using @option{-fsanitize=address}.
12010 To disable built-in functions protection use
12011 @option{--param asan-memintrin=0}.
12012
12013 @item asan-use-after-return
12014 Enable detection of use-after-return. This kind of protection
12015 is enabled by default when using the @option{-fsanitize=address} option.
12016 To disable it use @option{--param asan-use-after-return=0}.
12017
12018 Note: By default the check is disabled at run time. To enable it,
12019 add @code{detect_stack_use_after_return=1} to the environment variable
12020 @env{ASAN_OPTIONS}.
12021
12022 @item asan-instrumentation-with-call-threshold
12023 If number of memory accesses in function being instrumented
12024 is greater or equal to this number, use callbacks instead of inline checks.
12025 E.g. to disable inline code use
12026 @option{--param asan-instrumentation-with-call-threshold=0}.
12027
12028 @item use-after-scope-direct-emission-threshold
12029 If the size of a local variable in bytes is smaller or equal to this
12030 number, directly poison (or unpoison) shadow memory instead of using
12031 run-time callbacks.
12032
12033 @item max-fsm-thread-path-insns
12034 Maximum number of instructions to copy when duplicating blocks on a
12035 finite state automaton jump thread path.
12036
12037 @item max-fsm-thread-length
12038 Maximum number of basic blocks on a finite state automaton jump thread
12039 path.
12040
12041 @item max-fsm-thread-paths
12042 Maximum number of new jump thread paths to create for a finite state
12043 automaton.
12044
12045 @item parloops-chunk-size
12046 Chunk size of omp schedule for loops parallelized by parloops.
12047
12048 @item parloops-schedule
12049 Schedule type of omp schedule for loops parallelized by parloops (static,
12050 dynamic, guided, auto, runtime).
12051
12052 @item parloops-min-per-thread
12053 The minimum number of iterations per thread of an innermost parallelized
12054 loop for which the parallelized variant is preferred over the single threaded
12055 one. Note that for a parallelized loop nest the
12056 minimum number of iterations of the outermost loop per thread is two.
12057
12058 @item max-ssa-name-query-depth
12059 Maximum depth of recursion when querying properties of SSA names in things
12060 like fold routines. One level of recursion corresponds to following a
12061 use-def chain.
12062
12063 @item hsa-gen-debug-stores
12064 Enable emission of special debug stores within HSA kernels which are
12065 then read and reported by libgomp plugin. Generation of these stores
12066 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
12067 enable it.
12068
12069 @item max-speculative-devirt-maydefs
12070 The maximum number of may-defs we analyze when looking for a must-def
12071 specifying the dynamic type of an object that invokes a virtual call
12072 we may be able to devirtualize speculatively.
12073
12074 @item max-vrp-switch-assertions
12075 The maximum number of assertions to add along the default edge of a switch
12076 statement during VRP.
12077
12078 @item unroll-jam-min-percent
12079 The minimum percentage of memory references that must be optimized
12080 away for the unroll-and-jam transformation to be considered profitable.
12081
12082 @item unroll-jam-max-unroll
12083 The maximum number of times the outer loop should be unrolled by
12084 the unroll-and-jam transformation.
12085
12086 @item max-rtl-if-conversion-unpredictable-cost
12087 Maximum permissible cost for the sequence that would be generated
12088 by the RTL if-conversion pass for a branch that is considered unpredictable.
12089
12090 @item max-variable-expansions-in-unroller
12091 If @option{-fvariable-expansion-in-unroller} is used, the maximum number
12092 of times that an individual variable will be expanded during loop unrolling.
12093
12094 @item tracer-min-branch-probability-feedback
12095 Stop forward growth if the probability of best edge is less than
12096 this threshold (in percent). Used when profile feedback is available.
12097
12098 @item partial-inlining-entry-probability
12099 Maximum probability of the entry BB of split region
12100 (in percent relative to entry BB of the function)
12101 to make partial inlining happen.
12102
12103 @item max-tracked-strlens
12104 Maximum number of strings for which strlen optimization pass will
12105 track string lengths.
12106
12107 @item gcse-after-reload-partial-fraction
12108 The threshold ratio for performing partial redundancy
12109 elimination after reload.
12110
12111 @item gcse-after-reload-critical-fraction
12112 The threshold ratio of critical edges execution count that
12113 permit performing redundancy elimination after reload.
12114
12115 @item max-loop-header-insns
12116 The maximum number of insns in loop header duplicated
12117 by the copy loop headers pass.
12118
12119 @item vect-epilogues-nomask
12120 Enable loop epilogue vectorization using smaller vector size.
12121
12122 @item slp-max-insns-in-bb
12123 Maximum number of instructions in basic block to be
12124 considered for SLP vectorization.
12125
12126 @item avoid-fma-max-bits
12127 Maximum number of bits for which we avoid creating FMAs.
12128
12129 @item sms-loop-average-count-threshold
12130 A threshold on the average loop count considered by the swing modulo scheduler.
12131
12132 @item sms-dfa-history
12133 The number of cycles the swing modulo scheduler considers when checking
12134 conflicts using DFA.
12135
12136 @item hot-bb-count-fraction
12137 Select fraction of the maximal count of repetitions of basic block
12138 in program given basic block needs
12139 to have to be considered hot (used in non-LTO mode)
12140
12141 @item max-inline-insns-recursive-auto
12142 The maximum number of instructions non-inline function
12143 can grow to via recursive inlining.
12144
12145 @item graphite-allow-codegen-errors
12146 Whether codegen errors should be ICEs when @option{-fchecking}.
12147
12148 @item sms-max-ii-factor
12149 A factor for tuning the upper bound that swing modulo scheduler
12150 uses for scheduling a loop.
12151
12152 @item lra-max-considered-reload-pseudos
12153 The max number of reload pseudos which are considered during
12154 spilling a non-reload pseudo.
12155
12156 @item max-pow-sqrt-depth
12157 Maximum depth of sqrt chains to use when synthesizing exponentiation
12158 by a real constant.
12159
12160 @item max-dse-active-local-stores
12161 Maximum number of active local stores in RTL dead store elimination.
12162
12163 @item asan-instrument-allocas
12164 Enable asan allocas/VLAs protection.
12165
12166 @item max-iterations-computation-cost
12167 Bound on the cost of an expression to compute the number of iterations.
12168
12169 @item max-isl-operations
12170 Maximum number of isl operations, 0 means unlimited.
12171
12172 @item graphite-max-arrays-per-scop
12173 Maximum number of arrays per scop.
12174
12175 @item max-vartrack-reverse-op-size
12176 Max. size of loc list for which reverse ops should be added.
12177
12178 @item unlikely-bb-count-fraction
12179 The minimum fraction of profile runs a given basic block execution count
12180 must be not to be considered unlikely.
12181
12182 @item tracer-dynamic-coverage-feedback
12183 The percentage of function, weighted by execution frequency,
12184 that must be covered by trace formation.
12185 Used when profile feedback is available.
12186
12187 @item max-inline-recursive-depth-auto
12188 The maximum depth of recursive inlining for non-inline functions.
12189
12190 @item fsm-scale-path-stmts
12191 Scale factor to apply to the number of statements in a threading path
12192 when comparing to the number of (scaled) blocks.
12193
12194 @item fsm-maximum-phi-arguments
12195 Maximum number of arguments a PHI may have before the FSM threader
12196 will not try to thread through its block.
12197
12198 @item uninit-control-dep-attempts
12199 Maximum number of nested calls to search for control dependencies
12200 during uninitialized variable analysis.
12201
12202 @item max-once-peeled-insns
12203 The maximum number of insns of a peeled loop that rolls only once.
12204
12205 @item sra-max-scalarization-size-Osize
12206 Maximum size, in storage units, of an aggregate
12207 which should be considered for scalarization when compiling for size.
12208
12209 @item fsm-scale-path-blocks
12210 Scale factor to apply to the number of blocks in a threading path
12211 when comparing to the number of (scaled) statements.
12212
12213 @item sched-autopref-queue-depth
12214 Hardware autoprefetcher scheduler model control flag.
12215 Number of lookahead cycles the model looks into; at '
12216 ' only enable instruction sorting heuristic.
12217
12218 @item loop-versioning-max-inner-insns
12219 The maximum number of instructions that an inner loop can have
12220 before the loop versioning pass considers it too big to copy.
12221
12222 @item loop-versioning-max-outer-insns
12223 The maximum number of instructions that an outer loop can have
12224 before the loop versioning pass considers it too big to copy,
12225 discounting any instructions in inner loops that directly benefit
12226 from versioning.
12227
12228 @end table
12229 @end table
12230
12231 @node Instrumentation Options
12232 @section Program Instrumentation Options
12233 @cindex instrumentation options
12234 @cindex program instrumentation options
12235 @cindex run-time error checking options
12236 @cindex profiling options
12237 @cindex options, program instrumentation
12238 @cindex options, run-time error checking
12239 @cindex options, profiling
12240
12241 GCC supports a number of command-line options that control adding
12242 run-time instrumentation to the code it normally generates.
12243 For example, one purpose of instrumentation is collect profiling
12244 statistics for use in finding program hot spots, code coverage
12245 analysis, or profile-guided optimizations.
12246 Another class of program instrumentation is adding run-time checking
12247 to detect programming errors like invalid pointer
12248 dereferences or out-of-bounds array accesses, as well as deliberately
12249 hostile attacks such as stack smashing or C++ vtable hijacking.
12250 There is also a general hook which can be used to implement other
12251 forms of tracing or function-level instrumentation for debug or
12252 program analysis purposes.
12253
12254 @table @gcctabopt
12255 @cindex @command{prof}
12256 @cindex @command{gprof}
12257 @item -p
12258 @itemx -pg
12259 @opindex p
12260 @opindex pg
12261 Generate extra code to write profile information suitable for the
12262 analysis program @command{prof} (for @option{-p}) or @command{gprof}
12263 (for @option{-pg}). You must use this option when compiling
12264 the source files you want data about, and you must also use it when
12265 linking.
12266
12267 You can use the function attribute @code{no_instrument_function} to
12268 suppress profiling of individual functions when compiling with these options.
12269 @xref{Common Function Attributes}.
12270
12271 @item -fprofile-arcs
12272 @opindex fprofile-arcs
12273 Add code so that program flow @dfn{arcs} are instrumented. During
12274 execution the program records how many times each branch and call is
12275 executed and how many times it is taken or returns. On targets that support
12276 constructors with priority support, profiling properly handles constructors,
12277 destructors and C++ constructors (and destructors) of classes which are used
12278 as a type of a global variable.
12279
12280 When the compiled
12281 program exits it saves this data to a file called
12282 @file{@var{auxname}.gcda} for each source file. The data may be used for
12283 profile-directed optimizations (@option{-fbranch-probabilities}), or for
12284 test coverage analysis (@option{-ftest-coverage}). Each object file's
12285 @var{auxname} is generated from the name of the output file, if
12286 explicitly specified and it is not the final executable, otherwise it is
12287 the basename of the source file. In both cases any suffix is removed
12288 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
12289 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
12290 @xref{Cross-profiling}.
12291
12292 @cindex @command{gcov}
12293 @item --coverage
12294 @opindex coverage
12295
12296 This option is used to compile and link code instrumented for coverage
12297 analysis. The option is a synonym for @option{-fprofile-arcs}
12298 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
12299 linking). See the documentation for those options for more details.
12300
12301 @itemize
12302
12303 @item
12304 Compile the source files with @option{-fprofile-arcs} plus optimization
12305 and code generation options. For test coverage analysis, use the
12306 additional @option{-ftest-coverage} option. You do not need to profile
12307 every source file in a program.
12308
12309 @item
12310 Compile the source files additionally with @option{-fprofile-abs-path}
12311 to create absolute path names in the @file{.gcno} files. This allows
12312 @command{gcov} to find the correct sources in projects where compilations
12313 occur with different working directories.
12314
12315 @item
12316 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
12317 (the latter implies the former).
12318
12319 @item
12320 Run the program on a representative workload to generate the arc profile
12321 information. This may be repeated any number of times. You can run
12322 concurrent instances of your program, and provided that the file system
12323 supports locking, the data files will be correctly updated. Unless
12324 a strict ISO C dialect option is in effect, @code{fork} calls are
12325 detected and correctly handled without double counting.
12326
12327 @item
12328 For profile-directed optimizations, compile the source files again with
12329 the same optimization and code generation options plus
12330 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
12331 Control Optimization}).
12332
12333 @item
12334 For test coverage analysis, use @command{gcov} to produce human readable
12335 information from the @file{.gcno} and @file{.gcda} files. Refer to the
12336 @command{gcov} documentation for further information.
12337
12338 @end itemize
12339
12340 With @option{-fprofile-arcs}, for each function of your program GCC
12341 creates a program flow graph, then finds a spanning tree for the graph.
12342 Only arcs that are not on the spanning tree have to be instrumented: the
12343 compiler adds code to count the number of times that these arcs are
12344 executed. When an arc is the only exit or only entrance to a block, the
12345 instrumentation code can be added to the block; otherwise, a new basic
12346 block must be created to hold the instrumentation code.
12347
12348 @need 2000
12349 @item -ftest-coverage
12350 @opindex ftest-coverage
12351 Produce a notes file that the @command{gcov} code-coverage utility
12352 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
12353 show program coverage. Each source file's note file is called
12354 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
12355 above for a description of @var{auxname} and instructions on how to
12356 generate test coverage data. Coverage data matches the source files
12357 more closely if you do not optimize.
12358
12359 @item -fprofile-abs-path
12360 @opindex fprofile-abs-path
12361 Automatically convert relative source file names to absolute path names
12362 in the @file{.gcno} files. This allows @command{gcov} to find the correct
12363 sources in projects where compilations occur with different working
12364 directories.
12365
12366 @item -fprofile-dir=@var{path}
12367 @opindex fprofile-dir
12368
12369 Set the directory to search for the profile data files in to @var{path}.
12370 This option affects only the profile data generated by
12371 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
12372 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
12373 and its related options. Both absolute and relative paths can be used.
12374 By default, GCC uses the current directory as @var{path}, thus the
12375 profile data file appears in the same directory as the object file.
12376 In order to prevent the file name clashing, if the object file name is
12377 not an absolute path, we mangle the absolute path of the
12378 @file{@var{sourcename}.gcda} file and use it as the file name of a
12379 @file{.gcda} file.
12380
12381 When an executable is run in a massive parallel environment, it is recommended
12382 to save profile to different folders. That can be done with variables
12383 in @var{path} that are exported during run-time:
12384
12385 @table @gcctabopt
12386
12387 @item %p
12388 process ID.
12389
12390 @item %q@{VAR@}
12391 value of environment variable @var{VAR}
12392
12393 @end table
12394
12395 @item -fprofile-generate
12396 @itemx -fprofile-generate=@var{path}
12397 @opindex fprofile-generate
12398
12399 Enable options usually used for instrumenting application to produce
12400 profile useful for later recompilation with profile feedback based
12401 optimization. You must use @option{-fprofile-generate} both when
12402 compiling and when linking your program.
12403
12404 The following options are enabled:
12405 @option{-fprofile-arcs}, @option{-fprofile-values},
12406 @option{-finline-functions}, and @option{-fipa-bit-cp}.
12407
12408 If @var{path} is specified, GCC looks at the @var{path} to find
12409 the profile feedback data files. See @option{-fprofile-dir}.
12410
12411 To optimize the program based on the collected profile information, use
12412 @option{-fprofile-use}. @xref{Optimize Options}, for more information.
12413
12414 @item -fprofile-note=@var{path}
12415 @opindex fprofile-note
12416
12417 If @var{path} is specified, GCC saves gcno filename into @var{path} location.
12418
12419 @item -fprofile-update=@var{method}
12420 @opindex fprofile-update
12421
12422 Alter the update method for an application instrumented for profile
12423 feedback based optimization. The @var{method} argument should be one of
12424 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
12425 The first one is useful for single-threaded applications,
12426 while the second one prevents profile corruption by emitting thread-safe code.
12427
12428 @strong{Warning:} When an application does not properly join all threads
12429 (or creates an detached thread), a profile file can be still corrupted.
12430
12431 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
12432 when supported by a target, or to @samp{single} otherwise. The GCC driver
12433 automatically selects @samp{prefer-atomic} when @option{-pthread}
12434 is present in the command line.
12435
12436 @item -fprofile-filter-files=@var{regex}
12437 @opindex fprofile-filter-files
12438
12439 Instrument only functions from files where names match
12440 any regular expression (separated by a semi-colon).
12441
12442 For example, @option{-fprofile-filter-files=main.c;module.*.c} will instrument
12443 only @file{main.c} and all C files starting with 'module'.
12444
12445 @item -fprofile-exclude-files=@var{regex}
12446 @opindex fprofile-exclude-files
12447
12448 Instrument only functions from files where names do not match
12449 all the regular expressions (separated by a semi-colon).
12450
12451 For example, @option{-fprofile-exclude-files=/usr/*} will prevent instrumentation
12452 of all files that are located in @file{/usr/} folder.
12453
12454 @item -fsanitize=address
12455 @opindex fsanitize=address
12456 Enable AddressSanitizer, a fast memory error detector.
12457 Memory access instructions are instrumented to detect
12458 out-of-bounds and use-after-free bugs.
12459 The option enables @option{-fsanitize-address-use-after-scope}.
12460 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
12461 more details. The run-time behavior can be influenced using the
12462 @env{ASAN_OPTIONS} environment variable. When set to @code{help=1},
12463 the available options are shown at startup of the instrumented program. See
12464 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
12465 for a list of supported options.
12466 The option cannot be combined with @option{-fsanitize=thread}.
12467
12468 @item -fsanitize=kernel-address
12469 @opindex fsanitize=kernel-address
12470 Enable AddressSanitizer for Linux kernel.
12471 See @uref{https://github.com/google/kasan/wiki} for more details.
12472
12473 @item -fsanitize=pointer-compare
12474 @opindex fsanitize=pointer-compare
12475 Instrument comparison operation (<, <=, >, >=) with pointer operands.
12476 The option must be combined with either @option{-fsanitize=kernel-address} or
12477 @option{-fsanitize=address}
12478 The option cannot be combined with @option{-fsanitize=thread}.
12479 Note: By default the check is disabled at run time. To enable it,
12480 add @code{detect_invalid_pointer_pairs=2} to the environment variable
12481 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
12482 invalid operation only when both pointers are non-null.
12483
12484 @item -fsanitize=pointer-subtract
12485 @opindex fsanitize=pointer-subtract
12486 Instrument subtraction with pointer operands.
12487 The option must be combined with either @option{-fsanitize=kernel-address} or
12488 @option{-fsanitize=address}
12489 The option cannot be combined with @option{-fsanitize=thread}.
12490 Note: By default the check is disabled at run time. To enable it,
12491 add @code{detect_invalid_pointer_pairs=2} to the environment variable
12492 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
12493 invalid operation only when both pointers are non-null.
12494
12495 @item -fsanitize=thread
12496 @opindex fsanitize=thread
12497 Enable ThreadSanitizer, a fast data race detector.
12498 Memory access instructions are instrumented to detect
12499 data race bugs. See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
12500 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
12501 environment variable; see
12502 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
12503 supported options.
12504 The option cannot be combined with @option{-fsanitize=address},
12505 @option{-fsanitize=leak}.
12506
12507 Note that sanitized atomic builtins cannot throw exceptions when
12508 operating on invalid memory addresses with non-call exceptions
12509 (@option{-fnon-call-exceptions}).
12510
12511 @item -fsanitize=leak
12512 @opindex fsanitize=leak
12513 Enable LeakSanitizer, a memory leak detector.
12514 This option only matters for linking of executables and
12515 the executable is linked against a library that overrides @code{malloc}
12516 and other allocator functions. See
12517 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
12518 details. The run-time behavior can be influenced using the
12519 @env{LSAN_OPTIONS} environment variable.
12520 The option cannot be combined with @option{-fsanitize=thread}.
12521
12522 @item -fsanitize=undefined
12523 @opindex fsanitize=undefined
12524 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
12525 Various computations are instrumented to detect undefined behavior
12526 at runtime. Current suboptions are:
12527
12528 @table @gcctabopt
12529
12530 @item -fsanitize=shift
12531 @opindex fsanitize=shift
12532 This option enables checking that the result of a shift operation is
12533 not undefined. Note that what exactly is considered undefined differs
12534 slightly between C and C++, as well as between ISO C90 and C99, etc.
12535 This option has two suboptions, @option{-fsanitize=shift-base} and
12536 @option{-fsanitize=shift-exponent}.
12537
12538 @item -fsanitize=shift-exponent
12539 @opindex fsanitize=shift-exponent
12540 This option enables checking that the second argument of a shift operation
12541 is not negative and is smaller than the precision of the promoted first
12542 argument.
12543
12544 @item -fsanitize=shift-base
12545 @opindex fsanitize=shift-base
12546 If the second argument of a shift operation is within range, check that the
12547 result of a shift operation is not undefined. Note that what exactly is
12548 considered undefined differs slightly between C and C++, as well as between
12549 ISO C90 and C99, etc.
12550
12551 @item -fsanitize=integer-divide-by-zero
12552 @opindex fsanitize=integer-divide-by-zero
12553 Detect integer division by zero as well as @code{INT_MIN / -1} division.
12554
12555 @item -fsanitize=unreachable
12556 @opindex fsanitize=unreachable
12557 With this option, the compiler turns the @code{__builtin_unreachable}
12558 call into a diagnostics message call instead. When reaching the
12559 @code{__builtin_unreachable} call, the behavior is undefined.
12560
12561 @item -fsanitize=vla-bound
12562 @opindex fsanitize=vla-bound
12563 This option instructs the compiler to check that the size of a variable
12564 length array is positive.
12565
12566 @item -fsanitize=null
12567 @opindex fsanitize=null
12568 This option enables pointer checking. Particularly, the application
12569 built with this option turned on will issue an error message when it
12570 tries to dereference a NULL pointer, or if a reference (possibly an
12571 rvalue reference) is bound to a NULL pointer, or if a method is invoked
12572 on an object pointed by a NULL pointer.
12573
12574 @item -fsanitize=return
12575 @opindex fsanitize=return
12576 This option enables return statement checking. Programs
12577 built with this option turned on will issue an error message
12578 when the end of a non-void function is reached without actually
12579 returning a value. This option works in C++ only.
12580
12581 @item -fsanitize=signed-integer-overflow
12582 @opindex fsanitize=signed-integer-overflow
12583 This option enables signed integer overflow checking. We check that
12584 the result of @code{+}, @code{*}, and both unary and binary @code{-}
12585 does not overflow in the signed arithmetics. Note, integer promotion
12586 rules must be taken into account. That is, the following is not an
12587 overflow:
12588 @smallexample
12589 signed char a = SCHAR_MAX;
12590 a++;
12591 @end smallexample
12592
12593 @item -fsanitize=bounds
12594 @opindex fsanitize=bounds
12595 This option enables instrumentation of array bounds. Various out of bounds
12596 accesses are detected. Flexible array members, flexible array member-like
12597 arrays, and initializers of variables with static storage are not instrumented.
12598
12599 @item -fsanitize=bounds-strict
12600 @opindex fsanitize=bounds-strict
12601 This option enables strict instrumentation of array bounds. Most out of bounds
12602 accesses are detected, including flexible array members and flexible array
12603 member-like arrays. Initializers of variables with static storage are not
12604 instrumented.
12605
12606 @item -fsanitize=alignment
12607 @opindex fsanitize=alignment
12608
12609 This option enables checking of alignment of pointers when they are
12610 dereferenced, or when a reference is bound to insufficiently aligned target,
12611 or when a method or constructor is invoked on insufficiently aligned object.
12612
12613 @item -fsanitize=object-size
12614 @opindex fsanitize=object-size
12615 This option enables instrumentation of memory references using the
12616 @code{__builtin_object_size} function. Various out of bounds pointer
12617 accesses are detected.
12618
12619 @item -fsanitize=float-divide-by-zero
12620 @opindex fsanitize=float-divide-by-zero
12621 Detect floating-point division by zero. Unlike other similar options,
12622 @option{-fsanitize=float-divide-by-zero} is not enabled by
12623 @option{-fsanitize=undefined}, since floating-point division by zero can
12624 be a legitimate way of obtaining infinities and NaNs.
12625
12626 @item -fsanitize=float-cast-overflow
12627 @opindex fsanitize=float-cast-overflow
12628 This option enables floating-point type to integer conversion checking.
12629 We check that the result of the conversion does not overflow.
12630 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
12631 not enabled by @option{-fsanitize=undefined}.
12632 This option does not work well with @code{FE_INVALID} exceptions enabled.
12633
12634 @item -fsanitize=nonnull-attribute
12635 @opindex fsanitize=nonnull-attribute
12636
12637 This option enables instrumentation of calls, checking whether null values
12638 are not passed to arguments marked as requiring a non-null value by the
12639 @code{nonnull} function attribute.
12640
12641 @item -fsanitize=returns-nonnull-attribute
12642 @opindex fsanitize=returns-nonnull-attribute
12643
12644 This option enables instrumentation of return statements in functions
12645 marked with @code{returns_nonnull} function attribute, to detect returning
12646 of null values from such functions.
12647
12648 @item -fsanitize=bool
12649 @opindex fsanitize=bool
12650
12651 This option enables instrumentation of loads from bool. If a value other
12652 than 0/1 is loaded, a run-time error is issued.
12653
12654 @item -fsanitize=enum
12655 @opindex fsanitize=enum
12656
12657 This option enables instrumentation of loads from an enum type. If
12658 a value outside the range of values for the enum type is loaded,
12659 a run-time error is issued.
12660
12661 @item -fsanitize=vptr
12662 @opindex fsanitize=vptr
12663
12664 This option enables instrumentation of C++ member function calls, member
12665 accesses and some conversions between pointers to base and derived classes,
12666 to verify the referenced object has the correct dynamic type.
12667
12668 @item -fsanitize=pointer-overflow
12669 @opindex fsanitize=pointer-overflow
12670
12671 This option enables instrumentation of pointer arithmetics. If the pointer
12672 arithmetics overflows, a run-time error is issued.
12673
12674 @item -fsanitize=builtin
12675 @opindex fsanitize=builtin
12676
12677 This option enables instrumentation of arguments to selected builtin
12678 functions. If an invalid value is passed to such arguments, a run-time
12679 error is issued. E.g.@ passing 0 as the argument to @code{__builtin_ctz}
12680 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
12681 by this option.
12682
12683 @end table
12684
12685 While @option{-ftrapv} causes traps for signed overflows to be emitted,
12686 @option{-fsanitize=undefined} gives a diagnostic message.
12687 This currently works only for the C family of languages.
12688
12689 @item -fno-sanitize=all
12690 @opindex fno-sanitize=all
12691
12692 This option disables all previously enabled sanitizers.
12693 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
12694 together.
12695
12696 @item -fasan-shadow-offset=@var{number}
12697 @opindex fasan-shadow-offset
12698 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
12699 It is useful for experimenting with different shadow memory layouts in
12700 Kernel AddressSanitizer.
12701
12702 @item -fsanitize-sections=@var{s1},@var{s2},...
12703 @opindex fsanitize-sections
12704 Sanitize global variables in selected user-defined sections. @var{si} may
12705 contain wildcards.
12706
12707 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
12708 @opindex fsanitize-recover
12709 @opindex fno-sanitize-recover
12710 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
12711 mentioned in comma-separated list of @var{opts}. Enabling this option
12712 for a sanitizer component causes it to attempt to continue
12713 running the program as if no error happened. This means multiple
12714 runtime errors can be reported in a single program run, and the exit
12715 code of the program may indicate success even when errors
12716 have been reported. The @option{-fno-sanitize-recover=} option
12717 can be used to alter
12718 this behavior: only the first detected error is reported
12719 and program then exits with a non-zero exit code.
12720
12721 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
12722 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
12723 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
12724 @option{-fsanitize=bounds-strict},
12725 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
12726 For these sanitizers error recovery is turned on by default,
12727 except @option{-fsanitize=address}, for which this feature is experimental.
12728 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
12729 accepted, the former enables recovery for all sanitizers that support it,
12730 the latter disables recovery for all sanitizers that support it.
12731
12732 Even if a recovery mode is turned on the compiler side, it needs to be also
12733 enabled on the runtime library side, otherwise the failures are still fatal.
12734 The runtime library defaults to @code{halt_on_error=0} for
12735 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
12736 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
12737 setting the @code{halt_on_error} flag in the corresponding environment variable.
12738
12739 Syntax without an explicit @var{opts} parameter is deprecated. It is
12740 equivalent to specifying an @var{opts} list of:
12741
12742 @smallexample
12743 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
12744 @end smallexample
12745
12746 @item -fsanitize-address-use-after-scope
12747 @opindex fsanitize-address-use-after-scope
12748 Enable sanitization of local variables to detect use-after-scope bugs.
12749 The option sets @option{-fstack-reuse} to @samp{none}.
12750
12751 @item -fsanitize-undefined-trap-on-error
12752 @opindex fsanitize-undefined-trap-on-error
12753 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
12754 report undefined behavior using @code{__builtin_trap} rather than
12755 a @code{libubsan} library routine. The advantage of this is that the
12756 @code{libubsan} library is not needed and is not linked in, so this
12757 is usable even in freestanding environments.
12758
12759 @item -fsanitize-coverage=trace-pc
12760 @opindex fsanitize-coverage=trace-pc
12761 Enable coverage-guided fuzzing code instrumentation.
12762 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
12763
12764 @item -fsanitize-coverage=trace-cmp
12765 @opindex fsanitize-coverage=trace-cmp
12766 Enable dataflow guided fuzzing code instrumentation.
12767 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
12768 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
12769 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
12770 variable or @code{__sanitizer_cov_trace_const_cmp1},
12771 @code{__sanitizer_cov_trace_const_cmp2},
12772 @code{__sanitizer_cov_trace_const_cmp4} or
12773 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
12774 operand constant, @code{__sanitizer_cov_trace_cmpf} or
12775 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
12776 @code{__sanitizer_cov_trace_switch} for switch statements.
12777
12778 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
12779 @opindex fcf-protection
12780 Enable code instrumentation of control-flow transfers to increase
12781 program security by checking that target addresses of control-flow
12782 transfer instructions (such as indirect function call, function return,
12783 indirect jump) are valid. This prevents diverting the flow of control
12784 to an unexpected target. This is intended to protect against such
12785 threats as Return-oriented Programming (ROP), and similarly
12786 call/jmp-oriented programming (COP/JOP).
12787
12788 The value @code{branch} tells the compiler to implement checking of
12789 validity of control-flow transfer at the point of indirect branch
12790 instructions, i.e.@: call/jmp instructions. The value @code{return}
12791 implements checking of validity at the point of returning from a
12792 function. The value @code{full} is an alias for specifying both
12793 @code{branch} and @code{return}. The value @code{none} turns off
12794 instrumentation.
12795
12796 The macro @code{__CET__} is defined when @option{-fcf-protection} is
12797 used. The first bit of @code{__CET__} is set to 1 for the value
12798 @code{branch} and the second bit of @code{__CET__} is set to 1 for
12799 the @code{return}.
12800
12801 You can also use the @code{nocf_check} attribute to identify
12802 which functions and calls should be skipped from instrumentation
12803 (@pxref{Function Attributes}).
12804
12805 Currently the x86 GNU/Linux target provides an implementation based
12806 on Intel Control-flow Enforcement Technology (CET).
12807
12808 @item -fstack-protector
12809 @opindex fstack-protector
12810 Emit extra code to check for buffer overflows, such as stack smashing
12811 attacks. This is done by adding a guard variable to functions with
12812 vulnerable objects. This includes functions that call @code{alloca}, and
12813 functions with buffers larger than 8 bytes. The guards are initialized
12814 when a function is entered and then checked when the function exits.
12815 If a guard check fails, an error message is printed and the program exits.
12816
12817 @item -fstack-protector-all
12818 @opindex fstack-protector-all
12819 Like @option{-fstack-protector} except that all functions are protected.
12820
12821 @item -fstack-protector-strong
12822 @opindex fstack-protector-strong
12823 Like @option{-fstack-protector} but includes additional functions to
12824 be protected --- those that have local array definitions, or have
12825 references to local frame addresses.
12826
12827 @item -fstack-protector-explicit
12828 @opindex fstack-protector-explicit
12829 Like @option{-fstack-protector} but only protects those functions which
12830 have the @code{stack_protect} attribute.
12831
12832 @item -fstack-check
12833 @opindex fstack-check
12834 Generate code to verify that you do not go beyond the boundary of the
12835 stack. You should specify this flag if you are running in an
12836 environment with multiple threads, but you only rarely need to specify it in
12837 a single-threaded environment since stack overflow is automatically
12838 detected on nearly all systems if there is only one stack.
12839
12840 Note that this switch does not actually cause checking to be done; the
12841 operating system or the language runtime must do that. The switch causes
12842 generation of code to ensure that they see the stack being extended.
12843
12844 You can additionally specify a string parameter: @samp{no} means no
12845 checking, @samp{generic} means force the use of old-style checking,
12846 @samp{specific} means use the best checking method and is equivalent
12847 to bare @option{-fstack-check}.
12848
12849 Old-style checking is a generic mechanism that requires no specific
12850 target support in the compiler but comes with the following drawbacks:
12851
12852 @enumerate
12853 @item
12854 Modified allocation strategy for large objects: they are always
12855 allocated dynamically if their size exceeds a fixed threshold. Note this
12856 may change the semantics of some code.
12857
12858 @item
12859 Fixed limit on the size of the static frame of functions: when it is
12860 topped by a particular function, stack checking is not reliable and
12861 a warning is issued by the compiler.
12862
12863 @item
12864 Inefficiency: because of both the modified allocation strategy and the
12865 generic implementation, code performance is hampered.
12866 @end enumerate
12867
12868 Note that old-style stack checking is also the fallback method for
12869 @samp{specific} if no target support has been added in the compiler.
12870
12871 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
12872 and stack overflows. @samp{specific} is an excellent choice when compiling
12873 Ada code. It is not generally sufficient to protect against stack-clash
12874 attacks. To protect against those you want @samp{-fstack-clash-protection}.
12875
12876 @item -fstack-clash-protection
12877 @opindex fstack-clash-protection
12878 Generate code to prevent stack clash style attacks. When this option is
12879 enabled, the compiler will only allocate one page of stack space at a time
12880 and each page is accessed immediately after allocation. Thus, it prevents
12881 allocations from jumping over any stack guard page provided by the
12882 operating system.
12883
12884 Most targets do not fully support stack clash protection. However, on
12885 those targets @option{-fstack-clash-protection} will protect dynamic stack
12886 allocations. @option{-fstack-clash-protection} may also provide limited
12887 protection for static stack allocations if the target supports
12888 @option{-fstack-check=specific}.
12889
12890 @item -fstack-limit-register=@var{reg}
12891 @itemx -fstack-limit-symbol=@var{sym}
12892 @itemx -fno-stack-limit
12893 @opindex fstack-limit-register
12894 @opindex fstack-limit-symbol
12895 @opindex fno-stack-limit
12896 Generate code to ensure that the stack does not grow beyond a certain value,
12897 either the value of a register or the address of a symbol. If a larger
12898 stack is required, a signal is raised at run time. For most targets,
12899 the signal is raised before the stack overruns the boundary, so
12900 it is possible to catch the signal without taking special precautions.
12901
12902 For instance, if the stack starts at absolute address @samp{0x80000000}
12903 and grows downwards, you can use the flags
12904 @option{-fstack-limit-symbol=__stack_limit} and
12905 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12906 of 128KB@. Note that this may only work with the GNU linker.
12907
12908 You can locally override stack limit checking by using the
12909 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
12910
12911 @item -fsplit-stack
12912 @opindex fsplit-stack
12913 Generate code to automatically split the stack before it overflows.
12914 The resulting program has a discontiguous stack which can only
12915 overflow if the program is unable to allocate any more memory. This
12916 is most useful when running threaded programs, as it is no longer
12917 necessary to calculate a good stack size to use for each thread. This
12918 is currently only implemented for the x86 targets running
12919 GNU/Linux.
12920
12921 When code compiled with @option{-fsplit-stack} calls code compiled
12922 without @option{-fsplit-stack}, there may not be much stack space
12923 available for the latter code to run. If compiling all code,
12924 including library code, with @option{-fsplit-stack} is not an option,
12925 then the linker can fix up these calls so that the code compiled
12926 without @option{-fsplit-stack} always has a large stack. Support for
12927 this is implemented in the gold linker in GNU binutils release 2.21
12928 and later.
12929
12930 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
12931 @opindex fvtable-verify
12932 This option is only available when compiling C++ code.
12933 It turns on (or off, if using @option{-fvtable-verify=none}) the security
12934 feature that verifies at run time, for every virtual call, that
12935 the vtable pointer through which the call is made is valid for the type of
12936 the object, and has not been corrupted or overwritten. If an invalid vtable
12937 pointer is detected at run time, an error is reported and execution of the
12938 program is immediately halted.
12939
12940 This option causes run-time data structures to be built at program startup,
12941 which are used for verifying the vtable pointers.
12942 The options @samp{std} and @samp{preinit}
12943 control the timing of when these data structures are built. In both cases the
12944 data structures are built before execution reaches @code{main}. Using
12945 @option{-fvtable-verify=std} causes the data structures to be built after
12946 shared libraries have been loaded and initialized.
12947 @option{-fvtable-verify=preinit} causes them to be built before shared
12948 libraries have been loaded and initialized.
12949
12950 If this option appears multiple times in the command line with different
12951 values specified, @samp{none} takes highest priority over both @samp{std} and
12952 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
12953
12954 @item -fvtv-debug
12955 @opindex fvtv-debug
12956 When used in conjunction with @option{-fvtable-verify=std} or
12957 @option{-fvtable-verify=preinit}, causes debug versions of the
12958 runtime functions for the vtable verification feature to be called.
12959 This flag also causes the compiler to log information about which
12960 vtable pointers it finds for each class.
12961 This information is written to a file named @file{vtv_set_ptr_data.log}
12962 in the directory named by the environment variable @env{VTV_LOGS_DIR}
12963 if that is defined or the current working directory otherwise.
12964
12965 Note: This feature @emph{appends} data to the log file. If you want a fresh log
12966 file, be sure to delete any existing one.
12967
12968 @item -fvtv-counts
12969 @opindex fvtv-counts
12970 This is a debugging flag. When used in conjunction with
12971 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
12972 causes the compiler to keep track of the total number of virtual calls
12973 it encounters and the number of verifications it inserts. It also
12974 counts the number of calls to certain run-time library functions
12975 that it inserts and logs this information for each compilation unit.
12976 The compiler writes this information to a file named
12977 @file{vtv_count_data.log} in the directory named by the environment
12978 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12979 directory otherwise. It also counts the size of the vtable pointer sets
12980 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12981 in the same directory.
12982
12983 Note: This feature @emph{appends} data to the log files. To get fresh log
12984 files, be sure to delete any existing ones.
12985
12986 @item -finstrument-functions
12987 @opindex finstrument-functions
12988 Generate instrumentation calls for entry and exit to functions. Just
12989 after function entry and just before function exit, the following
12990 profiling functions are called with the address of the current
12991 function and its call site. (On some platforms,
12992 @code{__builtin_return_address} does not work beyond the current
12993 function, so the call site information may not be available to the
12994 profiling functions otherwise.)
12995
12996 @smallexample
12997 void __cyg_profile_func_enter (void *this_fn,
12998 void *call_site);
12999 void __cyg_profile_func_exit (void *this_fn,
13000 void *call_site);
13001 @end smallexample
13002
13003 The first argument is the address of the start of the current function,
13004 which may be looked up exactly in the symbol table.
13005
13006 This instrumentation is also done for functions expanded inline in other
13007 functions. The profiling calls indicate where, conceptually, the
13008 inline function is entered and exited. This means that addressable
13009 versions of such functions must be available. If all your uses of a
13010 function are expanded inline, this may mean an additional expansion of
13011 code size. If you use @code{extern inline} in your C code, an
13012 addressable version of such functions must be provided. (This is
13013 normally the case anyway, but if you get lucky and the optimizer always
13014 expands the functions inline, you might have gotten away without
13015 providing static copies.)
13016
13017 A function may be given the attribute @code{no_instrument_function}, in
13018 which case this instrumentation is not done. This can be used, for
13019 example, for the profiling functions listed above, high-priority
13020 interrupt routines, and any functions from which the profiling functions
13021 cannot safely be called (perhaps signal handlers, if the profiling
13022 routines generate output or allocate memory).
13023 @xref{Common Function Attributes}.
13024
13025 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
13026 @opindex finstrument-functions-exclude-file-list
13027
13028 Set the list of functions that are excluded from instrumentation (see
13029 the description of @option{-finstrument-functions}). If the file that
13030 contains a function definition matches with one of @var{file}, then
13031 that function is not instrumented. The match is done on substrings:
13032 if the @var{file} parameter is a substring of the file name, it is
13033 considered to be a match.
13034
13035 For example:
13036
13037 @smallexample
13038 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
13039 @end smallexample
13040
13041 @noindent
13042 excludes any inline function defined in files whose pathnames
13043 contain @file{/bits/stl} or @file{include/sys}.
13044
13045 If, for some reason, you want to include letter @samp{,} in one of
13046 @var{sym}, write @samp{\,}. For example,
13047 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
13048 (note the single quote surrounding the option).
13049
13050 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
13051 @opindex finstrument-functions-exclude-function-list
13052
13053 This is similar to @option{-finstrument-functions-exclude-file-list},
13054 but this option sets the list of function names to be excluded from
13055 instrumentation. The function name to be matched is its user-visible
13056 name, such as @code{vector<int> blah(const vector<int> &)}, not the
13057 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}). The
13058 match is done on substrings: if the @var{sym} parameter is a substring
13059 of the function name, it is considered to be a match. For C99 and C++
13060 extended identifiers, the function name must be given in UTF-8, not
13061 using universal character names.
13062
13063 @item -fpatchable-function-entry=@var{N}[,@var{M}]
13064 @opindex fpatchable-function-entry
13065 Generate @var{N} NOPs right at the beginning
13066 of each function, with the function entry point before the @var{M}th NOP.
13067 If @var{M} is omitted, it defaults to @code{0} so the
13068 function entry points to the address just at the first NOP.
13069 The NOP instructions reserve extra space which can be used to patch in
13070 any desired instrumentation at run time, provided that the code segment
13071 is writable. The amount of space is controllable indirectly via
13072 the number of NOPs; the NOP instruction used corresponds to the instruction
13073 emitted by the internal GCC back-end interface @code{gen_nop}. This behavior
13074 is target-specific and may also depend on the architecture variant and/or
13075 other compilation options.
13076
13077 For run-time identification, the starting addresses of these areas,
13078 which correspond to their respective function entries minus @var{M},
13079 are additionally collected in the @code{__patchable_function_entries}
13080 section of the resulting binary.
13081
13082 Note that the value of @code{__attribute__ ((patchable_function_entry
13083 (N,M)))} takes precedence over command-line option
13084 @option{-fpatchable-function-entry=N,M}. This can be used to increase
13085 the area size or to remove it completely on a single function.
13086 If @code{N=0}, no pad location is recorded.
13087
13088 The NOP instructions are inserted at---and maybe before, depending on
13089 @var{M}---the function entry address, even before the prologue.
13090
13091 @end table
13092
13093
13094 @node Preprocessor Options
13095 @section Options Controlling the Preprocessor
13096 @cindex preprocessor options
13097 @cindex options, preprocessor
13098
13099 These options control the C preprocessor, which is run on each C source
13100 file before actual compilation.
13101
13102 If you use the @option{-E} option, nothing is done except preprocessing.
13103 Some of these options make sense only together with @option{-E} because
13104 they cause the preprocessor output to be unsuitable for actual
13105 compilation.
13106
13107 In addition to the options listed here, there are a number of options
13108 to control search paths for include files documented in
13109 @ref{Directory Options}.
13110 Options to control preprocessor diagnostics are listed in
13111 @ref{Warning Options}.
13112
13113 @table @gcctabopt
13114 @include cppopts.texi
13115
13116 @item -Wp,@var{option}
13117 @opindex Wp
13118 You can use @option{-Wp,@var{option}} to bypass the compiler driver
13119 and pass @var{option} directly through to the preprocessor. If
13120 @var{option} contains commas, it is split into multiple options at the
13121 commas. However, many options are modified, translated or interpreted
13122 by the compiler driver before being passed to the preprocessor, and
13123 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
13124 interface is undocumented and subject to change, so whenever possible
13125 you should avoid using @option{-Wp} and let the driver handle the
13126 options instead.
13127
13128 @item -Xpreprocessor @var{option}
13129 @opindex Xpreprocessor
13130 Pass @var{option} as an option to the preprocessor. You can use this to
13131 supply system-specific preprocessor options that GCC does not
13132 recognize.
13133
13134 If you want to pass an option that takes an argument, you must use
13135 @option{-Xpreprocessor} twice, once for the option and once for the argument.
13136
13137 @item -no-integrated-cpp
13138 @opindex no-integrated-cpp
13139 Perform preprocessing as a separate pass before compilation.
13140 By default, GCC performs preprocessing as an integrated part of
13141 input tokenization and parsing.
13142 If this option is provided, the appropriate language front end
13143 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
13144 and Objective-C, respectively) is instead invoked twice,
13145 once for preprocessing only and once for actual compilation
13146 of the preprocessed input.
13147 This option may be useful in conjunction with the @option{-B} or
13148 @option{-wrapper} options to specify an alternate preprocessor or
13149 perform additional processing of the program source between
13150 normal preprocessing and compilation.
13151
13152 @end table
13153
13154 @node Assembler Options
13155 @section Passing Options to the Assembler
13156
13157 @c prevent bad page break with this line
13158 You can pass options to the assembler.
13159
13160 @table @gcctabopt
13161 @item -Wa,@var{option}
13162 @opindex Wa
13163 Pass @var{option} as an option to the assembler. If @var{option}
13164 contains commas, it is split into multiple options at the commas.
13165
13166 @item -Xassembler @var{option}
13167 @opindex Xassembler
13168 Pass @var{option} as an option to the assembler. You can use this to
13169 supply system-specific assembler options that GCC does not
13170 recognize.
13171
13172 If you want to pass an option that takes an argument, you must use
13173 @option{-Xassembler} twice, once for the option and once for the argument.
13174
13175 @end table
13176
13177 @node Link Options
13178 @section Options for Linking
13179 @cindex link options
13180 @cindex options, linking
13181
13182 These options come into play when the compiler links object files into
13183 an executable output file. They are meaningless if the compiler is
13184 not doing a link step.
13185
13186 @table @gcctabopt
13187 @cindex file names
13188 @item @var{object-file-name}
13189 A file name that does not end in a special recognized suffix is
13190 considered to name an object file or library. (Object files are
13191 distinguished from libraries by the linker according to the file
13192 contents.) If linking is done, these object files are used as input
13193 to the linker.
13194
13195 @item -c
13196 @itemx -S
13197 @itemx -E
13198 @opindex c
13199 @opindex S
13200 @opindex E
13201 If any of these options is used, then the linker is not run, and
13202 object file names should not be used as arguments. @xref{Overall
13203 Options}.
13204
13205 @item -flinker-output=@var{type}
13206 @opindex flinker-output
13207 This option controls code generation of the link-time optimizer. By
13208 default the linker output is automatically determined by the linker
13209 plugin. For debugging the compiler and if incremental linking with a
13210 non-LTO object file is desired, it may be useful to control the type
13211 manually.
13212
13213 If @var{type} is @samp{exec}, code generation produces a static
13214 binary. In this case @option{-fpic} and @option{-fpie} are both
13215 disabled.
13216
13217 If @var{type} is @samp{dyn}, code generation produces a shared
13218 library. In this case @option{-fpic} or @option{-fPIC} is preserved,
13219 but not enabled automatically. This allows to build shared libraries
13220 without position-independent code on architectures where this is
13221 possible, i.e.@: on x86.
13222
13223 If @var{type} is @samp{pie}, code generation produces an @option{-fpie}
13224 executable. This results in similar optimizations as @samp{exec}
13225 except that @option{-fpie} is not disabled if specified at compilation
13226 time.
13227
13228 If @var{type} is @samp{rel}, the compiler assumes that incremental linking is
13229 done. The sections containing intermediate code for link-time optimization are
13230 merged, pre-optimized, and output to the resulting object file. In addition, if
13231 @option{-ffat-lto-objects} is specified, binary code is produced for future
13232 non-LTO linking. The object file produced by incremental linking is smaller
13233 than a static library produced from the same object files. At link time the
13234 result of incremental linking also loads faster than a static
13235 library assuming that the majority of objects in the library are used.
13236
13237 Finally @samp{nolto-rel} configures the compiler for incremental linking where
13238 code generation is forced, a final binary is produced, and the intermediate
13239 code for later link-time optimization is stripped. When multiple object files
13240 are linked together the resulting code is better optimized than with
13241 link-time optimizations disabled (for example, cross-module inlining
13242 happens), but most of benefits of whole program optimizations are lost.
13243
13244 During the incremental link (by @option{-r}) the linker plugin defaults to
13245 @option{rel}. With current interfaces to GNU Binutils it is however not
13246 possible to incrementally link LTO objects and non-LTO objects into a single
13247 mixed object file. If any of object files in incremental link cannot
13248 be used for link-time optimization, the linker plugin issues a warning and
13249 uses @samp{nolto-rel}. To maintain whole program optimization, it is
13250 recommended to link such objects into static library instead. Alternatively it
13251 is possible to use H.J. Lu's binutils with support for mixed objects.
13252
13253 @item -fuse-ld=bfd
13254 @opindex fuse-ld=bfd
13255 Use the @command{bfd} linker instead of the default linker.
13256
13257 @item -fuse-ld=gold
13258 @opindex fuse-ld=gold
13259 Use the @command{gold} linker instead of the default linker.
13260
13261 @item -fuse-ld=lld
13262 @opindex fuse-ld=lld
13263 Use the LLVM @command{lld} linker instead of the default linker.
13264
13265 @cindex Libraries
13266 @item -l@var{library}
13267 @itemx -l @var{library}
13268 @opindex l
13269 Search the library named @var{library} when linking. (The second
13270 alternative with the library as a separate argument is only for
13271 POSIX compliance and is not recommended.)
13272
13273 The @option{-l} option is passed directly to the linker by GCC. Refer
13274 to your linker documentation for exact details. The general
13275 description below applies to the GNU linker.
13276
13277 The linker searches a standard list of directories for the library.
13278 The directories searched include several standard system directories
13279 plus any that you specify with @option{-L}.
13280
13281 Static libraries are archives of object files, and have file names
13282 like @file{lib@var{library}.a}. Some targets also support shared
13283 libraries, which typically have names like @file{lib@var{library}.so}.
13284 If both static and shared libraries are found, the linker gives
13285 preference to linking with the shared library unless the
13286 @option{-static} option is used.
13287
13288 It makes a difference where in the command you write this option; the
13289 linker searches and processes libraries and object files in the order they
13290 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
13291 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
13292 to functions in @samp{z}, those functions may not be loaded.
13293
13294 @item -lobjc
13295 @opindex lobjc
13296 You need this special case of the @option{-l} option in order to
13297 link an Objective-C or Objective-C++ program.
13298
13299 @item -nostartfiles
13300 @opindex nostartfiles
13301 Do not use the standard system startup files when linking.
13302 The standard system libraries are used normally, unless @option{-nostdlib},
13303 @option{-nolibc}, or @option{-nodefaultlibs} is used.
13304
13305 @item -nodefaultlibs
13306 @opindex nodefaultlibs
13307 Do not use the standard system libraries when linking.
13308 Only the libraries you specify are passed to the linker, and options
13309 specifying linkage of the system libraries, such as @option{-static-libgcc}
13310 or @option{-shared-libgcc}, are ignored.
13311 The standard startup files are used normally, unless @option{-nostartfiles}
13312 is used.
13313
13314 The compiler may generate calls to @code{memcmp},
13315 @code{memset}, @code{memcpy} and @code{memmove}.
13316 These entries are usually resolved by entries in
13317 libc. These entry points should be supplied through some other
13318 mechanism when this option is specified.
13319
13320 @item -nolibc
13321 @opindex nolibc
13322 Do not use the C library or system libraries tightly coupled with it when
13323 linking. Still link with the startup files, @file{libgcc} or toolchain
13324 provided language support libraries such as @file{libgnat}, @file{libgfortran}
13325 or @file{libstdc++} unless options preventing their inclusion are used as
13326 well. This typically removes @option{-lc} from the link command line, as well
13327 as system libraries that normally go with it and become meaningless when
13328 absence of a C library is assumed, for example @option{-lpthread} or
13329 @option{-lm} in some configurations. This is intended for bare-board
13330 targets when there is indeed no C library available.
13331
13332 @item -nostdlib
13333 @opindex nostdlib
13334 Do not use the standard system startup files or libraries when linking.
13335 No startup files and only the libraries you specify are passed to
13336 the linker, and options specifying linkage of the system libraries, such as
13337 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
13338
13339 The compiler may generate calls to @code{memcmp}, @code{memset},
13340 @code{memcpy} and @code{memmove}.
13341 These entries are usually resolved by entries in
13342 libc. These entry points should be supplied through some other
13343 mechanism when this option is specified.
13344
13345 @cindex @option{-lgcc}, use with @option{-nostdlib}
13346 @cindex @option{-nostdlib} and unresolved references
13347 @cindex unresolved references and @option{-nostdlib}
13348 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
13349 @cindex @option{-nodefaultlibs} and unresolved references
13350 @cindex unresolved references and @option{-nodefaultlibs}
13351 One of the standard libraries bypassed by @option{-nostdlib} and
13352 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
13353 which GCC uses to overcome shortcomings of particular machines, or special
13354 needs for some languages.
13355 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
13356 Collection (GCC) Internals},
13357 for more discussion of @file{libgcc.a}.)
13358 In most cases, you need @file{libgcc.a} even when you want to avoid
13359 other standard libraries. In other words, when you specify @option{-nostdlib}
13360 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
13361 This ensures that you have no unresolved references to internal GCC
13362 library subroutines.
13363 (An example of such an internal subroutine is @code{__main}, used to ensure C++
13364 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
13365 GNU Compiler Collection (GCC) Internals}.)
13366
13367 @item -e @var{entry}
13368 @itemx --entry=@var{entry}
13369 @opindex e
13370 @opindex entry
13371
13372 Specify that the program entry point is @var{entry}. The argument is
13373 interpreted by the linker; the GNU linker accepts either a symbol name
13374 or an address.
13375
13376 @item -pie
13377 @opindex pie
13378 Produce a dynamically linked position independent executable on targets
13379 that support it. For predictable results, you must also specify the same
13380 set of options used for compilation (@option{-fpie}, @option{-fPIE},
13381 or model suboptions) when you specify this linker option.
13382
13383 @item -no-pie
13384 @opindex no-pie
13385 Don't produce a dynamically linked position independent executable.
13386
13387 @item -static-pie
13388 @opindex static-pie
13389 Produce a static position independent executable on targets that support
13390 it. A static position independent executable is similar to a static
13391 executable, but can be loaded at any address without a dynamic linker.
13392 For predictable results, you must also specify the same set of options
13393 used for compilation (@option{-fpie}, @option{-fPIE}, or model
13394 suboptions) when you specify this linker option.
13395
13396 @item -pthread
13397 @opindex pthread
13398 Link with the POSIX threads library. This option is supported on
13399 GNU/Linux targets, most other Unix derivatives, and also on
13400 x86 Cygwin and MinGW targets. On some targets this option also sets
13401 flags for the preprocessor, so it should be used consistently for both
13402 compilation and linking.
13403
13404 @item -r
13405 @opindex r
13406 Produce a relocatable object as output. This is also known as partial
13407 linking.
13408
13409 @item -rdynamic
13410 @opindex rdynamic
13411 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
13412 that support it. This instructs the linker to add all symbols, not
13413 only used ones, to the dynamic symbol table. This option is needed
13414 for some uses of @code{dlopen} or to allow obtaining backtraces
13415 from within a program.
13416
13417 @item -s
13418 @opindex s
13419 Remove all symbol table and relocation information from the executable.
13420
13421 @item -static
13422 @opindex static
13423 On systems that support dynamic linking, this overrides @option{-pie}
13424 and prevents linking with the shared libraries. On other systems, this
13425 option has no effect.
13426
13427 @item -shared
13428 @opindex shared
13429 Produce a shared object which can then be linked with other objects to
13430 form an executable. Not all systems support this option. For predictable
13431 results, you must also specify the same set of options used for compilation
13432 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
13433 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
13434 needs to build supplementary stub code for constructors to work. On
13435 multi-libbed systems, @samp{gcc -shared} must select the correct support
13436 libraries to link against. Failing to supply the correct flags may lead
13437 to subtle defects. Supplying them in cases where they are not necessary
13438 is innocuous.}
13439
13440 @item -shared-libgcc
13441 @itemx -static-libgcc
13442 @opindex shared-libgcc
13443 @opindex static-libgcc
13444 On systems that provide @file{libgcc} as a shared library, these options
13445 force the use of either the shared or static version, respectively.
13446 If no shared version of @file{libgcc} was built when the compiler was
13447 configured, these options have no effect.
13448
13449 There are several situations in which an application should use the
13450 shared @file{libgcc} instead of the static version. The most common
13451 of these is when the application wishes to throw and catch exceptions
13452 across different shared libraries. In that case, each of the libraries
13453 as well as the application itself should use the shared @file{libgcc}.
13454
13455 Therefore, the G++ driver automatically adds @option{-shared-libgcc}
13456 whenever you build a shared library or a main executable, because C++
13457 programs typically use exceptions, so this is the right thing to do.
13458
13459 If, instead, you use the GCC driver to create shared libraries, you may
13460 find that they are not always linked with the shared @file{libgcc}.
13461 If GCC finds, at its configuration time, that you have a non-GNU linker
13462 or a GNU linker that does not support option @option{--eh-frame-hdr},
13463 it links the shared version of @file{libgcc} into shared libraries
13464 by default. Otherwise, it takes advantage of the linker and optimizes
13465 away the linking with the shared version of @file{libgcc}, linking with
13466 the static version of libgcc by default. This allows exceptions to
13467 propagate through such shared libraries, without incurring relocation
13468 costs at library load time.
13469
13470 However, if a library or main executable is supposed to throw or catch
13471 exceptions, you must link it using the G++ driver, or using the option
13472 @option{-shared-libgcc}, such that it is linked with the shared
13473 @file{libgcc}.
13474
13475 @item -static-libasan
13476 @opindex static-libasan
13477 When the @option{-fsanitize=address} option is used to link a program,
13478 the GCC driver automatically links against @option{libasan}. If
13479 @file{libasan} is available as a shared library, and the @option{-static}
13480 option is not used, then this links against the shared version of
13481 @file{libasan}. The @option{-static-libasan} option directs the GCC
13482 driver to link @file{libasan} statically, without necessarily linking
13483 other libraries statically.
13484
13485 @item -static-libtsan
13486 @opindex static-libtsan
13487 When the @option{-fsanitize=thread} option is used to link a program,
13488 the GCC driver automatically links against @option{libtsan}. If
13489 @file{libtsan} is available as a shared library, and the @option{-static}
13490 option is not used, then this links against the shared version of
13491 @file{libtsan}. The @option{-static-libtsan} option directs the GCC
13492 driver to link @file{libtsan} statically, without necessarily linking
13493 other libraries statically.
13494
13495 @item -static-liblsan
13496 @opindex static-liblsan
13497 When the @option{-fsanitize=leak} option is used to link a program,
13498 the GCC driver automatically links against @option{liblsan}. If
13499 @file{liblsan} is available as a shared library, and the @option{-static}
13500 option is not used, then this links against the shared version of
13501 @file{liblsan}. The @option{-static-liblsan} option directs the GCC
13502 driver to link @file{liblsan} statically, without necessarily linking
13503 other libraries statically.
13504
13505 @item -static-libubsan
13506 @opindex static-libubsan
13507 When the @option{-fsanitize=undefined} option is used to link a program,
13508 the GCC driver automatically links against @option{libubsan}. If
13509 @file{libubsan} is available as a shared library, and the @option{-static}
13510 option is not used, then this links against the shared version of
13511 @file{libubsan}. The @option{-static-libubsan} option directs the GCC
13512 driver to link @file{libubsan} statically, without necessarily linking
13513 other libraries statically.
13514
13515 @item -static-libstdc++
13516 @opindex static-libstdc++
13517 When the @command{g++} program is used to link a C++ program, it
13518 normally automatically links against @option{libstdc++}. If
13519 @file{libstdc++} is available as a shared library, and the
13520 @option{-static} option is not used, then this links against the
13521 shared version of @file{libstdc++}. That is normally fine. However, it
13522 is sometimes useful to freeze the version of @file{libstdc++} used by
13523 the program without going all the way to a fully static link. The
13524 @option{-static-libstdc++} option directs the @command{g++} driver to
13525 link @file{libstdc++} statically, without necessarily linking other
13526 libraries statically.
13527
13528 @item -symbolic
13529 @opindex symbolic
13530 Bind references to global symbols when building a shared object. Warn
13531 about any unresolved references (unless overridden by the link editor
13532 option @option{-Xlinker -z -Xlinker defs}). Only a few systems support
13533 this option.
13534
13535 @item -T @var{script}
13536 @opindex T
13537 @cindex linker script
13538 Use @var{script} as the linker script. This option is supported by most
13539 systems using the GNU linker. On some targets, such as bare-board
13540 targets without an operating system, the @option{-T} option may be required
13541 when linking to avoid references to undefined symbols.
13542
13543 @item -Xlinker @var{option}
13544 @opindex Xlinker
13545 Pass @var{option} as an option to the linker. You can use this to
13546 supply system-specific linker options that GCC does not recognize.
13547
13548 If you want to pass an option that takes a separate argument, you must use
13549 @option{-Xlinker} twice, once for the option and once for the argument.
13550 For example, to pass @option{-assert definitions}, you must write
13551 @option{-Xlinker -assert -Xlinker definitions}. It does not work to write
13552 @option{-Xlinker "-assert definitions"}, because this passes the entire
13553 string as a single argument, which is not what the linker expects.
13554
13555 When using the GNU linker, it is usually more convenient to pass
13556 arguments to linker options using the @option{@var{option}=@var{value}}
13557 syntax than as separate arguments. For example, you can specify
13558 @option{-Xlinker -Map=output.map} rather than
13559 @option{-Xlinker -Map -Xlinker output.map}. Other linkers may not support
13560 this syntax for command-line options.
13561
13562 @item -Wl,@var{option}
13563 @opindex Wl
13564 Pass @var{option} as an option to the linker. If @var{option} contains
13565 commas, it is split into multiple options at the commas. You can use this
13566 syntax to pass an argument to the option.
13567 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
13568 linker. When using the GNU linker, you can also get the same effect with
13569 @option{-Wl,-Map=output.map}.
13570
13571 @item -u @var{symbol}
13572 @opindex u
13573 Pretend the symbol @var{symbol} is undefined, to force linking of
13574 library modules to define it. You can use @option{-u} multiple times with
13575 different symbols to force loading of additional library modules.
13576
13577 @item -z @var{keyword}
13578 @opindex z
13579 @option{-z} is passed directly on to the linker along with the keyword
13580 @var{keyword}. See the section in the documentation of your linker for
13581 permitted values and their meanings.
13582 @end table
13583
13584 @node Directory Options
13585 @section Options for Directory Search
13586 @cindex directory options
13587 @cindex options, directory search
13588 @cindex search path
13589
13590 These options specify directories to search for header files, for
13591 libraries and for parts of the compiler:
13592
13593 @table @gcctabopt
13594 @include cppdiropts.texi
13595
13596 @item -iplugindir=@var{dir}
13597 @opindex iplugindir=
13598 Set the directory to search for plugins that are passed
13599 by @option{-fplugin=@var{name}} instead of
13600 @option{-fplugin=@var{path}/@var{name}.so}. This option is not meant
13601 to be used by the user, but only passed by the driver.
13602
13603 @item -L@var{dir}
13604 @opindex L
13605 Add directory @var{dir} to the list of directories to be searched
13606 for @option{-l}.
13607
13608 @item -B@var{prefix}
13609 @opindex B
13610 This option specifies where to find the executables, libraries,
13611 include files, and data files of the compiler itself.
13612
13613 The compiler driver program runs one or more of the subprograms
13614 @command{cpp}, @command{cc1}, @command{as} and @command{ld}. It tries
13615 @var{prefix} as a prefix for each program it tries to run, both with and
13616 without @samp{@var{machine}/@var{version}/} for the corresponding target
13617 machine and compiler version.
13618
13619 For each subprogram to be run, the compiler driver first tries the
13620 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
13621 is not specified, the driver tries two standard prefixes,
13622 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
13623 those results in a file name that is found, the unmodified program
13624 name is searched for using the directories specified in your
13625 @env{PATH} environment variable.
13626
13627 The compiler checks to see if the path provided by @option{-B}
13628 refers to a directory, and if necessary it adds a directory
13629 separator character at the end of the path.
13630
13631 @option{-B} prefixes that effectively specify directory names also apply
13632 to libraries in the linker, because the compiler translates these
13633 options into @option{-L} options for the linker. They also apply to
13634 include files in the preprocessor, because the compiler translates these
13635 options into @option{-isystem} options for the preprocessor. In this case,
13636 the compiler appends @samp{include} to the prefix.
13637
13638 The runtime support file @file{libgcc.a} can also be searched for using
13639 the @option{-B} prefix, if needed. If it is not found there, the two
13640 standard prefixes above are tried, and that is all. The file is left
13641 out of the link if it is not found by those means.
13642
13643 Another way to specify a prefix much like the @option{-B} prefix is to use
13644 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
13645 Variables}.
13646
13647 As a special kludge, if the path provided by @option{-B} is
13648 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
13649 9, then it is replaced by @file{[dir/]include}. This is to help
13650 with boot-strapping the compiler.
13651
13652 @item -no-canonical-prefixes
13653 @opindex no-canonical-prefixes
13654 Do not expand any symbolic links, resolve references to @samp{/../}
13655 or @samp{/./}, or make the path absolute when generating a relative
13656 prefix.
13657
13658 @item --sysroot=@var{dir}
13659 @opindex sysroot
13660 Use @var{dir} as the logical root directory for headers and libraries.
13661 For example, if the compiler normally searches for headers in
13662 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
13663 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
13664
13665 If you use both this option and the @option{-isysroot} option, then
13666 the @option{--sysroot} option applies to libraries, but the
13667 @option{-isysroot} option applies to header files.
13668
13669 The GNU linker (beginning with version 2.16) has the necessary support
13670 for this option. If your linker does not support this option, the
13671 header file aspect of @option{--sysroot} still works, but the
13672 library aspect does not.
13673
13674 @item --no-sysroot-suffix
13675 @opindex no-sysroot-suffix
13676 For some targets, a suffix is added to the root directory specified
13677 with @option{--sysroot}, depending on the other options used, so that
13678 headers may for example be found in
13679 @file{@var{dir}/@var{suffix}/usr/include} instead of
13680 @file{@var{dir}/usr/include}. This option disables the addition of
13681 such a suffix.
13682
13683 @end table
13684
13685 @node Code Gen Options
13686 @section Options for Code Generation Conventions
13687 @cindex code generation conventions
13688 @cindex options, code generation
13689 @cindex run-time options
13690
13691 These machine-independent options control the interface conventions
13692 used in code generation.
13693
13694 Most of them have both positive and negative forms; the negative form
13695 of @option{-ffoo} is @option{-fno-foo}. In the table below, only
13696 one of the forms is listed---the one that is not the default. You
13697 can figure out the other form by either removing @samp{no-} or adding
13698 it.
13699
13700 @table @gcctabopt
13701 @item -fstack-reuse=@var{reuse-level}
13702 @opindex fstack_reuse
13703 This option controls stack space reuse for user declared local/auto variables
13704 and compiler generated temporaries. @var{reuse_level} can be @samp{all},
13705 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
13706 local variables and temporaries, @samp{named_vars} enables the reuse only for
13707 user defined local variables with names, and @samp{none} disables stack reuse
13708 completely. The default value is @samp{all}. The option is needed when the
13709 program extends the lifetime of a scoped local variable or a compiler generated
13710 temporary beyond the end point defined by the language. When a lifetime of
13711 a variable ends, and if the variable lives in memory, the optimizing compiler
13712 has the freedom to reuse its stack space with other temporaries or scoped
13713 local variables whose live range does not overlap with it. Legacy code extending
13714 local lifetime is likely to break with the stack reuse optimization.
13715
13716 For example,
13717
13718 @smallexample
13719 int *p;
13720 @{
13721 int local1;
13722
13723 p = &local1;
13724 local1 = 10;
13725 ....
13726 @}
13727 @{
13728 int local2;
13729 local2 = 20;
13730 ...
13731 @}
13732
13733 if (*p == 10) // out of scope use of local1
13734 @{
13735
13736 @}
13737 @end smallexample
13738
13739 Another example:
13740 @smallexample
13741
13742 struct A
13743 @{
13744 A(int k) : i(k), j(k) @{ @}
13745 int i;
13746 int j;
13747 @};
13748
13749 A *ap;
13750
13751 void foo(const A& ar)
13752 @{
13753 ap = &ar;
13754 @}
13755
13756 void bar()
13757 @{
13758 foo(A(10)); // temp object's lifetime ends when foo returns
13759
13760 @{
13761 A a(20);
13762 ....
13763 @}
13764 ap->i+= 10; // ap references out of scope temp whose space
13765 // is reused with a. What is the value of ap->i?
13766 @}
13767
13768 @end smallexample
13769
13770 The lifetime of a compiler generated temporary is well defined by the C++
13771 standard. When a lifetime of a temporary ends, and if the temporary lives
13772 in memory, the optimizing compiler has the freedom to reuse its stack
13773 space with other temporaries or scoped local variables whose live range
13774 does not overlap with it. However some of the legacy code relies on
13775 the behavior of older compilers in which temporaries' stack space is
13776 not reused, the aggressive stack reuse can lead to runtime errors. This
13777 option is used to control the temporary stack reuse optimization.
13778
13779 @item -ftrapv
13780 @opindex ftrapv
13781 This option generates traps for signed overflow on addition, subtraction,
13782 multiplication operations.
13783 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
13784 @option{-ftrapv} @option{-fwrapv} on the command-line results in
13785 @option{-fwrapv} being effective. Note that only active options override, so
13786 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
13787 results in @option{-ftrapv} being effective.
13788
13789 @item -fwrapv
13790 @opindex fwrapv
13791 This option instructs the compiler to assume that signed arithmetic
13792 overflow of addition, subtraction and multiplication wraps around
13793 using twos-complement representation. This flag enables some optimizations
13794 and disables others.
13795 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
13796 @option{-ftrapv} @option{-fwrapv} on the command-line results in
13797 @option{-fwrapv} being effective. Note that only active options override, so
13798 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
13799 results in @option{-ftrapv} being effective.
13800
13801 @item -fwrapv-pointer
13802 @opindex fwrapv-pointer
13803 This option instructs the compiler to assume that pointer arithmetic
13804 overflow on addition and subtraction wraps around using twos-complement
13805 representation. This flag disables some optimizations which assume
13806 pointer overflow is invalid.
13807
13808 @item -fstrict-overflow
13809 @opindex fstrict-overflow
13810 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
13811 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
13812
13813 @item -fexceptions
13814 @opindex fexceptions
13815 Enable exception handling. Generates extra code needed to propagate
13816 exceptions. For some targets, this implies GCC generates frame
13817 unwind information for all functions, which can produce significant data
13818 size overhead, although it does not affect execution. If you do not
13819 specify this option, GCC enables it by default for languages like
13820 C++ that normally require exception handling, and disables it for
13821 languages like C that do not normally require it. However, you may need
13822 to enable this option when compiling C code that needs to interoperate
13823 properly with exception handlers written in C++. You may also wish to
13824 disable this option if you are compiling older C++ programs that don't
13825 use exception handling.
13826
13827 @item -fnon-call-exceptions
13828 @opindex fnon-call-exceptions
13829 Generate code that allows trapping instructions to throw exceptions.
13830 Note that this requires platform-specific runtime support that does
13831 not exist everywhere. Moreover, it only allows @emph{trapping}
13832 instructions to throw exceptions, i.e.@: memory references or floating-point
13833 instructions. It does not allow exceptions to be thrown from
13834 arbitrary signal handlers such as @code{SIGALRM}.
13835
13836 @item -fdelete-dead-exceptions
13837 @opindex fdelete-dead-exceptions
13838 Consider that instructions that may throw exceptions but don't otherwise
13839 contribute to the execution of the program can be optimized away.
13840 This option is enabled by default for the Ada front end, as permitted by
13841 the Ada language specification.
13842 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
13843
13844 @item -funwind-tables
13845 @opindex funwind-tables
13846 Similar to @option{-fexceptions}, except that it just generates any needed
13847 static data, but does not affect the generated code in any other way.
13848 You normally do not need to enable this option; instead, a language processor
13849 that needs this handling enables it on your behalf.
13850
13851 @item -fasynchronous-unwind-tables
13852 @opindex fasynchronous-unwind-tables
13853 Generate unwind table in DWARF format, if supported by target machine. The
13854 table is exact at each instruction boundary, so it can be used for stack
13855 unwinding from asynchronous events (such as debugger or garbage collector).
13856
13857 @item -fno-gnu-unique
13858 @opindex fno-gnu-unique
13859 @opindex fgnu-unique
13860 On systems with recent GNU assembler and C library, the C++ compiler
13861 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
13862 of template static data members and static local variables in inline
13863 functions are unique even in the presence of @code{RTLD_LOCAL}; this
13864 is necessary to avoid problems with a library used by two different
13865 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
13866 therefore disagreeing with the other one about the binding of the
13867 symbol. But this causes @code{dlclose} to be ignored for affected
13868 DSOs; if your program relies on reinitialization of a DSO via
13869 @code{dlclose} and @code{dlopen}, you can use
13870 @option{-fno-gnu-unique}.
13871
13872 @item -fpcc-struct-return
13873 @opindex fpcc-struct-return
13874 Return ``short'' @code{struct} and @code{union} values in memory like
13875 longer ones, rather than in registers. This convention is less
13876 efficient, but it has the advantage of allowing intercallability between
13877 GCC-compiled files and files compiled with other compilers, particularly
13878 the Portable C Compiler (pcc).
13879
13880 The precise convention for returning structures in memory depends
13881 on the target configuration macros.
13882
13883 Short structures and unions are those whose size and alignment match
13884 that of some integer type.
13885
13886 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13887 switch is not binary compatible with code compiled with the
13888 @option{-freg-struct-return} switch.
13889 Use it to conform to a non-default application binary interface.
13890
13891 @item -freg-struct-return
13892 @opindex freg-struct-return
13893 Return @code{struct} and @code{union} values in registers when possible.
13894 This is more efficient for small structures than
13895 @option{-fpcc-struct-return}.
13896
13897 If you specify neither @option{-fpcc-struct-return} nor
13898 @option{-freg-struct-return}, GCC defaults to whichever convention is
13899 standard for the target. If there is no standard convention, GCC
13900 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13901 the principal compiler. In those cases, we can choose the standard, and
13902 we chose the more efficient register return alternative.
13903
13904 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13905 switch is not binary compatible with code compiled with the
13906 @option{-fpcc-struct-return} switch.
13907 Use it to conform to a non-default application binary interface.
13908
13909 @item -fshort-enums
13910 @opindex fshort-enums
13911 Allocate to an @code{enum} type only as many bytes as it needs for the
13912 declared range of possible values. Specifically, the @code{enum} type
13913 is equivalent to the smallest integer type that has enough room.
13914
13915 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13916 code that is not binary compatible with code generated without that switch.
13917 Use it to conform to a non-default application binary interface.
13918
13919 @item -fshort-wchar
13920 @opindex fshort-wchar
13921 Override the underlying type for @code{wchar_t} to be @code{short
13922 unsigned int} instead of the default for the target. This option is
13923 useful for building programs to run under WINE@.
13924
13925 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13926 code that is not binary compatible with code generated without that switch.
13927 Use it to conform to a non-default application binary interface.
13928
13929 @item -fno-common
13930 @opindex fno-common
13931 @opindex fcommon
13932 @cindex tentative definitions
13933 In C code, this option controls the placement of global variables
13934 defined without an initializer, known as @dfn{tentative definitions}
13935 in the C standard. Tentative definitions are distinct from declarations
13936 of a variable with the @code{extern} keyword, which do not allocate storage.
13937
13938 Unix C compilers have traditionally allocated storage for
13939 uninitialized global variables in a common block. This allows the
13940 linker to resolve all tentative definitions of the same variable
13941 in different compilation units to the same object, or to a non-tentative
13942 definition.
13943 This is the behavior specified by @option{-fcommon}, and is the default for
13944 GCC on most targets.
13945 On the other hand, this behavior is not required by ISO
13946 C, and on some targets may carry a speed or code size penalty on
13947 variable references.
13948
13949 The @option{-fno-common} option specifies that the compiler should instead
13950 place uninitialized global variables in the BSS section of the object file.
13951 This inhibits the merging of tentative definitions by the linker so
13952 you get a multiple-definition error if the same
13953 variable is defined in more than one compilation unit.
13954 Compiling with @option{-fno-common} is useful on targets for which
13955 it provides better performance, or if you wish to verify that the
13956 program will work on other systems that always treat uninitialized
13957 variable definitions this way.
13958
13959 @item -fno-ident
13960 @opindex fno-ident
13961 @opindex fident
13962 Ignore the @code{#ident} directive.
13963
13964 @item -finhibit-size-directive
13965 @opindex finhibit-size-directive
13966 Don't output a @code{.size} assembler directive, or anything else that
13967 would cause trouble if the function is split in the middle, and the
13968 two halves are placed at locations far apart in memory. This option is
13969 used when compiling @file{crtstuff.c}; you should not need to use it
13970 for anything else.
13971
13972 @item -fverbose-asm
13973 @opindex fverbose-asm
13974 Put extra commentary information in the generated assembly code to
13975 make it more readable. This option is generally only of use to those
13976 who actually need to read the generated assembly code (perhaps while
13977 debugging the compiler itself).
13978
13979 @option{-fno-verbose-asm}, the default, causes the
13980 extra information to be omitted and is useful when comparing two assembler
13981 files.
13982
13983 The added comments include:
13984
13985 @itemize @bullet
13986
13987 @item
13988 information on the compiler version and command-line options,
13989
13990 @item
13991 the source code lines associated with the assembly instructions,
13992 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
13993
13994 @item
13995 hints on which high-level expressions correspond to
13996 the various assembly instruction operands.
13997
13998 @end itemize
13999
14000 For example, given this C source file:
14001
14002 @smallexample
14003 int test (int n)
14004 @{
14005 int i;
14006 int total = 0;
14007
14008 for (i = 0; i < n; i++)
14009 total += i * i;
14010
14011 return total;
14012 @}
14013 @end smallexample
14014
14015 compiling to (x86_64) assembly via @option{-S} and emitting the result
14016 direct to stdout via @option{-o} @option{-}
14017
14018 @smallexample
14019 gcc -S test.c -fverbose-asm -Os -o -
14020 @end smallexample
14021
14022 gives output similar to this:
14023
14024 @smallexample
14025 .file "test.c"
14026 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
14027 [...snip...]
14028 # options passed:
14029 [...snip...]
14030
14031 .text
14032 .globl test
14033 .type test, @@function
14034 test:
14035 .LFB0:
14036 .cfi_startproc
14037 # test.c:4: int total = 0;
14038 xorl %eax, %eax # <retval>
14039 # test.c:6: for (i = 0; i < n; i++)
14040 xorl %edx, %edx # i
14041 .L2:
14042 # test.c:6: for (i = 0; i < n; i++)
14043 cmpl %edi, %edx # n, i
14044 jge .L5 #,
14045 # test.c:7: total += i * i;
14046 movl %edx, %ecx # i, tmp92
14047 imull %edx, %ecx # i, tmp92
14048 # test.c:6: for (i = 0; i < n; i++)
14049 incl %edx # i
14050 # test.c:7: total += i * i;
14051 addl %ecx, %eax # tmp92, <retval>
14052 jmp .L2 #
14053 .L5:
14054 # test.c:10: @}
14055 ret
14056 .cfi_endproc
14057 .LFE0:
14058 .size test, .-test
14059 .ident "GCC: (GNU) 7.0.0 20160809 (experimental)"
14060 .section .note.GNU-stack,"",@@progbits
14061 @end smallexample
14062
14063 The comments are intended for humans rather than machines and hence the
14064 precise format of the comments is subject to change.
14065
14066 @item -frecord-gcc-switches
14067 @opindex frecord-gcc-switches
14068 This switch causes the command line used to invoke the
14069 compiler to be recorded into the object file that is being created.
14070 This switch is only implemented on some targets and the exact format
14071 of the recording is target and binary file format dependent, but it
14072 usually takes the form of a section containing ASCII text. This
14073 switch is related to the @option{-fverbose-asm} switch, but that
14074 switch only records information in the assembler output file as
14075 comments, so it never reaches the object file.
14076 See also @option{-grecord-gcc-switches} for another
14077 way of storing compiler options into the object file.
14078
14079 @item -fpic
14080 @opindex fpic
14081 @cindex global offset table
14082 @cindex PIC
14083 Generate position-independent code (PIC) suitable for use in a shared
14084 library, if supported for the target machine. Such code accesses all
14085 constant addresses through a global offset table (GOT)@. The dynamic
14086 loader resolves the GOT entries when the program starts (the dynamic
14087 loader is not part of GCC; it is part of the operating system). If
14088 the GOT size for the linked executable exceeds a machine-specific
14089 maximum size, you get an error message from the linker indicating that
14090 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14091 instead. (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
14092 on the m68k and RS/6000. The x86 has no such limit.)
14093
14094 Position-independent code requires special support, and therefore works
14095 only on certain machines. For the x86, GCC supports PIC for System V
14096 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
14097 position-independent.
14098
14099 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14100 are defined to 1.
14101
14102 @item -fPIC
14103 @opindex fPIC
14104 If supported for the target machine, emit position-independent code,
14105 suitable for dynamic linking and avoiding any limit on the size of the
14106 global offset table. This option makes a difference on AArch64, m68k,
14107 PowerPC and SPARC@.
14108
14109 Position-independent code requires special support, and therefore works
14110 only on certain machines.
14111
14112 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14113 are defined to 2.
14114
14115 @item -fpie
14116 @itemx -fPIE
14117 @opindex fpie
14118 @opindex fPIE
14119 These options are similar to @option{-fpic} and @option{-fPIC}, but the
14120 generated position-independent code can be only linked into executables.
14121 Usually these options are used to compile code that will be linked using
14122 the @option{-pie} GCC option.
14123
14124 @option{-fpie} and @option{-fPIE} both define the macros
14125 @code{__pie__} and @code{__PIE__}. The macros have the value 1
14126 for @option{-fpie} and 2 for @option{-fPIE}.
14127
14128 @item -fno-plt
14129 @opindex fno-plt
14130 @opindex fplt
14131 Do not use the PLT for external function calls in position-independent code.
14132 Instead, load the callee address at call sites from the GOT and branch to it.
14133 This leads to more efficient code by eliminating PLT stubs and exposing
14134 GOT loads to optimizations. On architectures such as 32-bit x86 where
14135 PLT stubs expect the GOT pointer in a specific register, this gives more
14136 register allocation freedom to the compiler.
14137 Lazy binding requires use of the PLT;
14138 with @option{-fno-plt} all external symbols are resolved at load time.
14139
14140 Alternatively, the function attribute @code{noplt} can be used to avoid calls
14141 through the PLT for specific external functions.
14142
14143 In position-dependent code, a few targets also convert calls to
14144 functions that are marked to not use the PLT to use the GOT instead.
14145
14146 @item -fno-jump-tables
14147 @opindex fno-jump-tables
14148 @opindex fjump-tables
14149 Do not use jump tables for switch statements even where it would be
14150 more efficient than other code generation strategies. This option is
14151 of use in conjunction with @option{-fpic} or @option{-fPIC} for
14152 building code that forms part of a dynamic linker and cannot
14153 reference the address of a jump table. On some targets, jump tables
14154 do not require a GOT and this option is not needed.
14155
14156 @item -ffixed-@var{reg}
14157 @opindex ffixed
14158 Treat the register named @var{reg} as a fixed register; generated code
14159 should never refer to it (except perhaps as a stack pointer, frame
14160 pointer or in some other fixed role).
14161
14162 @var{reg} must be the name of a register. The register names accepted
14163 are machine-specific and are defined in the @code{REGISTER_NAMES}
14164 macro in the machine description macro file.
14165
14166 This flag does not have a negative form, because it specifies a
14167 three-way choice.
14168
14169 @item -fcall-used-@var{reg}
14170 @opindex fcall-used
14171 Treat the register named @var{reg} as an allocable register that is
14172 clobbered by function calls. It may be allocated for temporaries or
14173 variables that do not live across a call. Functions compiled this way
14174 do not save and restore the register @var{reg}.
14175
14176 It is an error to use this flag with the frame pointer or stack pointer.
14177 Use of this flag for other registers that have fixed pervasive roles in
14178 the machine's execution model produces disastrous results.
14179
14180 This flag does not have a negative form, because it specifies a
14181 three-way choice.
14182
14183 @item -fcall-saved-@var{reg}
14184 @opindex fcall-saved
14185 Treat the register named @var{reg} as an allocable register saved by
14186 functions. It may be allocated even for temporaries or variables that
14187 live across a call. Functions compiled this way save and restore
14188 the register @var{reg} if they use it.
14189
14190 It is an error to use this flag with the frame pointer or stack pointer.
14191 Use of this flag for other registers that have fixed pervasive roles in
14192 the machine's execution model produces disastrous results.
14193
14194 A different sort of disaster results from the use of this flag for
14195 a register in which function values may be returned.
14196
14197 This flag does not have a negative form, because it specifies a
14198 three-way choice.
14199
14200 @item -fpack-struct[=@var{n}]
14201 @opindex fpack-struct
14202 Without a value specified, pack all structure members together without
14203 holes. When a value is specified (which must be a small power of two), pack
14204 structure members according to this value, representing the maximum
14205 alignment (that is, objects with default alignment requirements larger than
14206 this are output potentially unaligned at the next fitting location.
14207
14208 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
14209 code that is not binary compatible with code generated without that switch.
14210 Additionally, it makes the code suboptimal.
14211 Use it to conform to a non-default application binary interface.
14212
14213 @item -fleading-underscore
14214 @opindex fleading-underscore
14215 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
14216 change the way C symbols are represented in the object file. One use
14217 is to help link with legacy assembly code.
14218
14219 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
14220 generate code that is not binary compatible with code generated without that
14221 switch. Use it to conform to a non-default application binary interface.
14222 Not all targets provide complete support for this switch.
14223
14224 @item -ftls-model=@var{model}
14225 @opindex ftls-model
14226 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
14227 The @var{model} argument should be one of @samp{global-dynamic},
14228 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
14229 Note that the choice is subject to optimization: the compiler may use
14230 a more efficient model for symbols not visible outside of the translation
14231 unit, or if @option{-fpic} is not given on the command line.
14232
14233 The default without @option{-fpic} is @samp{initial-exec}; with
14234 @option{-fpic} the default is @samp{global-dynamic}.
14235
14236 @item -ftrampolines
14237 @opindex ftrampolines
14238 For targets that normally need trampolines for nested functions, always
14239 generate them instead of using descriptors. Otherwise, for targets that
14240 do not need them, like for example HP-PA or IA-64, do nothing.
14241
14242 A trampoline is a small piece of code that is created at run time on the
14243 stack when the address of a nested function is taken, and is used to call
14244 the nested function indirectly. Therefore, it requires the stack to be
14245 made executable in order for the program to work properly.
14246
14247 @option{-fno-trampolines} is enabled by default on a language by language
14248 basis to let the compiler avoid generating them, if it computes that this
14249 is safe, and replace them with descriptors. Descriptors are made up of data
14250 only, but the generated code must be prepared to deal with them. As of this
14251 writing, @option{-fno-trampolines} is enabled by default only for Ada.
14252
14253 Moreover, code compiled with @option{-ftrampolines} and code compiled with
14254 @option{-fno-trampolines} are not binary compatible if nested functions are
14255 present. This option must therefore be used on a program-wide basis and be
14256 manipulated with extreme care.
14257
14258 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
14259 @opindex fvisibility
14260 Set the default ELF image symbol visibility to the specified option---all
14261 symbols are marked with this unless overridden within the code.
14262 Using this feature can very substantially improve linking and
14263 load times of shared object libraries, produce more optimized
14264 code, provide near-perfect API export and prevent symbol clashes.
14265 It is @strong{strongly} recommended that you use this in any shared objects
14266 you distribute.
14267
14268 Despite the nomenclature, @samp{default} always means public; i.e.,
14269 available to be linked against from outside the shared object.
14270 @samp{protected} and @samp{internal} are pretty useless in real-world
14271 usage so the only other commonly used option is @samp{hidden}.
14272 The default if @option{-fvisibility} isn't specified is
14273 @samp{default}, i.e., make every symbol public.
14274
14275 A good explanation of the benefits offered by ensuring ELF
14276 symbols have the correct visibility is given by ``How To Write
14277 Shared Libraries'' by Ulrich Drepper (which can be found at
14278 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
14279 solution made possible by this option to marking things hidden when
14280 the default is public is to make the default hidden and mark things
14281 public. This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
14282 and @code{__attribute__ ((visibility("default")))} instead of
14283 @code{__declspec(dllexport)} you get almost identical semantics with
14284 identical syntax. This is a great boon to those working with
14285 cross-platform projects.
14286
14287 For those adding visibility support to existing code, you may find
14288 @code{#pragma GCC visibility} of use. This works by you enclosing
14289 the declarations you wish to set visibility for with (for example)
14290 @code{#pragma GCC visibility push(hidden)} and
14291 @code{#pragma GCC visibility pop}.
14292 Bear in mind that symbol visibility should be viewed @strong{as
14293 part of the API interface contract} and thus all new code should
14294 always specify visibility when it is not the default; i.e., declarations
14295 only for use within the local DSO should @strong{always} be marked explicitly
14296 as hidden as so to avoid PLT indirection overheads---making this
14297 abundantly clear also aids readability and self-documentation of the code.
14298 Note that due to ISO C++ specification requirements, @code{operator new} and
14299 @code{operator delete} must always be of default visibility.
14300
14301 Be aware that headers from outside your project, in particular system
14302 headers and headers from any other library you use, may not be
14303 expecting to be compiled with visibility other than the default. You
14304 may need to explicitly say @code{#pragma GCC visibility push(default)}
14305 before including any such headers.
14306
14307 @code{extern} declarations are not affected by @option{-fvisibility}, so
14308 a lot of code can be recompiled with @option{-fvisibility=hidden} with
14309 no modifications. However, this means that calls to @code{extern}
14310 functions with no explicit visibility use the PLT, so it is more
14311 effective to use @code{__attribute ((visibility))} and/or
14312 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
14313 declarations should be treated as hidden.
14314
14315 Note that @option{-fvisibility} does affect C++ vague linkage
14316 entities. This means that, for instance, an exception class that is
14317 be thrown between DSOs must be explicitly marked with default
14318 visibility so that the @samp{type_info} nodes are unified between
14319 the DSOs.
14320
14321 An overview of these techniques, their benefits and how to use them
14322 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
14323
14324 @item -fstrict-volatile-bitfields
14325 @opindex fstrict-volatile-bitfields
14326 This option should be used if accesses to volatile bit-fields (or other
14327 structure fields, although the compiler usually honors those types
14328 anyway) should use a single access of the width of the
14329 field's type, aligned to a natural alignment if possible. For
14330 example, targets with memory-mapped peripheral registers might require
14331 all such accesses to be 16 bits wide; with this flag you can
14332 declare all peripheral bit-fields as @code{unsigned short} (assuming short
14333 is 16 bits on these targets) to force GCC to use 16-bit accesses
14334 instead of, perhaps, a more efficient 32-bit access.
14335
14336 If this option is disabled, the compiler uses the most efficient
14337 instruction. In the previous example, that might be a 32-bit load
14338 instruction, even though that accesses bytes that do not contain
14339 any portion of the bit-field, or memory-mapped registers unrelated to
14340 the one being updated.
14341
14342 In some cases, such as when the @code{packed} attribute is applied to a
14343 structure field, it may not be possible to access the field with a single
14344 read or write that is correctly aligned for the target machine. In this
14345 case GCC falls back to generating multiple accesses rather than code that
14346 will fault or truncate the result at run time.
14347
14348 Note: Due to restrictions of the C/C++11 memory model, write accesses are
14349 not allowed to touch non bit-field members. It is therefore recommended
14350 to define all bits of the field's type as bit-field members.
14351
14352 The default value of this option is determined by the application binary
14353 interface for the target processor.
14354
14355 @item -fsync-libcalls
14356 @opindex fsync-libcalls
14357 This option controls whether any out-of-line instance of the @code{__sync}
14358 family of functions may be used to implement the C++11 @code{__atomic}
14359 family of functions.
14360
14361 The default value of this option is enabled, thus the only useful form
14362 of the option is @option{-fno-sync-libcalls}. This option is used in
14363 the implementation of the @file{libatomic} runtime library.
14364
14365 @end table
14366
14367 @node Developer Options
14368 @section GCC Developer Options
14369 @cindex developer options
14370 @cindex debugging GCC
14371 @cindex debug dump options
14372 @cindex dump options
14373 @cindex compilation statistics
14374
14375 This section describes command-line options that are primarily of
14376 interest to GCC developers, including options to support compiler
14377 testing and investigation of compiler bugs and compile-time
14378 performance problems. This includes options that produce debug dumps
14379 at various points in the compilation; that print statistics such as
14380 memory use and execution time; and that print information about GCC's
14381 configuration, such as where it searches for libraries. You should
14382 rarely need to use any of these options for ordinary compilation and
14383 linking tasks.
14384
14385 Many developer options that cause GCC to dump output to a file take an
14386 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
14387 or @samp{-} to dump to standard output, and @samp{stderr} for standard
14388 error.
14389
14390 If @samp{=@var{filename}} is omitted, a default dump file name is
14391 constructed by concatenating the base dump file name, a pass number,
14392 phase letter, and pass name. The base dump file name is the name of
14393 output file produced by the compiler if explicitly specified and not
14394 an executable; otherwise it is the source file name.
14395 The pass number is determined by the order passes are registered with
14396 the compiler's pass manager.
14397 This is generally the same as the order of execution, but passes
14398 registered by plugins, target-specific passes, or passes that are
14399 otherwise registered late are numbered higher than the pass named
14400 @samp{final}, even if they are executed earlier. The phase letter is
14401 one of @samp{i} (inter-procedural analysis), @samp{l}
14402 (language-specific), @samp{r} (RTL), or @samp{t} (tree).
14403 The files are created in the directory of the output file.
14404
14405 @table @gcctabopt
14406
14407 @item -d@var{letters}
14408 @itemx -fdump-rtl-@var{pass}
14409 @itemx -fdump-rtl-@var{pass}=@var{filename}
14410 @opindex d
14411 @opindex fdump-rtl-@var{pass}
14412 Says to make debugging dumps during compilation at times specified by
14413 @var{letters}. This is used for debugging the RTL-based passes of the
14414 compiler.
14415
14416 Some @option{-d@var{letters}} switches have different meaning when
14417 @option{-E} is used for preprocessing. @xref{Preprocessor Options},
14418 for information about preprocessor-specific dump options.
14419
14420 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
14421 @option{-d} option @var{letters}. Here are the possible
14422 letters for use in @var{pass} and @var{letters}, and their meanings:
14423
14424 @table @gcctabopt
14425
14426 @item -fdump-rtl-alignments
14427 @opindex fdump-rtl-alignments
14428 Dump after branch alignments have been computed.
14429
14430 @item -fdump-rtl-asmcons
14431 @opindex fdump-rtl-asmcons
14432 Dump after fixing rtl statements that have unsatisfied in/out constraints.
14433
14434 @item -fdump-rtl-auto_inc_dec
14435 @opindex fdump-rtl-auto_inc_dec
14436 Dump after auto-inc-dec discovery. This pass is only run on
14437 architectures that have auto inc or auto dec instructions.
14438
14439 @item -fdump-rtl-barriers
14440 @opindex fdump-rtl-barriers
14441 Dump after cleaning up the barrier instructions.
14442
14443 @item -fdump-rtl-bbpart
14444 @opindex fdump-rtl-bbpart
14445 Dump after partitioning hot and cold basic blocks.
14446
14447 @item -fdump-rtl-bbro
14448 @opindex fdump-rtl-bbro
14449 Dump after block reordering.
14450
14451 @item -fdump-rtl-btl1
14452 @itemx -fdump-rtl-btl2
14453 @opindex fdump-rtl-btl2
14454 @opindex fdump-rtl-btl2
14455 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
14456 after the two branch
14457 target load optimization passes.
14458
14459 @item -fdump-rtl-bypass
14460 @opindex fdump-rtl-bypass
14461 Dump after jump bypassing and control flow optimizations.
14462
14463 @item -fdump-rtl-combine
14464 @opindex fdump-rtl-combine
14465 Dump after the RTL instruction combination pass.
14466
14467 @item -fdump-rtl-compgotos
14468 @opindex fdump-rtl-compgotos
14469 Dump after duplicating the computed gotos.
14470
14471 @item -fdump-rtl-ce1
14472 @itemx -fdump-rtl-ce2
14473 @itemx -fdump-rtl-ce3
14474 @opindex fdump-rtl-ce1
14475 @opindex fdump-rtl-ce2
14476 @opindex fdump-rtl-ce3
14477 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
14478 @option{-fdump-rtl-ce3} enable dumping after the three
14479 if conversion passes.
14480
14481 @item -fdump-rtl-cprop_hardreg
14482 @opindex fdump-rtl-cprop_hardreg
14483 Dump after hard register copy propagation.
14484
14485 @item -fdump-rtl-csa
14486 @opindex fdump-rtl-csa
14487 Dump after combining stack adjustments.
14488
14489 @item -fdump-rtl-cse1
14490 @itemx -fdump-rtl-cse2
14491 @opindex fdump-rtl-cse1
14492 @opindex fdump-rtl-cse2
14493 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
14494 the two common subexpression elimination passes.
14495
14496 @item -fdump-rtl-dce
14497 @opindex fdump-rtl-dce
14498 Dump after the standalone dead code elimination passes.
14499
14500 @item -fdump-rtl-dbr
14501 @opindex fdump-rtl-dbr
14502 Dump after delayed branch scheduling.
14503
14504 @item -fdump-rtl-dce1
14505 @itemx -fdump-rtl-dce2
14506 @opindex fdump-rtl-dce1
14507 @opindex fdump-rtl-dce2
14508 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
14509 the two dead store elimination passes.
14510
14511 @item -fdump-rtl-eh
14512 @opindex fdump-rtl-eh
14513 Dump after finalization of EH handling code.
14514
14515 @item -fdump-rtl-eh_ranges
14516 @opindex fdump-rtl-eh_ranges
14517 Dump after conversion of EH handling range regions.
14518
14519 @item -fdump-rtl-expand
14520 @opindex fdump-rtl-expand
14521 Dump after RTL generation.
14522
14523 @item -fdump-rtl-fwprop1
14524 @itemx -fdump-rtl-fwprop2
14525 @opindex fdump-rtl-fwprop1
14526 @opindex fdump-rtl-fwprop2
14527 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
14528 dumping after the two forward propagation passes.
14529
14530 @item -fdump-rtl-gcse1
14531 @itemx -fdump-rtl-gcse2
14532 @opindex fdump-rtl-gcse1
14533 @opindex fdump-rtl-gcse2
14534 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
14535 after global common subexpression elimination.
14536
14537 @item -fdump-rtl-init-regs
14538 @opindex fdump-rtl-init-regs
14539 Dump after the initialization of the registers.
14540
14541 @item -fdump-rtl-initvals
14542 @opindex fdump-rtl-initvals
14543 Dump after the computation of the initial value sets.
14544
14545 @item -fdump-rtl-into_cfglayout
14546 @opindex fdump-rtl-into_cfglayout
14547 Dump after converting to cfglayout mode.
14548
14549 @item -fdump-rtl-ira
14550 @opindex fdump-rtl-ira
14551 Dump after iterated register allocation.
14552
14553 @item -fdump-rtl-jump
14554 @opindex fdump-rtl-jump
14555 Dump after the second jump optimization.
14556
14557 @item -fdump-rtl-loop2
14558 @opindex fdump-rtl-loop2
14559 @option{-fdump-rtl-loop2} enables dumping after the rtl
14560 loop optimization passes.
14561
14562 @item -fdump-rtl-mach
14563 @opindex fdump-rtl-mach
14564 Dump after performing the machine dependent reorganization pass, if that
14565 pass exists.
14566
14567 @item -fdump-rtl-mode_sw
14568 @opindex fdump-rtl-mode_sw
14569 Dump after removing redundant mode switches.
14570
14571 @item -fdump-rtl-rnreg
14572 @opindex fdump-rtl-rnreg
14573 Dump after register renumbering.
14574
14575 @item -fdump-rtl-outof_cfglayout
14576 @opindex fdump-rtl-outof_cfglayout
14577 Dump after converting from cfglayout mode.
14578
14579 @item -fdump-rtl-peephole2
14580 @opindex fdump-rtl-peephole2
14581 Dump after the peephole pass.
14582
14583 @item -fdump-rtl-postreload
14584 @opindex fdump-rtl-postreload
14585 Dump after post-reload optimizations.
14586
14587 @item -fdump-rtl-pro_and_epilogue
14588 @opindex fdump-rtl-pro_and_epilogue
14589 Dump after generating the function prologues and epilogues.
14590
14591 @item -fdump-rtl-sched1
14592 @itemx -fdump-rtl-sched2
14593 @opindex fdump-rtl-sched1
14594 @opindex fdump-rtl-sched2
14595 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
14596 after the basic block scheduling passes.
14597
14598 @item -fdump-rtl-ree
14599 @opindex fdump-rtl-ree
14600 Dump after sign/zero extension elimination.
14601
14602 @item -fdump-rtl-seqabstr
14603 @opindex fdump-rtl-seqabstr
14604 Dump after common sequence discovery.
14605
14606 @item -fdump-rtl-shorten
14607 @opindex fdump-rtl-shorten
14608 Dump after shortening branches.
14609
14610 @item -fdump-rtl-sibling
14611 @opindex fdump-rtl-sibling
14612 Dump after sibling call optimizations.
14613
14614 @item -fdump-rtl-split1
14615 @itemx -fdump-rtl-split2
14616 @itemx -fdump-rtl-split3
14617 @itemx -fdump-rtl-split4
14618 @itemx -fdump-rtl-split5
14619 @opindex fdump-rtl-split1
14620 @opindex fdump-rtl-split2
14621 @opindex fdump-rtl-split3
14622 @opindex fdump-rtl-split4
14623 @opindex fdump-rtl-split5
14624 These options enable dumping after five rounds of
14625 instruction splitting.
14626
14627 @item -fdump-rtl-sms
14628 @opindex fdump-rtl-sms
14629 Dump after modulo scheduling. This pass is only run on some
14630 architectures.
14631
14632 @item -fdump-rtl-stack
14633 @opindex fdump-rtl-stack
14634 Dump after conversion from GCC's ``flat register file'' registers to the
14635 x87's stack-like registers. This pass is only run on x86 variants.
14636
14637 @item -fdump-rtl-subreg1
14638 @itemx -fdump-rtl-subreg2
14639 @opindex fdump-rtl-subreg1
14640 @opindex fdump-rtl-subreg2
14641 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
14642 the two subreg expansion passes.
14643
14644 @item -fdump-rtl-unshare
14645 @opindex fdump-rtl-unshare
14646 Dump after all rtl has been unshared.
14647
14648 @item -fdump-rtl-vartrack
14649 @opindex fdump-rtl-vartrack
14650 Dump after variable tracking.
14651
14652 @item -fdump-rtl-vregs
14653 @opindex fdump-rtl-vregs
14654 Dump after converting virtual registers to hard registers.
14655
14656 @item -fdump-rtl-web
14657 @opindex fdump-rtl-web
14658 Dump after live range splitting.
14659
14660 @item -fdump-rtl-regclass
14661 @itemx -fdump-rtl-subregs_of_mode_init
14662 @itemx -fdump-rtl-subregs_of_mode_finish
14663 @itemx -fdump-rtl-dfinit
14664 @itemx -fdump-rtl-dfinish
14665 @opindex fdump-rtl-regclass
14666 @opindex fdump-rtl-subregs_of_mode_init
14667 @opindex fdump-rtl-subregs_of_mode_finish
14668 @opindex fdump-rtl-dfinit
14669 @opindex fdump-rtl-dfinish
14670 These dumps are defined but always produce empty files.
14671
14672 @item -da
14673 @itemx -fdump-rtl-all
14674 @opindex da
14675 @opindex fdump-rtl-all
14676 Produce all the dumps listed above.
14677
14678 @item -dA
14679 @opindex dA
14680 Annotate the assembler output with miscellaneous debugging information.
14681
14682 @item -dD
14683 @opindex dD
14684 Dump all macro definitions, at the end of preprocessing, in addition to
14685 normal output.
14686
14687 @item -dH
14688 @opindex dH
14689 Produce a core dump whenever an error occurs.
14690
14691 @item -dp
14692 @opindex dp
14693 Annotate the assembler output with a comment indicating which
14694 pattern and alternative is used. The length and cost of each instruction are
14695 also printed.
14696
14697 @item -dP
14698 @opindex dP
14699 Dump the RTL in the assembler output as a comment before each instruction.
14700 Also turns on @option{-dp} annotation.
14701
14702 @item -dx
14703 @opindex dx
14704 Just generate RTL for a function instead of compiling it. Usually used
14705 with @option{-fdump-rtl-expand}.
14706 @end table
14707
14708 @item -fdump-debug
14709 @opindex fdump-debug
14710 Dump debugging information generated during the debug
14711 generation phase.
14712
14713 @item -fdump-earlydebug
14714 @opindex fdump-earlydebug
14715 Dump debugging information generated during the early debug
14716 generation phase.
14717
14718 @item -fdump-noaddr
14719 @opindex fdump-noaddr
14720 When doing debugging dumps, suppress address output. This makes it more
14721 feasible to use diff on debugging dumps for compiler invocations with
14722 different compiler binaries and/or different
14723 text / bss / data / heap / stack / dso start locations.
14724
14725 @item -freport-bug
14726 @opindex freport-bug
14727 Collect and dump debug information into a temporary file if an
14728 internal compiler error (ICE) occurs.
14729
14730 @item -fdump-unnumbered
14731 @opindex fdump-unnumbered
14732 When doing debugging dumps, suppress instruction numbers and address output.
14733 This makes it more feasible to use diff on debugging dumps for compiler
14734 invocations with different options, in particular with and without
14735 @option{-g}.
14736
14737 @item -fdump-unnumbered-links
14738 @opindex fdump-unnumbered-links
14739 When doing debugging dumps (see @option{-d} option above), suppress
14740 instruction numbers for the links to the previous and next instructions
14741 in a sequence.
14742
14743 @item -fdump-ipa-@var{switch}
14744 @itemx -fdump-ipa-@var{switch}-@var{options}
14745 @opindex fdump-ipa
14746 Control the dumping at various stages of inter-procedural analysis
14747 language tree to a file. The file name is generated by appending a
14748 switch specific suffix to the source file name, and the file is created
14749 in the same directory as the output file. The following dumps are
14750 possible:
14751
14752 @table @samp
14753 @item all
14754 Enables all inter-procedural analysis dumps.
14755
14756 @item cgraph
14757 Dumps information about call-graph optimization, unused function removal,
14758 and inlining decisions.
14759
14760 @item inline
14761 Dump after function inlining.
14762
14763 @end table
14764
14765 Additionally, the options @option{-optimized}, @option{-missed},
14766 @option{-note}, and @option{-all} can be provided, with the same meaning
14767 as for @option{-fopt-info}, defaulting to @option{-optimized}.
14768
14769 For example, @option{-fdump-ipa-inline-optimized-missed} will emit
14770 information on callsites that were inlined, along with callsites
14771 that were not inlined.
14772
14773 By default, the dump will contain messages about successful
14774 optimizations (equivalent to @option{-optimized}) together with
14775 low-level details about the analysis.
14776
14777 @item -fdump-lang-all
14778 @itemx -fdump-lang-@var{switch}
14779 @itemx -fdump-lang-@var{switch}-@var{options}
14780 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
14781 @opindex fdump-lang-all
14782 @opindex fdump-lang
14783 Control the dumping of language-specific information. The @var{options}
14784 and @var{filename} portions behave as described in the
14785 @option{-fdump-tree} option. The following @var{switch} values are
14786 accepted:
14787
14788 @table @samp
14789 @item all
14790
14791 Enable all language-specific dumps.
14792
14793 @item class
14794 Dump class hierarchy information. Virtual table information is emitted
14795 unless '@option{slim}' is specified. This option is applicable to C++ only.
14796
14797 @item raw
14798 Dump the raw internal tree data. This option is applicable to C++ only.
14799
14800 @end table
14801
14802 @item -fdump-passes
14803 @opindex fdump-passes
14804 Print on @file{stderr} the list of optimization passes that are turned
14805 on and off by the current command-line options.
14806
14807 @item -fdump-statistics-@var{option}
14808 @opindex fdump-statistics
14809 Enable and control dumping of pass statistics in a separate file. The
14810 file name is generated by appending a suffix ending in
14811 @samp{.statistics} to the source file name, and the file is created in
14812 the same directory as the output file. If the @samp{-@var{option}}
14813 form is used, @samp{-stats} causes counters to be summed over the
14814 whole compilation unit while @samp{-details} dumps every event as
14815 the passes generate them. The default with no option is to sum
14816 counters for each function compiled.
14817
14818 @item -fdump-tree-all
14819 @itemx -fdump-tree-@var{switch}
14820 @itemx -fdump-tree-@var{switch}-@var{options}
14821 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
14822 @opindex fdump-tree-all
14823 @opindex fdump-tree
14824 Control the dumping at various stages of processing the intermediate
14825 language tree to a file. If the @samp{-@var{options}}
14826 form is used, @var{options} is a list of @samp{-} separated options
14827 which control the details of the dump. Not all options are applicable
14828 to all dumps; those that are not meaningful are ignored. The
14829 following options are available
14830
14831 @table @samp
14832 @item address
14833 Print the address of each node. Usually this is not meaningful as it
14834 changes according to the environment and source file. Its primary use
14835 is for tying up a dump file with a debug environment.
14836 @item asmname
14837 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
14838 in the dump instead of @code{DECL_NAME}. Its primary use is ease of
14839 use working backward from mangled names in the assembly file.
14840 @item slim
14841 When dumping front-end intermediate representations, inhibit dumping
14842 of members of a scope or body of a function merely because that scope
14843 has been reached. Only dump such items when they are directly reachable
14844 by some other path.
14845
14846 When dumping pretty-printed trees, this option inhibits dumping the
14847 bodies of control structures.
14848
14849 When dumping RTL, print the RTL in slim (condensed) form instead of
14850 the default LISP-like representation.
14851 @item raw
14852 Print a raw representation of the tree. By default, trees are
14853 pretty-printed into a C-like representation.
14854 @item details
14855 Enable more detailed dumps (not honored by every dump option). Also
14856 include information from the optimization passes.
14857 @item stats
14858 Enable dumping various statistics about the pass (not honored by every dump
14859 option).
14860 @item blocks
14861 Enable showing basic block boundaries (disabled in raw dumps).
14862 @item graph
14863 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
14864 dump a representation of the control flow graph suitable for viewing with
14865 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}. Each function in
14866 the file is pretty-printed as a subgraph, so that GraphViz can render them
14867 all in a single plot.
14868
14869 This option currently only works for RTL dumps, and the RTL is always
14870 dumped in slim form.
14871 @item vops
14872 Enable showing virtual operands for every statement.
14873 @item lineno
14874 Enable showing line numbers for statements.
14875 @item uid
14876 Enable showing the unique ID (@code{DECL_UID}) for each variable.
14877 @item verbose
14878 Enable showing the tree dump for each statement.
14879 @item eh
14880 Enable showing the EH region number holding each statement.
14881 @item scev
14882 Enable showing scalar evolution analysis details.
14883 @item optimized
14884 Enable showing optimization information (only available in certain
14885 passes).
14886 @item missed
14887 Enable showing missed optimization information (only available in certain
14888 passes).
14889 @item note
14890 Enable other detailed optimization information (only available in
14891 certain passes).
14892 @item all
14893 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
14894 and @option{lineno}.
14895 @item optall
14896 Turn on all optimization options, i.e., @option{optimized},
14897 @option{missed}, and @option{note}.
14898 @end table
14899
14900 To determine what tree dumps are available or find the dump for a pass
14901 of interest follow the steps below.
14902
14903 @enumerate
14904 @item
14905 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
14906 look for a code that corresponds to the pass you are interested in.
14907 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
14908 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
14909 The number at the end distinguishes distinct invocations of the same pass.
14910 @item
14911 To enable the creation of the dump file, append the pass code to
14912 the @option{-fdump-} option prefix and invoke GCC with it. For example,
14913 to enable the dump from the Early Value Range Propagation pass, invoke
14914 GCC with the @option{-fdump-tree-evrp} option. Optionally, you may
14915 specify the name of the dump file. If you don't specify one, GCC
14916 creates as described below.
14917 @item
14918 Find the pass dump in a file whose name is composed of three components
14919 separated by a period: the name of the source file GCC was invoked to
14920 compile, a numeric suffix indicating the pass number followed by the
14921 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
14922 and finally the pass code. For example, the Early VRP pass dump might
14923 be in a file named @file{myfile.c.038t.evrp} in the current working
14924 directory. Note that the numeric codes are not stable and may change
14925 from one version of GCC to another.
14926 @end enumerate
14927
14928 @item -fopt-info
14929 @itemx -fopt-info-@var{options}
14930 @itemx -fopt-info-@var{options}=@var{filename}
14931 @opindex fopt-info
14932 Controls optimization dumps from various optimization passes. If the
14933 @samp{-@var{options}} form is used, @var{options} is a list of
14934 @samp{-} separated option keywords to select the dump details and
14935 optimizations.
14936
14937 The @var{options} can be divided into three groups:
14938 @enumerate
14939 @item
14940 options describing what kinds of messages should be emitted,
14941 @item
14942 options describing the verbosity of the dump, and
14943 @item
14944 options describing which optimizations should be included.
14945 @end enumerate
14946 The options from each group can be freely mixed as they are
14947 non-overlapping. However, in case of any conflicts,
14948 the later options override the earlier options on the command
14949 line.
14950
14951 The following options control which kinds of messages should be emitted:
14952
14953 @table @samp
14954 @item optimized
14955 Print information when an optimization is successfully applied. It is
14956 up to a pass to decide which information is relevant. For example, the
14957 vectorizer passes print the source location of loops which are
14958 successfully vectorized.
14959 @item missed
14960 Print information about missed optimizations. Individual passes
14961 control which information to include in the output.
14962 @item note
14963 Print verbose information about optimizations, such as certain
14964 transformations, more detailed messages about decisions etc.
14965 @item all
14966 Print detailed optimization information. This includes
14967 @samp{optimized}, @samp{missed}, and @samp{note}.
14968 @end table
14969
14970 The following option controls the dump verbosity:
14971
14972 @table @samp
14973 @item internals
14974 By default, only ``high-level'' messages are emitted. This option enables
14975 additional, more detailed, messages, which are likely to only be of interest
14976 to GCC developers.
14977 @end table
14978
14979 One or more of the following option keywords can be used to describe a
14980 group of optimizations:
14981
14982 @table @samp
14983 @item ipa
14984 Enable dumps from all interprocedural optimizations.
14985 @item loop
14986 Enable dumps from all loop optimizations.
14987 @item inline
14988 Enable dumps from all inlining optimizations.
14989 @item omp
14990 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
14991 @item vec
14992 Enable dumps from all vectorization optimizations.
14993 @item optall
14994 Enable dumps from all optimizations. This is a superset of
14995 the optimization groups listed above.
14996 @end table
14997
14998 If @var{options} is
14999 omitted, it defaults to @samp{optimized-optall}, which means to dump messages
15000 about successful optimizations from all the passes, omitting messages
15001 that are treated as ``internals''.
15002
15003 If the @var{filename} is provided, then the dumps from all the
15004 applicable optimizations are concatenated into the @var{filename}.
15005 Otherwise the dump is output onto @file{stderr}. Though multiple
15006 @option{-fopt-info} options are accepted, only one of them can include
15007 a @var{filename}. If other filenames are provided then all but the
15008 first such option are ignored.
15009
15010 Note that the output @var{filename} is overwritten
15011 in case of multiple translation units. If a combined output from
15012 multiple translation units is desired, @file{stderr} should be used
15013 instead.
15014
15015 In the following example, the optimization info is output to
15016 @file{stderr}:
15017
15018 @smallexample
15019 gcc -O3 -fopt-info
15020 @end smallexample
15021
15022 This example:
15023 @smallexample
15024 gcc -O3 -fopt-info-missed=missed.all
15025 @end smallexample
15026
15027 @noindent
15028 outputs missed optimization report from all the passes into
15029 @file{missed.all}, and this one:
15030
15031 @smallexample
15032 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
15033 @end smallexample
15034
15035 @noindent
15036 prints information about missed optimization opportunities from
15037 vectorization passes on @file{stderr}.
15038 Note that @option{-fopt-info-vec-missed} is equivalent to
15039 @option{-fopt-info-missed-vec}. The order of the optimization group
15040 names and message types listed after @option{-fopt-info} does not matter.
15041
15042 As another example,
15043 @smallexample
15044 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
15045 @end smallexample
15046
15047 @noindent
15048 outputs information about missed optimizations as well as
15049 optimized locations from all the inlining passes into
15050 @file{inline.txt}.
15051
15052 Finally, consider:
15053
15054 @smallexample
15055 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
15056 @end smallexample
15057
15058 @noindent
15059 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
15060 in conflict since only one output file is allowed. In this case, only
15061 the first option takes effect and the subsequent options are
15062 ignored. Thus only @file{vec.miss} is produced which contains
15063 dumps from the vectorizer about missed opportunities.
15064
15065 @item -fsave-optimization-record
15066 @opindex fsave-optimization-record
15067 Write a SRCFILE.opt-record.json.gz file detailing what optimizations
15068 were performed, for those optimizations that support @option{-fopt-info}.
15069
15070 This option is experimental and the format of the data within the
15071 compressed JSON file is subject to change.
15072
15073 It is roughly equivalent to a machine-readable version of
15074 @option{-fopt-info-all}, as a collection of messages with source file,
15075 line number and column number, with the following additional data for
15076 each message:
15077
15078 @itemize @bullet
15079
15080 @item
15081 the execution count of the code being optimized, along with metadata about
15082 whether this was from actual profile data, or just an estimate, allowing
15083 consumers to prioritize messages by code hotness,
15084
15085 @item
15086 the function name of the code being optimized, where applicable,
15087
15088 @item
15089 the ``inlining chain'' for the code being optimized, so that when
15090 a function is inlined into several different places (which might
15091 themselves be inlined), the reader can distinguish between the copies,
15092
15093 @item
15094 objects identifying those parts of the message that refer to expressions,
15095 statements or symbol-table nodes, which of these categories they are, and,
15096 when available, their source code location,
15097
15098 @item
15099 the GCC pass that emitted the message, and
15100
15101 @item
15102 the location in GCC's own code from which the message was emitted
15103
15104 @end itemize
15105
15106 Additionally, some messages are logically nested within other
15107 messages, reflecting implementation details of the optimization
15108 passes.
15109
15110 @item -fsched-verbose=@var{n}
15111 @opindex fsched-verbose
15112 On targets that use instruction scheduling, this option controls the
15113 amount of debugging output the scheduler prints to the dump files.
15114
15115 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
15116 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
15117 For @var{n} greater than one, it also output basic block probabilities,
15118 detailed ready list information and unit/insn info. For @var{n} greater
15119 than two, it includes RTL at abort point, control-flow and regions info.
15120 And for @var{n} over four, @option{-fsched-verbose} also includes
15121 dependence info.
15122
15123
15124
15125 @item -fenable-@var{kind}-@var{pass}
15126 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
15127 @opindex fdisable-
15128 @opindex fenable-
15129
15130 This is a set of options that are used to explicitly disable/enable
15131 optimization passes. These options are intended for use for debugging GCC.
15132 Compiler users should use regular options for enabling/disabling
15133 passes instead.
15134
15135 @table @gcctabopt
15136
15137 @item -fdisable-ipa-@var{pass}
15138 Disable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
15139 statically invoked in the compiler multiple times, the pass name should be
15140 appended with a sequential number starting from 1.
15141
15142 @item -fdisable-rtl-@var{pass}
15143 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
15144 Disable RTL pass @var{pass}. @var{pass} is the pass name. If the same pass is
15145 statically invoked in the compiler multiple times, the pass name should be
15146 appended with a sequential number starting from 1. @var{range-list} is a
15147 comma-separated list of function ranges or assembler names. Each range is a number
15148 pair separated by a colon. The range is inclusive in both ends. If the range
15149 is trivial, the number pair can be simplified as a single number. If the
15150 function's call graph node's @var{uid} falls within one of the specified ranges,
15151 the @var{pass} is disabled for that function. The @var{uid} is shown in the
15152 function header of a dump file, and the pass names can be dumped by using
15153 option @option{-fdump-passes}.
15154
15155 @item -fdisable-tree-@var{pass}
15156 @itemx -fdisable-tree-@var{pass}=@var{range-list}
15157 Disable tree pass @var{pass}. See @option{-fdisable-rtl} for the description of
15158 option arguments.
15159
15160 @item -fenable-ipa-@var{pass}
15161 Enable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is
15162 statically invoked in the compiler multiple times, the pass name should be
15163 appended with a sequential number starting from 1.
15164
15165 @item -fenable-rtl-@var{pass}
15166 @itemx -fenable-rtl-@var{pass}=@var{range-list}
15167 Enable RTL pass @var{pass}. See @option{-fdisable-rtl} for option argument
15168 description and examples.
15169
15170 @item -fenable-tree-@var{pass}
15171 @itemx -fenable-tree-@var{pass}=@var{range-list}
15172 Enable tree pass @var{pass}. See @option{-fdisable-rtl} for the description
15173 of option arguments.
15174
15175 @end table
15176
15177 Here are some examples showing uses of these options.
15178
15179 @smallexample
15180
15181 # disable ccp1 for all functions
15182 -fdisable-tree-ccp1
15183 # disable complete unroll for function whose cgraph node uid is 1
15184 -fenable-tree-cunroll=1
15185 # disable gcse2 for functions at the following ranges [1,1],
15186 # [300,400], and [400,1000]
15187 # disable gcse2 for functions foo and foo2
15188 -fdisable-rtl-gcse2=foo,foo2
15189 # disable early inlining
15190 -fdisable-tree-einline
15191 # disable ipa inlining
15192 -fdisable-ipa-inline
15193 # enable tree full unroll
15194 -fenable-tree-unroll
15195
15196 @end smallexample
15197
15198 @item -fchecking
15199 @itemx -fchecking=@var{n}
15200 @opindex fchecking
15201 @opindex fno-checking
15202 Enable internal consistency checking. The default depends on
15203 the compiler configuration. @option{-fchecking=2} enables further
15204 internal consistency checking that might affect code generation.
15205
15206 @item -frandom-seed=@var{string}
15207 @opindex frandom-seed
15208 This option provides a seed that GCC uses in place of
15209 random numbers in generating certain symbol names
15210 that have to be different in every compiled file. It is also used to
15211 place unique stamps in coverage data files and the object files that
15212 produce them. You can use the @option{-frandom-seed} option to produce
15213 reproducibly identical object files.
15214
15215 The @var{string} can either be a number (decimal, octal or hex) or an
15216 arbitrary string (in which case it's converted to a number by
15217 computing CRC32).
15218
15219 The @var{string} should be different for every file you compile.
15220
15221 @item -save-temps
15222 @itemx -save-temps=cwd
15223 @opindex save-temps
15224 Store the usual ``temporary'' intermediate files permanently; place them
15225 in the current directory and name them based on the source file. Thus,
15226 compiling @file{foo.c} with @option{-c -save-temps} produces files
15227 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
15228 preprocessed @file{foo.i} output file even though the compiler now
15229 normally uses an integrated preprocessor.
15230
15231 When used in combination with the @option{-x} command-line option,
15232 @option{-save-temps} is sensible enough to avoid over writing an
15233 input source file with the same extension as an intermediate file.
15234 The corresponding intermediate file may be obtained by renaming the
15235 source file before using @option{-save-temps}.
15236
15237 If you invoke GCC in parallel, compiling several different source
15238 files that share a common base name in different subdirectories or the
15239 same source file compiled for multiple output destinations, it is
15240 likely that the different parallel compilers will interfere with each
15241 other, and overwrite the temporary files. For instance:
15242
15243 @smallexample
15244 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
15245 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
15246 @end smallexample
15247
15248 may result in @file{foo.i} and @file{foo.o} being written to
15249 simultaneously by both compilers.
15250
15251 @item -save-temps=obj
15252 @opindex save-temps=obj
15253 Store the usual ``temporary'' intermediate files permanently. If the
15254 @option{-o} option is used, the temporary files are based on the
15255 object file. If the @option{-o} option is not used, the
15256 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
15257
15258 For example:
15259
15260 @smallexample
15261 gcc -save-temps=obj -c foo.c
15262 gcc -save-temps=obj -c bar.c -o dir/xbar.o
15263 gcc -save-temps=obj foobar.c -o dir2/yfoobar
15264 @end smallexample
15265
15266 @noindent
15267 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
15268 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
15269 @file{dir2/yfoobar.o}.
15270
15271 @item -time@r{[}=@var{file}@r{]}
15272 @opindex time
15273 Report the CPU time taken by each subprocess in the compilation
15274 sequence. For C source files, this is the compiler proper and assembler
15275 (plus the linker if linking is done).
15276
15277 Without the specification of an output file, the output looks like this:
15278
15279 @smallexample
15280 # cc1 0.12 0.01
15281 # as 0.00 0.01
15282 @end smallexample
15283
15284 The first number on each line is the ``user time'', that is time spent
15285 executing the program itself. The second number is ``system time'',
15286 time spent executing operating system routines on behalf of the program.
15287 Both numbers are in seconds.
15288
15289 With the specification of an output file, the output is appended to the
15290 named file, and it looks like this:
15291
15292 @smallexample
15293 0.12 0.01 cc1 @var{options}
15294 0.00 0.01 as @var{options}
15295 @end smallexample
15296
15297 The ``user time'' and the ``system time'' are moved before the program
15298 name, and the options passed to the program are displayed, so that one
15299 can later tell what file was being compiled, and with which options.
15300
15301 @item -fdump-final-insns@r{[}=@var{file}@r{]}
15302 @opindex fdump-final-insns
15303 Dump the final internal representation (RTL) to @var{file}. If the
15304 optional argument is omitted (or if @var{file} is @code{.}), the name
15305 of the dump file is determined by appending @code{.gkd} to the
15306 compilation output file name.
15307
15308 @item -fcompare-debug@r{[}=@var{opts}@r{]}
15309 @opindex fcompare-debug
15310 @opindex fno-compare-debug
15311 If no error occurs during compilation, run the compiler a second time,
15312 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
15313 passed to the second compilation. Dump the final internal
15314 representation in both compilations, and print an error if they differ.
15315
15316 If the equal sign is omitted, the default @option{-gtoggle} is used.
15317
15318 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
15319 and nonzero, implicitly enables @option{-fcompare-debug}. If
15320 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
15321 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
15322 is used.
15323
15324 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
15325 is equivalent to @option{-fno-compare-debug}, which disables the dumping
15326 of the final representation and the second compilation, preventing even
15327 @env{GCC_COMPARE_DEBUG} from taking effect.
15328
15329 To verify full coverage during @option{-fcompare-debug} testing, set
15330 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
15331 which GCC rejects as an invalid option in any actual compilation
15332 (rather than preprocessing, assembly or linking). To get just a
15333 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
15334 not overridden} will do.
15335
15336 @item -fcompare-debug-second
15337 @opindex fcompare-debug-second
15338 This option is implicitly passed to the compiler for the second
15339 compilation requested by @option{-fcompare-debug}, along with options to
15340 silence warnings, and omitting other options that would cause the compiler
15341 to produce output to files or to standard output as a side effect. Dump
15342 files and preserved temporary files are renamed so as to contain the
15343 @code{.gk} additional extension during the second compilation, to avoid
15344 overwriting those generated by the first.
15345
15346 When this option is passed to the compiler driver, it causes the
15347 @emph{first} compilation to be skipped, which makes it useful for little
15348 other than debugging the compiler proper.
15349
15350 @item -gtoggle
15351 @opindex gtoggle
15352 Turn off generation of debug info, if leaving out this option
15353 generates it, or turn it on at level 2 otherwise. The position of this
15354 argument in the command line does not matter; it takes effect after all
15355 other options are processed, and it does so only once, no matter how
15356 many times it is given. This is mainly intended to be used with
15357 @option{-fcompare-debug}.
15358
15359 @item -fvar-tracking-assignments-toggle
15360 @opindex fvar-tracking-assignments-toggle
15361 @opindex fno-var-tracking-assignments-toggle
15362 Toggle @option{-fvar-tracking-assignments}, in the same way that
15363 @option{-gtoggle} toggles @option{-g}.
15364
15365 @item -Q
15366 @opindex Q
15367 Makes the compiler print out each function name as it is compiled, and
15368 print some statistics about each pass when it finishes.
15369
15370 @item -ftime-report
15371 @opindex ftime-report
15372 Makes the compiler print some statistics about the time consumed by each
15373 pass when it finishes.
15374
15375 @item -ftime-report-details
15376 @opindex ftime-report-details
15377 Record the time consumed by infrastructure parts separately for each pass.
15378
15379 @item -fira-verbose=@var{n}
15380 @opindex fira-verbose
15381 Control the verbosity of the dump file for the integrated register allocator.
15382 The default value is 5. If the value @var{n} is greater or equal to 10,
15383 the dump output is sent to stderr using the same format as @var{n} minus 10.
15384
15385 @item -flto-report
15386 @opindex flto-report
15387 Prints a report with internal details on the workings of the link-time
15388 optimizer. The contents of this report vary from version to version.
15389 It is meant to be useful to GCC developers when processing object
15390 files in LTO mode (via @option{-flto}).
15391
15392 Disabled by default.
15393
15394 @item -flto-report-wpa
15395 @opindex flto-report-wpa
15396 Like @option{-flto-report}, but only print for the WPA phase of link-time
15397 optimization.
15398
15399 @item -fmem-report
15400 @opindex fmem-report
15401 Makes the compiler print some statistics about permanent memory
15402 allocation when it finishes.
15403
15404 @item -fmem-report-wpa
15405 @opindex fmem-report-wpa
15406 Makes the compiler print some statistics about permanent memory
15407 allocation for the WPA phase only.
15408
15409 @item -fpre-ipa-mem-report
15410 @opindex fpre-ipa-mem-report
15411 @item -fpost-ipa-mem-report
15412 @opindex fpost-ipa-mem-report
15413 Makes the compiler print some statistics about permanent memory
15414 allocation before or after interprocedural optimization.
15415
15416 @item -fprofile-report
15417 @opindex fprofile-report
15418 Makes the compiler print some statistics about consistency of the
15419 (estimated) profile and effect of individual passes.
15420
15421 @item -fstack-usage
15422 @opindex fstack-usage
15423 Makes the compiler output stack usage information for the program, on a
15424 per-function basis. The filename for the dump is made by appending
15425 @file{.su} to the @var{auxname}. @var{auxname} is generated from the name of
15426 the output file, if explicitly specified and it is not an executable,
15427 otherwise it is the basename of the source file. An entry is made up
15428 of three fields:
15429
15430 @itemize
15431 @item
15432 The name of the function.
15433 @item
15434 A number of bytes.
15435 @item
15436 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
15437 @end itemize
15438
15439 The qualifier @code{static} means that the function manipulates the stack
15440 statically: a fixed number of bytes are allocated for the frame on function
15441 entry and released on function exit; no stack adjustments are otherwise made
15442 in the function. The second field is this fixed number of bytes.
15443
15444 The qualifier @code{dynamic} means that the function manipulates the stack
15445 dynamically: in addition to the static allocation described above, stack
15446 adjustments are made in the body of the function, for example to push/pop
15447 arguments around function calls. If the qualifier @code{bounded} is also
15448 present, the amount of these adjustments is bounded at compile time and
15449 the second field is an upper bound of the total amount of stack used by
15450 the function. If it is not present, the amount of these adjustments is
15451 not bounded at compile time and the second field only represents the
15452 bounded part.
15453
15454 @item -fstats
15455 @opindex fstats
15456 Emit statistics about front-end processing at the end of the compilation.
15457 This option is supported only by the C++ front end, and
15458 the information is generally only useful to the G++ development team.
15459
15460 @item -fdbg-cnt-list
15461 @opindex fdbg-cnt-list
15462 Print the name and the counter upper bound for all debug counters.
15463
15464
15465 @item -fdbg-cnt=@var{counter-value-list}
15466 @opindex fdbg-cnt
15467 Set the internal debug counter lower and upper bound. @var{counter-value-list}
15468 is a comma-separated list of @var{name}:@var{lower_bound}:@var{upper_bound}
15469 tuples which sets the lower and the upper bound of each debug
15470 counter @var{name}. The @var{lower_bound} is optional and is zero
15471 initialized if not set.
15472 All debug counters have the initial upper bound of @code{UINT_MAX};
15473 thus @code{dbg_cnt} returns true always unless the upper bound
15474 is set by this option.
15475 For example, with @option{-fdbg-cnt=dce:2:4,tail_call:10},
15476 @code{dbg_cnt(dce)} returns true only for third and fourth invocation.
15477 For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
15478
15479 @item -print-file-name=@var{library}
15480 @opindex print-file-name
15481 Print the full absolute name of the library file @var{library} that
15482 would be used when linking---and don't do anything else. With this
15483 option, GCC does not compile or link anything; it just prints the
15484 file name.
15485
15486 @item -print-multi-directory
15487 @opindex print-multi-directory
15488 Print the directory name corresponding to the multilib selected by any
15489 other switches present in the command line. This directory is supposed
15490 to exist in @env{GCC_EXEC_PREFIX}.
15491
15492 @item -print-multi-lib
15493 @opindex print-multi-lib
15494 Print the mapping from multilib directory names to compiler switches
15495 that enable them. The directory name is separated from the switches by
15496 @samp{;}, and each switch starts with an @samp{@@} instead of the
15497 @samp{-}, without spaces between multiple switches. This is supposed to
15498 ease shell processing.
15499
15500 @item -print-multi-os-directory
15501 @opindex print-multi-os-directory
15502 Print the path to OS libraries for the selected
15503 multilib, relative to some @file{lib} subdirectory. If OS libraries are
15504 present in the @file{lib} subdirectory and no multilibs are used, this is
15505 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
15506 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
15507 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
15508 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
15509
15510 @item -print-multiarch
15511 @opindex print-multiarch
15512 Print the path to OS libraries for the selected multiarch,
15513 relative to some @file{lib} subdirectory.
15514
15515 @item -print-prog-name=@var{program}
15516 @opindex print-prog-name
15517 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
15518
15519 @item -print-libgcc-file-name
15520 @opindex print-libgcc-file-name
15521 Same as @option{-print-file-name=libgcc.a}.
15522
15523 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
15524 but you do want to link with @file{libgcc.a}. You can do:
15525
15526 @smallexample
15527 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
15528 @end smallexample
15529
15530 @item -print-search-dirs
15531 @opindex print-search-dirs
15532 Print the name of the configured installation directory and a list of
15533 program and library directories @command{gcc} searches---and don't do anything else.
15534
15535 This is useful when @command{gcc} prints the error message
15536 @samp{installation problem, cannot exec cpp0: No such file or directory}.
15537 To resolve this you either need to put @file{cpp0} and the other compiler
15538 components where @command{gcc} expects to find them, or you can set the environment
15539 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
15540 Don't forget the trailing @samp{/}.
15541 @xref{Environment Variables}.
15542
15543 @item -print-sysroot
15544 @opindex print-sysroot
15545 Print the target sysroot directory that is used during
15546 compilation. This is the target sysroot specified either at configure
15547 time or using the @option{--sysroot} option, possibly with an extra
15548 suffix that depends on compilation options. If no target sysroot is
15549 specified, the option prints nothing.
15550
15551 @item -print-sysroot-headers-suffix
15552 @opindex print-sysroot-headers-suffix
15553 Print the suffix added to the target sysroot when searching for
15554 headers, or give an error if the compiler is not configured with such
15555 a suffix---and don't do anything else.
15556
15557 @item -dumpmachine
15558 @opindex dumpmachine
15559 Print the compiler's target machine (for example,
15560 @samp{i686-pc-linux-gnu})---and don't do anything else.
15561
15562 @item -dumpversion
15563 @opindex dumpversion
15564 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
15565 anything else. This is the compiler version used in filesystem paths and
15566 specs. Depending on how the compiler has been configured it can be just
15567 a single number (major version), two numbers separated by a dot (major and
15568 minor version) or three numbers separated by dots (major, minor and patchlevel
15569 version).
15570
15571 @item -dumpfullversion
15572 @opindex dumpfullversion
15573 Print the full compiler version---and don't do anything else. The output is
15574 always three numbers separated by dots, major, minor and patchlevel version.
15575
15576 @item -dumpspecs
15577 @opindex dumpspecs
15578 Print the compiler's built-in specs---and don't do anything else. (This
15579 is used when GCC itself is being built.) @xref{Spec Files}.
15580 @end table
15581
15582 @node Submodel Options
15583 @section Machine-Dependent Options
15584 @cindex submodel options
15585 @cindex specifying hardware config
15586 @cindex hardware models and configurations, specifying
15587 @cindex target-dependent options
15588 @cindex machine-dependent options
15589
15590 Each target machine supported by GCC can have its own options---for
15591 example, to allow you to compile for a particular processor variant or
15592 ABI, or to control optimizations specific to that machine. By
15593 convention, the names of machine-specific options start with
15594 @samp{-m}.
15595
15596 Some configurations of the compiler also support additional target-specific
15597 options, usually for compatibility with other compilers on the same
15598 platform.
15599
15600 @c This list is ordered alphanumerically by subsection name.
15601 @c It should be the same order and spelling as these options are listed
15602 @c in Machine Dependent Options
15603
15604 @menu
15605 * AArch64 Options::
15606 * Adapteva Epiphany Options::
15607 * AMD GCN Options::
15608 * ARC Options::
15609 * ARM Options::
15610 * AVR Options::
15611 * Blackfin Options::
15612 * C6X Options::
15613 * CRIS Options::
15614 * CR16 Options::
15615 * C-SKY Options::
15616 * Darwin Options::
15617 * DEC Alpha Options::
15618 * FR30 Options::
15619 * FT32 Options::
15620 * FRV Options::
15621 * GNU/Linux Options::
15622 * H8/300 Options::
15623 * HPPA Options::
15624 * IA-64 Options::
15625 * LM32 Options::
15626 * M32C Options::
15627 * M32R/D Options::
15628 * M680x0 Options::
15629 * MCore Options::
15630 * MeP Options::
15631 * MicroBlaze Options::
15632 * MIPS Options::
15633 * MMIX Options::
15634 * MN10300 Options::
15635 * Moxie Options::
15636 * MSP430 Options::
15637 * NDS32 Options::
15638 * Nios II Options::
15639 * Nvidia PTX Options::
15640 * OpenRISC Options::
15641 * PDP-11 Options::
15642 * picoChip Options::
15643 * PowerPC Options::
15644 * PRU Options::
15645 * RISC-V Options::
15646 * RL78 Options::
15647 * RS/6000 and PowerPC Options::
15648 * RX Options::
15649 * S/390 and zSeries Options::
15650 * Score Options::
15651 * SH Options::
15652 * Solaris 2 Options::
15653 * SPARC Options::
15654 * SPU Options::
15655 * System V Options::
15656 * TILE-Gx Options::
15657 * TILEPro Options::
15658 * V850 Options::
15659 * VAX Options::
15660 * Visium Options::
15661 * VMS Options::
15662 * VxWorks Options::
15663 * x86 Options::
15664 * x86 Windows Options::
15665 * Xstormy16 Options::
15666 * Xtensa Options::
15667 * zSeries Options::
15668 @end menu
15669
15670 @node AArch64 Options
15671 @subsection AArch64 Options
15672 @cindex AArch64 Options
15673
15674 These options are defined for AArch64 implementations:
15675
15676 @table @gcctabopt
15677
15678 @item -mabi=@var{name}
15679 @opindex mabi
15680 Generate code for the specified data model. Permissible values
15681 are @samp{ilp32} for SysV-like data model where int, long int and pointers
15682 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
15683 but long int and pointers are 64 bits.
15684
15685 The default depends on the specific target configuration. Note that
15686 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
15687 entire program with the same ABI, and link with a compatible set of libraries.
15688
15689 @item -mbig-endian
15690 @opindex mbig-endian
15691 Generate big-endian code. This is the default when GCC is configured for an
15692 @samp{aarch64_be-*-*} target.
15693
15694 @item -mgeneral-regs-only
15695 @opindex mgeneral-regs-only
15696 Generate code which uses only the general-purpose registers. This will prevent
15697 the compiler from using floating-point and Advanced SIMD registers but will not
15698 impose any restrictions on the assembler.
15699
15700 @item -mlittle-endian
15701 @opindex mlittle-endian
15702 Generate little-endian code. This is the default when GCC is configured for an
15703 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
15704
15705 @item -mcmodel=tiny
15706 @opindex mcmodel=tiny
15707 Generate code for the tiny code model. The program and its statically defined
15708 symbols must be within 1MB of each other. Programs can be statically or
15709 dynamically linked.
15710
15711 @item -mcmodel=small
15712 @opindex mcmodel=small
15713 Generate code for the small code model. The program and its statically defined
15714 symbols must be within 4GB of each other. Programs can be statically or
15715 dynamically linked. This is the default code model.
15716
15717 @item -mcmodel=large
15718 @opindex mcmodel=large
15719 Generate code for the large code model. This makes no assumptions about
15720 addresses and sizes of sections. Programs can be statically linked only.
15721
15722 @item -mstrict-align
15723 @itemx -mno-strict-align
15724 @opindex mstrict-align
15725 @opindex mno-strict-align
15726 Avoid or allow generating memory accesses that may not be aligned on a natural
15727 object boundary as described in the architecture specification.
15728
15729 @item -momit-leaf-frame-pointer
15730 @itemx -mno-omit-leaf-frame-pointer
15731 @opindex momit-leaf-frame-pointer
15732 @opindex mno-omit-leaf-frame-pointer
15733 Omit or keep the frame pointer in leaf functions. The former behavior is the
15734 default.
15735
15736 @item -mstack-protector-guard=@var{guard}
15737 @itemx -mstack-protector-guard-reg=@var{reg}
15738 @itemx -mstack-protector-guard-offset=@var{offset}
15739 @opindex mstack-protector-guard
15740 @opindex mstack-protector-guard-reg
15741 @opindex mstack-protector-guard-offset
15742 Generate stack protection code using canary at @var{guard}. Supported
15743 locations are @samp{global} for a global canary or @samp{sysreg} for a
15744 canary in an appropriate system register.
15745
15746 With the latter choice the options
15747 @option{-mstack-protector-guard-reg=@var{reg}} and
15748 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
15749 which system register to use as base register for reading the canary,
15750 and from what offset from that base register. There is no default
15751 register or offset as this is entirely for use within the Linux
15752 kernel.
15753
15754 @item -mstack-protector-guard=@var{guard}
15755 @itemx -mstack-protector-guard-reg=@var{reg}
15756 @itemx -mstack-protector-guard-offset=@var{offset}
15757 @opindex mstack-protector-guard
15758 @opindex mstack-protector-guard-reg
15759 @opindex mstack-protector-guard-offset
15760 Generate stack protection code using canary at @var{guard}. Supported
15761 locations are @samp{global} for a global canary or @samp{sysreg} for a
15762 canary in an appropriate system register.
15763
15764 With the latter choice the options
15765 @option{-mstack-protector-guard-reg=@var{reg}} and
15766 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
15767 which system register to use as base register for reading the canary,
15768 and from what offset from that base register. There is no default
15769 register or offset as this is entirely for use within the Linux
15770 kernel.
15771
15772 @item -mtls-dialect=desc
15773 @opindex mtls-dialect=desc
15774 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
15775 of TLS variables. This is the default.
15776
15777 @item -mtls-dialect=traditional
15778 @opindex mtls-dialect=traditional
15779 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
15780 of TLS variables.
15781
15782 @item -mtls-size=@var{size}
15783 @opindex mtls-size
15784 Specify bit size of immediate TLS offsets. Valid values are 12, 24, 32, 48.
15785 This option requires binutils 2.26 or newer.
15786
15787 @item -mfix-cortex-a53-835769
15788 @itemx -mno-fix-cortex-a53-835769
15789 @opindex mfix-cortex-a53-835769
15790 @opindex mno-fix-cortex-a53-835769
15791 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
15792 This involves inserting a NOP instruction between memory instructions and
15793 64-bit integer multiply-accumulate instructions.
15794
15795 @item -mfix-cortex-a53-843419
15796 @itemx -mno-fix-cortex-a53-843419
15797 @opindex mfix-cortex-a53-843419
15798 @opindex mno-fix-cortex-a53-843419
15799 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
15800 This erratum workaround is made at link time and this will only pass the
15801 corresponding flag to the linker.
15802
15803 @item -mlow-precision-recip-sqrt
15804 @itemx -mno-low-precision-recip-sqrt
15805 @opindex mlow-precision-recip-sqrt
15806 @opindex mno-low-precision-recip-sqrt
15807 Enable or disable the reciprocal square root approximation.
15808 This option only has an effect if @option{-ffast-math} or
15809 @option{-funsafe-math-optimizations} is used as well. Enabling this reduces
15810 precision of reciprocal square root results to about 16 bits for
15811 single precision and to 32 bits for double precision.
15812
15813 @item -mlow-precision-sqrt
15814 @itemx -mno-low-precision-sqrt
15815 @opindex mlow-precision-sqrt
15816 @opindex mno-low-precision-sqrt
15817 Enable or disable the square root approximation.
15818 This option only has an effect if @option{-ffast-math} or
15819 @option{-funsafe-math-optimizations} is used as well. Enabling this reduces
15820 precision of square root results to about 16 bits for
15821 single precision and to 32 bits for double precision.
15822 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
15823
15824 @item -mlow-precision-div
15825 @itemx -mno-low-precision-div
15826 @opindex mlow-precision-div
15827 @opindex mno-low-precision-div
15828 Enable or disable the division approximation.
15829 This option only has an effect if @option{-ffast-math} or
15830 @option{-funsafe-math-optimizations} is used as well. Enabling this reduces
15831 precision of division results to about 16 bits for
15832 single precision and to 32 bits for double precision.
15833
15834 @item -mtrack-speculation
15835 @itemx -mno-track-speculation
15836 Enable or disable generation of additional code to track speculative
15837 execution through conditional branches. The tracking state can then
15838 be used by the compiler when expanding calls to
15839 @code{__builtin_speculation_safe_copy} to permit a more efficient code
15840 sequence to be generated.
15841
15842 @item -march=@var{name}
15843 @opindex march
15844 Specify the name of the target architecture and, optionally, one or
15845 more feature modifiers. This option has the form
15846 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
15847
15848 The permissible values for @var{arch} are @samp{armv8-a},
15849 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a}, @samp{armv8.4-a},
15850 @samp{armv8.5-a} or @var{native}.
15851
15852 The value @samp{armv8.5-a} implies @samp{armv8.4-a} and enables compiler
15853 support for the ARMv8.5-A architecture extensions.
15854
15855 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
15856 support for the ARMv8.4-A architecture extensions.
15857
15858 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
15859 support for the ARMv8.3-A architecture extensions.
15860
15861 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
15862 support for the ARMv8.2-A architecture extensions.
15863
15864 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
15865 support for the ARMv8.1-A architecture extension. In particular, it
15866 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
15867
15868 The value @samp{native} is available on native AArch64 GNU/Linux and
15869 causes the compiler to pick the architecture of the host system. This
15870 option has no effect if the compiler is unable to recognize the
15871 architecture of the host system,
15872
15873 The permissible values for @var{feature} are listed in the sub-section
15874 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
15875 Feature Modifiers}. Where conflicting feature modifiers are
15876 specified, the right-most feature is used.
15877
15878 GCC uses @var{name} to determine what kind of instructions it can emit
15879 when generating assembly code. If @option{-march} is specified
15880 without either of @option{-mtune} or @option{-mcpu} also being
15881 specified, the code is tuned to perform well across a range of target
15882 processors implementing the target architecture.
15883
15884 @item -mtune=@var{name}
15885 @opindex mtune
15886 Specify the name of the target processor for which GCC should tune the
15887 performance of the code. Permissible values for this option are:
15888 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15889 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15890 @samp{cortex-a76}, @samp{ares}, @samp{exynos-m1}, @samp{emag}, @samp{falkor},
15891 @samp{neoverse-e1},@samp{neoverse-n1},@samp{qdf24xx}, @samp{saphira},
15892 @samp{phecda}, @samp{xgene1}, @samp{vulcan}, @samp{octeontx},
15893 @samp{octeontx81}, @samp{octeontx83}, @samp{thunderx}, @samp{thunderxt88},
15894 @samp{thunderxt88p1}, @samp{thunderxt81}, @samp{tsv110},
15895 @samp{thunderxt83}, @samp{thunderx2t99},
15896 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15897 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
15898 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}
15899 @samp{native}.
15900
15901 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15902 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
15903 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55} specify that GCC
15904 should tune for a big.LITTLE system.
15905
15906 Additionally on native AArch64 GNU/Linux systems the value
15907 @samp{native} tunes performance to the host system. This option has no effect
15908 if the compiler is unable to recognize the processor of the host system.
15909
15910 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
15911 are specified, the code is tuned to perform well across a range
15912 of target processors.
15913
15914 This option cannot be suffixed by feature modifiers.
15915
15916 @item -mcpu=@var{name}
15917 @opindex mcpu
15918 Specify the name of the target processor, optionally suffixed by one
15919 or more feature modifiers. This option has the form
15920 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
15921 the permissible values for @var{cpu} are the same as those available
15922 for @option{-mtune}. The permissible values for @var{feature} are
15923 documented in the sub-section on
15924 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
15925 Feature Modifiers}. Where conflicting feature modifiers are
15926 specified, the right-most feature is used.
15927
15928 GCC uses @var{name} to determine what kind of instructions it can emit when
15929 generating assembly code (as if by @option{-march}) and to determine
15930 the target processor for which to tune for performance (as if
15931 by @option{-mtune}). Where this option is used in conjunction
15932 with @option{-march} or @option{-mtune}, those options take precedence
15933 over the appropriate part of this option.
15934
15935 @item -moverride=@var{string}
15936 @opindex moverride
15937 Override tuning decisions made by the back-end in response to a
15938 @option{-mtune=} switch. The syntax, semantics, and accepted values
15939 for @var{string} in this option are not guaranteed to be consistent
15940 across releases.
15941
15942 This option is only intended to be useful when developing GCC.
15943
15944 @item -mverbose-cost-dump
15945 @opindex mverbose-cost-dump
15946 Enable verbose cost model dumping in the debug dump files. This option is
15947 provided for use in debugging the compiler.
15948
15949 @item -mpc-relative-literal-loads
15950 @itemx -mno-pc-relative-literal-loads
15951 @opindex mpc-relative-literal-loads
15952 @opindex mno-pc-relative-literal-loads
15953 Enable or disable PC-relative literal loads. With this option literal pools are
15954 accessed using a single instruction and emitted after each function. This
15955 limits the maximum size of functions to 1MB. This is enabled by default for
15956 @option{-mcmodel=tiny}.
15957
15958 @item -msign-return-address=@var{scope}
15959 @opindex msign-return-address
15960 Select the function scope on which return address signing will be applied.
15961 Permissible values are @samp{none}, which disables return address signing,
15962 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
15963 functions, and @samp{all}, which enables pointer signing for all functions. The
15964 default value is @samp{none}. This option has been deprecated by
15965 -mbranch-protection.
15966
15967 @item -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}+@var{b-key}]|@var{bti}
15968 @opindex mbranch-protection
15969 Select the branch protection features to use.
15970 @samp{none} is the default and turns off all types of branch protection.
15971 @samp{standard} turns on all types of branch protection features. If a feature
15972 has additional tuning options, then @samp{standard} sets it to its standard
15973 level.
15974 @samp{pac-ret[+@var{leaf}]} turns on return address signing to its standard
15975 level: signing functions that save the return address to memory (non-leaf
15976 functions will practically always do this) using the a-key. The optional
15977 argument @samp{leaf} can be used to extend the signing to include leaf
15978 functions. The optional argument @samp{b-key} can be used to sign the functions
15979 with the B-key instead of the A-key.
15980 @samp{bti} turns on branch target identification mechanism.
15981
15982 @item -msve-vector-bits=@var{bits}
15983 @opindex msve-vector-bits
15984 Specify the number of bits in an SVE vector register. This option only has
15985 an effect when SVE is enabled.
15986
15987 GCC supports two forms of SVE code generation: ``vector-length
15988 agnostic'' output that works with any size of vector register and
15989 ``vector-length specific'' output that allows GCC to make assumptions
15990 about the vector length when it is useful for optimization reasons.
15991 The possible values of @samp{bits} are: @samp{scalable}, @samp{128},
15992 @samp{256}, @samp{512}, @samp{1024} and @samp{2048}.
15993 Specifying @samp{scalable} selects vector-length agnostic
15994 output. At present @samp{-msve-vector-bits=128} also generates vector-length
15995 agnostic output. All other values generate vector-length specific code.
15996 The behavior of these values may change in future releases and no value except
15997 @samp{scalable} should be relied on for producing code that is portable across
15998 different hardware SVE vector lengths.
15999
16000 The default is @samp{-msve-vector-bits=scalable}, which produces
16001 vector-length agnostic code.
16002 @end table
16003
16004 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
16005 @anchor{aarch64-feature-modifiers}
16006 @cindex @option{-march} feature modifiers
16007 @cindex @option{-mcpu} feature modifiers
16008 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
16009 the following and their inverses @option{no@var{feature}}:
16010
16011 @table @samp
16012 @item crc
16013 Enable CRC extension. This is on by default for
16014 @option{-march=armv8.1-a}.
16015 @item crypto
16016 Enable Crypto extension. This also enables Advanced SIMD and floating-point
16017 instructions.
16018 @item fp
16019 Enable floating-point instructions. This is on by default for all possible
16020 values for options @option{-march} and @option{-mcpu}.
16021 @item simd
16022 Enable Advanced SIMD instructions. This also enables floating-point
16023 instructions. This is on by default for all possible values for options
16024 @option{-march} and @option{-mcpu}.
16025 @item sve
16026 Enable Scalable Vector Extension instructions. This also enables Advanced
16027 SIMD and floating-point instructions.
16028 @item lse
16029 Enable Large System Extension instructions. This is on by default for
16030 @option{-march=armv8.1-a}.
16031 @item rdma
16032 Enable Round Double Multiply Accumulate instructions. This is on by default
16033 for @option{-march=armv8.1-a}.
16034 @item fp16
16035 Enable FP16 extension. This also enables floating-point instructions.
16036 @item fp16fml
16037 Enable FP16 fmla extension. This also enables FP16 extensions and
16038 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.
16039
16040 @item rcpc
16041 Enable the RcPc extension. This does not change code generation from GCC,
16042 but is passed on to the assembler, enabling inline asm statements to use
16043 instructions from the RcPc extension.
16044 @item dotprod
16045 Enable the Dot Product extension. This also enables Advanced SIMD instructions.
16046 @item aes
16047 Enable the Armv8-a aes and pmull crypto extension. This also enables Advanced
16048 SIMD instructions.
16049 @item sha2
16050 Enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions.
16051 @item sha3
16052 Enable the sha512 and sha3 crypto extension. This also enables Advanced SIMD
16053 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
16054 @item sm4
16055 Enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD instructions.
16056 Use of this option with architectures prior to Armv8.2-A is not supported.
16057 @item profile
16058 Enable the Statistical Profiling extension. This option is only to enable the
16059 extension at the assembler level and does not affect code generation.
16060 @item rng
16061 Enable the Armv8.5-a Random Number instructions. This option is only to
16062 enable the extension at the assembler level and does not affect code
16063 generation.
16064 @item memtag
16065 Enable the Armv8.5-a Memory Tagging Extensions. This option is only to
16066 enable the extension at the assembler level and does not affect code
16067 generation.
16068 @item sb
16069 Enable the Armv8-a Speculation Barrier instruction. This option is only to
16070 enable the extension at the assembler level and does not affect code
16071 generation. This option is enabled by default for @option{-march=armv8.5-a}.
16072 @item ssbs
16073 Enable the Armv8-a Speculative Store Bypass Safe instruction. This option
16074 is only to enable the extension at the assembler level and does not affect code
16075 generation. This option is enabled by default for @option{-march=armv8.5-a}.
16076 @item predres
16077 Enable the Armv8-a Execution and Data Prediction Restriction instructions.
16078 This option is only to enable the extension at the assembler level and does
16079 not affect code generation. This option is enabled by default for
16080 @item sve2
16081 Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE
16082 instructions.
16083 @item bitperm
16084 Enable SVE2 bitperm instructions. This also enables SVE2 instructions.
16085 @item sve2-sm4
16086 Enable SVE2 sm4 instructions. This also enables SVE2 instructions.
16087 @item sve2-aes
16088 Enable SVE2 aes instructions. This also enables SVE2 instructions.
16089 @item sve2-sha3
16090 Enable SVE2 sha3 instructions. This also enables SVE2 instructions.
16091 @option{-march=armv8.5-a}.
16092
16093 @end table
16094
16095 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
16096 which implies @option{fp}.
16097 Conversely, @option{nofp} implies @option{nosimd}, which implies
16098 @option{nocrypto}, @option{noaes} and @option{nosha2}.
16099
16100 @node Adapteva Epiphany Options
16101 @subsection Adapteva Epiphany Options
16102
16103 These @samp{-m} options are defined for Adapteva Epiphany:
16104
16105 @table @gcctabopt
16106 @item -mhalf-reg-file
16107 @opindex mhalf-reg-file
16108 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
16109 That allows code to run on hardware variants that lack these registers.
16110
16111 @item -mprefer-short-insn-regs
16112 @opindex mprefer-short-insn-regs
16113 Preferentially allocate registers that allow short instruction generation.
16114 This can result in increased instruction count, so this may either reduce or
16115 increase overall code size.
16116
16117 @item -mbranch-cost=@var{num}
16118 @opindex mbranch-cost
16119 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16120 This cost is only a heuristic and is not guaranteed to produce
16121 consistent results across releases.
16122
16123 @item -mcmove
16124 @opindex mcmove
16125 Enable the generation of conditional moves.
16126
16127 @item -mnops=@var{num}
16128 @opindex mnops
16129 Emit @var{num} NOPs before every other generated instruction.
16130
16131 @item -mno-soft-cmpsf
16132 @opindex mno-soft-cmpsf
16133 @opindex msoft-cmpsf
16134 For single-precision floating-point comparisons, emit an @code{fsub} instruction
16135 and test the flags. This is faster than a software comparison, but can
16136 get incorrect results in the presence of NaNs, or when two different small
16137 numbers are compared such that their difference is calculated as zero.
16138 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
16139 software comparisons.
16140
16141 @item -mstack-offset=@var{num}
16142 @opindex mstack-offset
16143 Set the offset between the top of the stack and the stack pointer.
16144 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
16145 can be used by leaf functions without stack allocation.
16146 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
16147 Note also that this option changes the ABI; compiling a program with a
16148 different stack offset than the libraries have been compiled with
16149 generally does not work.
16150 This option can be useful if you want to evaluate if a different stack
16151 offset would give you better code, but to actually use a different stack
16152 offset to build working programs, it is recommended to configure the
16153 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
16154
16155 @item -mno-round-nearest
16156 @opindex mno-round-nearest
16157 @opindex mround-nearest
16158 Make the scheduler assume that the rounding mode has been set to
16159 truncating. The default is @option{-mround-nearest}.
16160
16161 @item -mlong-calls
16162 @opindex mlong-calls
16163 If not otherwise specified by an attribute, assume all calls might be beyond
16164 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
16165 function address into a register before performing a (otherwise direct) call.
16166 This is the default.
16167
16168 @item -mshort-calls
16169 @opindex short-calls
16170 If not otherwise specified by an attribute, assume all direct calls are
16171 in the range of the @code{b} / @code{bl} instructions, so use these instructions
16172 for direct calls. The default is @option{-mlong-calls}.
16173
16174 @item -msmall16
16175 @opindex msmall16
16176 Assume addresses can be loaded as 16-bit unsigned values. This does not
16177 apply to function addresses for which @option{-mlong-calls} semantics
16178 are in effect.
16179
16180 @item -mfp-mode=@var{mode}
16181 @opindex mfp-mode
16182 Set the prevailing mode of the floating-point unit.
16183 This determines the floating-point mode that is provided and expected
16184 at function call and return time. Making this mode match the mode you
16185 predominantly need at function start can make your programs smaller and
16186 faster by avoiding unnecessary mode switches.
16187
16188 @var{mode} can be set to one the following values:
16189
16190 @table @samp
16191 @item caller
16192 Any mode at function entry is valid, and retained or restored when
16193 the function returns, and when it calls other functions.
16194 This mode is useful for compiling libraries or other compilation units
16195 you might want to incorporate into different programs with different
16196 prevailing FPU modes, and the convenience of being able to use a single
16197 object file outweighs the size and speed overhead for any extra
16198 mode switching that might be needed, compared with what would be needed
16199 with a more specific choice of prevailing FPU mode.
16200
16201 @item truncate
16202 This is the mode used for floating-point calculations with
16203 truncating (i.e.@: round towards zero) rounding mode. That includes
16204 conversion from floating point to integer.
16205
16206 @item round-nearest
16207 This is the mode used for floating-point calculations with
16208 round-to-nearest-or-even rounding mode.
16209
16210 @item int
16211 This is the mode used to perform integer calculations in the FPU, e.g.@:
16212 integer multiply, or integer multiply-and-accumulate.
16213 @end table
16214
16215 The default is @option{-mfp-mode=caller}
16216
16217 @item -mno-split-lohi
16218 @itemx -mno-postinc
16219 @itemx -mno-postmodify
16220 @opindex mno-split-lohi
16221 @opindex msplit-lohi
16222 @opindex mno-postinc
16223 @opindex mpostinc
16224 @opindex mno-postmodify
16225 @opindex mpostmodify
16226 Code generation tweaks that disable, respectively, splitting of 32-bit
16227 loads, generation of post-increment addresses, and generation of
16228 post-modify addresses. The defaults are @option{msplit-lohi},
16229 @option{-mpost-inc}, and @option{-mpost-modify}.
16230
16231 @item -mnovect-double
16232 @opindex mno-vect-double
16233 @opindex mvect-double
16234 Change the preferred SIMD mode to SImode. The default is
16235 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
16236
16237 @item -max-vect-align=@var{num}
16238 @opindex max-vect-align
16239 The maximum alignment for SIMD vector mode types.
16240 @var{num} may be 4 or 8. The default is 8.
16241 Note that this is an ABI change, even though many library function
16242 interfaces are unaffected if they don't use SIMD vector modes
16243 in places that affect size and/or alignment of relevant types.
16244
16245 @item -msplit-vecmove-early
16246 @opindex msplit-vecmove-early
16247 Split vector moves into single word moves before reload. In theory this
16248 can give better register allocation, but so far the reverse seems to be
16249 generally the case.
16250
16251 @item -m1reg-@var{reg}
16252 @opindex m1reg-
16253 Specify a register to hold the constant @minus{}1, which makes loading small negative
16254 constants and certain bitmasks faster.
16255 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
16256 which specify use of that register as a fixed register,
16257 and @samp{none}, which means that no register is used for this
16258 purpose. The default is @option{-m1reg-none}.
16259
16260 @end table
16261
16262 @node AMD GCN Options
16263 @subsection AMD GCN Options
16264 @cindex AMD GCN Options
16265
16266 These options are defined specifically for the AMD GCN port.
16267
16268 @table @gcctabopt
16269
16270 @item -march=@var{gpu}
16271 @opindex march
16272 @itemx -mtune=@var{gpu}
16273 @opindex mtune
16274 Set architecture type or tuning for @var{gpu}. Supported values for @var{gpu}
16275 are
16276
16277 @table @samp
16278 @opindex fiji
16279 @item fiji
16280 Compile for GCN3 Fiji devices (gfx803).
16281
16282 @item gfx900
16283 Compile for GCN5 Vega 10 devices (gfx900).
16284
16285 @item gfx906
16286 Compile for GCN5 Vega 20 devices (gfx906).
16287
16288 @end table
16289
16290 @item -mstack-size=@var{bytes}
16291 @opindex mstack-size
16292 Specify how many @var{bytes} of stack space will be requested for each GPU
16293 thread (wave-front). Beware that there may be many threads and limited memory
16294 available. The size of the stack allocation may also have an impact on
16295 run-time performance. The default is 32KB when using OpenACC or OpenMP, and
16296 1MB otherwise.
16297
16298 @end table
16299
16300 @node ARC Options
16301 @subsection ARC Options
16302 @cindex ARC options
16303
16304 The following options control the architecture variant for which code
16305 is being compiled:
16306
16307 @c architecture variants
16308 @table @gcctabopt
16309
16310 @item -mbarrel-shifter
16311 @opindex mbarrel-shifter
16312 Generate instructions supported by barrel shifter. This is the default
16313 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
16314
16315 @item -mjli-always
16316 @opindex mjli-alawys
16317 Force to call a function using jli_s instruction. This option is
16318 valid only for ARCv2 architecture.
16319
16320 @item -mcpu=@var{cpu}
16321 @opindex mcpu
16322 Set architecture type, register usage, and instruction scheduling
16323 parameters for @var{cpu}. There are also shortcut alias options
16324 available for backward compatibility and convenience. Supported
16325 values for @var{cpu} are
16326
16327 @table @samp
16328 @opindex mA6
16329 @opindex mARC600
16330 @item arc600
16331 Compile for ARC600. Aliases: @option{-mA6}, @option{-mARC600}.
16332
16333 @item arc601
16334 @opindex mARC601
16335 Compile for ARC601. Alias: @option{-mARC601}.
16336
16337 @item arc700
16338 @opindex mA7
16339 @opindex mARC700
16340 Compile for ARC700. Aliases: @option{-mA7}, @option{-mARC700}.
16341 This is the default when configured with @option{--with-cpu=arc700}@.
16342
16343 @item arcem
16344 Compile for ARC EM.
16345
16346 @item archs
16347 Compile for ARC HS.
16348
16349 @item em
16350 Compile for ARC EM CPU with no hardware extensions.
16351
16352 @item em4
16353 Compile for ARC EM4 CPU.
16354
16355 @item em4_dmips
16356 Compile for ARC EM4 DMIPS CPU.
16357
16358 @item em4_fpus
16359 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
16360 extension.
16361
16362 @item em4_fpuda
16363 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
16364 double assist instructions.
16365
16366 @item hs
16367 Compile for ARC HS CPU with no hardware extensions except the atomic
16368 instructions.
16369
16370 @item hs34
16371 Compile for ARC HS34 CPU.
16372
16373 @item hs38
16374 Compile for ARC HS38 CPU.
16375
16376 @item hs38_linux
16377 Compile for ARC HS38 CPU with all hardware extensions on.
16378
16379 @item arc600_norm
16380 Compile for ARC 600 CPU with @code{norm} instructions enabled.
16381
16382 @item arc600_mul32x16
16383 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply
16384 instructions enabled.
16385
16386 @item arc600_mul64
16387 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family
16388 instructions enabled.
16389
16390 @item arc601_norm
16391 Compile for ARC 601 CPU with @code{norm} instructions enabled.
16392
16393 @item arc601_mul32x16
16394 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
16395 instructions enabled.
16396
16397 @item arc601_mul64
16398 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
16399 instructions enabled.
16400
16401 @item nps400
16402 Compile for ARC 700 on NPS400 chip.
16403
16404 @item em_mini
16405 Compile for ARC EM minimalist configuration featuring reduced register
16406 set.
16407
16408 @end table
16409
16410 @item -mdpfp
16411 @opindex mdpfp
16412 @itemx -mdpfp-compact
16413 @opindex mdpfp-compact
16414 Generate double-precision FPX instructions, tuned for the compact
16415 implementation.
16416
16417 @item -mdpfp-fast
16418 @opindex mdpfp-fast
16419 Generate double-precision FPX instructions, tuned for the fast
16420 implementation.
16421
16422 @item -mno-dpfp-lrsr
16423 @opindex mno-dpfp-lrsr
16424 Disable @code{lr} and @code{sr} instructions from using FPX extension
16425 aux registers.
16426
16427 @item -mea
16428 @opindex mea
16429 Generate extended arithmetic instructions. Currently only
16430 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
16431 supported. This is always enabled for @option{-mcpu=ARC700}.
16432
16433 @item -mno-mpy
16434 @opindex mno-mpy
16435 @opindex mmpy
16436 Do not generate @code{mpy}-family instructions for ARC700. This option is
16437 deprecated.
16438
16439 @item -mmul32x16
16440 @opindex mmul32x16
16441 Generate 32x16-bit multiply and multiply-accumulate instructions.
16442
16443 @item -mmul64
16444 @opindex mmul64
16445 Generate @code{mul64} and @code{mulu64} instructions.
16446 Only valid for @option{-mcpu=ARC600}.
16447
16448 @item -mnorm
16449 @opindex mnorm
16450 Generate @code{norm} instructions. This is the default if @option{-mcpu=ARC700}
16451 is in effect.
16452
16453 @item -mspfp
16454 @opindex mspfp
16455 @itemx -mspfp-compact
16456 @opindex mspfp-compact
16457 Generate single-precision FPX instructions, tuned for the compact
16458 implementation.
16459
16460 @item -mspfp-fast
16461 @opindex mspfp-fast
16462 Generate single-precision FPX instructions, tuned for the fast
16463 implementation.
16464
16465 @item -msimd
16466 @opindex msimd
16467 Enable generation of ARC SIMD instructions via target-specific
16468 builtins. Only valid for @option{-mcpu=ARC700}.
16469
16470 @item -msoft-float
16471 @opindex msoft-float
16472 This option ignored; it is provided for compatibility purposes only.
16473 Software floating-point code is emitted by default, and this default
16474 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
16475 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
16476 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
16477
16478 @item -mswap
16479 @opindex mswap
16480 Generate @code{swap} instructions.
16481
16482 @item -matomic
16483 @opindex matomic
16484 This enables use of the locked load/store conditional extension to implement
16485 atomic memory built-in functions. Not available for ARC 6xx or ARC
16486 EM cores.
16487
16488 @item -mdiv-rem
16489 @opindex mdiv-rem
16490 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
16491
16492 @item -mcode-density
16493 @opindex mcode-density
16494 Enable code density instructions for ARC EM.
16495 This option is on by default for ARC HS.
16496
16497 @item -mll64
16498 @opindex mll64
16499 Enable double load/store operations for ARC HS cores.
16500
16501 @item -mtp-regno=@var{regno}
16502 @opindex mtp-regno
16503 Specify thread pointer register number.
16504
16505 @item -mmpy-option=@var{multo}
16506 @opindex mmpy-option
16507 Compile ARCv2 code with a multiplier design option. You can specify
16508 the option using either a string or numeric value for @var{multo}.
16509 @samp{wlh1} is the default value. The recognized values are:
16510
16511 @table @samp
16512 @item 0
16513 @itemx none
16514 No multiplier available.
16515
16516 @item 1
16517 @itemx w
16518 16x16 multiplier, fully pipelined.
16519 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
16520
16521 @item 2
16522 @itemx wlh1
16523 32x32 multiplier, fully
16524 pipelined (1 stage). The following instructions are additionally
16525 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
16526
16527 @item 3
16528 @itemx wlh2
16529 32x32 multiplier, fully pipelined
16530 (2 stages). The following instructions are additionally enabled: @code{mpy},
16531 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
16532
16533 @item 4
16534 @itemx wlh3
16535 Two 16x16 multipliers, blocking,
16536 sequential. The following instructions are additionally enabled: @code{mpy},
16537 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
16538
16539 @item 5
16540 @itemx wlh4
16541 One 16x16 multiplier, blocking,
16542 sequential. The following instructions are additionally enabled: @code{mpy},
16543 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
16544
16545 @item 6
16546 @itemx wlh5
16547 One 32x4 multiplier, blocking,
16548 sequential. The following instructions are additionally enabled: @code{mpy},
16549 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
16550
16551 @item 7
16552 @itemx plus_dmpy
16553 ARC HS SIMD support.
16554
16555 @item 8
16556 @itemx plus_macd
16557 ARC HS SIMD support.
16558
16559 @item 9
16560 @itemx plus_qmacw
16561 ARC HS SIMD support.
16562
16563 @end table
16564
16565 This option is only available for ARCv2 cores@.
16566
16567 @item -mfpu=@var{fpu}
16568 @opindex mfpu
16569 Enables support for specific floating-point hardware extensions for ARCv2
16570 cores. Supported values for @var{fpu} are:
16571
16572 @table @samp
16573
16574 @item fpus
16575 Enables support for single-precision floating-point hardware
16576 extensions@.
16577
16578 @item fpud
16579 Enables support for double-precision floating-point hardware
16580 extensions. The single-precision floating-point extension is also
16581 enabled. Not available for ARC EM@.
16582
16583 @item fpuda
16584 Enables support for double-precision floating-point hardware
16585 extensions using double-precision assist instructions. The single-precision
16586 floating-point extension is also enabled. This option is
16587 only available for ARC EM@.
16588
16589 @item fpuda_div
16590 Enables support for double-precision floating-point hardware
16591 extensions using double-precision assist instructions.
16592 The single-precision floating-point, square-root, and divide
16593 extensions are also enabled. This option is
16594 only available for ARC EM@.
16595
16596 @item fpuda_fma
16597 Enables support for double-precision floating-point hardware
16598 extensions using double-precision assist instructions.
16599 The single-precision floating-point and fused multiply and add
16600 hardware extensions are also enabled. This option is
16601 only available for ARC EM@.
16602
16603 @item fpuda_all
16604 Enables support for double-precision floating-point hardware
16605 extensions using double-precision assist instructions.
16606 All single-precision floating-point hardware extensions are also
16607 enabled. This option is only available for ARC EM@.
16608
16609 @item fpus_div
16610 Enables support for single-precision floating-point, square-root and divide
16611 hardware extensions@.
16612
16613 @item fpud_div
16614 Enables support for double-precision floating-point, square-root and divide
16615 hardware extensions. This option
16616 includes option @samp{fpus_div}. Not available for ARC EM@.
16617
16618 @item fpus_fma
16619 Enables support for single-precision floating-point and
16620 fused multiply and add hardware extensions@.
16621
16622 @item fpud_fma
16623 Enables support for double-precision floating-point and
16624 fused multiply and add hardware extensions. This option
16625 includes option @samp{fpus_fma}. Not available for ARC EM@.
16626
16627 @item fpus_all
16628 Enables support for all single-precision floating-point hardware
16629 extensions@.
16630
16631 @item fpud_all
16632 Enables support for all single- and double-precision floating-point
16633 hardware extensions. Not available for ARC EM@.
16634
16635 @end table
16636
16637 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
16638 @opindex mirq-ctrl-saved
16639 Specifies general-purposes registers that the processor automatically
16640 saves/restores on interrupt entry and exit. @var{register-range} is
16641 specified as two registers separated by a dash. The register range
16642 always starts with @code{r0}, the upper limit is @code{fp} register.
16643 @var{blink} and @var{lp_count} are optional. This option is only
16644 valid for ARC EM and ARC HS cores.
16645
16646 @item -mrgf-banked-regs=@var{number}
16647 @opindex mrgf-banked-regs
16648 Specifies the number of registers replicated in second register bank
16649 on entry to fast interrupt. Fast interrupts are interrupts with the
16650 highest priority level P0. These interrupts save only PC and STATUS32
16651 registers to avoid memory transactions during interrupt entry and exit
16652 sequences. Use this option when you are using fast interrupts in an
16653 ARC V2 family processor. Permitted values are 4, 8, 16, and 32.
16654
16655 @item -mlpc-width=@var{width}
16656 @opindex mlpc-width
16657 Specify the width of the @code{lp_count} register. Valid values for
16658 @var{width} are 8, 16, 20, 24, 28 and 32 bits. The default width is
16659 fixed to 32 bits. If the width is less than 32, the compiler does not
16660 attempt to transform loops in your program to use the zero-delay loop
16661 mechanism unless it is known that the @code{lp_count} register can
16662 hold the required loop-counter value. Depending on the width
16663 specified, the compiler and run-time library might continue to use the
16664 loop mechanism for various needs. This option defines macro
16665 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
16666
16667 @item -mrf16
16668 @opindex mrf16
16669 This option instructs the compiler to generate code for a 16-entry
16670 register file. This option defines the @code{__ARC_RF16__}
16671 preprocessor macro.
16672
16673 @item -mbranch-index
16674 @opindex mbranch-index
16675 Enable use of @code{bi} or @code{bih} instructions to implement jump
16676 tables.
16677
16678 @end table
16679
16680 The following options are passed through to the assembler, and also
16681 define preprocessor macro symbols.
16682
16683 @c Flags used by the assembler, but for which we define preprocessor
16684 @c macro symbols as well.
16685 @table @gcctabopt
16686 @item -mdsp-packa
16687 @opindex mdsp-packa
16688 Passed down to the assembler to enable the DSP Pack A extensions.
16689 Also sets the preprocessor symbol @code{__Xdsp_packa}. This option is
16690 deprecated.
16691
16692 @item -mdvbf
16693 @opindex mdvbf
16694 Passed down to the assembler to enable the dual Viterbi butterfly
16695 extension. Also sets the preprocessor symbol @code{__Xdvbf}. This
16696 option is deprecated.
16697
16698 @c ARC700 4.10 extension instruction
16699 @item -mlock
16700 @opindex mlock
16701 Passed down to the assembler to enable the locked load/store
16702 conditional extension. Also sets the preprocessor symbol
16703 @code{__Xlock}.
16704
16705 @item -mmac-d16
16706 @opindex mmac-d16
16707 Passed down to the assembler. Also sets the preprocessor symbol
16708 @code{__Xxmac_d16}. This option is deprecated.
16709
16710 @item -mmac-24
16711 @opindex mmac-24
16712 Passed down to the assembler. Also sets the preprocessor symbol
16713 @code{__Xxmac_24}. This option is deprecated.
16714
16715 @c ARC700 4.10 extension instruction
16716 @item -mrtsc
16717 @opindex mrtsc
16718 Passed down to the assembler to enable the 64-bit time-stamp counter
16719 extension instruction. Also sets the preprocessor symbol
16720 @code{__Xrtsc}. This option is deprecated.
16721
16722 @c ARC700 4.10 extension instruction
16723 @item -mswape
16724 @opindex mswape
16725 Passed down to the assembler to enable the swap byte ordering
16726 extension instruction. Also sets the preprocessor symbol
16727 @code{__Xswape}.
16728
16729 @item -mtelephony
16730 @opindex mtelephony
16731 Passed down to the assembler to enable dual- and single-operand
16732 instructions for telephony. Also sets the preprocessor symbol
16733 @code{__Xtelephony}. This option is deprecated.
16734
16735 @item -mxy
16736 @opindex mxy
16737 Passed down to the assembler to enable the XY memory extension. Also
16738 sets the preprocessor symbol @code{__Xxy}.
16739
16740 @end table
16741
16742 The following options control how the assembly code is annotated:
16743
16744 @c Assembly annotation options
16745 @table @gcctabopt
16746 @item -misize
16747 @opindex misize
16748 Annotate assembler instructions with estimated addresses.
16749
16750 @item -mannotate-align
16751 @opindex mannotate-align
16752 Explain what alignment considerations lead to the decision to make an
16753 instruction short or long.
16754
16755 @end table
16756
16757 The following options are passed through to the linker:
16758
16759 @c options passed through to the linker
16760 @table @gcctabopt
16761 @item -marclinux
16762 @opindex marclinux
16763 Passed through to the linker, to specify use of the @code{arclinux} emulation.
16764 This option is enabled by default in tool chains built for
16765 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
16766 when profiling is not requested.
16767
16768 @item -marclinux_prof
16769 @opindex marclinux_prof
16770 Passed through to the linker, to specify use of the
16771 @code{arclinux_prof} emulation. This option is enabled by default in
16772 tool chains built for @w{@code{arc-linux-uclibc}} and
16773 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
16774
16775 @end table
16776
16777 The following options control the semantics of generated code:
16778
16779 @c semantically relevant code generation options
16780 @table @gcctabopt
16781 @item -mlong-calls
16782 @opindex mlong-calls
16783 Generate calls as register indirect calls, thus providing access
16784 to the full 32-bit address range.
16785
16786 @item -mmedium-calls
16787 @opindex mmedium-calls
16788 Don't use less than 25-bit addressing range for calls, which is the
16789 offset available for an unconditional branch-and-link
16790 instruction. Conditional execution of function calls is suppressed, to
16791 allow use of the 25-bit range, rather than the 21-bit range with
16792 conditional branch-and-link. This is the default for tool chains built
16793 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
16794
16795 @item -G @var{num}
16796 @opindex G
16797 Put definitions of externally-visible data in a small data section if
16798 that data is no bigger than @var{num} bytes. The default value of
16799 @var{num} is 4 for any ARC configuration, or 8 when we have double
16800 load/store operations.
16801
16802 @item -mno-sdata
16803 @opindex mno-sdata
16804 @opindex msdata
16805 Do not generate sdata references. This is the default for tool chains
16806 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
16807 targets.
16808
16809 @item -mvolatile-cache
16810 @opindex mvolatile-cache
16811 Use ordinarily cached memory accesses for volatile references. This is the
16812 default.
16813
16814 @item -mno-volatile-cache
16815 @opindex mno-volatile-cache
16816 @opindex mvolatile-cache
16817 Enable cache bypass for volatile references.
16818
16819 @end table
16820
16821 The following options fine tune code generation:
16822 @c code generation tuning options
16823 @table @gcctabopt
16824 @item -malign-call
16825 @opindex malign-call
16826 Do alignment optimizations for call instructions.
16827
16828 @item -mauto-modify-reg
16829 @opindex mauto-modify-reg
16830 Enable the use of pre/post modify with register displacement.
16831
16832 @item -mbbit-peephole
16833 @opindex mbbit-peephole
16834 Enable bbit peephole2.
16835
16836 @item -mno-brcc
16837 @opindex mno-brcc
16838 This option disables a target-specific pass in @file{arc_reorg} to
16839 generate compare-and-branch (@code{br@var{cc}}) instructions.
16840 It has no effect on
16841 generation of these instructions driven by the combiner pass.
16842
16843 @item -mcase-vector-pcrel
16844 @opindex mcase-vector-pcrel
16845 Use PC-relative switch case tables to enable case table shortening.
16846 This is the default for @option{-Os}.
16847
16848 @item -mcompact-casesi
16849 @opindex mcompact-casesi
16850 Enable compact @code{casesi} pattern. This is the default for @option{-Os},
16851 and only available for ARCv1 cores. This option is deprecated.
16852
16853 @item -mno-cond-exec
16854 @opindex mno-cond-exec
16855 Disable the ARCompact-specific pass to generate conditional
16856 execution instructions.
16857
16858 Due to delay slot scheduling and interactions between operand numbers,
16859 literal sizes, instruction lengths, and the support for conditional execution,
16860 the target-independent pass to generate conditional execution is often lacking,
16861 so the ARC port has kept a special pass around that tries to find more
16862 conditional execution generation opportunities after register allocation,
16863 branch shortening, and delay slot scheduling have been done. This pass
16864 generally, but not always, improves performance and code size, at the cost of
16865 extra compilation time, which is why there is an option to switch it off.
16866 If you have a problem with call instructions exceeding their allowable
16867 offset range because they are conditionalized, you should consider using
16868 @option{-mmedium-calls} instead.
16869
16870 @item -mearly-cbranchsi
16871 @opindex mearly-cbranchsi
16872 Enable pre-reload use of the @code{cbranchsi} pattern.
16873
16874 @item -mexpand-adddi
16875 @opindex mexpand-adddi
16876 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
16877 @code{add.f}, @code{adc} etc. This option is deprecated.
16878
16879 @item -mindexed-loads
16880 @opindex mindexed-loads
16881 Enable the use of indexed loads. This can be problematic because some
16882 optimizers then assume that indexed stores exist, which is not
16883 the case.
16884
16885 @item -mlra
16886 @opindex mlra
16887 Enable Local Register Allocation. This is still experimental for ARC,
16888 so by default the compiler uses standard reload
16889 (i.e.@: @option{-mno-lra}).
16890
16891 @item -mlra-priority-none
16892 @opindex mlra-priority-none
16893 Don't indicate any priority for target registers.
16894
16895 @item -mlra-priority-compact
16896 @opindex mlra-priority-compact
16897 Indicate target register priority for r0..r3 / r12..r15.
16898
16899 @item -mlra-priority-noncompact
16900 @opindex mlra-priority-noncompact
16901 Reduce target register priority for r0..r3 / r12..r15.
16902
16903 @item -mmillicode
16904 @opindex mmillicode
16905 When optimizing for size (using @option{-Os}), prologues and epilogues
16906 that have to save or restore a large number of registers are often
16907 shortened by using call to a special function in libgcc; this is
16908 referred to as a @emph{millicode} call. As these calls can pose
16909 performance issues, and/or cause linking issues when linking in a
16910 nonstandard way, this option is provided to turn on or off millicode
16911 call generation.
16912
16913 @item -mcode-density-frame
16914 @opindex mcode-density-frame
16915 This option enable the compiler to emit @code{enter} and @code{leave}
16916 instructions. These instructions are only valid for CPUs with
16917 code-density feature.
16918
16919 @item -mmixed-code
16920 @opindex mmixed-code
16921 Tweak register allocation to help 16-bit instruction generation.
16922 This generally has the effect of decreasing the average instruction size
16923 while increasing the instruction count.
16924
16925 @item -mq-class
16926 @opindex mq-class
16927 Enable @samp{q} instruction alternatives.
16928 This is the default for @option{-Os}.
16929
16930 @item -mRcq
16931 @opindex mRcq
16932 Enable @samp{Rcq} constraint handling.
16933 Most short code generation depends on this.
16934 This is the default.
16935
16936 @item -mRcw
16937 @opindex mRcw
16938 Enable @samp{Rcw} constraint handling.
16939 Most ccfsm condexec mostly depends on this.
16940 This is the default.
16941
16942 @item -msize-level=@var{level}
16943 @opindex msize-level
16944 Fine-tune size optimization with regards to instruction lengths and alignment.
16945 The recognized values for @var{level} are:
16946 @table @samp
16947 @item 0
16948 No size optimization. This level is deprecated and treated like @samp{1}.
16949
16950 @item 1
16951 Short instructions are used opportunistically.
16952
16953 @item 2
16954 In addition, alignment of loops and of code after barriers are dropped.
16955
16956 @item 3
16957 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
16958
16959 @end table
16960
16961 This defaults to @samp{3} when @option{-Os} is in effect. Otherwise,
16962 the behavior when this is not set is equivalent to level @samp{1}.
16963
16964 @item -mtune=@var{cpu}
16965 @opindex mtune
16966 Set instruction scheduling parameters for @var{cpu}, overriding any implied
16967 by @option{-mcpu=}.
16968
16969 Supported values for @var{cpu} are
16970
16971 @table @samp
16972 @item ARC600
16973 Tune for ARC600 CPU.
16974
16975 @item ARC601
16976 Tune for ARC601 CPU.
16977
16978 @item ARC700
16979 Tune for ARC700 CPU with standard multiplier block.
16980
16981 @item ARC700-xmac
16982 Tune for ARC700 CPU with XMAC block.
16983
16984 @item ARC725D
16985 Tune for ARC725D CPU.
16986
16987 @item ARC750D
16988 Tune for ARC750D CPU.
16989
16990 @end table
16991
16992 @item -mmultcost=@var{num}
16993 @opindex mmultcost
16994 Cost to assume for a multiply instruction, with @samp{4} being equal to a
16995 normal instruction.
16996
16997 @item -munalign-prob-threshold=@var{probability}
16998 @opindex munalign-prob-threshold
16999 Set probability threshold for unaligning branches.
17000 When tuning for @samp{ARC700} and optimizing for speed, branches without
17001 filled delay slot are preferably emitted unaligned and long, unless
17002 profiling indicates that the probability for the branch to be taken
17003 is below @var{probability}. @xref{Cross-profiling}.
17004 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
17005
17006 @end table
17007
17008 The following options are maintained for backward compatibility, but
17009 are now deprecated and will be removed in a future release:
17010
17011 @c Deprecated options
17012 @table @gcctabopt
17013
17014 @item -margonaut
17015 @opindex margonaut
17016 Obsolete FPX.
17017
17018 @item -mbig-endian
17019 @opindex mbig-endian
17020 @itemx -EB
17021 @opindex EB
17022 Compile code for big-endian targets. Use of these options is now
17023 deprecated. Big-endian code is supported by configuring GCC to build
17024 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
17025 for which big endian is the default.
17026
17027 @item -mlittle-endian
17028 @opindex mlittle-endian
17029 @itemx -EL
17030 @opindex EL
17031 Compile code for little-endian targets. Use of these options is now
17032 deprecated. Little-endian code is supported by configuring GCC to build
17033 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
17034 for which little endian is the default.
17035
17036 @item -mbarrel_shifter
17037 @opindex mbarrel_shifter
17038 Replaced by @option{-mbarrel-shifter}.
17039
17040 @item -mdpfp_compact
17041 @opindex mdpfp_compact
17042 Replaced by @option{-mdpfp-compact}.
17043
17044 @item -mdpfp_fast
17045 @opindex mdpfp_fast
17046 Replaced by @option{-mdpfp-fast}.
17047
17048 @item -mdsp_packa
17049 @opindex mdsp_packa
17050 Replaced by @option{-mdsp-packa}.
17051
17052 @item -mEA
17053 @opindex mEA
17054 Replaced by @option{-mea}.
17055
17056 @item -mmac_24
17057 @opindex mmac_24
17058 Replaced by @option{-mmac-24}.
17059
17060 @item -mmac_d16
17061 @opindex mmac_d16
17062 Replaced by @option{-mmac-d16}.
17063
17064 @item -mspfp_compact
17065 @opindex mspfp_compact
17066 Replaced by @option{-mspfp-compact}.
17067
17068 @item -mspfp_fast
17069 @opindex mspfp_fast
17070 Replaced by @option{-mspfp-fast}.
17071
17072 @item -mtune=@var{cpu}
17073 @opindex mtune
17074 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
17075 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
17076 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
17077
17078 @item -multcost=@var{num}
17079 @opindex multcost
17080 Replaced by @option{-mmultcost}.
17081
17082 @end table
17083
17084 @node ARM Options
17085 @subsection ARM Options
17086 @cindex ARM options
17087
17088 These @samp{-m} options are defined for the ARM port:
17089
17090 @table @gcctabopt
17091 @item -mabi=@var{name}
17092 @opindex mabi
17093 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
17094 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
17095
17096 @item -mapcs-frame
17097 @opindex mapcs-frame
17098 Generate a stack frame that is compliant with the ARM Procedure Call
17099 Standard for all functions, even if this is not strictly necessary for
17100 correct execution of the code. Specifying @option{-fomit-frame-pointer}
17101 with this option causes the stack frames not to be generated for
17102 leaf functions. The default is @option{-mno-apcs-frame}.
17103 This option is deprecated.
17104
17105 @item -mapcs
17106 @opindex mapcs
17107 This is a synonym for @option{-mapcs-frame} and is deprecated.
17108
17109 @ignore
17110 @c not currently implemented
17111 @item -mapcs-stack-check
17112 @opindex mapcs-stack-check
17113 Generate code to check the amount of stack space available upon entry to
17114 every function (that actually uses some stack space). If there is
17115 insufficient space available then either the function
17116 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
17117 called, depending upon the amount of stack space required. The runtime
17118 system is required to provide these functions. The default is
17119 @option{-mno-apcs-stack-check}, since this produces smaller code.
17120
17121 @c not currently implemented
17122 @item -mapcs-reentrant
17123 @opindex mapcs-reentrant
17124 Generate reentrant, position-independent code. The default is
17125 @option{-mno-apcs-reentrant}.
17126 @end ignore
17127
17128 @item -mthumb-interwork
17129 @opindex mthumb-interwork
17130 Generate code that supports calling between the ARM and Thumb
17131 instruction sets. Without this option, on pre-v5 architectures, the
17132 two instruction sets cannot be reliably used inside one program. The
17133 default is @option{-mno-thumb-interwork}, since slightly larger code
17134 is generated when @option{-mthumb-interwork} is specified. In AAPCS
17135 configurations this option is meaningless.
17136
17137 @item -mno-sched-prolog
17138 @opindex mno-sched-prolog
17139 @opindex msched-prolog
17140 Prevent the reordering of instructions in the function prologue, or the
17141 merging of those instruction with the instructions in the function's
17142 body. This means that all functions start with a recognizable set
17143 of instructions (or in fact one of a choice from a small set of
17144 different function prologues), and this information can be used to
17145 locate the start of functions inside an executable piece of code. The
17146 default is @option{-msched-prolog}.
17147
17148 @item -mfloat-abi=@var{name}
17149 @opindex mfloat-abi
17150 Specifies which floating-point ABI to use. Permissible values
17151 are: @samp{soft}, @samp{softfp} and @samp{hard}.
17152
17153 Specifying @samp{soft} causes GCC to generate output containing
17154 library calls for floating-point operations.
17155 @samp{softfp} allows the generation of code using hardware floating-point
17156 instructions, but still uses the soft-float calling conventions.
17157 @samp{hard} allows generation of floating-point instructions
17158 and uses FPU-specific calling conventions.
17159
17160 The default depends on the specific target configuration. Note that
17161 the hard-float and soft-float ABIs are not link-compatible; you must
17162 compile your entire program with the same ABI, and link with a
17163 compatible set of libraries.
17164
17165 @item -mgeneral-regs-only
17166 @opindex mgeneral-regs-only
17167 Generate code which uses only the general-purpose registers. This will prevent
17168 the compiler from using floating-point and Advanced SIMD registers but will not
17169 impose any restrictions on the assembler.
17170
17171 @item -mlittle-endian
17172 @opindex mlittle-endian
17173 Generate code for a processor running in little-endian mode. This is
17174 the default for all standard configurations.
17175
17176 @item -mbig-endian
17177 @opindex mbig-endian
17178 Generate code for a processor running in big-endian mode; the default is
17179 to compile code for a little-endian processor.
17180
17181 @item -mbe8
17182 @itemx -mbe32
17183 @opindex mbe8
17184 When linking a big-endian image select between BE8 and BE32 formats.
17185 The option has no effect for little-endian images and is ignored. The
17186 default is dependent on the selected target architecture. For ARMv6
17187 and later architectures the default is BE8, for older architectures
17188 the default is BE32. BE32 format has been deprecated by ARM.
17189
17190 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
17191 @opindex march
17192 This specifies the name of the target ARM architecture. GCC uses this
17193 name to determine what kind of instructions it can emit when generating
17194 assembly code. This option can be used in conjunction with or instead
17195 of the @option{-mcpu=} option.
17196
17197 Permissible names are:
17198 @samp{armv4t},
17199 @samp{armv5t}, @samp{armv5te},
17200 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
17201 @samp{armv6z}, @samp{armv6zk},
17202 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve},
17203 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
17204 @samp{armv8.4-a},
17205 @samp{armv8.5-a},
17206 @samp{armv7-r},
17207 @samp{armv8-r},
17208 @samp{armv6-m}, @samp{armv6s-m},
17209 @samp{armv7-m}, @samp{armv7e-m},
17210 @samp{armv8-m.base}, @samp{armv8-m.main},
17211 @samp{iwmmxt} and @samp{iwmmxt2}.
17212
17213 Additionally, the following architectures, which lack support for the
17214 Thumb execution state, are recognized but support is deprecated: @samp{armv4}.
17215
17216 Many of the architectures support extensions. These can be added by
17217 appending @samp{+@var{extension}} to the architecture name. Extension
17218 options are processed in order and capabilities accumulate. An extension
17219 will also enable any necessary base extensions
17220 upon which it depends. For example, the @samp{+crypto} extension
17221 will always enable the @samp{+simd} extension. The exception to the
17222 additive construction is for extensions that are prefixed with
17223 @samp{+no@dots{}}: these extensions disable the specified option and
17224 any other extensions that may depend on the presence of that
17225 extension.
17226
17227 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
17228 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
17229 entirely disabled by the @samp{+nofp} option that follows it.
17230
17231 Most extension names are generically named, but have an effect that is
17232 dependent upon the architecture to which it is applied. For example,
17233 the @samp{+simd} option can be applied to both @samp{armv7-a} and
17234 @samp{armv8-a} architectures, but will enable the original ARMv7-A
17235 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
17236 variant for @samp{armv8-a}.
17237
17238 The table below lists the supported extensions for each architecture.
17239 Architectures not mentioned do not support any extensions.
17240
17241 @table @samp
17242 @item armv5te
17243 @itemx armv6
17244 @itemx armv6j
17245 @itemx armv6k
17246 @itemx armv6kz
17247 @itemx armv6t2
17248 @itemx armv6z
17249 @itemx armv6zk
17250 @table @samp
17251 @item +fp
17252 The VFPv2 floating-point instructions. The extension @samp{+vfpv2} can be
17253 used as an alias for this extension.
17254
17255 @item +nofp
17256 Disable the floating-point instructions.
17257 @end table
17258
17259 @item armv7
17260 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
17261 @table @samp
17262 @item +fp
17263 The VFPv3 floating-point instructions, with 16 double-precision
17264 registers. The extension @samp{+vfpv3-d16} can be used as an alias
17265 for this extension. Note that floating-point is not supported by the
17266 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
17267 ARMv7-R architectures.
17268
17269 @item +nofp
17270 Disable the floating-point instructions.
17271 @end table
17272
17273 @item armv7-a
17274 @table @samp
17275 @item +mp
17276 The multiprocessing extension.
17277
17278 @item +sec
17279 The security extension.
17280
17281 @item +fp
17282 The VFPv3 floating-point instructions, with 16 double-precision
17283 registers. The extension @samp{+vfpv3-d16} can be used as an alias
17284 for this extension.
17285
17286 @item +simd
17287 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
17288 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
17289 for this extension.
17290
17291 @item +vfpv3
17292 The VFPv3 floating-point instructions, with 32 double-precision
17293 registers.
17294
17295 @item +vfpv3-d16-fp16
17296 The VFPv3 floating-point instructions, with 16 double-precision
17297 registers and the half-precision floating-point conversion operations.
17298
17299 @item +vfpv3-fp16
17300 The VFPv3 floating-point instructions, with 32 double-precision
17301 registers and the half-precision floating-point conversion operations.
17302
17303 @item +vfpv4-d16
17304 The VFPv4 floating-point instructions, with 16 double-precision
17305 registers.
17306
17307 @item +vfpv4
17308 The VFPv4 floating-point instructions, with 32 double-precision
17309 registers.
17310
17311 @item +neon-fp16
17312 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
17313 the half-precision floating-point conversion operations.
17314
17315 @item +neon-vfpv4
17316 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
17317
17318 @item +nosimd
17319 Disable the Advanced SIMD instructions (does not disable floating point).
17320
17321 @item +nofp
17322 Disable the floating-point and Advanced SIMD instructions.
17323 @end table
17324
17325 @item armv7ve
17326 The extended version of the ARMv7-A architecture with support for
17327 virtualization.
17328 @table @samp
17329 @item +fp
17330 The VFPv4 floating-point instructions, with 16 double-precision registers.
17331 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
17332
17333 @item +simd
17334 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. The
17335 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
17336
17337 @item +vfpv3-d16
17338 The VFPv3 floating-point instructions, with 16 double-precision
17339 registers.
17340
17341 @item +vfpv3
17342 The VFPv3 floating-point instructions, with 32 double-precision
17343 registers.
17344
17345 @item +vfpv3-d16-fp16
17346 The VFPv3 floating-point instructions, with 16 double-precision
17347 registers and the half-precision floating-point conversion operations.
17348
17349 @item +vfpv3-fp16
17350 The VFPv3 floating-point instructions, with 32 double-precision
17351 registers and the half-precision floating-point conversion operations.
17352
17353 @item +vfpv4-d16
17354 The VFPv4 floating-point instructions, with 16 double-precision
17355 registers.
17356
17357 @item +vfpv4
17358 The VFPv4 floating-point instructions, with 32 double-precision
17359 registers.
17360
17361 @item +neon
17362 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
17363 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
17364
17365 @item +neon-fp16
17366 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
17367 the half-precision floating-point conversion operations.
17368
17369 @item +nosimd
17370 Disable the Advanced SIMD instructions (does not disable floating point).
17371
17372 @item +nofp
17373 Disable the floating-point and Advanced SIMD instructions.
17374 @end table
17375
17376 @item armv8-a
17377 @table @samp
17378 @item +crc
17379 The Cyclic Redundancy Check (CRC) instructions.
17380 @item +simd
17381 The ARMv8-A Advanced SIMD and floating-point instructions.
17382 @item +crypto
17383 The cryptographic instructions.
17384 @item +nocrypto
17385 Disable the cryptographic instructions.
17386 @item +nofp
17387 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17388 @item +sb
17389 Speculation Barrier Instruction.
17390 @item +predres
17391 Execution and Data Prediction Restriction Instructions.
17392 @end table
17393
17394 @item armv8.1-a
17395 @table @samp
17396 @item +simd
17397 The ARMv8.1-A Advanced SIMD and floating-point instructions.
17398
17399 @item +crypto
17400 The cryptographic instructions. This also enables the Advanced SIMD and
17401 floating-point instructions.
17402
17403 @item +nocrypto
17404 Disable the cryptographic instructions.
17405
17406 @item +nofp
17407 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17408
17409 @item +sb
17410 Speculation Barrier Instruction.
17411
17412 @item +predres
17413 Execution and Data Prediction Restriction Instructions.
17414 @end table
17415
17416 @item armv8.2-a
17417 @itemx armv8.3-a
17418 @table @samp
17419 @item +fp16
17420 The half-precision floating-point data processing instructions.
17421 This also enables the Advanced SIMD and floating-point instructions.
17422
17423 @item +fp16fml
17424 The half-precision floating-point fmla extension. This also enables
17425 the half-precision floating-point extension and Advanced SIMD and
17426 floating-point instructions.
17427
17428 @item +simd
17429 The ARMv8.1-A Advanced SIMD and floating-point instructions.
17430
17431 @item +crypto
17432 The cryptographic instructions. This also enables the Advanced SIMD and
17433 floating-point instructions.
17434
17435 @item +dotprod
17436 Enable the Dot Product extension. This also enables Advanced SIMD instructions.
17437
17438 @item +nocrypto
17439 Disable the cryptographic extension.
17440
17441 @item +nofp
17442 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17443
17444 @item +sb
17445 Speculation Barrier Instruction.
17446
17447 @item +predres
17448 Execution and Data Prediction Restriction Instructions.
17449 @end table
17450
17451 @item armv8.4-a
17452 @table @samp
17453 @item +fp16
17454 The half-precision floating-point data processing instructions.
17455 This also enables the Advanced SIMD and floating-point instructions as well
17456 as the Dot Product extension and the half-precision floating-point fmla
17457 extension.
17458
17459 @item +simd
17460 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
17461 Dot Product extension.
17462
17463 @item +crypto
17464 The cryptographic instructions. This also enables the Advanced SIMD and
17465 floating-point instructions as well as the Dot Product extension.
17466
17467 @item +nocrypto
17468 Disable the cryptographic extension.
17469
17470 @item +nofp
17471 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17472
17473 @item +sb
17474 Speculation Barrier Instruction.
17475
17476 @item +predres
17477 Execution and Data Prediction Restriction Instructions.
17478 @end table
17479
17480 @item armv8.5-a
17481 @table @samp
17482 @item +fp16
17483 The half-precision floating-point data processing instructions.
17484 This also enables the Advanced SIMD and floating-point instructions as well
17485 as the Dot Product extension and the half-precision floating-point fmla
17486 extension.
17487
17488 @item +simd
17489 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
17490 Dot Product extension.
17491
17492 @item +crypto
17493 The cryptographic instructions. This also enables the Advanced SIMD and
17494 floating-point instructions as well as the Dot Product extension.
17495
17496 @item +nocrypto
17497 Disable the cryptographic extension.
17498
17499 @item +nofp
17500 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17501 @end table
17502
17503 @item armv7-r
17504 @table @samp
17505 @item +fp.sp
17506 The single-precision VFPv3 floating-point instructions. The extension
17507 @samp{+vfpv3xd} can be used as an alias for this extension.
17508
17509 @item +fp
17510 The VFPv3 floating-point instructions with 16 double-precision registers.
17511 The extension +vfpv3-d16 can be used as an alias for this extension.
17512
17513 @item +vfpv3xd-d16-fp16
17514 The single-precision VFPv3 floating-point instructions with 16 double-precision
17515 registers and the half-precision floating-point conversion operations.
17516
17517 @item +vfpv3-d16-fp16
17518 The VFPv3 floating-point instructions with 16 double-precision
17519 registers and the half-precision floating-point conversion operations.
17520
17521 @item +nofp
17522 Disable the floating-point extension.
17523
17524 @item +idiv
17525 The ARM-state integer division instructions.
17526
17527 @item +noidiv
17528 Disable the ARM-state integer division extension.
17529 @end table
17530
17531 @item armv7e-m
17532 @table @samp
17533 @item +fp
17534 The single-precision VFPv4 floating-point instructions.
17535
17536 @item +fpv5
17537 The single-precision FPv5 floating-point instructions.
17538
17539 @item +fp.dp
17540 The single- and double-precision FPv5 floating-point instructions.
17541
17542 @item +nofp
17543 Disable the floating-point extensions.
17544 @end table
17545
17546 @item armv8-m.main
17547 @table @samp
17548 @item +dsp
17549 The DSP instructions.
17550
17551 @item +nodsp
17552 Disable the DSP extension.
17553
17554 @item +fp
17555 The single-precision floating-point instructions.
17556
17557 @item +fp.dp
17558 The single- and double-precision floating-point instructions.
17559
17560 @item +nofp
17561 Disable the floating-point extension.
17562 @end table
17563
17564 @item armv8-r
17565 @table @samp
17566 @item +crc
17567 The Cyclic Redundancy Check (CRC) instructions.
17568 @item +fp.sp
17569 The single-precision FPv5 floating-point instructions.
17570 @item +simd
17571 The ARMv8-A Advanced SIMD and floating-point instructions.
17572 @item +crypto
17573 The cryptographic instructions.
17574 @item +nocrypto
17575 Disable the cryptographic instructions.
17576 @item +nofp
17577 Disable the floating-point, Advanced SIMD and cryptographic instructions.
17578 @end table
17579
17580 @end table
17581
17582 @option{-march=native} causes the compiler to auto-detect the architecture
17583 of the build computer. At present, this feature is only supported on
17584 GNU/Linux, and not all architectures are recognized. If the auto-detect
17585 is unsuccessful the option has no effect.
17586
17587 @item -mtune=@var{name}
17588 @opindex mtune
17589 This option specifies the name of the target ARM processor for
17590 which GCC should tune the performance of the code.
17591 For some ARM implementations better performance can be obtained by using
17592 this option.
17593 Permissible names are: @samp{arm7tdmi}, @samp{arm7tdmi-s}, @samp{arm710t},
17594 @samp{arm720t}, @samp{arm740t}, @samp{strongarm}, @samp{strongarm110},
17595 @samp{strongarm1100}, 0@samp{strongarm1110}, @samp{arm8}, @samp{arm810},
17596 @samp{arm9}, @samp{arm9e}, @samp{arm920}, @samp{arm920t}, @samp{arm922t},
17597 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm926ej-s},
17598 @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi}, @samp{arm1020t},
17599 @samp{arm1026ej-s}, @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
17600 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
17601 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
17602 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
17603 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
17604 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
17605 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
17606 @samp{cortex-a76}, @samp{ares}, @samp{cortex-r4}, @samp{cortex-r4f},
17607 @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8}, @samp{cortex-r52},
17608 @samp{cortex-m0}, @samp{cortex-m0plus}, @samp{cortex-m1}, @samp{cortex-m3},
17609 @samp{cortex-m4}, @samp{cortex-m7}, @samp{cortex-m23}, @samp{cortex-m33},
17610 @samp{cortex-m1.small-multiply}, @samp{cortex-m0.small-multiply},
17611 @samp{cortex-m0plus.small-multiply}, @samp{exynos-m1}, @samp{marvell-pj4},
17612 @samp{neoverse-n1}, @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2},
17613 @samp{ep9312}, @samp{fa526}, @samp{fa626}, @samp{fa606te}, @samp{fa626te},
17614 @samp{fmp626}, @samp{fa726te}, @samp{xgene1}.
17615
17616 Additionally, this option can specify that GCC should tune the performance
17617 of the code for a big.LITTLE system. Permissible names are:
17618 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
17619 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
17620 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
17621 @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}.
17622
17623 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
17624 performance for a blend of processors within architecture @var{arch}.
17625 The aim is to generate code that run well on the current most popular
17626 processors, balancing between optimizations that benefit some CPUs in the
17627 range, and avoiding performance pitfalls of other CPUs. The effects of
17628 this option may change in future GCC versions as CPU models come and go.
17629
17630 @option{-mtune} permits the same extension options as @option{-mcpu}, but
17631 the extension options do not affect the tuning of the generated code.
17632
17633 @option{-mtune=native} causes the compiler to auto-detect the CPU
17634 of the build computer. At present, this feature is only supported on
17635 GNU/Linux, and not all architectures are recognized. If the auto-detect is
17636 unsuccessful the option has no effect.
17637
17638 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
17639 @opindex mcpu
17640 This specifies the name of the target ARM processor. GCC uses this name
17641 to derive the name of the target ARM architecture (as if specified
17642 by @option{-march}) and the ARM processor type for which to tune for
17643 performance (as if specified by @option{-mtune}). Where this option
17644 is used in conjunction with @option{-march} or @option{-mtune},
17645 those options take precedence over the appropriate part of this option.
17646
17647 Many of the supported CPUs implement optional architectural
17648 extensions. Where this is so the architectural extensions are
17649 normally enabled by default. If implementations that lack the
17650 extension exist, then the extension syntax can be used to disable
17651 those extensions that have been omitted. For floating-point and
17652 Advanced SIMD (Neon) instructions, the settings of the options
17653 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
17654 floating-point and Advanced SIMD instructions will only be used if
17655 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
17656 @option{-mfpu} other than @samp{auto} will override the available
17657 floating-point and SIMD extension instructions.
17658
17659 For example, @samp{cortex-a9} can be found in three major
17660 configurations: integer only, with just a floating-point unit or with
17661 floating-point and Advanced SIMD. The default is to enable all the
17662 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
17663 be used to disable just the SIMD or both the SIMD and floating-point
17664 instructions respectively.
17665
17666 Permissible names for this option are the same as those for
17667 @option{-mtune}.
17668
17669 The following extension options are common to the listed CPUs:
17670
17671 @table @samp
17672 @item +nodsp
17673 Disable the DSP instructions on @samp{cortex-m33}.
17674
17675 @item +nofp
17676 Disables the floating-point instructions on @samp{arm9e},
17677 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
17678 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
17679 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
17680 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
17681 Disables the floating-point and SIMD instructions on
17682 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
17683 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
17684 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
17685 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
17686 @samp{cortex-a53} and @samp{cortex-a55}.
17687
17688 @item +nofp.dp
17689 Disables the double-precision component of the floating-point instructions
17690 on @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8}, @samp{cortex-r52} and
17691 @samp{cortex-m7}.
17692
17693 @item +nosimd
17694 Disables the SIMD (but not floating-point) instructions on
17695 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
17696 and @samp{cortex-a9}.
17697
17698 @item +crypto
17699 Enables the cryptographic instructions on @samp{cortex-a32},
17700 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
17701 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
17702 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
17703 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
17704 @samp{cortex-a75.cortex-a55}.
17705 @end table
17706
17707 Additionally the @samp{generic-armv7-a} pseudo target defaults to
17708 VFPv3 with 16 double-precision registers. It supports the following
17709 extension options: @samp{mp}, @samp{sec}, @samp{vfpv3-d16},
17710 @samp{vfpv3}, @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16},
17711 @samp{vfpv4-d16}, @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3},
17712 @samp{neon-fp16}, @samp{neon-vfpv4}. The meanings are the same as for
17713 the extensions to @option{-march=armv7-a}.
17714
17715 @option{-mcpu=generic-@var{arch}} is also permissible, and is
17716 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
17717 See @option{-mtune} for more information.
17718
17719 @option{-mcpu=native} causes the compiler to auto-detect the CPU
17720 of the build computer. At present, this feature is only supported on
17721 GNU/Linux, and not all architectures are recognized. If the auto-detect
17722 is unsuccessful the option has no effect.
17723
17724 @item -mfpu=@var{name}
17725 @opindex mfpu
17726 This specifies what floating-point hardware (or hardware emulation) is
17727 available on the target. Permissible names are: @samp{auto}, @samp{vfpv2},
17728 @samp{vfpv3},
17729 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
17730 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
17731 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
17732 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
17733 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
17734 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
17735 is an alias for @samp{vfpv2}.
17736
17737 The setting @samp{auto} is the default and is special. It causes the
17738 compiler to select the floating-point and Advanced SIMD instructions
17739 based on the settings of @option{-mcpu} and @option{-march}.
17740
17741 If the selected floating-point hardware includes the NEON extension
17742 (e.g.@: @option{-mfpu=neon}), note that floating-point
17743 operations are not generated by GCC's auto-vectorization pass unless
17744 @option{-funsafe-math-optimizations} is also specified. This is
17745 because NEON hardware does not fully implement the IEEE 754 standard for
17746 floating-point arithmetic (in particular denormal values are treated as
17747 zero), so the use of NEON instructions may lead to a loss of precision.
17748
17749 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}).
17750
17751 @item -mfp16-format=@var{name}
17752 @opindex mfp16-format
17753 Specify the format of the @code{__fp16} half-precision floating-point type.
17754 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
17755 the default is @samp{none}, in which case the @code{__fp16} type is not
17756 defined. @xref{Half-Precision}, for more information.
17757
17758 @item -mstructure-size-boundary=@var{n}
17759 @opindex mstructure-size-boundary
17760 The sizes of all structures and unions are rounded up to a multiple
17761 of the number of bits set by this option. Permissible values are 8, 32
17762 and 64. The default value varies for different toolchains. For the COFF
17763 targeted toolchain the default value is 8. A value of 64 is only allowed
17764 if the underlying ABI supports it.
17765
17766 Specifying a larger number can produce faster, more efficient code, but
17767 can also increase the size of the program. Different values are potentially
17768 incompatible. Code compiled with one value cannot necessarily expect to
17769 work with code or libraries compiled with another value, if they exchange
17770 information using structures or unions.
17771
17772 This option is deprecated.
17773
17774 @item -mabort-on-noreturn
17775 @opindex mabort-on-noreturn
17776 Generate a call to the function @code{abort} at the end of a
17777 @code{noreturn} function. It is executed if the function tries to
17778 return.
17779
17780 @item -mlong-calls
17781 @itemx -mno-long-calls
17782 @opindex mlong-calls
17783 @opindex mno-long-calls
17784 Tells the compiler to perform function calls by first loading the
17785 address of the function into a register and then performing a subroutine
17786 call on this register. This switch is needed if the target function
17787 lies outside of the 64-megabyte addressing range of the offset-based
17788 version of subroutine call instruction.
17789
17790 Even if this switch is enabled, not all function calls are turned
17791 into long calls. The heuristic is that static functions, functions
17792 that have the @code{short_call} attribute, functions that are inside
17793 the scope of a @code{#pragma no_long_calls} directive, and functions whose
17794 definitions have already been compiled within the current compilation
17795 unit are not turned into long calls. The exceptions to this rule are
17796 that weak function definitions, functions with the @code{long_call}
17797 attribute or the @code{section} attribute, and functions that are within
17798 the scope of a @code{#pragma long_calls} directive are always
17799 turned into long calls.
17800
17801 This feature is not enabled by default. Specifying
17802 @option{-mno-long-calls} restores the default behavior, as does
17803 placing the function calls within the scope of a @code{#pragma
17804 long_calls_off} directive. Note these switches have no effect on how
17805 the compiler generates code to handle function calls via function
17806 pointers.
17807
17808 @item -msingle-pic-base
17809 @opindex msingle-pic-base
17810 Treat the register used for PIC addressing as read-only, rather than
17811 loading it in the prologue for each function. The runtime system is
17812 responsible for initializing this register with an appropriate value
17813 before execution begins.
17814
17815 @item -mpic-register=@var{reg}
17816 @opindex mpic-register
17817 Specify the register to be used for PIC addressing.
17818 For standard PIC base case, the default is any suitable register
17819 determined by compiler. For single PIC base case, the default is
17820 @samp{R9} if target is EABI based or stack-checking is enabled,
17821 otherwise the default is @samp{R10}.
17822
17823 @item -mpic-data-is-text-relative
17824 @opindex mpic-data-is-text-relative
17825 Assume that the displacement between the text and data segments is fixed
17826 at static link time. This permits using PC-relative addressing
17827 operations to access data known to be in the data segment. For
17828 non-VxWorks RTP targets, this option is enabled by default. When
17829 disabled on such targets, it will enable @option{-msingle-pic-base} by
17830 default.
17831
17832 @item -mpoke-function-name
17833 @opindex mpoke-function-name
17834 Write the name of each function into the text section, directly
17835 preceding the function prologue. The generated code is similar to this:
17836
17837 @smallexample
17838 t0
17839 .ascii "arm_poke_function_name", 0
17840 .align
17841 t1
17842 .word 0xff000000 + (t1 - t0)
17843 arm_poke_function_name
17844 mov ip, sp
17845 stmfd sp!, @{fp, ip, lr, pc@}
17846 sub fp, ip, #4
17847 @end smallexample
17848
17849 When performing a stack backtrace, code can inspect the value of
17850 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
17851 location @code{pc - 12} and the top 8 bits are set, then we know that
17852 there is a function name embedded immediately preceding this location
17853 and has length @code{((pc[-3]) & 0xff000000)}.
17854
17855 @item -mthumb
17856 @itemx -marm
17857 @opindex marm
17858 @opindex mthumb
17859
17860 Select between generating code that executes in ARM and Thumb
17861 states. The default for most configurations is to generate code
17862 that executes in ARM state, but the default can be changed by
17863 configuring GCC with the @option{--with-mode=}@var{state}
17864 configure option.
17865
17866 You can also override the ARM and Thumb mode for each function
17867 by using the @code{target("thumb")} and @code{target("arm")} function attributes
17868 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
17869
17870 @item -mflip-thumb
17871 @opindex mflip-thumb
17872 Switch ARM/Thumb modes on alternating functions.
17873 This option is provided for regression testing of mixed Thumb/ARM code
17874 generation, and is not intended for ordinary use in compiling code.
17875
17876 @item -mtpcs-frame
17877 @opindex mtpcs-frame
17878 Generate a stack frame that is compliant with the Thumb Procedure Call
17879 Standard for all non-leaf functions. (A leaf function is one that does
17880 not call any other functions.) The default is @option{-mno-tpcs-frame}.
17881
17882 @item -mtpcs-leaf-frame
17883 @opindex mtpcs-leaf-frame
17884 Generate a stack frame that is compliant with the Thumb Procedure Call
17885 Standard for all leaf functions. (A leaf function is one that does
17886 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
17887
17888 @item -mcallee-super-interworking
17889 @opindex mcallee-super-interworking
17890 Gives all externally visible functions in the file being compiled an ARM
17891 instruction set header which switches to Thumb mode before executing the
17892 rest of the function. This allows these functions to be called from
17893 non-interworking code. This option is not valid in AAPCS configurations
17894 because interworking is enabled by default.
17895
17896 @item -mcaller-super-interworking
17897 @opindex mcaller-super-interworking
17898 Allows calls via function pointers (including virtual functions) to
17899 execute correctly regardless of whether the target code has been
17900 compiled for interworking or not. There is a small overhead in the cost
17901 of executing a function pointer if this option is enabled. This option
17902 is not valid in AAPCS configurations because interworking is enabled
17903 by default.
17904
17905 @item -mtp=@var{name}
17906 @opindex mtp
17907 Specify the access model for the thread local storage pointer. The valid
17908 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
17909 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
17910 (supported in the arm6k architecture), and @samp{auto}, which uses the
17911 best available method for the selected processor. The default setting is
17912 @samp{auto}.
17913
17914 @item -mtls-dialect=@var{dialect}
17915 @opindex mtls-dialect
17916 Specify the dialect to use for accessing thread local storage. Two
17917 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}. The
17918 @samp{gnu} dialect selects the original GNU scheme for supporting
17919 local and global dynamic TLS models. The @samp{gnu2} dialect
17920 selects the GNU descriptor scheme, which provides better performance
17921 for shared libraries. The GNU descriptor scheme is compatible with
17922 the original scheme, but does require new assembler, linker and
17923 library support. Initial and local exec TLS models are unaffected by
17924 this option and always use the original scheme.
17925
17926 @item -mword-relocations
17927 @opindex mword-relocations
17928 Only generate absolute relocations on word-sized values (i.e.@: R_ARM_ABS32).
17929 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
17930 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
17931 is specified. This option conflicts with @option{-mslow-flash-data}.
17932
17933 @item -mfix-cortex-m3-ldrd
17934 @opindex mfix-cortex-m3-ldrd
17935 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
17936 with overlapping destination and base registers are used. This option avoids
17937 generating these instructions. This option is enabled by default when
17938 @option{-mcpu=cortex-m3} is specified.
17939
17940 @item -munaligned-access
17941 @itemx -mno-unaligned-access
17942 @opindex munaligned-access
17943 @opindex mno-unaligned-access
17944 Enables (or disables) reading and writing of 16- and 32- bit values
17945 from addresses that are not 16- or 32- bit aligned. By default
17946 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
17947 ARMv8-M Baseline architectures, and enabled for all other
17948 architectures. If unaligned access is not enabled then words in packed
17949 data structures are accessed a byte at a time.
17950
17951 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
17952 generated object file to either true or false, depending upon the
17953 setting of this option. If unaligned access is enabled then the
17954 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
17955 defined.
17956
17957 @item -mneon-for-64bits
17958 @opindex mneon-for-64bits
17959 Enables using Neon to handle scalar 64-bits operations. This is
17960 disabled by default since the cost of moving data from core registers
17961 to Neon is high.
17962
17963 @item -mslow-flash-data
17964 @opindex mslow-flash-data
17965 Assume loading data from flash is slower than fetching instruction.
17966 Therefore literal load is minimized for better performance.
17967 This option is only supported when compiling for ARMv7 M-profile and
17968 off by default. It conflicts with @option{-mword-relocations}.
17969
17970 @item -masm-syntax-unified
17971 @opindex masm-syntax-unified
17972 Assume inline assembler is using unified asm syntax. The default is
17973 currently off which implies divided syntax. This option has no impact
17974 on Thumb2. However, this may change in future releases of GCC.
17975 Divided syntax should be considered deprecated.
17976
17977 @item -mrestrict-it
17978 @opindex mrestrict-it
17979 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
17980 IT blocks can only contain a single 16-bit instruction from a select
17981 set of instructions. This option is on by default for ARMv8-A Thumb mode.
17982
17983 @item -mprint-tune-info
17984 @opindex mprint-tune-info
17985 Print CPU tuning information as comment in assembler file. This is
17986 an option used only for regression testing of the compiler and not
17987 intended for ordinary use in compiling code. This option is disabled
17988 by default.
17989
17990 @item -mverbose-cost-dump
17991 @opindex mverbose-cost-dump
17992 Enable verbose cost model dumping in the debug dump files. This option is
17993 provided for use in debugging the compiler.
17994
17995 @item -mpure-code
17996 @opindex mpure-code
17997 Do not allow constant data to be placed in code sections.
17998 Additionally, when compiling for ELF object format give all text sections the
17999 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}. This option
18000 is only available when generating non-pic code for M-profile targets with the
18001 MOVT instruction.
18002
18003 @item -mcmse
18004 @opindex mcmse
18005 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
18006 Development Tools Engineering Specification", which can be found on
18007 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
18008 @end table
18009
18010 @node AVR Options
18011 @subsection AVR Options
18012 @cindex AVR Options
18013
18014 These options are defined for AVR implementations:
18015
18016 @table @gcctabopt
18017 @item -mmcu=@var{mcu}
18018 @opindex mmcu
18019 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
18020
18021 The default for this option is@tie{}@samp{avr2}.
18022
18023 GCC supports the following AVR devices and ISAs:
18024
18025 @include avr-mmcu.texi
18026
18027 @item -mabsdata
18028 @opindex mabsdata
18029
18030 Assume that all data in static storage can be accessed by LDS / STS
18031 instructions. This option has only an effect on reduced Tiny devices like
18032 ATtiny40. See also the @code{absdata}
18033 @ref{AVR Variable Attributes,variable attribute}.
18034
18035 @item -maccumulate-args
18036 @opindex maccumulate-args
18037 Accumulate outgoing function arguments and acquire/release the needed
18038 stack space for outgoing function arguments once in function
18039 prologue/epilogue. Without this option, outgoing arguments are pushed
18040 before calling a function and popped afterwards.
18041
18042 Popping the arguments after the function call can be expensive on
18043 AVR so that accumulating the stack space might lead to smaller
18044 executables because arguments need not be removed from the
18045 stack after such a function call.
18046
18047 This option can lead to reduced code size for functions that perform
18048 several calls to functions that get their arguments on the stack like
18049 calls to printf-like functions.
18050
18051 @item -mbranch-cost=@var{cost}
18052 @opindex mbranch-cost
18053 Set the branch costs for conditional branch instructions to
18054 @var{cost}. Reasonable values for @var{cost} are small, non-negative
18055 integers. The default branch cost is 0.
18056
18057 @item -mcall-prologues
18058 @opindex mcall-prologues
18059 Functions prologues/epilogues are expanded as calls to appropriate
18060 subroutines. Code size is smaller.
18061
18062 @item -mgas-isr-prologues
18063 @opindex mgas-isr-prologues
18064 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
18065 instruction supported by GNU Binutils.
18066 If this option is on, the feature can still be disabled for individual
18067 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
18068 function attribute. This feature is activated per default
18069 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
18070 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
18071
18072 @item -mint8
18073 @opindex mint8
18074 Assume @code{int} to be 8-bit integer. This affects the sizes of all types: a
18075 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
18076 and @code{long long} is 4 bytes. Please note that this option does not
18077 conform to the C standards, but it results in smaller code
18078 size.
18079
18080 @item -mmain-is-OS_task
18081 @opindex mmain-is-OS_task
18082 Do not save registers in @code{main}. The effect is the same like
18083 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
18084 to @code{main}. It is activated per default if optimization is on.
18085
18086 @item -mn-flash=@var{num}
18087 @opindex mn-flash
18088 Assume that the flash memory has a size of
18089 @var{num} times 64@tie{}KiB.
18090
18091 @item -mno-interrupts
18092 @opindex mno-interrupts
18093 Generated code is not compatible with hardware interrupts.
18094 Code size is smaller.
18095
18096 @item -mrelax
18097 @opindex mrelax
18098 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
18099 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
18100 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
18101 the assembler's command line and the @option{--relax} option to the
18102 linker's command line.
18103
18104 Jump relaxing is performed by the linker because jump offsets are not
18105 known before code is located. Therefore, the assembler code generated by the
18106 compiler is the same, but the instructions in the executable may
18107 differ from instructions in the assembler code.
18108
18109 Relaxing must be turned on if linker stubs are needed, see the
18110 section on @code{EIND} and linker stubs below.
18111
18112 @item -mrmw
18113 @opindex mrmw
18114 Assume that the device supports the Read-Modify-Write
18115 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
18116
18117 @item -mshort-calls
18118 @opindex mshort-calls
18119
18120 Assume that @code{RJMP} and @code{RCALL} can target the whole
18121 program memory.
18122
18123 This option is used internally for multilib selection. It is
18124 not an optimization option, and you don't need to set it by hand.
18125
18126 @item -msp8
18127 @opindex msp8
18128 Treat the stack pointer register as an 8-bit register,
18129 i.e.@: assume the high byte of the stack pointer is zero.
18130 In general, you don't need to set this option by hand.
18131
18132 This option is used internally by the compiler to select and
18133 build multilibs for architectures @code{avr2} and @code{avr25}.
18134 These architectures mix devices with and without @code{SPH}.
18135 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
18136 the compiler driver adds or removes this option from the compiler
18137 proper's command line, because the compiler then knows if the device
18138 or architecture has an 8-bit stack pointer and thus no @code{SPH}
18139 register or not.
18140
18141 @item -mstrict-X
18142 @opindex mstrict-X
18143 Use address register @code{X} in a way proposed by the hardware. This means
18144 that @code{X} is only used in indirect, post-increment or
18145 pre-decrement addressing.
18146
18147 Without this option, the @code{X} register may be used in the same way
18148 as @code{Y} or @code{Z} which then is emulated by additional
18149 instructions.
18150 For example, loading a value with @code{X+const} addressing with a
18151 small non-negative @code{const < 64} to a register @var{Rn} is
18152 performed as
18153
18154 @example
18155 adiw r26, const ; X += const
18156 ld @var{Rn}, X ; @var{Rn} = *X
18157 sbiw r26, const ; X -= const
18158 @end example
18159
18160 @item -mtiny-stack
18161 @opindex mtiny-stack
18162 Only change the lower 8@tie{}bits of the stack pointer.
18163
18164 @item -mfract-convert-truncate
18165 @opindex mfract-convert-truncate
18166 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
18167
18168 @item -nodevicelib
18169 @opindex nodevicelib
18170 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
18171
18172 @item -Waddr-space-convert
18173 @opindex Waddr-space-convert
18174 @opindex Wno-addr-space-convert
18175 Warn about conversions between address spaces in the case where the
18176 resulting address space is not contained in the incoming address space.
18177
18178 @item -Wmisspelled-isr
18179 @opindex Wmisspelled-isr
18180 @opindex Wno-misspelled-isr
18181 Warn if the ISR is misspelled, i.e.@: without __vector prefix.
18182 Enabled by default.
18183 @end table
18184
18185 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
18186 @cindex @code{EIND}
18187 Pointers in the implementation are 16@tie{}bits wide.
18188 The address of a function or label is represented as word address so
18189 that indirect jumps and calls can target any code address in the
18190 range of 64@tie{}Ki words.
18191
18192 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
18193 bytes of program memory space, there is a special function register called
18194 @code{EIND} that serves as most significant part of the target address
18195 when @code{EICALL} or @code{EIJMP} instructions are used.
18196
18197 Indirect jumps and calls on these devices are handled as follows by
18198 the compiler and are subject to some limitations:
18199
18200 @itemize @bullet
18201
18202 @item
18203 The compiler never sets @code{EIND}.
18204
18205 @item
18206 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
18207 instructions or might read @code{EIND} directly in order to emulate an
18208 indirect call/jump by means of a @code{RET} instruction.
18209
18210 @item
18211 The compiler assumes that @code{EIND} never changes during the startup
18212 code or during the application. In particular, @code{EIND} is not
18213 saved/restored in function or interrupt service routine
18214 prologue/epilogue.
18215
18216 @item
18217 For indirect calls to functions and computed goto, the linker
18218 generates @emph{stubs}. Stubs are jump pads sometimes also called
18219 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
18220 The stub contains a direct jump to the desired address.
18221
18222 @item
18223 Linker relaxation must be turned on so that the linker generates
18224 the stubs correctly in all situations. See the compiler option
18225 @option{-mrelax} and the linker option @option{--relax}.
18226 There are corner cases where the linker is supposed to generate stubs
18227 but aborts without relaxation and without a helpful error message.
18228
18229 @item
18230 The default linker script is arranged for code with @code{EIND = 0}.
18231 If code is supposed to work for a setup with @code{EIND != 0}, a custom
18232 linker script has to be used in order to place the sections whose
18233 name start with @code{.trampolines} into the segment where @code{EIND}
18234 points to.
18235
18236 @item
18237 The startup code from libgcc never sets @code{EIND}.
18238 Notice that startup code is a blend of code from libgcc and AVR-LibC.
18239 For the impact of AVR-LibC on @code{EIND}, see the
18240 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
18241
18242 @item
18243 It is legitimate for user-specific startup code to set up @code{EIND}
18244 early, for example by means of initialization code located in
18245 section @code{.init3}. Such code runs prior to general startup code
18246 that initializes RAM and calls constructors, but after the bit
18247 of startup code from AVR-LibC that sets @code{EIND} to the segment
18248 where the vector table is located.
18249 @example
18250 #include <avr/io.h>
18251
18252 static void
18253 __attribute__((section(".init3"),naked,used,no_instrument_function))
18254 init3_set_eind (void)
18255 @{
18256 __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
18257 "out %i0,r24" :: "n" (&EIND) : "r24","memory");
18258 @}
18259 @end example
18260
18261 @noindent
18262 The @code{__trampolines_start} symbol is defined in the linker script.
18263
18264 @item
18265 Stubs are generated automatically by the linker if
18266 the following two conditions are met:
18267 @itemize @minus
18268
18269 @item The address of a label is taken by means of the @code{gs} modifier
18270 (short for @emph{generate stubs}) like so:
18271 @example
18272 LDI r24, lo8(gs(@var{func}))
18273 LDI r25, hi8(gs(@var{func}))
18274 @end example
18275 @item The final location of that label is in a code segment
18276 @emph{outside} the segment where the stubs are located.
18277 @end itemize
18278
18279 @item
18280 The compiler emits such @code{gs} modifiers for code labels in the
18281 following situations:
18282 @itemize @minus
18283 @item Taking address of a function or code label.
18284 @item Computed goto.
18285 @item If prologue-save function is used, see @option{-mcall-prologues}
18286 command-line option.
18287 @item Switch/case dispatch tables. If you do not want such dispatch
18288 tables you can specify the @option{-fno-jump-tables} command-line option.
18289 @item C and C++ constructors/destructors called during startup/shutdown.
18290 @item If the tools hit a @code{gs()} modifier explained above.
18291 @end itemize
18292
18293 @item
18294 Jumping to non-symbolic addresses like so is @emph{not} supported:
18295
18296 @example
18297 int main (void)
18298 @{
18299 /* Call function at word address 0x2 */
18300 return ((int(*)(void)) 0x2)();
18301 @}
18302 @end example
18303
18304 Instead, a stub has to be set up, i.e.@: the function has to be called
18305 through a symbol (@code{func_4} in the example):
18306
18307 @example
18308 int main (void)
18309 @{
18310 extern int func_4 (void);
18311
18312 /* Call function at byte address 0x4 */
18313 return func_4();
18314 @}
18315 @end example
18316
18317 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
18318 Alternatively, @code{func_4} can be defined in the linker script.
18319 @end itemize
18320
18321 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
18322 @cindex @code{RAMPD}
18323 @cindex @code{RAMPX}
18324 @cindex @code{RAMPY}
18325 @cindex @code{RAMPZ}
18326 Some AVR devices support memories larger than the 64@tie{}KiB range
18327 that can be accessed with 16-bit pointers. To access memory locations
18328 outside this 64@tie{}KiB range, the content of a @code{RAMP}
18329 register is used as high part of the address:
18330 The @code{X}, @code{Y}, @code{Z} address register is concatenated
18331 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
18332 register, respectively, to get a wide address. Similarly,
18333 @code{RAMPD} is used together with direct addressing.
18334
18335 @itemize
18336 @item
18337 The startup code initializes the @code{RAMP} special function
18338 registers with zero.
18339
18340 @item
18341 If a @ref{AVR Named Address Spaces,named address space} other than
18342 generic or @code{__flash} is used, then @code{RAMPZ} is set
18343 as needed before the operation.
18344
18345 @item
18346 If the device supports RAM larger than 64@tie{}KiB and the compiler
18347 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
18348 is reset to zero after the operation.
18349
18350 @item
18351 If the device comes with a specific @code{RAMP} register, the ISR
18352 prologue/epilogue saves/restores that SFR and initializes it with
18353 zero in case the ISR code might (implicitly) use it.
18354
18355 @item
18356 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
18357 If you use inline assembler to read from locations outside the
18358 16-bit address range and change one of the @code{RAMP} registers,
18359 you must reset it to zero after the access.
18360
18361 @end itemize
18362
18363 @subsubsection AVR Built-in Macros
18364
18365 GCC defines several built-in macros so that the user code can test
18366 for the presence or absence of features. Almost any of the following
18367 built-in macros are deduced from device capabilities and thus
18368 triggered by the @option{-mmcu=} command-line option.
18369
18370 For even more AVR-specific built-in macros see
18371 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
18372
18373 @table @code
18374
18375 @item __AVR_ARCH__
18376 Build-in macro that resolves to a decimal number that identifies the
18377 architecture and depends on the @option{-mmcu=@var{mcu}} option.
18378 Possible values are:
18379
18380 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
18381 @code{4}, @code{5}, @code{51}, @code{6}
18382
18383 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
18384 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
18385
18386 respectively and
18387
18388 @code{100},
18389 @code{102}, @code{103}, @code{104},
18390 @code{105}, @code{106}, @code{107}
18391
18392 for @var{mcu}=@code{avrtiny},
18393 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
18394 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
18395 If @var{mcu} specifies a device, this built-in macro is set
18396 accordingly. For example, with @option{-mmcu=atmega8} the macro is
18397 defined to @code{4}.
18398
18399 @item __AVR_@var{Device}__
18400 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
18401 the device's name. For example, @option{-mmcu=atmega8} defines the
18402 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
18403 @code{__AVR_ATtiny261A__}, etc.
18404
18405 The built-in macros' names follow
18406 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
18407 the device name as from the AVR user manual. The difference between
18408 @var{Device} in the built-in macro and @var{device} in
18409 @option{-mmcu=@var{device}} is that the latter is always lowercase.
18410
18411 If @var{device} is not a device but only a core architecture like
18412 @samp{avr51}, this macro is not defined.
18413
18414 @item __AVR_DEVICE_NAME__
18415 Setting @option{-mmcu=@var{device}} defines this built-in macro to
18416 the device's name. For example, with @option{-mmcu=atmega8} the macro
18417 is defined to @code{atmega8}.
18418
18419 If @var{device} is not a device but only a core architecture like
18420 @samp{avr51}, this macro is not defined.
18421
18422 @item __AVR_XMEGA__
18423 The device / architecture belongs to the XMEGA family of devices.
18424
18425 @item __AVR_HAVE_ELPM__
18426 The device has the @code{ELPM} instruction.
18427
18428 @item __AVR_HAVE_ELPMX__
18429 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
18430 R@var{n},Z+} instructions.
18431
18432 @item __AVR_HAVE_MOVW__
18433 The device has the @code{MOVW} instruction to perform 16-bit
18434 register-register moves.
18435
18436 @item __AVR_HAVE_LPMX__
18437 The device has the @code{LPM R@var{n},Z} and
18438 @code{LPM R@var{n},Z+} instructions.
18439
18440 @item __AVR_HAVE_MUL__
18441 The device has a hardware multiplier.
18442
18443 @item __AVR_HAVE_JMP_CALL__
18444 The device has the @code{JMP} and @code{CALL} instructions.
18445 This is the case for devices with more than 8@tie{}KiB of program
18446 memory.
18447
18448 @item __AVR_HAVE_EIJMP_EICALL__
18449 @itemx __AVR_3_BYTE_PC__
18450 The device has the @code{EIJMP} and @code{EICALL} instructions.
18451 This is the case for devices with more than 128@tie{}KiB of program memory.
18452 This also means that the program counter
18453 (PC) is 3@tie{}bytes wide.
18454
18455 @item __AVR_2_BYTE_PC__
18456 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
18457 with up to 128@tie{}KiB of program memory.
18458
18459 @item __AVR_HAVE_8BIT_SP__
18460 @itemx __AVR_HAVE_16BIT_SP__
18461 The stack pointer (SP) register is treated as 8-bit respectively
18462 16-bit register by the compiler.
18463 The definition of these macros is affected by @option{-mtiny-stack}.
18464
18465 @item __AVR_HAVE_SPH__
18466 @itemx __AVR_SP8__
18467 The device has the SPH (high part of stack pointer) special function
18468 register or has an 8-bit stack pointer, respectively.
18469 The definition of these macros is affected by @option{-mmcu=} and
18470 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
18471 by @option{-msp8}.
18472
18473 @item __AVR_HAVE_RAMPD__
18474 @itemx __AVR_HAVE_RAMPX__
18475 @itemx __AVR_HAVE_RAMPY__
18476 @itemx __AVR_HAVE_RAMPZ__
18477 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
18478 @code{RAMPZ} special function register, respectively.
18479
18480 @item __NO_INTERRUPTS__
18481 This macro reflects the @option{-mno-interrupts} command-line option.
18482
18483 @item __AVR_ERRATA_SKIP__
18484 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
18485 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
18486 instructions because of a hardware erratum. Skip instructions are
18487 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
18488 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
18489 set.
18490
18491 @item __AVR_ISA_RMW__
18492 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
18493
18494 @item __AVR_SFR_OFFSET__=@var{offset}
18495 Instructions that can address I/O special function registers directly
18496 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
18497 address as if addressed by an instruction to access RAM like @code{LD}
18498 or @code{STS}. This offset depends on the device architecture and has
18499 to be subtracted from the RAM address in order to get the
18500 respective I/O@tie{}address.
18501
18502 @item __AVR_SHORT_CALLS__
18503 The @option{-mshort-calls} command line option is set.
18504
18505 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
18506 Some devices support reading from flash memory by means of @code{LD*}
18507 instructions. The flash memory is seen in the data address space
18508 at an offset of @code{__AVR_PM_BASE_ADDRESS__}. If this macro
18509 is not defined, this feature is not available. If defined,
18510 the address space is linear and there is no need to put
18511 @code{.rodata} into RAM. This is handled by the default linker
18512 description file, and is currently available for
18513 @code{avrtiny} and @code{avrxmega3}. Even more convenient,
18514 there is no need to use address spaces like @code{__flash} or
18515 features like attribute @code{progmem} and @code{pgm_read_*}.
18516
18517 @item __WITH_AVRLIBC__
18518 The compiler is configured to be used together with AVR-Libc.
18519 See the @option{--with-avrlibc} configure option.
18520
18521 @end table
18522
18523 @node Blackfin Options
18524 @subsection Blackfin Options
18525 @cindex Blackfin Options
18526
18527 @table @gcctabopt
18528 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
18529 @opindex mcpu=
18530 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
18531 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
18532 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
18533 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
18534 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
18535 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
18536 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
18537 @samp{bf561}, @samp{bf592}.
18538
18539 The optional @var{sirevision} specifies the silicon revision of the target
18540 Blackfin processor. Any workarounds available for the targeted silicon revision
18541 are enabled. If @var{sirevision} is @samp{none}, no workarounds are enabled.
18542 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
18543 are enabled. The @code{__SILICON_REVISION__} macro is defined to two
18544 hexadecimal digits representing the major and minor numbers in the silicon
18545 revision. If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
18546 is not defined. If @var{sirevision} is @samp{any}, the
18547 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
18548 If this optional @var{sirevision} is not used, GCC assumes the latest known
18549 silicon revision of the targeted Blackfin processor.
18550
18551 GCC defines a preprocessor macro for the specified @var{cpu}.
18552 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
18553 provided by libgloss to be linked in if @option{-msim} is not given.
18554
18555 Without this option, @samp{bf532} is used as the processor by default.
18556
18557 Note that support for @samp{bf561} is incomplete. For @samp{bf561},
18558 only the preprocessor macro is defined.
18559
18560 @item -msim
18561 @opindex msim
18562 Specifies that the program will be run on the simulator. This causes
18563 the simulator BSP provided by libgloss to be linked in. This option
18564 has effect only for @samp{bfin-elf} toolchain.
18565 Certain other options, such as @option{-mid-shared-library} and
18566 @option{-mfdpic}, imply @option{-msim}.
18567
18568 @item -momit-leaf-frame-pointer
18569 @opindex momit-leaf-frame-pointer
18570 Don't keep the frame pointer in a register for leaf functions. This
18571 avoids the instructions to save, set up and restore frame pointers and
18572 makes an extra register available in leaf functions.
18573
18574 @item -mspecld-anomaly
18575 @opindex mspecld-anomaly
18576 When enabled, the compiler ensures that the generated code does not
18577 contain speculative loads after jump instructions. If this option is used,
18578 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
18579
18580 @item -mno-specld-anomaly
18581 @opindex mno-specld-anomaly
18582 @opindex mspecld-anomaly
18583 Don't generate extra code to prevent speculative loads from occurring.
18584
18585 @item -mcsync-anomaly
18586 @opindex mcsync-anomaly
18587 When enabled, the compiler ensures that the generated code does not
18588 contain CSYNC or SSYNC instructions too soon after conditional branches.
18589 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
18590
18591 @item -mno-csync-anomaly
18592 @opindex mno-csync-anomaly
18593 @opindex mcsync-anomaly
18594 Don't generate extra code to prevent CSYNC or SSYNC instructions from
18595 occurring too soon after a conditional branch.
18596
18597 @item -mlow64k
18598 @opindex mlow64k
18599 When enabled, the compiler is free to take advantage of the knowledge that
18600 the entire program fits into the low 64k of memory.
18601
18602 @item -mno-low64k
18603 @opindex mno-low64k
18604 Assume that the program is arbitrarily large. This is the default.
18605
18606 @item -mstack-check-l1
18607 @opindex mstack-check-l1
18608 Do stack checking using information placed into L1 scratchpad memory by the
18609 uClinux kernel.
18610
18611 @item -mid-shared-library
18612 @opindex mid-shared-library
18613 Generate code that supports shared libraries via the library ID method.
18614 This allows for execute in place and shared libraries in an environment
18615 without virtual memory management. This option implies @option{-fPIC}.
18616 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18617
18618 @item -mno-id-shared-library
18619 @opindex mno-id-shared-library
18620 @opindex mid-shared-library
18621 Generate code that doesn't assume ID-based shared libraries are being used.
18622 This is the default.
18623
18624 @item -mleaf-id-shared-library
18625 @opindex mleaf-id-shared-library
18626 Generate code that supports shared libraries via the library ID method,
18627 but assumes that this library or executable won't link against any other
18628 ID shared libraries. That allows the compiler to use faster code for jumps
18629 and calls.
18630
18631 @item -mno-leaf-id-shared-library
18632 @opindex mno-leaf-id-shared-library
18633 @opindex mleaf-id-shared-library
18634 Do not assume that the code being compiled won't link against any ID shared
18635 libraries. Slower code is generated for jump and call insns.
18636
18637 @item -mshared-library-id=n
18638 @opindex mshared-library-id
18639 Specifies the identification number of the ID-based shared library being
18640 compiled. Specifying a value of 0 generates more compact code; specifying
18641 other values forces the allocation of that number to the current
18642 library but is no more space- or time-efficient than omitting this option.
18643
18644 @item -msep-data
18645 @opindex msep-data
18646 Generate code that allows the data segment to be located in a different
18647 area of memory from the text segment. This allows for execute in place in
18648 an environment without virtual memory management by eliminating relocations
18649 against the text section.
18650
18651 @item -mno-sep-data
18652 @opindex mno-sep-data
18653 @opindex msep-data
18654 Generate code that assumes that the data segment follows the text segment.
18655 This is the default.
18656
18657 @item -mlong-calls
18658 @itemx -mno-long-calls
18659 @opindex mlong-calls
18660 @opindex mno-long-calls
18661 Tells the compiler to perform function calls by first loading the
18662 address of the function into a register and then performing a subroutine
18663 call on this register. This switch is needed if the target function
18664 lies outside of the 24-bit addressing range of the offset-based
18665 version of subroutine call instruction.
18666
18667 This feature is not enabled by default. Specifying
18668 @option{-mno-long-calls} restores the default behavior. Note these
18669 switches have no effect on how the compiler generates code to handle
18670 function calls via function pointers.
18671
18672 @item -mfast-fp
18673 @opindex mfast-fp
18674 Link with the fast floating-point library. This library relaxes some of
18675 the IEEE floating-point standard's rules for checking inputs against
18676 Not-a-Number (NAN), in the interest of performance.
18677
18678 @item -minline-plt
18679 @opindex minline-plt
18680 Enable inlining of PLT entries in function calls to functions that are
18681 not known to bind locally. It has no effect without @option{-mfdpic}.
18682
18683 @item -mmulticore
18684 @opindex mmulticore
18685 Build a standalone application for multicore Blackfin processors.
18686 This option causes proper start files and link scripts supporting
18687 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}.
18688 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}.
18689
18690 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
18691 selects the one-application-per-core programming model. Without
18692 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
18693 programming model is used. In this model, the main function of Core B
18694 should be named as @code{coreb_main}.
18695
18696 If this option is not used, the single-core application programming
18697 model is used.
18698
18699 @item -mcorea
18700 @opindex mcorea
18701 Build a standalone application for Core A of BF561 when using
18702 the one-application-per-core programming model. Proper start files
18703 and link scripts are used to support Core A, and the macro
18704 @code{__BFIN_COREA} is defined.
18705 This option can only be used in conjunction with @option{-mmulticore}.
18706
18707 @item -mcoreb
18708 @opindex mcoreb
18709 Build a standalone application for Core B of BF561 when using
18710 the one-application-per-core programming model. Proper start files
18711 and link scripts are used to support Core B, and the macro
18712 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
18713 should be used instead of @code{main}.
18714 This option can only be used in conjunction with @option{-mmulticore}.
18715
18716 @item -msdram
18717 @opindex msdram
18718 Build a standalone application for SDRAM. Proper start files and
18719 link scripts are used to put the application into SDRAM, and the macro
18720 @code{__BFIN_SDRAM} is defined.
18721 The loader should initialize SDRAM before loading the application.
18722
18723 @item -micplb
18724 @opindex micplb
18725 Assume that ICPLBs are enabled at run time. This has an effect on certain
18726 anomaly workarounds. For Linux targets, the default is to assume ICPLBs
18727 are enabled; for standalone applications the default is off.
18728 @end table
18729
18730 @node C6X Options
18731 @subsection C6X Options
18732 @cindex C6X Options
18733
18734 @table @gcctabopt
18735 @item -march=@var{name}
18736 @opindex march
18737 This specifies the name of the target architecture. GCC uses this
18738 name to determine what kind of instructions it can emit when generating
18739 assembly code. Permissible names are: @samp{c62x},
18740 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
18741
18742 @item -mbig-endian
18743 @opindex mbig-endian
18744 Generate code for a big-endian target.
18745
18746 @item -mlittle-endian
18747 @opindex mlittle-endian
18748 Generate code for a little-endian target. This is the default.
18749
18750 @item -msim
18751 @opindex msim
18752 Choose startup files and linker script suitable for the simulator.
18753
18754 @item -msdata=default
18755 @opindex msdata=default
18756 Put small global and static data in the @code{.neardata} section,
18757 which is pointed to by register @code{B14}. Put small uninitialized
18758 global and static data in the @code{.bss} section, which is adjacent
18759 to the @code{.neardata} section. Put small read-only data into the
18760 @code{.rodata} section. The corresponding sections used for large
18761 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
18762
18763 @item -msdata=all
18764 @opindex msdata=all
18765 Put all data, not just small objects, into the sections reserved for
18766 small data, and use addressing relative to the @code{B14} register to
18767 access them.
18768
18769 @item -msdata=none
18770 @opindex msdata=none
18771 Make no use of the sections reserved for small data, and use absolute
18772 addresses to access all data. Put all initialized global and static
18773 data in the @code{.fardata} section, and all uninitialized data in the
18774 @code{.far} section. Put all constant data into the @code{.const}
18775 section.
18776 @end table
18777
18778 @node CRIS Options
18779 @subsection CRIS Options
18780 @cindex CRIS Options
18781
18782 These options are defined specifically for the CRIS ports.
18783
18784 @table @gcctabopt
18785 @item -march=@var{architecture-type}
18786 @itemx -mcpu=@var{architecture-type}
18787 @opindex march
18788 @opindex mcpu
18789 Generate code for the specified architecture. The choices for
18790 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
18791 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
18792 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
18793 @samp{v10}.
18794
18795 @item -mtune=@var{architecture-type}
18796 @opindex mtune
18797 Tune to @var{architecture-type} everything applicable about the generated
18798 code, except for the ABI and the set of available instructions. The
18799 choices for @var{architecture-type} are the same as for
18800 @option{-march=@var{architecture-type}}.
18801
18802 @item -mmax-stack-frame=@var{n}
18803 @opindex mmax-stack-frame
18804 Warn when the stack frame of a function exceeds @var{n} bytes.
18805
18806 @item -metrax4
18807 @itemx -metrax100
18808 @opindex metrax4
18809 @opindex metrax100
18810 The options @option{-metrax4} and @option{-metrax100} are synonyms for
18811 @option{-march=v3} and @option{-march=v8} respectively.
18812
18813 @item -mmul-bug-workaround
18814 @itemx -mno-mul-bug-workaround
18815 @opindex mmul-bug-workaround
18816 @opindex mno-mul-bug-workaround
18817 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
18818 models where it applies. This option is active by default.
18819
18820 @item -mpdebug
18821 @opindex mpdebug
18822 Enable CRIS-specific verbose debug-related information in the assembly
18823 code. This option also has the effect of turning off the @samp{#NO_APP}
18824 formatted-code indicator to the assembler at the beginning of the
18825 assembly file.
18826
18827 @item -mcc-init
18828 @opindex mcc-init
18829 Do not use condition-code results from previous instruction; always emit
18830 compare and test instructions before use of condition codes.
18831
18832 @item -mno-side-effects
18833 @opindex mno-side-effects
18834 @opindex mside-effects
18835 Do not emit instructions with side effects in addressing modes other than
18836 post-increment.
18837
18838 @item -mstack-align
18839 @itemx -mno-stack-align
18840 @itemx -mdata-align
18841 @itemx -mno-data-align
18842 @itemx -mconst-align
18843 @itemx -mno-const-align
18844 @opindex mstack-align
18845 @opindex mno-stack-align
18846 @opindex mdata-align
18847 @opindex mno-data-align
18848 @opindex mconst-align
18849 @opindex mno-const-align
18850 These options (@samp{no-} options) arrange (eliminate arrangements) for the
18851 stack frame, individual data and constants to be aligned for the maximum
18852 single data access size for the chosen CPU model. The default is to
18853 arrange for 32-bit alignment. ABI details such as structure layout are
18854 not affected by these options.
18855
18856 @item -m32-bit
18857 @itemx -m16-bit
18858 @itemx -m8-bit
18859 @opindex m32-bit
18860 @opindex m16-bit
18861 @opindex m8-bit
18862 Similar to the stack- data- and const-align options above, these options
18863 arrange for stack frame, writable data and constants to all be 32-bit,
18864 16-bit or 8-bit aligned. The default is 32-bit alignment.
18865
18866 @item -mno-prologue-epilogue
18867 @itemx -mprologue-epilogue
18868 @opindex mno-prologue-epilogue
18869 @opindex mprologue-epilogue
18870 With @option{-mno-prologue-epilogue}, the normal function prologue and
18871 epilogue which set up the stack frame are omitted and no return
18872 instructions or return sequences are generated in the code. Use this
18873 option only together with visual inspection of the compiled code: no
18874 warnings or errors are generated when call-saved registers must be saved,
18875 or storage for local variables needs to be allocated.
18876
18877 @item -mno-gotplt
18878 @itemx -mgotplt
18879 @opindex mno-gotplt
18880 @opindex mgotplt
18881 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
18882 instruction sequences that load addresses for functions from the PLT part
18883 of the GOT rather than (traditional on other architectures) calls to the
18884 PLT@. The default is @option{-mgotplt}.
18885
18886 @item -melf
18887 @opindex melf
18888 Legacy no-op option only recognized with the cris-axis-elf and
18889 cris-axis-linux-gnu targets.
18890
18891 @item -mlinux
18892 @opindex mlinux
18893 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
18894
18895 @item -sim
18896 @opindex sim
18897 This option, recognized for the cris-axis-elf, arranges
18898 to link with input-output functions from a simulator library. Code,
18899 initialized data and zero-initialized data are allocated consecutively.
18900
18901 @item -sim2
18902 @opindex sim2
18903 Like @option{-sim}, but pass linker options to locate initialized data at
18904 0x40000000 and zero-initialized data at 0x80000000.
18905 @end table
18906
18907 @node CR16 Options
18908 @subsection CR16 Options
18909 @cindex CR16 Options
18910
18911 These options are defined specifically for the CR16 ports.
18912
18913 @table @gcctabopt
18914
18915 @item -mmac
18916 @opindex mmac
18917 Enable the use of multiply-accumulate instructions. Disabled by default.
18918
18919 @item -mcr16cplus
18920 @itemx -mcr16c
18921 @opindex mcr16cplus
18922 @opindex mcr16c
18923 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture
18924 is default.
18925
18926 @item -msim
18927 @opindex msim
18928 Links the library libsim.a which is in compatible with simulator. Applicable
18929 to ELF compiler only.
18930
18931 @item -mint32
18932 @opindex mint32
18933 Choose integer type as 32-bit wide.
18934
18935 @item -mbit-ops
18936 @opindex mbit-ops
18937 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
18938
18939 @item -mdata-model=@var{model}
18940 @opindex mdata-model
18941 Choose a data model. The choices for @var{model} are @samp{near},
18942 @samp{far} or @samp{medium}. @samp{medium} is default.
18943 However, @samp{far} is not valid with @option{-mcr16c}, as the
18944 CR16C architecture does not support the far data model.
18945 @end table
18946
18947 @node C-SKY Options
18948 @subsection C-SKY Options
18949 @cindex C-SKY Options
18950
18951 GCC supports these options when compiling for C-SKY V2 processors.
18952
18953 @table @gcctabopt
18954
18955 @item -march=@var{arch}
18956 @opindex march=
18957 Specify the C-SKY target architecture. Valid values for @var{arch} are:
18958 @samp{ck801}, @samp{ck802}, @samp{ck803}, @samp{ck807}, and @samp{ck810}.
18959 The default is @samp{ck810}.
18960
18961 @item -mcpu=@var{cpu}
18962 @opindex mcpu=
18963 Specify the C-SKY target processor. Valid values for @var{cpu} are:
18964 @samp{ck801}, @samp{ck801t},
18965 @samp{ck802}, @samp{ck802t}, @samp{ck802j},
18966 @samp{ck803}, @samp{ck803h}, @samp{ck803t}, @samp{ck803ht},
18967 @samp{ck803f}, @samp{ck803fh}, @samp{ck803e}, @samp{ck803eh},
18968 @samp{ck803et}, @samp{ck803eht}, @samp{ck803ef}, @samp{ck803efh},
18969 @samp{ck803ft}, @samp{ck803eft}, @samp{ck803efht}, @samp{ck803r1},
18970 @samp{ck803hr1}, @samp{ck803tr1}, @samp{ck803htr1}, @samp{ck803fr1},
18971 @samp{ck803fhr1}, @samp{ck803er1}, @samp{ck803ehr1}, @samp{ck803etr1},
18972 @samp{ck803ehtr1}, @samp{ck803efr1}, @samp{ck803efhr1}, @samp{ck803ftr1},
18973 @samp{ck803eftr1}, @samp{ck803efhtr1},
18974 @samp{ck803s}, @samp{ck803st}, @samp{ck803se}, @samp{ck803sf},
18975 @samp{ck803sef}, @samp{ck803seft},
18976 @samp{ck807e}, @samp{ck807ef}, @samp{ck807}, @samp{ck807f},
18977 @samp{ck810e}, @samp{ck810et}, @samp{ck810ef}, @samp{ck810eft},
18978 @samp{ck810}, @samp{ck810v}, @samp{ck810f}, @samp{ck810t}, @samp{ck810fv},
18979 @samp{ck810tv}, @samp{ck810ft}, and @samp{ck810ftv}.
18980
18981 @item -mbig-endian
18982 @opindex mbig-endian
18983 @itemx -EB
18984 @opindex EB
18985 @itemx -mlittle-endian
18986 @opindex mlittle-endian
18987 @itemx -EL
18988 @opindex EL
18989
18990 Select big- or little-endian code. The default is little-endian.
18991
18992 @item -mhard-float
18993 @opindex mhard-float
18994 @itemx -msoft-float
18995 @opindex msoft-float
18996
18997 Select hardware or software floating-point implementations.
18998 The default is soft float.
18999
19000 @item -mdouble-float
19001 @itemx -mno-double-float
19002 @opindex mdouble-float
19003 When @option{-mhard-float} is in effect, enable generation of
19004 double-precision float instructions. This is the default except
19005 when compiling for CK803.
19006
19007 @item -mfdivdu
19008 @itemx -mno-fdivdu
19009 @opindex mfdivdu
19010 When @option{-mhard-float} is in effect, enable generation of
19011 @code{frecipd}, @code{fsqrtd}, and @code{fdivd} instructions.
19012 This is the default except when compiling for CK803.
19013
19014 @item -mfpu=@var{fpu}
19015 @opindex mfpu=
19016 Select the floating-point processor. This option can only be used with
19017 @option{-mhard-float}.
19018 Values for @var{fpu} are
19019 @samp{fpv2_sf} (equivalent to @samp{-mno-double-float -mno-fdivdu}),
19020 @samp{fpv2} (@samp{-mdouble-float -mno-divdu}), and
19021 @samp{fpv2_divd} (@samp{-mdouble-float -mdivdu}).
19022
19023 @item -melrw
19024 @itemx -mno-elrw
19025 @opindex melrw
19026 Enable the extended @code{lrw} instruction. This option defaults to on
19027 for CK801 and off otherwise.
19028
19029 @item -mistack
19030 @itemx -mno-istack
19031 @opindex mistack
19032 Enable interrupt stack instructions; the default is off.
19033
19034 The @option{-mistack} option is required to handle the
19035 @code{interrupt} and @code{isr} function attributes
19036 (@pxref{C-SKY Function Attributes}).
19037
19038 @item -mmp
19039 @opindex mmp
19040 Enable multiprocessor instructions; the default is off.
19041
19042 @item -mcp
19043 @opindex mcp
19044 Enable coprocessor instructions; the default is off.
19045
19046 @item -mcache
19047 @opindex mcache
19048 Enable coprocessor instructions; the default is off.
19049
19050 @item -msecurity
19051 @opindex msecurity
19052 Enable C-SKY security instructions; the default is off.
19053
19054 @item -mtrust
19055 @opindex mtrust
19056 Enable C-SKY trust instructions; the default is off.
19057
19058 @item -mdsp
19059 @opindex mdsp
19060 @itemx -medsp
19061 @opindex medsp
19062 @itemx -mvdsp
19063 @opindex mvdsp
19064 Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively.
19065 All of these options default to off.
19066
19067 @item -mdiv
19068 @itemx -mno-div
19069 @opindex mdiv
19070 Generate divide instructions. Default is off.
19071
19072 @item -msmart
19073 @itemx -mno-smart
19074 @opindex msmart
19075 Generate code for Smart Mode, using only registers numbered 0-7 to allow
19076 use of 16-bit instructions. This option is ignored for CK801 where this
19077 is the required behavior, and it defaults to on for CK802.
19078 For other targets, the default is off.
19079
19080 @item -mhigh-registers
19081 @itemx -mno-high-registers
19082 @opindex mhigh-registers
19083 Generate code using the high registers numbered 16-31. This option
19084 is not supported on CK801, CK802, or CK803, and is enabled by default
19085 for other processors.
19086
19087 @item -manchor
19088 @itemx -mno-anchor
19089 @opindex manchor
19090 Generate code using global anchor symbol addresses.
19091
19092 @item -mpushpop
19093 @itemx -mno-pushpop
19094 @opindex mpushpop
19095 Generate code using @code{push} and @code{pop} instructions. This option
19096 defaults to on.
19097
19098 @item -mmultiple-stld
19099 @itemx -mstm
19100 @itemx -mno-multiple-stld
19101 @itemx -mno-stm
19102 @opindex mmultiple-stld
19103 Generate code using @code{stm} and @code{ldm} instructions. This option
19104 isn't supported on CK801 but is enabled by default on other processors.
19105
19106 @item -mconstpool
19107 @itemx -mno-constpool
19108 @opindex mconstpool
19109 Create constant pools in the compiler instead of deferring it to the
19110 assembler. This option is the default and required for correct code
19111 generation on CK801 and CK802, and is optional on other processors.
19112
19113 @item -mstack-size
19114 @item -mno-stack-size
19115 @opindex mstack-size
19116 Emit @code{.stack_size} directives for each function in the assembly
19117 output. This option defaults to off.
19118
19119 @item -mccrt
19120 @itemx -mno-ccrt
19121 @opindex mccrt
19122 Generate code for the C-SKY compiler runtime instead of libgcc. This
19123 option defaults to off.
19124
19125 @item -mbranch-cost=@var{n}
19126 @opindex mbranch-cost=
19127 Set the branch costs to roughly @code{n} instructions. The default is 1.
19128
19129 @item -msched-prolog
19130 @itemx -mno-sched-prolog
19131 @opindex msched-prolog
19132 Permit scheduling of function prologue and epilogue sequences. Using
19133 this option can result in code that is not compliant with the C-SKY V2 ABI
19134 prologue requirements and that cannot be debugged or backtraced.
19135 It is disabled by default.
19136
19137 @end table
19138
19139 @node Darwin Options
19140 @subsection Darwin Options
19141 @cindex Darwin options
19142
19143 These options are defined for all architectures running the Darwin operating
19144 system.
19145
19146 FSF GCC on Darwin does not create ``fat'' object files; it creates
19147 an object file for the single architecture that GCC was built to
19148 target. Apple's GCC on Darwin does create ``fat'' files if multiple
19149 @option{-arch} options are used; it does so by running the compiler or
19150 linker multiple times and joining the results together with
19151 @file{lipo}.
19152
19153 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
19154 @samp{i686}) is determined by the flags that specify the ISA
19155 that GCC is targeting, like @option{-mcpu} or @option{-march}. The
19156 @option{-force_cpusubtype_ALL} option can be used to override this.
19157
19158 The Darwin tools vary in their behavior when presented with an ISA
19159 mismatch. The assembler, @file{as}, only permits instructions to
19160 be used that are valid for the subtype of the file it is generating,
19161 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
19162 The linker for shared libraries, @file{/usr/bin/libtool}, fails
19163 and prints an error if asked to create a shared library with a less
19164 restrictive subtype than its input files (for instance, trying to put
19165 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
19166 for executables, @command{ld}, quietly gives the executable the most
19167 restrictive subtype of any of its input files.
19168
19169 @table @gcctabopt
19170 @item -F@var{dir}
19171 @opindex F
19172 Add the framework directory @var{dir} to the head of the list of
19173 directories to be searched for header files. These directories are
19174 interleaved with those specified by @option{-I} options and are
19175 scanned in a left-to-right order.
19176
19177 A framework directory is a directory with frameworks in it. A
19178 framework is a directory with a @file{Headers} and/or
19179 @file{PrivateHeaders} directory contained directly in it that ends
19180 in @file{.framework}. The name of a framework is the name of this
19181 directory excluding the @file{.framework}. Headers associated with
19182 the framework are found in one of those two directories, with
19183 @file{Headers} being searched first. A subframework is a framework
19184 directory that is in a framework's @file{Frameworks} directory.
19185 Includes of subframework headers can only appear in a header of a
19186 framework that contains the subframework, or in a sibling subframework
19187 header. Two subframeworks are siblings if they occur in the same
19188 framework. A subframework should not have the same name as a
19189 framework; a warning is issued if this is violated. Currently a
19190 subframework cannot have subframeworks; in the future, the mechanism
19191 may be extended to support this. The standard frameworks can be found
19192 in @file{/System/Library/Frameworks} and
19193 @file{/Library/Frameworks}. An example include looks like
19194 @code{#include <Framework/header.h>}, where @file{Framework} denotes
19195 the name of the framework and @file{header.h} is found in the
19196 @file{PrivateHeaders} or @file{Headers} directory.
19197
19198 @item -iframework@var{dir}
19199 @opindex iframework
19200 Like @option{-F} except the directory is a treated as a system
19201 directory. The main difference between this @option{-iframework} and
19202 @option{-F} is that with @option{-iframework} the compiler does not
19203 warn about constructs contained within header files found via
19204 @var{dir}. This option is valid only for the C family of languages.
19205
19206 @item -gused
19207 @opindex gused
19208 Emit debugging information for symbols that are used. For stabs
19209 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
19210 This is by default ON@.
19211
19212 @item -gfull
19213 @opindex gfull
19214 Emit debugging information for all symbols and types.
19215
19216 @item -mmacosx-version-min=@var{version}
19217 The earliest version of MacOS X that this executable will run on
19218 is @var{version}. Typical values of @var{version} include @code{10.1},
19219 @code{10.2}, and @code{10.3.9}.
19220
19221 If the compiler was built to use the system's headers by default,
19222 then the default for this option is the system version on which the
19223 compiler is running, otherwise the default is to make choices that
19224 are compatible with as many systems and code bases as possible.
19225
19226 @item -mkernel
19227 @opindex mkernel
19228 Enable kernel development mode. The @option{-mkernel} option sets
19229 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
19230 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
19231 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
19232 applicable. This mode also sets @option{-mno-altivec},
19233 @option{-msoft-float}, @option{-fno-builtin} and
19234 @option{-mlong-branch} for PowerPC targets.
19235
19236 @item -mone-byte-bool
19237 @opindex mone-byte-bool
19238 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
19239 By default @code{sizeof(bool)} is @code{4} when compiling for
19240 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
19241 option has no effect on x86.
19242
19243 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
19244 to generate code that is not binary compatible with code generated
19245 without that switch. Using this switch may require recompiling all
19246 other modules in a program, including system libraries. Use this
19247 switch to conform to a non-default data model.
19248
19249 @item -mfix-and-continue
19250 @itemx -ffix-and-continue
19251 @itemx -findirect-data
19252 @opindex mfix-and-continue
19253 @opindex ffix-and-continue
19254 @opindex findirect-data
19255 Generate code suitable for fast turnaround development, such as to
19256 allow GDB to dynamically load @file{.o} files into already-running
19257 programs. @option{-findirect-data} and @option{-ffix-and-continue}
19258 are provided for backwards compatibility.
19259
19260 @item -all_load
19261 @opindex all_load
19262 Loads all members of static archive libraries.
19263 See man ld(1) for more information.
19264
19265 @item -arch_errors_fatal
19266 @opindex arch_errors_fatal
19267 Cause the errors having to do with files that have the wrong architecture
19268 to be fatal.
19269
19270 @item -bind_at_load
19271 @opindex bind_at_load
19272 Causes the output file to be marked such that the dynamic linker will
19273 bind all undefined references when the file is loaded or launched.
19274
19275 @item -bundle
19276 @opindex bundle
19277 Produce a Mach-o bundle format file.
19278 See man ld(1) for more information.
19279
19280 @item -bundle_loader @var{executable}
19281 @opindex bundle_loader
19282 This option specifies the @var{executable} that will load the build
19283 output file being linked. See man ld(1) for more information.
19284
19285 @item -dynamiclib
19286 @opindex dynamiclib
19287 When passed this option, GCC produces a dynamic library instead of
19288 an executable when linking, using the Darwin @file{libtool} command.
19289
19290 @item -force_cpusubtype_ALL
19291 @opindex force_cpusubtype_ALL
19292 This causes GCC's output file to have the @samp{ALL} subtype, instead of
19293 one controlled by the @option{-mcpu} or @option{-march} option.
19294
19295 @item -allowable_client @var{client_name}
19296 @itemx -client_name
19297 @itemx -compatibility_version
19298 @itemx -current_version
19299 @itemx -dead_strip
19300 @itemx -dependency-file
19301 @itemx -dylib_file
19302 @itemx -dylinker_install_name
19303 @itemx -dynamic
19304 @itemx -exported_symbols_list
19305 @itemx -filelist
19306 @need 800
19307 @itemx -flat_namespace
19308 @itemx -force_flat_namespace
19309 @itemx -headerpad_max_install_names
19310 @itemx -image_base
19311 @itemx -init
19312 @itemx -install_name
19313 @itemx -keep_private_externs
19314 @itemx -multi_module
19315 @itemx -multiply_defined
19316 @itemx -multiply_defined_unused
19317 @need 800
19318 @itemx -noall_load
19319 @itemx -no_dead_strip_inits_and_terms
19320 @itemx -nofixprebinding
19321 @itemx -nomultidefs
19322 @itemx -noprebind
19323 @itemx -noseglinkedit
19324 @itemx -pagezero_size
19325 @itemx -prebind
19326 @itemx -prebind_all_twolevel_modules
19327 @itemx -private_bundle
19328 @need 800
19329 @itemx -read_only_relocs
19330 @itemx -sectalign
19331 @itemx -sectobjectsymbols
19332 @itemx -whyload
19333 @itemx -seg1addr
19334 @itemx -sectcreate
19335 @itemx -sectobjectsymbols
19336 @itemx -sectorder
19337 @itemx -segaddr
19338 @itemx -segs_read_only_addr
19339 @need 800
19340 @itemx -segs_read_write_addr
19341 @itemx -seg_addr_table
19342 @itemx -seg_addr_table_filename
19343 @itemx -seglinkedit
19344 @itemx -segprot
19345 @itemx -segs_read_only_addr
19346 @itemx -segs_read_write_addr
19347 @itemx -single_module
19348 @itemx -static
19349 @itemx -sub_library
19350 @need 800
19351 @itemx -sub_umbrella
19352 @itemx -twolevel_namespace
19353 @itemx -umbrella
19354 @itemx -undefined
19355 @itemx -unexported_symbols_list
19356 @itemx -weak_reference_mismatches
19357 @itemx -whatsloaded
19358 @opindex allowable_client
19359 @opindex client_name
19360 @opindex compatibility_version
19361 @opindex current_version
19362 @opindex dead_strip
19363 @opindex dependency-file
19364 @opindex dylib_file
19365 @opindex dylinker_install_name
19366 @opindex dynamic
19367 @opindex exported_symbols_list
19368 @opindex filelist
19369 @opindex flat_namespace
19370 @opindex force_flat_namespace
19371 @opindex headerpad_max_install_names
19372 @opindex image_base
19373 @opindex init
19374 @opindex install_name
19375 @opindex keep_private_externs
19376 @opindex multi_module
19377 @opindex multiply_defined
19378 @opindex multiply_defined_unused
19379 @opindex noall_load
19380 @opindex no_dead_strip_inits_and_terms
19381 @opindex nofixprebinding
19382 @opindex nomultidefs
19383 @opindex noprebind
19384 @opindex noseglinkedit
19385 @opindex pagezero_size
19386 @opindex prebind
19387 @opindex prebind_all_twolevel_modules
19388 @opindex private_bundle
19389 @opindex read_only_relocs
19390 @opindex sectalign
19391 @opindex sectobjectsymbols
19392 @opindex whyload
19393 @opindex seg1addr
19394 @opindex sectcreate
19395 @opindex sectobjectsymbols
19396 @opindex sectorder
19397 @opindex segaddr
19398 @opindex segs_read_only_addr
19399 @opindex segs_read_write_addr
19400 @opindex seg_addr_table
19401 @opindex seg_addr_table_filename
19402 @opindex seglinkedit
19403 @opindex segprot
19404 @opindex segs_read_only_addr
19405 @opindex segs_read_write_addr
19406 @opindex single_module
19407 @opindex static
19408 @opindex sub_library
19409 @opindex sub_umbrella
19410 @opindex twolevel_namespace
19411 @opindex umbrella
19412 @opindex undefined
19413 @opindex unexported_symbols_list
19414 @opindex weak_reference_mismatches
19415 @opindex whatsloaded
19416 These options are passed to the Darwin linker. The Darwin linker man page
19417 describes them in detail.
19418 @end table
19419
19420 @node DEC Alpha Options
19421 @subsection DEC Alpha Options
19422
19423 These @samp{-m} options are defined for the DEC Alpha implementations:
19424
19425 @table @gcctabopt
19426 @item -mno-soft-float
19427 @itemx -msoft-float
19428 @opindex mno-soft-float
19429 @opindex msoft-float
19430 Use (do not use) the hardware floating-point instructions for
19431 floating-point operations. When @option{-msoft-float} is specified,
19432 functions in @file{libgcc.a} are used to perform floating-point
19433 operations. Unless they are replaced by routines that emulate the
19434 floating-point operations, or compiled in such a way as to call such
19435 emulations routines, these routines issue floating-point
19436 operations. If you are compiling for an Alpha without floating-point
19437 operations, you must ensure that the library is built so as not to call
19438 them.
19439
19440 Note that Alpha implementations without floating-point operations are
19441 required to have floating-point registers.
19442
19443 @item -mfp-reg
19444 @itemx -mno-fp-regs
19445 @opindex mfp-reg
19446 @opindex mno-fp-regs
19447 Generate code that uses (does not use) the floating-point register set.
19448 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
19449 register set is not used, floating-point operands are passed in integer
19450 registers as if they were integers and floating-point results are passed
19451 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
19452 so any function with a floating-point argument or return value called by code
19453 compiled with @option{-mno-fp-regs} must also be compiled with that
19454 option.
19455
19456 A typical use of this option is building a kernel that does not use,
19457 and hence need not save and restore, any floating-point registers.
19458
19459 @item -mieee
19460 @opindex mieee
19461 The Alpha architecture implements floating-point hardware optimized for
19462 maximum performance. It is mostly compliant with the IEEE floating-point
19463 standard. However, for full compliance, software assistance is
19464 required. This option generates code fully IEEE-compliant code
19465 @emph{except} that the @var{inexact-flag} is not maintained (see below).
19466 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
19467 defined during compilation. The resulting code is less efficient but is
19468 able to correctly support denormalized numbers and exceptional IEEE
19469 values such as not-a-number and plus/minus infinity. Other Alpha
19470 compilers call this option @option{-ieee_with_no_inexact}.
19471
19472 @item -mieee-with-inexact
19473 @opindex mieee-with-inexact
19474 This is like @option{-mieee} except the generated code also maintains
19475 the IEEE @var{inexact-flag}. Turning on this option causes the
19476 generated code to implement fully-compliant IEEE math. In addition to
19477 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
19478 macro. On some Alpha implementations the resulting code may execute
19479 significantly slower than the code generated by default. Since there is
19480 very little code that depends on the @var{inexact-flag}, you should
19481 normally not specify this option. Other Alpha compilers call this
19482 option @option{-ieee_with_inexact}.
19483
19484 @item -mfp-trap-mode=@var{trap-mode}
19485 @opindex mfp-trap-mode
19486 This option controls what floating-point related traps are enabled.
19487 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
19488 The trap mode can be set to one of four values:
19489
19490 @table @samp
19491 @item n
19492 This is the default (normal) setting. The only traps that are enabled
19493 are the ones that cannot be disabled in software (e.g., division by zero
19494 trap).
19495
19496 @item u
19497 In addition to the traps enabled by @samp{n}, underflow traps are enabled
19498 as well.
19499
19500 @item su
19501 Like @samp{u}, but the instructions are marked to be safe for software
19502 completion (see Alpha architecture manual for details).
19503
19504 @item sui
19505 Like @samp{su}, but inexact traps are enabled as well.
19506 @end table
19507
19508 @item -mfp-rounding-mode=@var{rounding-mode}
19509 @opindex mfp-rounding-mode
19510 Selects the IEEE rounding mode. Other Alpha compilers call this option
19511 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
19512 of:
19513
19514 @table @samp
19515 @item n
19516 Normal IEEE rounding mode. Floating-point numbers are rounded towards
19517 the nearest machine number or towards the even machine number in case
19518 of a tie.
19519
19520 @item m
19521 Round towards minus infinity.
19522
19523 @item c
19524 Chopped rounding mode. Floating-point numbers are rounded towards zero.
19525
19526 @item d
19527 Dynamic rounding mode. A field in the floating-point control register
19528 (@var{fpcr}, see Alpha architecture reference manual) controls the
19529 rounding mode in effect. The C library initializes this register for
19530 rounding towards plus infinity. Thus, unless your program modifies the
19531 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
19532 @end table
19533
19534 @item -mtrap-precision=@var{trap-precision}
19535 @opindex mtrap-precision
19536 In the Alpha architecture, floating-point traps are imprecise. This
19537 means without software assistance it is impossible to recover from a
19538 floating trap and program execution normally needs to be terminated.
19539 GCC can generate code that can assist operating system trap handlers
19540 in determining the exact location that caused a floating-point trap.
19541 Depending on the requirements of an application, different levels of
19542 precisions can be selected:
19543
19544 @table @samp
19545 @item p
19546 Program precision. This option is the default and means a trap handler
19547 can only identify which program caused a floating-point exception.
19548
19549 @item f
19550 Function precision. The trap handler can determine the function that
19551 caused a floating-point exception.
19552
19553 @item i
19554 Instruction precision. The trap handler can determine the exact
19555 instruction that caused a floating-point exception.
19556 @end table
19557
19558 Other Alpha compilers provide the equivalent options called
19559 @option{-scope_safe} and @option{-resumption_safe}.
19560
19561 @item -mieee-conformant
19562 @opindex mieee-conformant
19563 This option marks the generated code as IEEE conformant. You must not
19564 use this option unless you also specify @option{-mtrap-precision=i} and either
19565 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
19566 is to emit the line @samp{.eflag 48} in the function prologue of the
19567 generated assembly file.
19568
19569 @item -mbuild-constants
19570 @opindex mbuild-constants
19571 Normally GCC examines a 32- or 64-bit integer constant to
19572 see if it can construct it from smaller constants in two or three
19573 instructions. If it cannot, it outputs the constant as a literal and
19574 generates code to load it from the data segment at run time.
19575
19576 Use this option to require GCC to construct @emph{all} integer constants
19577 using code, even if it takes more instructions (the maximum is six).
19578
19579 You typically use this option to build a shared library dynamic
19580 loader. Itself a shared library, it must relocate itself in memory
19581 before it can find the variables and constants in its own data segment.
19582
19583 @item -mbwx
19584 @itemx -mno-bwx
19585 @itemx -mcix
19586 @itemx -mno-cix
19587 @itemx -mfix
19588 @itemx -mno-fix
19589 @itemx -mmax
19590 @itemx -mno-max
19591 @opindex mbwx
19592 @opindex mno-bwx
19593 @opindex mcix
19594 @opindex mno-cix
19595 @opindex mfix
19596 @opindex mno-fix
19597 @opindex mmax
19598 @opindex mno-max
19599 Indicate whether GCC should generate code to use the optional BWX,
19600 CIX, FIX and MAX instruction sets. The default is to use the instruction
19601 sets supported by the CPU type specified via @option{-mcpu=} option or that
19602 of the CPU on which GCC was built if none is specified.
19603
19604 @item -mfloat-vax
19605 @itemx -mfloat-ieee
19606 @opindex mfloat-vax
19607 @opindex mfloat-ieee
19608 Generate code that uses (does not use) VAX F and G floating-point
19609 arithmetic instead of IEEE single and double precision.
19610
19611 @item -mexplicit-relocs
19612 @itemx -mno-explicit-relocs
19613 @opindex mexplicit-relocs
19614 @opindex mno-explicit-relocs
19615 Older Alpha assemblers provided no way to generate symbol relocations
19616 except via assembler macros. Use of these macros does not allow
19617 optimal instruction scheduling. GNU binutils as of version 2.12
19618 supports a new syntax that allows the compiler to explicitly mark
19619 which relocations should apply to which instructions. This option
19620 is mostly useful for debugging, as GCC detects the capabilities of
19621 the assembler when it is built and sets the default accordingly.
19622
19623 @item -msmall-data
19624 @itemx -mlarge-data
19625 @opindex msmall-data
19626 @opindex mlarge-data
19627 When @option{-mexplicit-relocs} is in effect, static data is
19628 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
19629 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
19630 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
19631 16-bit relocations off of the @code{$gp} register. This limits the
19632 size of the small data area to 64KB, but allows the variables to be
19633 directly accessed via a single instruction.
19634
19635 The default is @option{-mlarge-data}. With this option the data area
19636 is limited to just below 2GB@. Programs that require more than 2GB of
19637 data must use @code{malloc} or @code{mmap} to allocate the data in the
19638 heap instead of in the program's data segment.
19639
19640 When generating code for shared libraries, @option{-fpic} implies
19641 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
19642
19643 @item -msmall-text
19644 @itemx -mlarge-text
19645 @opindex msmall-text
19646 @opindex mlarge-text
19647 When @option{-msmall-text} is used, the compiler assumes that the
19648 code of the entire program (or shared library) fits in 4MB, and is
19649 thus reachable with a branch instruction. When @option{-msmall-data}
19650 is used, the compiler can assume that all local symbols share the
19651 same @code{$gp} value, and thus reduce the number of instructions
19652 required for a function call from 4 to 1.
19653
19654 The default is @option{-mlarge-text}.
19655
19656 @item -mcpu=@var{cpu_type}
19657 @opindex mcpu
19658 Set the instruction set and instruction scheduling parameters for
19659 machine type @var{cpu_type}. You can specify either the @samp{EV}
19660 style name or the corresponding chip number. GCC supports scheduling
19661 parameters for the EV4, EV5 and EV6 family of processors and
19662 chooses the default values for the instruction set from the processor
19663 you specify. If you do not specify a processor type, GCC defaults
19664 to the processor on which the compiler was built.
19665
19666 Supported values for @var{cpu_type} are
19667
19668 @table @samp
19669 @item ev4
19670 @itemx ev45
19671 @itemx 21064
19672 Schedules as an EV4 and has no instruction set extensions.
19673
19674 @item ev5
19675 @itemx 21164
19676 Schedules as an EV5 and has no instruction set extensions.
19677
19678 @item ev56
19679 @itemx 21164a
19680 Schedules as an EV5 and supports the BWX extension.
19681
19682 @item pca56
19683 @itemx 21164pc
19684 @itemx 21164PC
19685 Schedules as an EV5 and supports the BWX and MAX extensions.
19686
19687 @item ev6
19688 @itemx 21264
19689 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
19690
19691 @item ev67
19692 @itemx 21264a
19693 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
19694 @end table
19695
19696 Native toolchains also support the value @samp{native},
19697 which selects the best architecture option for the host processor.
19698 @option{-mcpu=native} has no effect if GCC does not recognize
19699 the processor.
19700
19701 @item -mtune=@var{cpu_type}
19702 @opindex mtune
19703 Set only the instruction scheduling parameters for machine type
19704 @var{cpu_type}. The instruction set is not changed.
19705
19706 Native toolchains also support the value @samp{native},
19707 which selects the best architecture option for the host processor.
19708 @option{-mtune=native} has no effect if GCC does not recognize
19709 the processor.
19710
19711 @item -mmemory-latency=@var{time}
19712 @opindex mmemory-latency
19713 Sets the latency the scheduler should assume for typical memory
19714 references as seen by the application. This number is highly
19715 dependent on the memory access patterns used by the application
19716 and the size of the external cache on the machine.
19717
19718 Valid options for @var{time} are
19719
19720 @table @samp
19721 @item @var{number}
19722 A decimal number representing clock cycles.
19723
19724 @item L1
19725 @itemx L2
19726 @itemx L3
19727 @itemx main
19728 The compiler contains estimates of the number of clock cycles for
19729 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
19730 (also called Dcache, Scache, and Bcache), as well as to main memory.
19731 Note that L3 is only valid for EV5.
19732
19733 @end table
19734 @end table
19735
19736 @node FR30 Options
19737 @subsection FR30 Options
19738 @cindex FR30 Options
19739
19740 These options are defined specifically for the FR30 port.
19741
19742 @table @gcctabopt
19743
19744 @item -msmall-model
19745 @opindex msmall-model
19746 Use the small address space model. This can produce smaller code, but
19747 it does assume that all symbolic values and addresses fit into a
19748 20-bit range.
19749
19750 @item -mno-lsim
19751 @opindex mno-lsim
19752 Assume that runtime support has been provided and so there is no need
19753 to include the simulator library (@file{libsim.a}) on the linker
19754 command line.
19755
19756 @end table
19757
19758 @node FT32 Options
19759 @subsection FT32 Options
19760 @cindex FT32 Options
19761
19762 These options are defined specifically for the FT32 port.
19763
19764 @table @gcctabopt
19765
19766 @item -msim
19767 @opindex msim
19768 Specifies that the program will be run on the simulator. This causes
19769 an alternate runtime startup and library to be linked.
19770 You must not use this option when generating programs that will run on
19771 real hardware; you must provide your own runtime library for whatever
19772 I/O functions are needed.
19773
19774 @item -mlra
19775 @opindex mlra
19776 Enable Local Register Allocation. This is still experimental for FT32,
19777 so by default the compiler uses standard reload.
19778
19779 @item -mnodiv
19780 @opindex mnodiv
19781 Do not use div and mod instructions.
19782
19783 @item -mft32b
19784 @opindex mft32b
19785 Enable use of the extended instructions of the FT32B processor.
19786
19787 @item -mcompress
19788 @opindex mcompress
19789 Compress all code using the Ft32B code compression scheme.
19790
19791 @item -mnopm
19792 @opindex mnopm
19793 Do not generate code that reads program memory.
19794
19795 @end table
19796
19797 @node FRV Options
19798 @subsection FRV Options
19799 @cindex FRV Options
19800
19801 @table @gcctabopt
19802 @item -mgpr-32
19803 @opindex mgpr-32
19804
19805 Only use the first 32 general-purpose registers.
19806
19807 @item -mgpr-64
19808 @opindex mgpr-64
19809
19810 Use all 64 general-purpose registers.
19811
19812 @item -mfpr-32
19813 @opindex mfpr-32
19814
19815 Use only the first 32 floating-point registers.
19816
19817 @item -mfpr-64
19818 @opindex mfpr-64
19819
19820 Use all 64 floating-point registers.
19821
19822 @item -mhard-float
19823 @opindex mhard-float
19824
19825 Use hardware instructions for floating-point operations.
19826
19827 @item -msoft-float
19828 @opindex msoft-float
19829
19830 Use library routines for floating-point operations.
19831
19832 @item -malloc-cc
19833 @opindex malloc-cc
19834
19835 Dynamically allocate condition code registers.
19836
19837 @item -mfixed-cc
19838 @opindex mfixed-cc
19839
19840 Do not try to dynamically allocate condition code registers, only
19841 use @code{icc0} and @code{fcc0}.
19842
19843 @item -mdword
19844 @opindex mdword
19845
19846 Change ABI to use double word insns.
19847
19848 @item -mno-dword
19849 @opindex mno-dword
19850 @opindex mdword
19851
19852 Do not use double word instructions.
19853
19854 @item -mdouble
19855 @opindex mdouble
19856
19857 Use floating-point double instructions.
19858
19859 @item -mno-double
19860 @opindex mno-double
19861
19862 Do not use floating-point double instructions.
19863
19864 @item -mmedia
19865 @opindex mmedia
19866
19867 Use media instructions.
19868
19869 @item -mno-media
19870 @opindex mno-media
19871
19872 Do not use media instructions.
19873
19874 @item -mmuladd
19875 @opindex mmuladd
19876
19877 Use multiply and add/subtract instructions.
19878
19879 @item -mno-muladd
19880 @opindex mno-muladd
19881
19882 Do not use multiply and add/subtract instructions.
19883
19884 @item -mfdpic
19885 @opindex mfdpic
19886
19887 Select the FDPIC ABI, which uses function descriptors to represent
19888 pointers to functions. Without any PIC/PIE-related options, it
19889 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
19890 assumes GOT entries and small data are within a 12-bit range from the
19891 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
19892 are computed with 32 bits.
19893 With a @samp{bfin-elf} target, this option implies @option{-msim}.
19894
19895 @item -minline-plt
19896 @opindex minline-plt
19897
19898 Enable inlining of PLT entries in function calls to functions that are
19899 not known to bind locally. It has no effect without @option{-mfdpic}.
19900 It's enabled by default if optimizing for speed and compiling for
19901 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
19902 optimization option such as @option{-O3} or above is present in the
19903 command line.
19904
19905 @item -mTLS
19906 @opindex mTLS
19907
19908 Assume a large TLS segment when generating thread-local code.
19909
19910 @item -mtls
19911 @opindex mtls
19912
19913 Do not assume a large TLS segment when generating thread-local code.
19914
19915 @item -mgprel-ro
19916 @opindex mgprel-ro
19917
19918 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
19919 that is known to be in read-only sections. It's enabled by default,
19920 except for @option{-fpic} or @option{-fpie}: even though it may help
19921 make the global offset table smaller, it trades 1 instruction for 4.
19922 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
19923 one of which may be shared by multiple symbols, and it avoids the need
19924 for a GOT entry for the referenced symbol, so it's more likely to be a
19925 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
19926
19927 @item -multilib-library-pic
19928 @opindex multilib-library-pic
19929
19930 Link with the (library, not FD) pic libraries. It's implied by
19931 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
19932 @option{-fpic} without @option{-mfdpic}. You should never have to use
19933 it explicitly.
19934
19935 @item -mlinked-fp
19936 @opindex mlinked-fp
19937
19938 Follow the EABI requirement of always creating a frame pointer whenever
19939 a stack frame is allocated. This option is enabled by default and can
19940 be disabled with @option{-mno-linked-fp}.
19941
19942 @item -mlong-calls
19943 @opindex mlong-calls
19944
19945 Use indirect addressing to call functions outside the current
19946 compilation unit. This allows the functions to be placed anywhere
19947 within the 32-bit address space.
19948
19949 @item -malign-labels
19950 @opindex malign-labels
19951
19952 Try to align labels to an 8-byte boundary by inserting NOPs into the
19953 previous packet. This option only has an effect when VLIW packing
19954 is enabled. It doesn't create new packets; it merely adds NOPs to
19955 existing ones.
19956
19957 @item -mlibrary-pic
19958 @opindex mlibrary-pic
19959
19960 Generate position-independent EABI code.
19961
19962 @item -macc-4
19963 @opindex macc-4
19964
19965 Use only the first four media accumulator registers.
19966
19967 @item -macc-8
19968 @opindex macc-8
19969
19970 Use all eight media accumulator registers.
19971
19972 @item -mpack
19973 @opindex mpack
19974
19975 Pack VLIW instructions.
19976
19977 @item -mno-pack
19978 @opindex mno-pack
19979
19980 Do not pack VLIW instructions.
19981
19982 @item -mno-eflags
19983 @opindex mno-eflags
19984
19985 Do not mark ABI switches in e_flags.
19986
19987 @item -mcond-move
19988 @opindex mcond-move
19989
19990 Enable the use of conditional-move instructions (default).
19991
19992 This switch is mainly for debugging the compiler and will likely be removed
19993 in a future version.
19994
19995 @item -mno-cond-move
19996 @opindex mno-cond-move
19997
19998 Disable the use of conditional-move instructions.
19999
20000 This switch is mainly for debugging the compiler and will likely be removed
20001 in a future version.
20002
20003 @item -mscc
20004 @opindex mscc
20005
20006 Enable the use of conditional set instructions (default).
20007
20008 This switch is mainly for debugging the compiler and will likely be removed
20009 in a future version.
20010
20011 @item -mno-scc
20012 @opindex mno-scc
20013
20014 Disable the use of conditional set instructions.
20015
20016 This switch is mainly for debugging the compiler and will likely be removed
20017 in a future version.
20018
20019 @item -mcond-exec
20020 @opindex mcond-exec
20021
20022 Enable the use of conditional execution (default).
20023
20024 This switch is mainly for debugging the compiler and will likely be removed
20025 in a future version.
20026
20027 @item -mno-cond-exec
20028 @opindex mno-cond-exec
20029
20030 Disable the use of conditional execution.
20031
20032 This switch is mainly for debugging the compiler and will likely be removed
20033 in a future version.
20034
20035 @item -mvliw-branch
20036 @opindex mvliw-branch
20037
20038 Run a pass to pack branches into VLIW instructions (default).
20039
20040 This switch is mainly for debugging the compiler and will likely be removed
20041 in a future version.
20042
20043 @item -mno-vliw-branch
20044 @opindex mno-vliw-branch
20045
20046 Do not run a pass to pack branches into VLIW instructions.
20047
20048 This switch is mainly for debugging the compiler and will likely be removed
20049 in a future version.
20050
20051 @item -mmulti-cond-exec
20052 @opindex mmulti-cond-exec
20053
20054 Enable optimization of @code{&&} and @code{||} in conditional execution
20055 (default).
20056
20057 This switch is mainly for debugging the compiler and will likely be removed
20058 in a future version.
20059
20060 @item -mno-multi-cond-exec
20061 @opindex mno-multi-cond-exec
20062
20063 Disable optimization of @code{&&} and @code{||} in conditional execution.
20064
20065 This switch is mainly for debugging the compiler and will likely be removed
20066 in a future version.
20067
20068 @item -mnested-cond-exec
20069 @opindex mnested-cond-exec
20070
20071 Enable nested conditional execution optimizations (default).
20072
20073 This switch is mainly for debugging the compiler and will likely be removed
20074 in a future version.
20075
20076 @item -mno-nested-cond-exec
20077 @opindex mno-nested-cond-exec
20078
20079 Disable nested conditional execution optimizations.
20080
20081 This switch is mainly for debugging the compiler and will likely be removed
20082 in a future version.
20083
20084 @item -moptimize-membar
20085 @opindex moptimize-membar
20086
20087 This switch removes redundant @code{membar} instructions from the
20088 compiler-generated code. It is enabled by default.
20089
20090 @item -mno-optimize-membar
20091 @opindex mno-optimize-membar
20092 @opindex moptimize-membar
20093
20094 This switch disables the automatic removal of redundant @code{membar}
20095 instructions from the generated code.
20096
20097 @item -mtomcat-stats
20098 @opindex mtomcat-stats
20099
20100 Cause gas to print out tomcat statistics.
20101
20102 @item -mcpu=@var{cpu}
20103 @opindex mcpu
20104
20105 Select the processor type for which to generate code. Possible values are
20106 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
20107 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
20108
20109 @end table
20110
20111 @node GNU/Linux Options
20112 @subsection GNU/Linux Options
20113
20114 These @samp{-m} options are defined for GNU/Linux targets:
20115
20116 @table @gcctabopt
20117 @item -mglibc
20118 @opindex mglibc
20119 Use the GNU C library. This is the default except
20120 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
20121 @samp{*-*-linux-*android*} targets.
20122
20123 @item -muclibc
20124 @opindex muclibc
20125 Use uClibc C library. This is the default on
20126 @samp{*-*-linux-*uclibc*} targets.
20127
20128 @item -mmusl
20129 @opindex mmusl
20130 Use the musl C library. This is the default on
20131 @samp{*-*-linux-*musl*} targets.
20132
20133 @item -mbionic
20134 @opindex mbionic
20135 Use Bionic C library. This is the default on
20136 @samp{*-*-linux-*android*} targets.
20137
20138 @item -mandroid
20139 @opindex mandroid
20140 Compile code compatible with Android platform. This is the default on
20141 @samp{*-*-linux-*android*} targets.
20142
20143 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
20144 @option{-fno-exceptions} and @option{-fno-rtti} by default. When linking,
20145 this option makes the GCC driver pass Android-specific options to the linker.
20146 Finally, this option causes the preprocessor macro @code{__ANDROID__}
20147 to be defined.
20148
20149 @item -tno-android-cc
20150 @opindex tno-android-cc
20151 Disable compilation effects of @option{-mandroid}, i.e., do not enable
20152 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
20153 @option{-fno-rtti} by default.
20154
20155 @item -tno-android-ld
20156 @opindex tno-android-ld
20157 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
20158 linking options to the linker.
20159
20160 @end table
20161
20162 @node H8/300 Options
20163 @subsection H8/300 Options
20164
20165 These @samp{-m} options are defined for the H8/300 implementations:
20166
20167 @table @gcctabopt
20168 @item -mrelax
20169 @opindex mrelax
20170 Shorten some address references at link time, when possible; uses the
20171 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
20172 ld, Using ld}, for a fuller description.
20173
20174 @item -mh
20175 @opindex mh
20176 Generate code for the H8/300H@.
20177
20178 @item -ms
20179 @opindex ms
20180 Generate code for the H8S@.
20181
20182 @item -mn
20183 @opindex mn
20184 Generate code for the H8S and H8/300H in the normal mode. This switch
20185 must be used either with @option{-mh} or @option{-ms}.
20186
20187 @item -ms2600
20188 @opindex ms2600
20189 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
20190
20191 @item -mexr
20192 @opindex mexr
20193 Extended registers are stored on stack before execution of function
20194 with monitor attribute. Default option is @option{-mexr}.
20195 This option is valid only for H8S targets.
20196
20197 @item -mno-exr
20198 @opindex mno-exr
20199 @opindex mexr
20200 Extended registers are not stored on stack before execution of function
20201 with monitor attribute. Default option is @option{-mno-exr}.
20202 This option is valid only for H8S targets.
20203
20204 @item -mint32
20205 @opindex mint32
20206 Make @code{int} data 32 bits by default.
20207
20208 @item -malign-300
20209 @opindex malign-300
20210 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
20211 The default for the H8/300H and H8S is to align longs and floats on
20212 4-byte boundaries.
20213 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
20214 This option has no effect on the H8/300.
20215 @end table
20216
20217 @node HPPA Options
20218 @subsection HPPA Options
20219 @cindex HPPA Options
20220
20221 These @samp{-m} options are defined for the HPPA family of computers:
20222
20223 @table @gcctabopt
20224 @item -march=@var{architecture-type}
20225 @opindex march
20226 Generate code for the specified architecture. The choices for
20227 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
20228 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
20229 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
20230 architecture option for your machine. Code compiled for lower numbered
20231 architectures runs on higher numbered architectures, but not the
20232 other way around.
20233
20234 @item -mpa-risc-1-0
20235 @itemx -mpa-risc-1-1
20236 @itemx -mpa-risc-2-0
20237 @opindex mpa-risc-1-0
20238 @opindex mpa-risc-1-1
20239 @opindex mpa-risc-2-0
20240 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
20241
20242 @item -mcaller-copies
20243 @opindex mcaller-copies
20244 The caller copies function arguments passed by hidden reference. This
20245 option should be used with care as it is not compatible with the default
20246 32-bit runtime. However, only aggregates larger than eight bytes are
20247 passed by hidden reference and the option provides better compatibility
20248 with OpenMP.
20249
20250 @item -mjump-in-delay
20251 @opindex mjump-in-delay
20252 This option is ignored and provided for compatibility purposes only.
20253
20254 @item -mdisable-fpregs
20255 @opindex mdisable-fpregs
20256 Prevent floating-point registers from being used in any manner. This is
20257 necessary for compiling kernels that perform lazy context switching of
20258 floating-point registers. If you use this option and attempt to perform
20259 floating-point operations, the compiler aborts.
20260
20261 @item -mdisable-indexing
20262 @opindex mdisable-indexing
20263 Prevent the compiler from using indexing address modes. This avoids some
20264 rather obscure problems when compiling MIG generated code under MACH@.
20265
20266 @item -mno-space-regs
20267 @opindex mno-space-regs
20268 @opindex mspace-regs
20269 Generate code that assumes the target has no space registers. This allows
20270 GCC to generate faster indirect calls and use unscaled index address modes.
20271
20272 Such code is suitable for level 0 PA systems and kernels.
20273
20274 @item -mfast-indirect-calls
20275 @opindex mfast-indirect-calls
20276 Generate code that assumes calls never cross space boundaries. This
20277 allows GCC to emit code that performs faster indirect calls.
20278
20279 This option does not work in the presence of shared libraries or nested
20280 functions.
20281
20282 @item -mfixed-range=@var{register-range}
20283 @opindex mfixed-range
20284 Generate code treating the given register range as fixed registers.
20285 A fixed register is one that the register allocator cannot use. This is
20286 useful when compiling kernel code. A register range is specified as
20287 two registers separated by a dash. Multiple register ranges can be
20288 specified separated by a comma.
20289
20290 @item -mlong-load-store
20291 @opindex mlong-load-store
20292 Generate 3-instruction load and store sequences as sometimes required by
20293 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
20294 the HP compilers.
20295
20296 @item -mportable-runtime
20297 @opindex mportable-runtime
20298 Use the portable calling conventions proposed by HP for ELF systems.
20299
20300 @item -mgas
20301 @opindex mgas
20302 Enable the use of assembler directives only GAS understands.
20303
20304 @item -mschedule=@var{cpu-type}
20305 @opindex mschedule
20306 Schedule code according to the constraints for the machine type
20307 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
20308 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
20309 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
20310 proper scheduling option for your machine. The default scheduling is
20311 @samp{8000}.
20312
20313 @item -mlinker-opt
20314 @opindex mlinker-opt
20315 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
20316 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
20317 linkers in which they give bogus error messages when linking some programs.
20318
20319 @item -msoft-float
20320 @opindex msoft-float
20321 Generate output containing library calls for floating point.
20322 @strong{Warning:} the requisite libraries are not available for all HPPA
20323 targets. Normally the facilities of the machine's usual C compiler are
20324 used, but this cannot be done directly in cross-compilation. You must make
20325 your own arrangements to provide suitable library functions for
20326 cross-compilation.
20327
20328 @option{-msoft-float} changes the calling convention in the output file;
20329 therefore, it is only useful if you compile @emph{all} of a program with
20330 this option. In particular, you need to compile @file{libgcc.a}, the
20331 library that comes with GCC, with @option{-msoft-float} in order for
20332 this to work.
20333
20334 @item -msio
20335 @opindex msio
20336 Generate the predefine, @code{_SIO}, for server IO@. The default is
20337 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
20338 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
20339 options are available under HP-UX and HI-UX@.
20340
20341 @item -mgnu-ld
20342 @opindex mgnu-ld
20343 Use options specific to GNU @command{ld}.
20344 This passes @option{-shared} to @command{ld} when
20345 building a shared library. It is the default when GCC is configured,
20346 explicitly or implicitly, with the GNU linker. This option does not
20347 affect which @command{ld} is called; it only changes what parameters
20348 are passed to that @command{ld}.
20349 The @command{ld} that is called is determined by the
20350 @option{--with-ld} configure option, GCC's program search path, and
20351 finally by the user's @env{PATH}. The linker used by GCC can be printed
20352 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
20353 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
20354
20355 @item -mhp-ld
20356 @opindex mhp-ld
20357 Use options specific to HP @command{ld}.
20358 This passes @option{-b} to @command{ld} when building
20359 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
20360 links. It is the default when GCC is configured, explicitly or
20361 implicitly, with the HP linker. This option does not affect
20362 which @command{ld} is called; it only changes what parameters are passed to that
20363 @command{ld}.
20364 The @command{ld} that is called is determined by the @option{--with-ld}
20365 configure option, GCC's program search path, and finally by the user's
20366 @env{PATH}. The linker used by GCC can be printed using @samp{which
20367 `gcc -print-prog-name=ld`}. This option is only available on the 64-bit
20368 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
20369
20370 @item -mlong-calls
20371 @opindex mno-long-calls
20372 @opindex mlong-calls
20373 Generate code that uses long call sequences. This ensures that a call
20374 is always able to reach linker generated stubs. The default is to generate
20375 long calls only when the distance from the call site to the beginning
20376 of the function or translation unit, as the case may be, exceeds a
20377 predefined limit set by the branch type being used. The limits for
20378 normal calls are 7,600,000 and 240,000 bytes, respectively for the
20379 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
20380 240,000 bytes.
20381
20382 Distances are measured from the beginning of functions when using the
20383 @option{-ffunction-sections} option, or when using the @option{-mgas}
20384 and @option{-mno-portable-runtime} options together under HP-UX with
20385 the SOM linker.
20386
20387 It is normally not desirable to use this option as it degrades
20388 performance. However, it may be useful in large applications,
20389 particularly when partial linking is used to build the application.
20390
20391 The types of long calls used depends on the capabilities of the
20392 assembler and linker, and the type of code being generated. The
20393 impact on systems that support long absolute calls, and long pic
20394 symbol-difference or pc-relative calls should be relatively small.
20395 However, an indirect call is used on 32-bit ELF systems in pic code
20396 and it is quite long.
20397
20398 @item -munix=@var{unix-std}
20399 @opindex march
20400 Generate compiler predefines and select a startfile for the specified
20401 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
20402 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
20403 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
20404 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
20405 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
20406 and later.
20407
20408 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
20409 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
20410 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
20411 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
20412 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
20413 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
20414
20415 It is @emph{important} to note that this option changes the interfaces
20416 for various library routines. It also affects the operational behavior
20417 of the C library. Thus, @emph{extreme} care is needed in using this
20418 option.
20419
20420 Library code that is intended to operate with more than one UNIX
20421 standard must test, set and restore the variable @code{__xpg4_extended_mask}
20422 as appropriate. Most GNU software doesn't provide this capability.
20423
20424 @item -nolibdld
20425 @opindex nolibdld
20426 Suppress the generation of link options to search libdld.sl when the
20427 @option{-static} option is specified on HP-UX 10 and later.
20428
20429 @item -static
20430 @opindex static
20431 The HP-UX implementation of setlocale in libc has a dependency on
20432 libdld.sl. There isn't an archive version of libdld.sl. Thus,
20433 when the @option{-static} option is specified, special link options
20434 are needed to resolve this dependency.
20435
20436 On HP-UX 10 and later, the GCC driver adds the necessary options to
20437 link with libdld.sl when the @option{-static} option is specified.
20438 This causes the resulting binary to be dynamic. On the 64-bit port,
20439 the linkers generate dynamic binaries by default in any case. The
20440 @option{-nolibdld} option can be used to prevent the GCC driver from
20441 adding these link options.
20442
20443 @item -threads
20444 @opindex threads
20445 Add support for multithreading with the @dfn{dce thread} library
20446 under HP-UX@. This option sets flags for both the preprocessor and
20447 linker.
20448 @end table
20449
20450 @node IA-64 Options
20451 @subsection IA-64 Options
20452 @cindex IA-64 Options
20453
20454 These are the @samp{-m} options defined for the Intel IA-64 architecture.
20455
20456 @table @gcctabopt
20457 @item -mbig-endian
20458 @opindex mbig-endian
20459 Generate code for a big-endian target. This is the default for HP-UX@.
20460
20461 @item -mlittle-endian
20462 @opindex mlittle-endian
20463 Generate code for a little-endian target. This is the default for AIX5
20464 and GNU/Linux.
20465
20466 @item -mgnu-as
20467 @itemx -mno-gnu-as
20468 @opindex mgnu-as
20469 @opindex mno-gnu-as
20470 Generate (or don't) code for the GNU assembler. This is the default.
20471 @c Also, this is the default if the configure option @option{--with-gnu-as}
20472 @c is used.
20473
20474 @item -mgnu-ld
20475 @itemx -mno-gnu-ld
20476 @opindex mgnu-ld
20477 @opindex mno-gnu-ld
20478 Generate (or don't) code for the GNU linker. This is the default.
20479 @c Also, this is the default if the configure option @option{--with-gnu-ld}
20480 @c is used.
20481
20482 @item -mno-pic
20483 @opindex mno-pic
20484 Generate code that does not use a global pointer register. The result
20485 is not position independent code, and violates the IA-64 ABI@.
20486
20487 @item -mvolatile-asm-stop
20488 @itemx -mno-volatile-asm-stop
20489 @opindex mvolatile-asm-stop
20490 @opindex mno-volatile-asm-stop
20491 Generate (or don't) a stop bit immediately before and after volatile asm
20492 statements.
20493
20494 @item -mregister-names
20495 @itemx -mno-register-names
20496 @opindex mregister-names
20497 @opindex mno-register-names
20498 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
20499 the stacked registers. This may make assembler output more readable.
20500
20501 @item -mno-sdata
20502 @itemx -msdata
20503 @opindex mno-sdata
20504 @opindex msdata
20505 Disable (or enable) optimizations that use the small data section. This may
20506 be useful for working around optimizer bugs.
20507
20508 @item -mconstant-gp
20509 @opindex mconstant-gp
20510 Generate code that uses a single constant global pointer value. This is
20511 useful when compiling kernel code.
20512
20513 @item -mauto-pic
20514 @opindex mauto-pic
20515 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
20516 This is useful when compiling firmware code.
20517
20518 @item -minline-float-divide-min-latency
20519 @opindex minline-float-divide-min-latency
20520 Generate code for inline divides of floating-point values
20521 using the minimum latency algorithm.
20522
20523 @item -minline-float-divide-max-throughput
20524 @opindex minline-float-divide-max-throughput
20525 Generate code for inline divides of floating-point values
20526 using the maximum throughput algorithm.
20527
20528 @item -mno-inline-float-divide
20529 @opindex mno-inline-float-divide
20530 Do not generate inline code for divides of floating-point values.
20531
20532 @item -minline-int-divide-min-latency
20533 @opindex minline-int-divide-min-latency
20534 Generate code for inline divides of integer values
20535 using the minimum latency algorithm.
20536
20537 @item -minline-int-divide-max-throughput
20538 @opindex minline-int-divide-max-throughput
20539 Generate code for inline divides of integer values
20540 using the maximum throughput algorithm.
20541
20542 @item -mno-inline-int-divide
20543 @opindex mno-inline-int-divide
20544 @opindex minline-int-divide
20545 Do not generate inline code for divides of integer values.
20546
20547 @item -minline-sqrt-min-latency
20548 @opindex minline-sqrt-min-latency
20549 Generate code for inline square roots
20550 using the minimum latency algorithm.
20551
20552 @item -minline-sqrt-max-throughput
20553 @opindex minline-sqrt-max-throughput
20554 Generate code for inline square roots
20555 using the maximum throughput algorithm.
20556
20557 @item -mno-inline-sqrt
20558 @opindex mno-inline-sqrt
20559 Do not generate inline code for @code{sqrt}.
20560
20561 @item -mfused-madd
20562 @itemx -mno-fused-madd
20563 @opindex mfused-madd
20564 @opindex mno-fused-madd
20565 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
20566 instructions. The default is to use these instructions.
20567
20568 @item -mno-dwarf2-asm
20569 @itemx -mdwarf2-asm
20570 @opindex mno-dwarf2-asm
20571 @opindex mdwarf2-asm
20572 Don't (or do) generate assembler code for the DWARF line number debugging
20573 info. This may be useful when not using the GNU assembler.
20574
20575 @item -mearly-stop-bits
20576 @itemx -mno-early-stop-bits
20577 @opindex mearly-stop-bits
20578 @opindex mno-early-stop-bits
20579 Allow stop bits to be placed earlier than immediately preceding the
20580 instruction that triggered the stop bit. This can improve instruction
20581 scheduling, but does not always do so.
20582
20583 @item -mfixed-range=@var{register-range}
20584 @opindex mfixed-range
20585 Generate code treating the given register range as fixed registers.
20586 A fixed register is one that the register allocator cannot use. This is
20587 useful when compiling kernel code. A register range is specified as
20588 two registers separated by a dash. Multiple register ranges can be
20589 specified separated by a comma.
20590
20591 @item -mtls-size=@var{tls-size}
20592 @opindex mtls-size
20593 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
20594 64.
20595
20596 @item -mtune=@var{cpu-type}
20597 @opindex mtune
20598 Tune the instruction scheduling for a particular CPU, Valid values are
20599 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
20600 and @samp{mckinley}.
20601
20602 @item -milp32
20603 @itemx -mlp64
20604 @opindex milp32
20605 @opindex mlp64
20606 Generate code for a 32-bit or 64-bit environment.
20607 The 32-bit environment sets int, long and pointer to 32 bits.
20608 The 64-bit environment sets int to 32 bits and long and pointer
20609 to 64 bits. These are HP-UX specific flags.
20610
20611 @item -mno-sched-br-data-spec
20612 @itemx -msched-br-data-spec
20613 @opindex mno-sched-br-data-spec
20614 @opindex msched-br-data-spec
20615 (Dis/En)able data speculative scheduling before reload.
20616 This results in generation of @code{ld.a} instructions and
20617 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
20618 The default setting is disabled.
20619
20620 @item -msched-ar-data-spec
20621 @itemx -mno-sched-ar-data-spec
20622 @opindex msched-ar-data-spec
20623 @opindex mno-sched-ar-data-spec
20624 (En/Dis)able data speculative scheduling after reload.
20625 This results in generation of @code{ld.a} instructions and
20626 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
20627 The default setting is enabled.
20628
20629 @item -mno-sched-control-spec
20630 @itemx -msched-control-spec
20631 @opindex mno-sched-control-spec
20632 @opindex msched-control-spec
20633 (Dis/En)able control speculative scheduling. This feature is
20634 available only during region scheduling (i.e.@: before reload).
20635 This results in generation of the @code{ld.s} instructions and
20636 the corresponding check instructions @code{chk.s}.
20637 The default setting is disabled.
20638
20639 @item -msched-br-in-data-spec
20640 @itemx -mno-sched-br-in-data-spec
20641 @opindex msched-br-in-data-spec
20642 @opindex mno-sched-br-in-data-spec
20643 (En/Dis)able speculative scheduling of the instructions that
20644 are dependent on the data speculative loads before reload.
20645 This is effective only with @option{-msched-br-data-spec} enabled.
20646 The default setting is enabled.
20647
20648 @item -msched-ar-in-data-spec
20649 @itemx -mno-sched-ar-in-data-spec
20650 @opindex msched-ar-in-data-spec
20651 @opindex mno-sched-ar-in-data-spec
20652 (En/Dis)able speculative scheduling of the instructions that
20653 are dependent on the data speculative loads after reload.
20654 This is effective only with @option{-msched-ar-data-spec} enabled.
20655 The default setting is enabled.
20656
20657 @item -msched-in-control-spec
20658 @itemx -mno-sched-in-control-spec
20659 @opindex msched-in-control-spec
20660 @opindex mno-sched-in-control-spec
20661 (En/Dis)able speculative scheduling of the instructions that
20662 are dependent on the control speculative loads.
20663 This is effective only with @option{-msched-control-spec} enabled.
20664 The default setting is enabled.
20665
20666 @item -mno-sched-prefer-non-data-spec-insns
20667 @itemx -msched-prefer-non-data-spec-insns
20668 @opindex mno-sched-prefer-non-data-spec-insns
20669 @opindex msched-prefer-non-data-spec-insns
20670 If enabled, data-speculative instructions are chosen for schedule
20671 only if there are no other choices at the moment. This makes
20672 the use of the data speculation much more conservative.
20673 The default setting is disabled.
20674
20675 @item -mno-sched-prefer-non-control-spec-insns
20676 @itemx -msched-prefer-non-control-spec-insns
20677 @opindex mno-sched-prefer-non-control-spec-insns
20678 @opindex msched-prefer-non-control-spec-insns
20679 If enabled, control-speculative instructions are chosen for schedule
20680 only if there are no other choices at the moment. This makes
20681 the use of the control speculation much more conservative.
20682 The default setting is disabled.
20683
20684 @item -mno-sched-count-spec-in-critical-path
20685 @itemx -msched-count-spec-in-critical-path
20686 @opindex mno-sched-count-spec-in-critical-path
20687 @opindex msched-count-spec-in-critical-path
20688 If enabled, speculative dependencies are considered during
20689 computation of the instructions priorities. This makes the use of the
20690 speculation a bit more conservative.
20691 The default setting is disabled.
20692
20693 @item -msched-spec-ldc
20694 @opindex msched-spec-ldc
20695 Use a simple data speculation check. This option is on by default.
20696
20697 @item -msched-control-spec-ldc
20698 @opindex msched-spec-ldc
20699 Use a simple check for control speculation. This option is on by default.
20700
20701 @item -msched-stop-bits-after-every-cycle
20702 @opindex msched-stop-bits-after-every-cycle
20703 Place a stop bit after every cycle when scheduling. This option is on
20704 by default.
20705
20706 @item -msched-fp-mem-deps-zero-cost
20707 @opindex msched-fp-mem-deps-zero-cost
20708 Assume that floating-point stores and loads are not likely to cause a conflict
20709 when placed into the same instruction group. This option is disabled by
20710 default.
20711
20712 @item -msel-sched-dont-check-control-spec
20713 @opindex msel-sched-dont-check-control-spec
20714 Generate checks for control speculation in selective scheduling.
20715 This flag is disabled by default.
20716
20717 @item -msched-max-memory-insns=@var{max-insns}
20718 @opindex msched-max-memory-insns
20719 Limit on the number of memory insns per instruction group, giving lower
20720 priority to subsequent memory insns attempting to schedule in the same
20721 instruction group. Frequently useful to prevent cache bank conflicts.
20722 The default value is 1.
20723
20724 @item -msched-max-memory-insns-hard-limit
20725 @opindex msched-max-memory-insns-hard-limit
20726 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
20727 disallowing more than that number in an instruction group.
20728 Otherwise, the limit is ``soft'', meaning that non-memory operations
20729 are preferred when the limit is reached, but memory operations may still
20730 be scheduled.
20731
20732 @end table
20733
20734 @node LM32 Options
20735 @subsection LM32 Options
20736 @cindex LM32 options
20737
20738 These @option{-m} options are defined for the LatticeMico32 architecture:
20739
20740 @table @gcctabopt
20741 @item -mbarrel-shift-enabled
20742 @opindex mbarrel-shift-enabled
20743 Enable barrel-shift instructions.
20744
20745 @item -mdivide-enabled
20746 @opindex mdivide-enabled
20747 Enable divide and modulus instructions.
20748
20749 @item -mmultiply-enabled
20750 @opindex multiply-enabled
20751 Enable multiply instructions.
20752
20753 @item -msign-extend-enabled
20754 @opindex msign-extend-enabled
20755 Enable sign extend instructions.
20756
20757 @item -muser-enabled
20758 @opindex muser-enabled
20759 Enable user-defined instructions.
20760
20761 @end table
20762
20763 @node M32C Options
20764 @subsection M32C Options
20765 @cindex M32C options
20766
20767 @table @gcctabopt
20768 @item -mcpu=@var{name}
20769 @opindex mcpu=
20770 Select the CPU for which code is generated. @var{name} may be one of
20771 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
20772 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
20773 the M32C/80 series.
20774
20775 @item -msim
20776 @opindex msim
20777 Specifies that the program will be run on the simulator. This causes
20778 an alternate runtime library to be linked in which supports, for
20779 example, file I/O@. You must not use this option when generating
20780 programs that will run on real hardware; you must provide your own
20781 runtime library for whatever I/O functions are needed.
20782
20783 @item -memregs=@var{number}
20784 @opindex memregs=
20785 Specifies the number of memory-based pseudo-registers GCC uses
20786 during code generation. These pseudo-registers are used like real
20787 registers, so there is a tradeoff between GCC's ability to fit the
20788 code into available registers, and the performance penalty of using
20789 memory instead of registers. Note that all modules in a program must
20790 be compiled with the same value for this option. Because of that, you
20791 must not use this option with GCC's default runtime libraries.
20792
20793 @end table
20794
20795 @node M32R/D Options
20796 @subsection M32R/D Options
20797 @cindex M32R/D options
20798
20799 These @option{-m} options are defined for Renesas M32R/D architectures:
20800
20801 @table @gcctabopt
20802 @item -m32r2
20803 @opindex m32r2
20804 Generate code for the M32R/2@.
20805
20806 @item -m32rx
20807 @opindex m32rx
20808 Generate code for the M32R/X@.
20809
20810 @item -m32r
20811 @opindex m32r
20812 Generate code for the M32R@. This is the default.
20813
20814 @item -mmodel=small
20815 @opindex mmodel=small
20816 Assume all objects live in the lower 16MB of memory (so that their addresses
20817 can be loaded with the @code{ld24} instruction), and assume all subroutines
20818 are reachable with the @code{bl} instruction.
20819 This is the default.
20820
20821 The addressability of a particular object can be set with the
20822 @code{model} attribute.
20823
20824 @item -mmodel=medium
20825 @opindex mmodel=medium
20826 Assume objects may be anywhere in the 32-bit address space (the compiler
20827 generates @code{seth/add3} instructions to load their addresses), and
20828 assume all subroutines are reachable with the @code{bl} instruction.
20829
20830 @item -mmodel=large
20831 @opindex mmodel=large
20832 Assume objects may be anywhere in the 32-bit address space (the compiler
20833 generates @code{seth/add3} instructions to load their addresses), and
20834 assume subroutines may not be reachable with the @code{bl} instruction
20835 (the compiler generates the much slower @code{seth/add3/jl}
20836 instruction sequence).
20837
20838 @item -msdata=none
20839 @opindex msdata=none
20840 Disable use of the small data area. Variables are put into
20841 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
20842 @code{section} attribute has been specified).
20843 This is the default.
20844
20845 The small data area consists of sections @code{.sdata} and @code{.sbss}.
20846 Objects may be explicitly put in the small data area with the
20847 @code{section} attribute using one of these sections.
20848
20849 @item -msdata=sdata
20850 @opindex msdata=sdata
20851 Put small global and static data in the small data area, but do not
20852 generate special code to reference them.
20853
20854 @item -msdata=use
20855 @opindex msdata=use
20856 Put small global and static data in the small data area, and generate
20857 special instructions to reference them.
20858
20859 @item -G @var{num}
20860 @opindex G
20861 @cindex smaller data references
20862 Put global and static objects less than or equal to @var{num} bytes
20863 into the small data or BSS sections instead of the normal data or BSS
20864 sections. The default value of @var{num} is 8.
20865 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
20866 for this option to have any effect.
20867
20868 All modules should be compiled with the same @option{-G @var{num}} value.
20869 Compiling with different values of @var{num} may or may not work; if it
20870 doesn't the linker gives an error message---incorrect code is not
20871 generated.
20872
20873 @item -mdebug
20874 @opindex mdebug
20875 Makes the M32R-specific code in the compiler display some statistics
20876 that might help in debugging programs.
20877
20878 @item -malign-loops
20879 @opindex malign-loops
20880 Align all loops to a 32-byte boundary.
20881
20882 @item -mno-align-loops
20883 @opindex mno-align-loops
20884 Do not enforce a 32-byte alignment for loops. This is the default.
20885
20886 @item -missue-rate=@var{number}
20887 @opindex missue-rate=@var{number}
20888 Issue @var{number} instructions per cycle. @var{number} can only be 1
20889 or 2.
20890
20891 @item -mbranch-cost=@var{number}
20892 @opindex mbranch-cost=@var{number}
20893 @var{number} can only be 1 or 2. If it is 1 then branches are
20894 preferred over conditional code, if it is 2, then the opposite applies.
20895
20896 @item -mflush-trap=@var{number}
20897 @opindex mflush-trap=@var{number}
20898 Specifies the trap number to use to flush the cache. The default is
20899 12. Valid numbers are between 0 and 15 inclusive.
20900
20901 @item -mno-flush-trap
20902 @opindex mno-flush-trap
20903 Specifies that the cache cannot be flushed by using a trap.
20904
20905 @item -mflush-func=@var{name}
20906 @opindex mflush-func=@var{name}
20907 Specifies the name of the operating system function to call to flush
20908 the cache. The default is @samp{_flush_cache}, but a function call
20909 is only used if a trap is not available.
20910
20911 @item -mno-flush-func
20912 @opindex mno-flush-func
20913 Indicates that there is no OS function for flushing the cache.
20914
20915 @end table
20916
20917 @node M680x0 Options
20918 @subsection M680x0 Options
20919 @cindex M680x0 options
20920
20921 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
20922 The default settings depend on which architecture was selected when
20923 the compiler was configured; the defaults for the most common choices
20924 are given below.
20925
20926 @table @gcctabopt
20927 @item -march=@var{arch}
20928 @opindex march
20929 Generate code for a specific M680x0 or ColdFire instruction set
20930 architecture. Permissible values of @var{arch} for M680x0
20931 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
20932 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire
20933 architectures are selected according to Freescale's ISA classification
20934 and the permissible values are: @samp{isaa}, @samp{isaaplus},
20935 @samp{isab} and @samp{isac}.
20936
20937 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
20938 code for a ColdFire target. The @var{arch} in this macro is one of the
20939 @option{-march} arguments given above.
20940
20941 When used together, @option{-march} and @option{-mtune} select code
20942 that runs on a family of similar processors but that is optimized
20943 for a particular microarchitecture.
20944
20945 @item -mcpu=@var{cpu}
20946 @opindex mcpu
20947 Generate code for a specific M680x0 or ColdFire processor.
20948 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
20949 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
20950 and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table
20951 below, which also classifies the CPUs into families:
20952
20953 @multitable @columnfractions 0.20 0.80
20954 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
20955 @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}
20956 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
20957 @item @samp{5206e} @tab @samp{5206e}
20958 @item @samp{5208} @tab @samp{5207} @samp{5208}
20959 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
20960 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
20961 @item @samp{5216} @tab @samp{5214} @samp{5216}
20962 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
20963 @item @samp{5225} @tab @samp{5224} @samp{5225}
20964 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
20965 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
20966 @item @samp{5249} @tab @samp{5249}
20967 @item @samp{5250} @tab @samp{5250}
20968 @item @samp{5271} @tab @samp{5270} @samp{5271}
20969 @item @samp{5272} @tab @samp{5272}
20970 @item @samp{5275} @tab @samp{5274} @samp{5275}
20971 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
20972 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
20973 @item @samp{5307} @tab @samp{5307}
20974 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
20975 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
20976 @item @samp{5407} @tab @samp{5407}
20977 @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}
20978 @end multitable
20979
20980 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
20981 @var{arch} is compatible with @var{cpu}. Other combinations of
20982 @option{-mcpu} and @option{-march} are rejected.
20983
20984 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
20985 @var{cpu} is selected. It also defines @code{__mcf_family_@var{family}},
20986 where the value of @var{family} is given by the table above.
20987
20988 @item -mtune=@var{tune}
20989 @opindex mtune
20990 Tune the code for a particular microarchitecture within the
20991 constraints set by @option{-march} and @option{-mcpu}.
20992 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
20993 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
20994 and @samp{cpu32}. The ColdFire microarchitectures
20995 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
20996
20997 You can also use @option{-mtune=68020-40} for code that needs
20998 to run relatively well on 68020, 68030 and 68040 targets.
20999 @option{-mtune=68020-60} is similar but includes 68060 targets
21000 as well. These two options select the same tuning decisions as
21001 @option{-m68020-40} and @option{-m68020-60} respectively.
21002
21003 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
21004 when tuning for 680x0 architecture @var{arch}. It also defines
21005 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
21006 option is used. If GCC is tuning for a range of architectures,
21007 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
21008 it defines the macros for every architecture in the range.
21009
21010 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
21011 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
21012 of the arguments given above.
21013
21014 @item -m68000
21015 @itemx -mc68000
21016 @opindex m68000
21017 @opindex mc68000
21018 Generate output for a 68000. This is the default
21019 when the compiler is configured for 68000-based systems.
21020 It is equivalent to @option{-march=68000}.
21021
21022 Use this option for microcontrollers with a 68000 or EC000 core,
21023 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
21024
21025 @item -m68010
21026 @opindex m68010
21027 Generate output for a 68010. This is the default
21028 when the compiler is configured for 68010-based systems.
21029 It is equivalent to @option{-march=68010}.
21030
21031 @item -m68020
21032 @itemx -mc68020
21033 @opindex m68020
21034 @opindex mc68020
21035 Generate output for a 68020. This is the default
21036 when the compiler is configured for 68020-based systems.
21037 It is equivalent to @option{-march=68020}.
21038
21039 @item -m68030
21040 @opindex m68030
21041 Generate output for a 68030. This is the default when the compiler is
21042 configured for 68030-based systems. It is equivalent to
21043 @option{-march=68030}.
21044
21045 @item -m68040
21046 @opindex m68040
21047 Generate output for a 68040. This is the default when the compiler is
21048 configured for 68040-based systems. It is equivalent to
21049 @option{-march=68040}.
21050
21051 This option inhibits the use of 68881/68882 instructions that have to be
21052 emulated by software on the 68040. Use this option if your 68040 does not
21053 have code to emulate those instructions.
21054
21055 @item -m68060
21056 @opindex m68060
21057 Generate output for a 68060. This is the default when the compiler is
21058 configured for 68060-based systems. It is equivalent to
21059 @option{-march=68060}.
21060
21061 This option inhibits the use of 68020 and 68881/68882 instructions that
21062 have to be emulated by software on the 68060. Use this option if your 68060
21063 does not have code to emulate those instructions.
21064
21065 @item -mcpu32
21066 @opindex mcpu32
21067 Generate output for a CPU32. This is the default
21068 when the compiler is configured for CPU32-based systems.
21069 It is equivalent to @option{-march=cpu32}.
21070
21071 Use this option for microcontrollers with a
21072 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
21073 68336, 68340, 68341, 68349 and 68360.
21074
21075 @item -m5200
21076 @opindex m5200
21077 Generate output for a 520X ColdFire CPU@. This is the default
21078 when the compiler is configured for 520X-based systems.
21079 It is equivalent to @option{-mcpu=5206}, and is now deprecated
21080 in favor of that option.
21081
21082 Use this option for microcontroller with a 5200 core, including
21083 the MCF5202, MCF5203, MCF5204 and MCF5206.
21084
21085 @item -m5206e
21086 @opindex m5206e
21087 Generate output for a 5206e ColdFire CPU@. The option is now
21088 deprecated in favor of the equivalent @option{-mcpu=5206e}.
21089
21090 @item -m528x
21091 @opindex m528x
21092 Generate output for a member of the ColdFire 528X family.
21093 The option is now deprecated in favor of the equivalent
21094 @option{-mcpu=528x}.
21095
21096 @item -m5307
21097 @opindex m5307
21098 Generate output for a ColdFire 5307 CPU@. The option is now deprecated
21099 in favor of the equivalent @option{-mcpu=5307}.
21100
21101 @item -m5407
21102 @opindex m5407
21103 Generate output for a ColdFire 5407 CPU@. The option is now deprecated
21104 in favor of the equivalent @option{-mcpu=5407}.
21105
21106 @item -mcfv4e
21107 @opindex mcfv4e
21108 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
21109 This includes use of hardware floating-point instructions.
21110 The option is equivalent to @option{-mcpu=547x}, and is now
21111 deprecated in favor of that option.
21112
21113 @item -m68020-40
21114 @opindex m68020-40
21115 Generate output for a 68040, without using any of the new instructions.
21116 This results in code that can run relatively efficiently on either a
21117 68020/68881 or a 68030 or a 68040. The generated code does use the
21118 68881 instructions that are emulated on the 68040.
21119
21120 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
21121
21122 @item -m68020-60
21123 @opindex m68020-60
21124 Generate output for a 68060, without using any of the new instructions.
21125 This results in code that can run relatively efficiently on either a
21126 68020/68881 or a 68030 or a 68040. The generated code does use the
21127 68881 instructions that are emulated on the 68060.
21128
21129 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
21130
21131 @item -mhard-float
21132 @itemx -m68881
21133 @opindex mhard-float
21134 @opindex m68881
21135 Generate floating-point instructions. This is the default for 68020
21136 and above, and for ColdFire devices that have an FPU@. It defines the
21137 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
21138 on ColdFire targets.
21139
21140 @item -msoft-float
21141 @opindex msoft-float
21142 Do not generate floating-point instructions; use library calls instead.
21143 This is the default for 68000, 68010, and 68832 targets. It is also
21144 the default for ColdFire devices that have no FPU.
21145
21146 @item -mdiv
21147 @itemx -mno-div
21148 @opindex mdiv
21149 @opindex mno-div
21150 Generate (do not generate) ColdFire hardware divide and remainder
21151 instructions. If @option{-march} is used without @option{-mcpu},
21152 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
21153 architectures. Otherwise, the default is taken from the target CPU
21154 (either the default CPU, or the one specified by @option{-mcpu}). For
21155 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
21156 @option{-mcpu=5206e}.
21157
21158 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
21159
21160 @item -mshort
21161 @opindex mshort
21162 Consider type @code{int} to be 16 bits wide, like @code{short int}.
21163 Additionally, parameters passed on the stack are also aligned to a
21164 16-bit boundary even on targets whose API mandates promotion to 32-bit.
21165
21166 @item -mno-short
21167 @opindex mno-short
21168 Do not consider type @code{int} to be 16 bits wide. This is the default.
21169
21170 @item -mnobitfield
21171 @itemx -mno-bitfield
21172 @opindex mnobitfield
21173 @opindex mno-bitfield
21174 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
21175 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
21176
21177 @item -mbitfield
21178 @opindex mbitfield
21179 Do use the bit-field instructions. The @option{-m68020} option implies
21180 @option{-mbitfield}. This is the default if you use a configuration
21181 designed for a 68020.
21182
21183 @item -mrtd
21184 @opindex mrtd
21185 Use a different function-calling convention, in which functions
21186 that take a fixed number of arguments return with the @code{rtd}
21187 instruction, which pops their arguments while returning. This
21188 saves one instruction in the caller since there is no need to pop
21189 the arguments there.
21190
21191 This calling convention is incompatible with the one normally
21192 used on Unix, so you cannot use it if you need to call libraries
21193 compiled with the Unix compiler.
21194
21195 Also, you must provide function prototypes for all functions that
21196 take variable numbers of arguments (including @code{printf});
21197 otherwise incorrect code is generated for calls to those
21198 functions.
21199
21200 In addition, seriously incorrect code results if you call a
21201 function with too many arguments. (Normally, extra arguments are
21202 harmlessly ignored.)
21203
21204 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
21205 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
21206
21207 The default is @option{-mno-rtd}.
21208
21209 @item -malign-int
21210 @itemx -mno-align-int
21211 @opindex malign-int
21212 @opindex mno-align-int
21213 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
21214 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
21215 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
21216 Aligning variables on 32-bit boundaries produces code that runs somewhat
21217 faster on processors with 32-bit busses at the expense of more memory.
21218
21219 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
21220 aligns structures containing the above types differently than
21221 most published application binary interface specifications for the m68k.
21222
21223 @item -mpcrel
21224 @opindex mpcrel
21225 Use the pc-relative addressing mode of the 68000 directly, instead of
21226 using a global offset table. At present, this option implies @option{-fpic},
21227 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
21228 not presently supported with @option{-mpcrel}, though this could be supported for
21229 68020 and higher processors.
21230
21231 @item -mno-strict-align
21232 @itemx -mstrict-align
21233 @opindex mno-strict-align
21234 @opindex mstrict-align
21235 Do not (do) assume that unaligned memory references are handled by
21236 the system.
21237
21238 @item -msep-data
21239 Generate code that allows the data segment to be located in a different
21240 area of memory from the text segment. This allows for execute-in-place in
21241 an environment without virtual memory management. This option implies
21242 @option{-fPIC}.
21243
21244 @item -mno-sep-data
21245 Generate code that assumes that the data segment follows the text segment.
21246 This is the default.
21247
21248 @item -mid-shared-library
21249 Generate code that supports shared libraries via the library ID method.
21250 This allows for execute-in-place and shared libraries in an environment
21251 without virtual memory management. This option implies @option{-fPIC}.
21252
21253 @item -mno-id-shared-library
21254 Generate code that doesn't assume ID-based shared libraries are being used.
21255 This is the default.
21256
21257 @item -mshared-library-id=n
21258 Specifies the identification number of the ID-based shared library being
21259 compiled. Specifying a value of 0 generates more compact code; specifying
21260 other values forces the allocation of that number to the current
21261 library, but is no more space- or time-efficient than omitting this option.
21262
21263 @item -mxgot
21264 @itemx -mno-xgot
21265 @opindex mxgot
21266 @opindex mno-xgot
21267 When generating position-independent code for ColdFire, generate code
21268 that works if the GOT has more than 8192 entries. This code is
21269 larger and slower than code generated without this option. On M680x0
21270 processors, this option is not needed; @option{-fPIC} suffices.
21271
21272 GCC normally uses a single instruction to load values from the GOT@.
21273 While this is relatively efficient, it only works if the GOT
21274 is smaller than about 64k. Anything larger causes the linker
21275 to report an error such as:
21276
21277 @cindex relocation truncated to fit (ColdFire)
21278 @smallexample
21279 relocation truncated to fit: R_68K_GOT16O foobar
21280 @end smallexample
21281
21282 If this happens, you should recompile your code with @option{-mxgot}.
21283 It should then work with very large GOTs. However, code generated with
21284 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
21285 the value of a global symbol.
21286
21287 Note that some linkers, including newer versions of the GNU linker,
21288 can create multiple GOTs and sort GOT entries. If you have such a linker,
21289 you should only need to use @option{-mxgot} when compiling a single
21290 object file that accesses more than 8192 GOT entries. Very few do.
21291
21292 These options have no effect unless GCC is generating
21293 position-independent code.
21294
21295 @item -mlong-jump-table-offsets
21296 @opindex mlong-jump-table-offsets
21297 Use 32-bit offsets in @code{switch} tables. The default is to use
21298 16-bit offsets.
21299
21300 @end table
21301
21302 @node MCore Options
21303 @subsection MCore Options
21304 @cindex MCore options
21305
21306 These are the @samp{-m} options defined for the Motorola M*Core
21307 processors.
21308
21309 @table @gcctabopt
21310
21311 @item -mhardlit
21312 @itemx -mno-hardlit
21313 @opindex mhardlit
21314 @opindex mno-hardlit
21315 Inline constants into the code stream if it can be done in two
21316 instructions or less.
21317
21318 @item -mdiv
21319 @itemx -mno-div
21320 @opindex mdiv
21321 @opindex mno-div
21322 Use the divide instruction. (Enabled by default).
21323
21324 @item -mrelax-immediate
21325 @itemx -mno-relax-immediate
21326 @opindex mrelax-immediate
21327 @opindex mno-relax-immediate
21328 Allow arbitrary-sized immediates in bit operations.
21329
21330 @item -mwide-bitfields
21331 @itemx -mno-wide-bitfields
21332 @opindex mwide-bitfields
21333 @opindex mno-wide-bitfields
21334 Always treat bit-fields as @code{int}-sized.
21335
21336 @item -m4byte-functions
21337 @itemx -mno-4byte-functions
21338 @opindex m4byte-functions
21339 @opindex mno-4byte-functions
21340 Force all functions to be aligned to a 4-byte boundary.
21341
21342 @item -mcallgraph-data
21343 @itemx -mno-callgraph-data
21344 @opindex mcallgraph-data
21345 @opindex mno-callgraph-data
21346 Emit callgraph information.
21347
21348 @item -mslow-bytes
21349 @itemx -mno-slow-bytes
21350 @opindex mslow-bytes
21351 @opindex mno-slow-bytes
21352 Prefer word access when reading byte quantities.
21353
21354 @item -mlittle-endian
21355 @itemx -mbig-endian
21356 @opindex mlittle-endian
21357 @opindex mbig-endian
21358 Generate code for a little-endian target.
21359
21360 @item -m210
21361 @itemx -m340
21362 @opindex m210
21363 @opindex m340
21364 Generate code for the 210 processor.
21365
21366 @item -mno-lsim
21367 @opindex mno-lsim
21368 Assume that runtime support has been provided and so omit the
21369 simulator library (@file{libsim.a)} from the linker command line.
21370
21371 @item -mstack-increment=@var{size}
21372 @opindex mstack-increment
21373 Set the maximum amount for a single stack increment operation. Large
21374 values can increase the speed of programs that contain functions
21375 that need a large amount of stack space, but they can also trigger a
21376 segmentation fault if the stack is extended too much. The default
21377 value is 0x1000.
21378
21379 @end table
21380
21381 @node MeP Options
21382 @subsection MeP Options
21383 @cindex MeP options
21384
21385 @table @gcctabopt
21386
21387 @item -mabsdiff
21388 @opindex mabsdiff
21389 Enables the @code{abs} instruction, which is the absolute difference
21390 between two registers.
21391
21392 @item -mall-opts
21393 @opindex mall-opts
21394 Enables all the optional instructions---average, multiply, divide, bit
21395 operations, leading zero, absolute difference, min/max, clip, and
21396 saturation.
21397
21398
21399 @item -maverage
21400 @opindex maverage
21401 Enables the @code{ave} instruction, which computes the average of two
21402 registers.
21403
21404 @item -mbased=@var{n}
21405 @opindex mbased=
21406 Variables of size @var{n} bytes or smaller are placed in the
21407 @code{.based} section by default. Based variables use the @code{$tp}
21408 register as a base register, and there is a 128-byte limit to the
21409 @code{.based} section.
21410
21411 @item -mbitops
21412 @opindex mbitops
21413 Enables the bit operation instructions---bit test (@code{btstm}), set
21414 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
21415 test-and-set (@code{tas}).
21416
21417 @item -mc=@var{name}
21418 @opindex mc=
21419 Selects which section constant data is placed in. @var{name} may
21420 be @samp{tiny}, @samp{near}, or @samp{far}.
21421
21422 @item -mclip
21423 @opindex mclip
21424 Enables the @code{clip} instruction. Note that @option{-mclip} is not
21425 useful unless you also provide @option{-mminmax}.
21426
21427 @item -mconfig=@var{name}
21428 @opindex mconfig=
21429 Selects one of the built-in core configurations. Each MeP chip has
21430 one or more modules in it; each module has a core CPU and a variety of
21431 coprocessors, optional instructions, and peripherals. The
21432 @code{MeP-Integrator} tool, not part of GCC, provides these
21433 configurations through this option; using this option is the same as
21434 using all the corresponding command-line options. The default
21435 configuration is @samp{default}.
21436
21437 @item -mcop
21438 @opindex mcop
21439 Enables the coprocessor instructions. By default, this is a 32-bit
21440 coprocessor. Note that the coprocessor is normally enabled via the
21441 @option{-mconfig=} option.
21442
21443 @item -mcop32
21444 @opindex mcop32
21445 Enables the 32-bit coprocessor's instructions.
21446
21447 @item -mcop64
21448 @opindex mcop64
21449 Enables the 64-bit coprocessor's instructions.
21450
21451 @item -mivc2
21452 @opindex mivc2
21453 Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor.
21454
21455 @item -mdc
21456 @opindex mdc
21457 Causes constant variables to be placed in the @code{.near} section.
21458
21459 @item -mdiv
21460 @opindex mdiv
21461 Enables the @code{div} and @code{divu} instructions.
21462
21463 @item -meb
21464 @opindex meb
21465 Generate big-endian code.
21466
21467 @item -mel
21468 @opindex mel
21469 Generate little-endian code.
21470
21471 @item -mio-volatile
21472 @opindex mio-volatile
21473 Tells the compiler that any variable marked with the @code{io}
21474 attribute is to be considered volatile.
21475
21476 @item -ml
21477 @opindex ml
21478 Causes variables to be assigned to the @code{.far} section by default.
21479
21480 @item -mleadz
21481 @opindex mleadz
21482 Enables the @code{leadz} (leading zero) instruction.
21483
21484 @item -mm
21485 @opindex mm
21486 Causes variables to be assigned to the @code{.near} section by default.
21487
21488 @item -mminmax
21489 @opindex mminmax
21490 Enables the @code{min} and @code{max} instructions.
21491
21492 @item -mmult
21493 @opindex mmult
21494 Enables the multiplication and multiply-accumulate instructions.
21495
21496 @item -mno-opts
21497 @opindex mno-opts
21498 Disables all the optional instructions enabled by @option{-mall-opts}.
21499
21500 @item -mrepeat
21501 @opindex mrepeat
21502 Enables the @code{repeat} and @code{erepeat} instructions, used for
21503 low-overhead looping.
21504
21505 @item -ms
21506 @opindex ms
21507 Causes all variables to default to the @code{.tiny} section. Note
21508 that there is a 65536-byte limit to this section. Accesses to these
21509 variables use the @code{%gp} base register.
21510
21511 @item -msatur
21512 @opindex msatur
21513 Enables the saturation instructions. Note that the compiler does not
21514 currently generate these itself, but this option is included for
21515 compatibility with other tools, like @code{as}.
21516
21517 @item -msdram
21518 @opindex msdram
21519 Link the SDRAM-based runtime instead of the default ROM-based runtime.
21520
21521 @item -msim
21522 @opindex msim
21523 Link the simulator run-time libraries.
21524
21525 @item -msimnovec
21526 @opindex msimnovec
21527 Link the simulator runtime libraries, excluding built-in support
21528 for reset and exception vectors and tables.
21529
21530 @item -mtf
21531 @opindex mtf
21532 Causes all functions to default to the @code{.far} section. Without
21533 this option, functions default to the @code{.near} section.
21534
21535 @item -mtiny=@var{n}
21536 @opindex mtiny=
21537 Variables that are @var{n} bytes or smaller are allocated to the
21538 @code{.tiny} section. These variables use the @code{$gp} base
21539 register. The default for this option is 4, but note that there's a
21540 65536-byte limit to the @code{.tiny} section.
21541
21542 @end table
21543
21544 @node MicroBlaze Options
21545 @subsection MicroBlaze Options
21546 @cindex MicroBlaze Options
21547
21548 @table @gcctabopt
21549
21550 @item -msoft-float
21551 @opindex msoft-float
21552 Use software emulation for floating point (default).
21553
21554 @item -mhard-float
21555 @opindex mhard-float
21556 Use hardware floating-point instructions.
21557
21558 @item -mmemcpy
21559 @opindex mmemcpy
21560 Do not optimize block moves, use @code{memcpy}.
21561
21562 @item -mno-clearbss
21563 @opindex mno-clearbss
21564 This option is deprecated. Use @option{-fno-zero-initialized-in-bss} instead.
21565
21566 @item -mcpu=@var{cpu-type}
21567 @opindex mcpu=
21568 Use features of, and schedule code for, the given CPU.
21569 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
21570 where @var{X} is a major version, @var{YY} is the minor version, and
21571 @var{Z} is compatibility code. Example values are @samp{v3.00.a},
21572 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v6.00.a}.
21573
21574 @item -mxl-soft-mul
21575 @opindex mxl-soft-mul
21576 Use software multiply emulation (default).
21577
21578 @item -mxl-soft-div
21579 @opindex mxl-soft-div
21580 Use software emulation for divides (default).
21581
21582 @item -mxl-barrel-shift
21583 @opindex mxl-barrel-shift
21584 Use the hardware barrel shifter.
21585
21586 @item -mxl-pattern-compare
21587 @opindex mxl-pattern-compare
21588 Use pattern compare instructions.
21589
21590 @item -msmall-divides
21591 @opindex msmall-divides
21592 Use table lookup optimization for small signed integer divisions.
21593
21594 @item -mxl-stack-check
21595 @opindex mxl-stack-check
21596 This option is deprecated. Use @option{-fstack-check} instead.
21597
21598 @item -mxl-gp-opt
21599 @opindex mxl-gp-opt
21600 Use GP-relative @code{.sdata}/@code{.sbss} sections.
21601
21602 @item -mxl-multiply-high
21603 @opindex mxl-multiply-high
21604 Use multiply high instructions for high part of 32x32 multiply.
21605
21606 @item -mxl-float-convert
21607 @opindex mxl-float-convert
21608 Use hardware floating-point conversion instructions.
21609
21610 @item -mxl-float-sqrt
21611 @opindex mxl-float-sqrt
21612 Use hardware floating-point square root instruction.
21613
21614 @item -mbig-endian
21615 @opindex mbig-endian
21616 Generate code for a big-endian target.
21617
21618 @item -mlittle-endian
21619 @opindex mlittle-endian
21620 Generate code for a little-endian target.
21621
21622 @item -mxl-reorder
21623 @opindex mxl-reorder
21624 Use reorder instructions (swap and byte reversed load/store).
21625
21626 @item -mxl-mode-@var{app-model}
21627 Select application model @var{app-model}. Valid models are
21628 @table @samp
21629 @item executable
21630 normal executable (default), uses startup code @file{crt0.o}.
21631
21632 @item -mpic-data-is-text-relative
21633 @opindex mpic-data-is-text-relative
21634 Assume that the displacement between the text and data segments is fixed
21635 at static link time. This allows data to be referenced by offset from start of
21636 text address instead of GOT since PC-relative addressing is not supported.
21637
21638 @item xmdstub
21639 for use with Xilinx Microprocessor Debugger (XMD) based
21640 software intrusive debug agent called xmdstub. This uses startup file
21641 @file{crt1.o} and sets the start address of the program to 0x800.
21642
21643 @item bootstrap
21644 for applications that are loaded using a bootloader.
21645 This model uses startup file @file{crt2.o} which does not contain a processor
21646 reset vector handler. This is suitable for transferring control on a
21647 processor reset to the bootloader rather than the application.
21648
21649 @item novectors
21650 for applications that do not require any of the
21651 MicroBlaze vectors. This option may be useful for applications running
21652 within a monitoring application. This model uses @file{crt3.o} as a startup file.
21653 @end table
21654
21655 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
21656 @option{-mxl-mode-@var{app-model}}.
21657
21658 @end table
21659
21660 @node MIPS Options
21661 @subsection MIPS Options
21662 @cindex MIPS options
21663
21664 @table @gcctabopt
21665
21666 @item -EB
21667 @opindex EB
21668 Generate big-endian code.
21669
21670 @item -EL
21671 @opindex EL
21672 Generate little-endian code. This is the default for @samp{mips*el-*-*}
21673 configurations.
21674
21675 @item -march=@var{arch}
21676 @opindex march
21677 Generate code that runs on @var{arch}, which can be the name of a
21678 generic MIPS ISA, or the name of a particular processor.
21679 The ISA names are:
21680 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
21681 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
21682 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
21683 @samp{mips64r5} and @samp{mips64r6}.
21684 The processor names are:
21685 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
21686 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
21687 @samp{5kc}, @samp{5kf},
21688 @samp{20kc},
21689 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
21690 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
21691 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
21692 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
21693 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
21694 @samp{i6400}, @samp{i6500},
21695 @samp{interaptiv},
21696 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a}, @samp{gs464},
21697 @samp{gs464e}, @samp{gs264e},
21698 @samp{m4k},
21699 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
21700 @samp{m5100}, @samp{m5101},
21701 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
21702 @samp{orion},
21703 @samp{p5600}, @samp{p6600},
21704 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
21705 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r5900},
21706 @samp{r6000}, @samp{r8000},
21707 @samp{rm7000}, @samp{rm9000},
21708 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
21709 @samp{sb1},
21710 @samp{sr71000},
21711 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
21712 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
21713 @samp{xlr} and @samp{xlp}.
21714 The special value @samp{from-abi} selects the
21715 most compatible architecture for the selected ABI (that is,
21716 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
21717
21718 The native Linux/GNU toolchain also supports the value @samp{native},
21719 which selects the best architecture option for the host processor.
21720 @option{-march=native} has no effect if GCC does not recognize
21721 the processor.
21722
21723 In processor names, a final @samp{000} can be abbreviated as @samp{k}
21724 (for example, @option{-march=r2k}). Prefixes are optional, and
21725 @samp{vr} may be written @samp{r}.
21726
21727 Names of the form @samp{@var{n}f2_1} refer to processors with
21728 FPUs clocked at half the rate of the core, names of the form
21729 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
21730 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
21731 processors with FPUs clocked a ratio of 3:2 with respect to the core.
21732 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
21733 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
21734 accepted as synonyms for @samp{@var{n}f1_1}.
21735
21736 GCC defines two macros based on the value of this option. The first
21737 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
21738 a string. The second has the form @code{_MIPS_ARCH_@var{foo}},
21739 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
21740 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
21741 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
21742
21743 Note that the @code{_MIPS_ARCH} macro uses the processor names given
21744 above. In other words, it has the full prefix and does not
21745 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
21746 the macro names the resolved architecture (either @code{"mips1"} or
21747 @code{"mips3"}). It names the default architecture when no
21748 @option{-march} option is given.
21749
21750 @item -mtune=@var{arch}
21751 @opindex mtune
21752 Optimize for @var{arch}. Among other things, this option controls
21753 the way instructions are scheduled, and the perceived cost of arithmetic
21754 operations. The list of @var{arch} values is the same as for
21755 @option{-march}.
21756
21757 When this option is not used, GCC optimizes for the processor
21758 specified by @option{-march}. By using @option{-march} and
21759 @option{-mtune} together, it is possible to generate code that
21760 runs on a family of processors, but optimize the code for one
21761 particular member of that family.
21762
21763 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
21764 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
21765 @option{-march} ones described above.
21766
21767 @item -mips1
21768 @opindex mips1
21769 Equivalent to @option{-march=mips1}.
21770
21771 @item -mips2
21772 @opindex mips2
21773 Equivalent to @option{-march=mips2}.
21774
21775 @item -mips3
21776 @opindex mips3
21777 Equivalent to @option{-march=mips3}.
21778
21779 @item -mips4
21780 @opindex mips4
21781 Equivalent to @option{-march=mips4}.
21782
21783 @item -mips32
21784 @opindex mips32
21785 Equivalent to @option{-march=mips32}.
21786
21787 @item -mips32r3
21788 @opindex mips32r3
21789 Equivalent to @option{-march=mips32r3}.
21790
21791 @item -mips32r5
21792 @opindex mips32r5
21793 Equivalent to @option{-march=mips32r5}.
21794
21795 @item -mips32r6
21796 @opindex mips32r6
21797 Equivalent to @option{-march=mips32r6}.
21798
21799 @item -mips64
21800 @opindex mips64
21801 Equivalent to @option{-march=mips64}.
21802
21803 @item -mips64r2
21804 @opindex mips64r2
21805 Equivalent to @option{-march=mips64r2}.
21806
21807 @item -mips64r3
21808 @opindex mips64r3
21809 Equivalent to @option{-march=mips64r3}.
21810
21811 @item -mips64r5
21812 @opindex mips64r5
21813 Equivalent to @option{-march=mips64r5}.
21814
21815 @item -mips64r6
21816 @opindex mips64r6
21817 Equivalent to @option{-march=mips64r6}.
21818
21819 @item -mips16
21820 @itemx -mno-mips16
21821 @opindex mips16
21822 @opindex mno-mips16
21823 Generate (do not generate) MIPS16 code. If GCC is targeting a
21824 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
21825
21826 MIPS16 code generation can also be controlled on a per-function basis
21827 by means of @code{mips16} and @code{nomips16} attributes.
21828 @xref{Function Attributes}, for more information.
21829
21830 @item -mflip-mips16
21831 @opindex mflip-mips16
21832 Generate MIPS16 code on alternating functions. This option is provided
21833 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
21834 not intended for ordinary use in compiling user code.
21835
21836 @item -minterlink-compressed
21837 @itemx -mno-interlink-compressed
21838 @opindex minterlink-compressed
21839 @opindex mno-interlink-compressed
21840 Require (do not require) that code using the standard (uncompressed) MIPS ISA
21841 be link-compatible with MIPS16 and microMIPS code, and vice versa.
21842
21843 For example, code using the standard ISA encoding cannot jump directly
21844 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
21845 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
21846 knows that the target of the jump is not compressed.
21847
21848 @item -minterlink-mips16
21849 @itemx -mno-interlink-mips16
21850 @opindex minterlink-mips16
21851 @opindex mno-interlink-mips16
21852 Aliases of @option{-minterlink-compressed} and
21853 @option{-mno-interlink-compressed}. These options predate the microMIPS ASE
21854 and are retained for backwards compatibility.
21855
21856 @item -mabi=32
21857 @itemx -mabi=o64
21858 @itemx -mabi=n32
21859 @itemx -mabi=64
21860 @itemx -mabi=eabi
21861 @opindex mabi=32
21862 @opindex mabi=o64
21863 @opindex mabi=n32
21864 @opindex mabi=64
21865 @opindex mabi=eabi
21866 Generate code for the given ABI@.
21867
21868 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
21869 generates 64-bit code when you select a 64-bit architecture, but you
21870 can use @option{-mgp32} to get 32-bit code instead.
21871
21872 For information about the O64 ABI, see
21873 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
21874
21875 GCC supports a variant of the o32 ABI in which floating-point registers
21876 are 64 rather than 32 bits wide. You can select this combination with
21877 @option{-mabi=32} @option{-mfp64}. This ABI relies on the @code{mthc1}
21878 and @code{mfhc1} instructions and is therefore only supported for
21879 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
21880
21881 The register assignments for arguments and return values remain the
21882 same, but each scalar value is passed in a single 64-bit register
21883 rather than a pair of 32-bit registers. For example, scalar
21884 floating-point values are returned in @samp{$f0} only, not a
21885 @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also
21886 remains the same in that the even-numbered double-precision registers
21887 are saved.
21888
21889 Two additional variants of the o32 ABI are supported to enable
21890 a transition from 32-bit to 64-bit registers. These are FPXX
21891 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
21892 The FPXX extension mandates that all code must execute correctly
21893 when run using 32-bit or 64-bit registers. The code can be interlinked
21894 with either FP32 or FP64, but not both.
21895 The FP64A extension is similar to the FP64 extension but forbids the
21896 use of odd-numbered single-precision registers. This can be used
21897 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
21898 processors and allows both FP32 and FP64A code to interlink and
21899 run in the same process without changing FPU modes.
21900
21901 @item -mabicalls
21902 @itemx -mno-abicalls
21903 @opindex mabicalls
21904 @opindex mno-abicalls
21905 Generate (do not generate) code that is suitable for SVR4-style
21906 dynamic objects. @option{-mabicalls} is the default for SVR4-based
21907 systems.
21908
21909 @item -mshared
21910 @itemx -mno-shared
21911 Generate (do not generate) code that is fully position-independent,
21912 and that can therefore be linked into shared libraries. This option
21913 only affects @option{-mabicalls}.
21914
21915 All @option{-mabicalls} code has traditionally been position-independent,
21916 regardless of options like @option{-fPIC} and @option{-fpic}. However,
21917 as an extension, the GNU toolchain allows executables to use absolute
21918 accesses for locally-binding symbols. It can also use shorter GP
21919 initialization sequences and generate direct calls to locally-defined
21920 functions. This mode is selected by @option{-mno-shared}.
21921
21922 @option{-mno-shared} depends on binutils 2.16 or higher and generates
21923 objects that can only be linked by the GNU linker. However, the option
21924 does not affect the ABI of the final executable; it only affects the ABI
21925 of relocatable objects. Using @option{-mno-shared} generally makes
21926 executables both smaller and quicker.
21927
21928 @option{-mshared} is the default.
21929
21930 @item -mplt
21931 @itemx -mno-plt
21932 @opindex mplt
21933 @opindex mno-plt
21934 Assume (do not assume) that the static and dynamic linkers
21935 support PLTs and copy relocations. This option only affects
21936 @option{-mno-shared -mabicalls}. For the n64 ABI, this option
21937 has no effect without @option{-msym32}.
21938
21939 You can make @option{-mplt} the default by configuring
21940 GCC with @option{--with-mips-plt}. The default is
21941 @option{-mno-plt} otherwise.
21942
21943 @item -mxgot
21944 @itemx -mno-xgot
21945 @opindex mxgot
21946 @opindex mno-xgot
21947 Lift (do not lift) the usual restrictions on the size of the global
21948 offset table.
21949
21950 GCC normally uses a single instruction to load values from the GOT@.
21951 While this is relatively efficient, it only works if the GOT
21952 is smaller than about 64k. Anything larger causes the linker
21953 to report an error such as:
21954
21955 @cindex relocation truncated to fit (MIPS)
21956 @smallexample
21957 relocation truncated to fit: R_MIPS_GOT16 foobar
21958 @end smallexample
21959
21960 If this happens, you should recompile your code with @option{-mxgot}.
21961 This works with very large GOTs, although the code is also
21962 less efficient, since it takes three instructions to fetch the
21963 value of a global symbol.
21964
21965 Note that some linkers can create multiple GOTs. If you have such a
21966 linker, you should only need to use @option{-mxgot} when a single object
21967 file accesses more than 64k's worth of GOT entries. Very few do.
21968
21969 These options have no effect unless GCC is generating position
21970 independent code.
21971
21972 @item -mgp32
21973 @opindex mgp32
21974 Assume that general-purpose registers are 32 bits wide.
21975
21976 @item -mgp64
21977 @opindex mgp64
21978 Assume that general-purpose registers are 64 bits wide.
21979
21980 @item -mfp32
21981 @opindex mfp32
21982 Assume that floating-point registers are 32 bits wide.
21983
21984 @item -mfp64
21985 @opindex mfp64
21986 Assume that floating-point registers are 64 bits wide.
21987
21988 @item -mfpxx
21989 @opindex mfpxx
21990 Do not assume the width of floating-point registers.
21991
21992 @item -mhard-float
21993 @opindex mhard-float
21994 Use floating-point coprocessor instructions.
21995
21996 @item -msoft-float
21997 @opindex msoft-float
21998 Do not use floating-point coprocessor instructions. Implement
21999 floating-point calculations using library calls instead.
22000
22001 @item -mno-float
22002 @opindex mno-float
22003 Equivalent to @option{-msoft-float}, but additionally asserts that the
22004 program being compiled does not perform any floating-point operations.
22005 This option is presently supported only by some bare-metal MIPS
22006 configurations, where it may select a special set of libraries
22007 that lack all floating-point support (including, for example, the
22008 floating-point @code{printf} formats).
22009 If code compiled with @option{-mno-float} accidentally contains
22010 floating-point operations, it is likely to suffer a link-time
22011 or run-time failure.
22012
22013 @item -msingle-float
22014 @opindex msingle-float
22015 Assume that the floating-point coprocessor only supports single-precision
22016 operations.
22017
22018 @item -mdouble-float
22019 @opindex mdouble-float
22020 Assume that the floating-point coprocessor supports double-precision
22021 operations. This is the default.
22022
22023 @item -modd-spreg
22024 @itemx -mno-odd-spreg
22025 @opindex modd-spreg
22026 @opindex mno-odd-spreg
22027 Enable the use of odd-numbered single-precision floating-point registers
22028 for the o32 ABI. This is the default for processors that are known to
22029 support these registers. When using the o32 FPXX ABI, @option{-mno-odd-spreg}
22030 is set by default.
22031
22032 @item -mabs=2008
22033 @itemx -mabs=legacy
22034 @opindex mabs=2008
22035 @opindex mabs=legacy
22036 These options control the treatment of the special not-a-number (NaN)
22037 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
22038 @code{neg.@i{fmt}} machine instructions.
22039
22040 By default or when @option{-mabs=legacy} is used the legacy
22041 treatment is selected. In this case these instructions are considered
22042 arithmetic and avoided where correct operation is required and the
22043 input operand might be a NaN. A longer sequence of instructions that
22044 manipulate the sign bit of floating-point datum manually is used
22045 instead unless the @option{-ffinite-math-only} option has also been
22046 specified.
22047
22048 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment. In
22049 this case these instructions are considered non-arithmetic and therefore
22050 operating correctly in all cases, including in particular where the
22051 input operand is a NaN. These instructions are therefore always used
22052 for the respective operations.
22053
22054 @item -mnan=2008
22055 @itemx -mnan=legacy
22056 @opindex mnan=2008
22057 @opindex mnan=legacy
22058 These options control the encoding of the special not-a-number (NaN)
22059 IEEE 754 floating-point data.
22060
22061 The @option{-mnan=legacy} option selects the legacy encoding. In this
22062 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
22063 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
22064 by the first bit of their trailing significand field being 1.
22065
22066 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding. In
22067 this case qNaNs are denoted by the first bit of their trailing
22068 significand field being 1, whereas sNaNs are denoted by the first bit of
22069 their trailing significand field being 0.
22070
22071 The default is @option{-mnan=legacy} unless GCC has been configured with
22072 @option{--with-nan=2008}.
22073
22074 @item -mllsc
22075 @itemx -mno-llsc
22076 @opindex mllsc
22077 @opindex mno-llsc
22078 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
22079 implement atomic memory built-in functions. When neither option is
22080 specified, GCC uses the instructions if the target architecture
22081 supports them.
22082
22083 @option{-mllsc} is useful if the runtime environment can emulate the
22084 instructions and @option{-mno-llsc} can be useful when compiling for
22085 nonstandard ISAs. You can make either option the default by
22086 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
22087 respectively. @option{--with-llsc} is the default for some
22088 configurations; see the installation documentation for details.
22089
22090 @item -mdsp
22091 @itemx -mno-dsp
22092 @opindex mdsp
22093 @opindex mno-dsp
22094 Use (do not use) revision 1 of the MIPS DSP ASE@.
22095 @xref{MIPS DSP Built-in Functions}. This option defines the
22096 preprocessor macro @code{__mips_dsp}. It also defines
22097 @code{__mips_dsp_rev} to 1.
22098
22099 @item -mdspr2
22100 @itemx -mno-dspr2
22101 @opindex mdspr2
22102 @opindex mno-dspr2
22103 Use (do not use) revision 2 of the MIPS DSP ASE@.
22104 @xref{MIPS DSP Built-in Functions}. This option defines the
22105 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
22106 It also defines @code{__mips_dsp_rev} to 2.
22107
22108 @item -msmartmips
22109 @itemx -mno-smartmips
22110 @opindex msmartmips
22111 @opindex mno-smartmips
22112 Use (do not use) the MIPS SmartMIPS ASE.
22113
22114 @item -mpaired-single
22115 @itemx -mno-paired-single
22116 @opindex mpaired-single
22117 @opindex mno-paired-single
22118 Use (do not use) paired-single floating-point instructions.
22119 @xref{MIPS Paired-Single Support}. This option requires
22120 hardware floating-point support to be enabled.
22121
22122 @item -mdmx
22123 @itemx -mno-mdmx
22124 @opindex mdmx
22125 @opindex mno-mdmx
22126 Use (do not use) MIPS Digital Media Extension instructions.
22127 This option can only be used when generating 64-bit code and requires
22128 hardware floating-point support to be enabled.
22129
22130 @item -mips3d
22131 @itemx -mno-mips3d
22132 @opindex mips3d
22133 @opindex mno-mips3d
22134 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
22135 The option @option{-mips3d} implies @option{-mpaired-single}.
22136
22137 @item -mmicromips
22138 @itemx -mno-micromips
22139 @opindex mmicromips
22140 @opindex mno-mmicromips
22141 Generate (do not generate) microMIPS code.
22142
22143 MicroMIPS code generation can also be controlled on a per-function basis
22144 by means of @code{micromips} and @code{nomicromips} attributes.
22145 @xref{Function Attributes}, for more information.
22146
22147 @item -mmt
22148 @itemx -mno-mt
22149 @opindex mmt
22150 @opindex mno-mt
22151 Use (do not use) MT Multithreading instructions.
22152
22153 @item -mmcu
22154 @itemx -mno-mcu
22155 @opindex mmcu
22156 @opindex mno-mcu
22157 Use (do not use) the MIPS MCU ASE instructions.
22158
22159 @item -meva
22160 @itemx -mno-eva
22161 @opindex meva
22162 @opindex mno-eva
22163 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
22164
22165 @item -mvirt
22166 @itemx -mno-virt
22167 @opindex mvirt
22168 @opindex mno-virt
22169 Use (do not use) the MIPS Virtualization (VZ) instructions.
22170
22171 @item -mxpa
22172 @itemx -mno-xpa
22173 @opindex mxpa
22174 @opindex mno-xpa
22175 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
22176
22177 @item -mcrc
22178 @itemx -mno-crc
22179 @opindex mcrc
22180 @opindex mno-crc
22181 Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
22182
22183 @item -mginv
22184 @itemx -mno-ginv
22185 @opindex mginv
22186 @opindex mno-ginv
22187 Use (do not use) the MIPS Global INValidate (GINV) instructions.
22188
22189 @item -mloongson-mmi
22190 @itemx -mno-loongson-mmi
22191 @opindex mloongson-mmi
22192 @opindex mno-loongson-mmi
22193 Use (do not use) the MIPS Loongson MultiMedia extensions Instructions (MMI).
22194
22195 @item -mloongson-ext
22196 @itemx -mno-loongson-ext
22197 @opindex mloongson-ext
22198 @opindex mno-loongson-ext
22199 Use (do not use) the MIPS Loongson EXTensions (EXT) instructions.
22200
22201 @item -mloongson-ext2
22202 @itemx -mno-loongson-ext2
22203 @opindex mloongson-ext2
22204 @opindex mno-loongson-ext2
22205 Use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
22206
22207 @item -mlong64
22208 @opindex mlong64
22209 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
22210 an explanation of the default and the way that the pointer size is
22211 determined.
22212
22213 @item -mlong32
22214 @opindex mlong32
22215 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
22216
22217 The default size of @code{int}s, @code{long}s and pointers depends on
22218 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
22219 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
22220 32-bit @code{long}s. Pointers are the same size as @code{long}s,
22221 or the same size as integer registers, whichever is smaller.
22222
22223 @item -msym32
22224 @itemx -mno-sym32
22225 @opindex msym32
22226 @opindex mno-sym32
22227 Assume (do not assume) that all symbols have 32-bit values, regardless
22228 of the selected ABI@. This option is useful in combination with
22229 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
22230 to generate shorter and faster references to symbolic addresses.
22231
22232 @item -G @var{num}
22233 @opindex G
22234 Put definitions of externally-visible data in a small data section
22235 if that data is no bigger than @var{num} bytes. GCC can then generate
22236 more efficient accesses to the data; see @option{-mgpopt} for details.
22237
22238 The default @option{-G} option depends on the configuration.
22239
22240 @item -mlocal-sdata
22241 @itemx -mno-local-sdata
22242 @opindex mlocal-sdata
22243 @opindex mno-local-sdata
22244 Extend (do not extend) the @option{-G} behavior to local data too,
22245 such as to static variables in C@. @option{-mlocal-sdata} is the
22246 default for all configurations.
22247
22248 If the linker complains that an application is using too much small data,
22249 you might want to try rebuilding the less performance-critical parts with
22250 @option{-mno-local-sdata}. You might also want to build large
22251 libraries with @option{-mno-local-sdata}, so that the libraries leave
22252 more room for the main program.
22253
22254 @item -mextern-sdata
22255 @itemx -mno-extern-sdata
22256 @opindex mextern-sdata
22257 @opindex mno-extern-sdata
22258 Assume (do not assume) that externally-defined data is in
22259 a small data section if the size of that data is within the @option{-G} limit.
22260 @option{-mextern-sdata} is the default for all configurations.
22261
22262 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
22263 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
22264 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
22265 is placed in a small data section. If @var{Var} is defined by another
22266 module, you must either compile that module with a high-enough
22267 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
22268 definition. If @var{Var} is common, you must link the application
22269 with a high-enough @option{-G} setting.
22270
22271 The easiest way of satisfying these restrictions is to compile
22272 and link every module with the same @option{-G} option. However,
22273 you may wish to build a library that supports several different
22274 small data limits. You can do this by compiling the library with
22275 the highest supported @option{-G} setting and additionally using
22276 @option{-mno-extern-sdata} to stop the library from making assumptions
22277 about externally-defined data.
22278
22279 @item -mgpopt
22280 @itemx -mno-gpopt
22281 @opindex mgpopt
22282 @opindex mno-gpopt
22283 Use (do not use) GP-relative accesses for symbols that are known to be
22284 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
22285 @option{-mextern-sdata}. @option{-mgpopt} is the default for all
22286 configurations.
22287
22288 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
22289 might not hold the value of @code{_gp}. For example, if the code is
22290 part of a library that might be used in a boot monitor, programs that
22291 call boot monitor routines pass an unknown value in @code{$gp}.
22292 (In such situations, the boot monitor itself is usually compiled
22293 with @option{-G0}.)
22294
22295 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
22296 @option{-mno-extern-sdata}.
22297
22298 @item -membedded-data
22299 @itemx -mno-embedded-data
22300 @opindex membedded-data
22301 @opindex mno-embedded-data
22302 Allocate variables to the read-only data section first if possible, then
22303 next in the small data section if possible, otherwise in data. This gives
22304 slightly slower code than the default, but reduces the amount of RAM required
22305 when executing, and thus may be preferred for some embedded systems.
22306
22307 @item -muninit-const-in-rodata
22308 @itemx -mno-uninit-const-in-rodata
22309 @opindex muninit-const-in-rodata
22310 @opindex mno-uninit-const-in-rodata
22311 Put uninitialized @code{const} variables in the read-only data section.
22312 This option is only meaningful in conjunction with @option{-membedded-data}.
22313
22314 @item -mcode-readable=@var{setting}
22315 @opindex mcode-readable
22316 Specify whether GCC may generate code that reads from executable sections.
22317 There are three possible settings:
22318
22319 @table @gcctabopt
22320 @item -mcode-readable=yes
22321 Instructions may freely access executable sections. This is the
22322 default setting.
22323
22324 @item -mcode-readable=pcrel
22325 MIPS16 PC-relative load instructions can access executable sections,
22326 but other instructions must not do so. This option is useful on 4KSc
22327 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
22328 It is also useful on processors that can be configured to have a dual
22329 instruction/data SRAM interface and that, like the M4K, automatically
22330 redirect PC-relative loads to the instruction RAM.
22331
22332 @item -mcode-readable=no
22333 Instructions must not access executable sections. This option can be
22334 useful on targets that are configured to have a dual instruction/data
22335 SRAM interface but that (unlike the M4K) do not automatically redirect
22336 PC-relative loads to the instruction RAM.
22337 @end table
22338
22339 @item -msplit-addresses
22340 @itemx -mno-split-addresses
22341 @opindex msplit-addresses
22342 @opindex mno-split-addresses
22343 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
22344 relocation operators. This option has been superseded by
22345 @option{-mexplicit-relocs} but is retained for backwards compatibility.
22346
22347 @item -mexplicit-relocs
22348 @itemx -mno-explicit-relocs
22349 @opindex mexplicit-relocs
22350 @opindex mno-explicit-relocs
22351 Use (do not use) assembler relocation operators when dealing with symbolic
22352 addresses. The alternative, selected by @option{-mno-explicit-relocs},
22353 is to use assembler macros instead.
22354
22355 @option{-mexplicit-relocs} is the default if GCC was configured
22356 to use an assembler that supports relocation operators.
22357
22358 @item -mcheck-zero-division
22359 @itemx -mno-check-zero-division
22360 @opindex mcheck-zero-division
22361 @opindex mno-check-zero-division
22362 Trap (do not trap) on integer division by zero.
22363
22364 The default is @option{-mcheck-zero-division}.
22365
22366 @item -mdivide-traps
22367 @itemx -mdivide-breaks
22368 @opindex mdivide-traps
22369 @opindex mdivide-breaks
22370 MIPS systems check for division by zero by generating either a
22371 conditional trap or a break instruction. Using traps results in
22372 smaller code, but is only supported on MIPS II and later. Also, some
22373 versions of the Linux kernel have a bug that prevents trap from
22374 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
22375 allow conditional traps on architectures that support them and
22376 @option{-mdivide-breaks} to force the use of breaks.
22377
22378 The default is usually @option{-mdivide-traps}, but this can be
22379 overridden at configure time using @option{--with-divide=breaks}.
22380 Divide-by-zero checks can be completely disabled using
22381 @option{-mno-check-zero-division}.
22382
22383 @item -mload-store-pairs
22384 @itemx -mno-load-store-pairs
22385 @opindex mload-store-pairs
22386 @opindex mno-load-store-pairs
22387 Enable (disable) an optimization that pairs consecutive load or store
22388 instructions to enable load/store bonding. This option is enabled by
22389 default but only takes effect when the selected architecture is known
22390 to support bonding.
22391
22392 @item -mmemcpy
22393 @itemx -mno-memcpy
22394 @opindex mmemcpy
22395 @opindex mno-memcpy
22396 Force (do not force) the use of @code{memcpy} for non-trivial block
22397 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
22398 most constant-sized copies.
22399
22400 @item -mlong-calls
22401 @itemx -mno-long-calls
22402 @opindex mlong-calls
22403 @opindex mno-long-calls
22404 Disable (do not disable) use of the @code{jal} instruction. Calling
22405 functions using @code{jal} is more efficient but requires the caller
22406 and callee to be in the same 256 megabyte segment.
22407
22408 This option has no effect on abicalls code. The default is
22409 @option{-mno-long-calls}.
22410
22411 @item -mmad
22412 @itemx -mno-mad
22413 @opindex mmad
22414 @opindex mno-mad
22415 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
22416 instructions, as provided by the R4650 ISA@.
22417
22418 @item -mimadd
22419 @itemx -mno-imadd
22420 @opindex mimadd
22421 @opindex mno-imadd
22422 Enable (disable) use of the @code{madd} and @code{msub} integer
22423 instructions. The default is @option{-mimadd} on architectures
22424 that support @code{madd} and @code{msub} except for the 74k
22425 architecture where it was found to generate slower code.
22426
22427 @item -mfused-madd
22428 @itemx -mno-fused-madd
22429 @opindex mfused-madd
22430 @opindex mno-fused-madd
22431 Enable (disable) use of the floating-point multiply-accumulate
22432 instructions, when they are available. The default is
22433 @option{-mfused-madd}.
22434
22435 On the R8000 CPU when multiply-accumulate instructions are used,
22436 the intermediate product is calculated to infinite precision
22437 and is not subject to the FCSR Flush to Zero bit. This may be
22438 undesirable in some circumstances. On other processors the result
22439 is numerically identical to the equivalent computation using
22440 separate multiply, add, subtract and negate instructions.
22441
22442 @item -nocpp
22443 @opindex nocpp
22444 Tell the MIPS assembler to not run its preprocessor over user
22445 assembler files (with a @samp{.s} suffix) when assembling them.
22446
22447 @item -mfix-24k
22448 @itemx -mno-fix-24k
22449 @opindex mfix-24k
22450 @opindex mno-fix-24k
22451 Work around the 24K E48 (lost data on stores during refill) errata.
22452 The workarounds are implemented by the assembler rather than by GCC@.
22453
22454 @item -mfix-r4000
22455 @itemx -mno-fix-r4000
22456 @opindex mfix-r4000
22457 @opindex mno-fix-r4000
22458 Work around certain R4000 CPU errata:
22459 @itemize @minus
22460 @item
22461 A double-word or a variable shift may give an incorrect result if executed
22462 immediately after starting an integer division.
22463 @item
22464 A double-word or a variable shift may give an incorrect result if executed
22465 while an integer multiplication is in progress.
22466 @item
22467 An integer division may give an incorrect result if started in a delay slot
22468 of a taken branch or a jump.
22469 @end itemize
22470
22471 @item -mfix-r4400
22472 @itemx -mno-fix-r4400
22473 @opindex mfix-r4400
22474 @opindex mno-fix-r4400
22475 Work around certain R4400 CPU errata:
22476 @itemize @minus
22477 @item
22478 A double-word or a variable shift may give an incorrect result if executed
22479 immediately after starting an integer division.
22480 @end itemize
22481
22482 @item -mfix-r10000
22483 @itemx -mno-fix-r10000
22484 @opindex mfix-r10000
22485 @opindex mno-fix-r10000
22486 Work around certain R10000 errata:
22487 @itemize @minus
22488 @item
22489 @code{ll}/@code{sc} sequences may not behave atomically on revisions
22490 prior to 3.0. They may deadlock on revisions 2.6 and earlier.
22491 @end itemize
22492
22493 This option can only be used if the target architecture supports
22494 branch-likely instructions. @option{-mfix-r10000} is the default when
22495 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
22496 otherwise.
22497
22498 @item -mfix-r5900
22499 @itemx -mno-fix-r5900
22500 @opindex mfix-r5900
22501 Do not attempt to schedule the preceding instruction into the delay slot
22502 of a branch instruction placed at the end of a short loop of six
22503 instructions or fewer and always schedule a @code{nop} instruction there
22504 instead. The short loop bug under certain conditions causes loops to
22505 execute only once or twice, due to a hardware bug in the R5900 chip. The
22506 workaround is implemented by the assembler rather than by GCC@.
22507
22508 @item -mfix-rm7000
22509 @itemx -mno-fix-rm7000
22510 @opindex mfix-rm7000
22511 Work around the RM7000 @code{dmult}/@code{dmultu} errata. The
22512 workarounds are implemented by the assembler rather than by GCC@.
22513
22514 @item -mfix-vr4120
22515 @itemx -mno-fix-vr4120
22516 @opindex mfix-vr4120
22517 Work around certain VR4120 errata:
22518 @itemize @minus
22519 @item
22520 @code{dmultu} does not always produce the correct result.
22521 @item
22522 @code{div} and @code{ddiv} do not always produce the correct result if one
22523 of the operands is negative.
22524 @end itemize
22525 The workarounds for the division errata rely on special functions in
22526 @file{libgcc.a}. At present, these functions are only provided by
22527 the @code{mips64vr*-elf} configurations.
22528
22529 Other VR4120 errata require a NOP to be inserted between certain pairs of
22530 instructions. These errata are handled by the assembler, not by GCC itself.
22531
22532 @item -mfix-vr4130
22533 @opindex mfix-vr4130
22534 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
22535 workarounds are implemented by the assembler rather than by GCC,
22536 although GCC avoids using @code{mflo} and @code{mfhi} if the
22537 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
22538 instructions are available instead.
22539
22540 @item -mfix-sb1
22541 @itemx -mno-fix-sb1
22542 @opindex mfix-sb1
22543 Work around certain SB-1 CPU core errata.
22544 (This flag currently works around the SB-1 revision 2
22545 ``F1'' and ``F2'' floating-point errata.)
22546
22547 @item -mr10k-cache-barrier=@var{setting}
22548 @opindex mr10k-cache-barrier
22549 Specify whether GCC should insert cache barriers to avoid the
22550 side effects of speculation on R10K processors.
22551
22552 In common with many processors, the R10K tries to predict the outcome
22553 of a conditional branch and speculatively executes instructions from
22554 the ``taken'' branch. It later aborts these instructions if the
22555 predicted outcome is wrong. However, on the R10K, even aborted
22556 instructions can have side effects.
22557
22558 This problem only affects kernel stores and, depending on the system,
22559 kernel loads. As an example, a speculatively-executed store may load
22560 the target memory into cache and mark the cache line as dirty, even if
22561 the store itself is later aborted. If a DMA operation writes to the
22562 same area of memory before the ``dirty'' line is flushed, the cached
22563 data overwrites the DMA-ed data. See the R10K processor manual
22564 for a full description, including other potential problems.
22565
22566 One workaround is to insert cache barrier instructions before every memory
22567 access that might be speculatively executed and that might have side
22568 effects even if aborted. @option{-mr10k-cache-barrier=@var{setting}}
22569 controls GCC's implementation of this workaround. It assumes that
22570 aborted accesses to any byte in the following regions does not have
22571 side effects:
22572
22573 @enumerate
22574 @item
22575 the memory occupied by the current function's stack frame;
22576
22577 @item
22578 the memory occupied by an incoming stack argument;
22579
22580 @item
22581 the memory occupied by an object with a link-time-constant address.
22582 @end enumerate
22583
22584 It is the kernel's responsibility to ensure that speculative
22585 accesses to these regions are indeed safe.
22586
22587 If the input program contains a function declaration such as:
22588
22589 @smallexample
22590 void foo (void);
22591 @end smallexample
22592
22593 then the implementation of @code{foo} must allow @code{j foo} and
22594 @code{jal foo} to be executed speculatively. GCC honors this
22595 restriction for functions it compiles itself. It expects non-GCC
22596 functions (such as hand-written assembly code) to do the same.
22597
22598 The option has three forms:
22599
22600 @table @gcctabopt
22601 @item -mr10k-cache-barrier=load-store
22602 Insert a cache barrier before a load or store that might be
22603 speculatively executed and that might have side effects even
22604 if aborted.
22605
22606 @item -mr10k-cache-barrier=store
22607 Insert a cache barrier before a store that might be speculatively
22608 executed and that might have side effects even if aborted.
22609
22610 @item -mr10k-cache-barrier=none
22611 Disable the insertion of cache barriers. This is the default setting.
22612 @end table
22613
22614 @item -mflush-func=@var{func}
22615 @itemx -mno-flush-func
22616 @opindex mflush-func
22617 Specifies the function to call to flush the I and D caches, or to not
22618 call any such function. If called, the function must take the same
22619 arguments as the common @code{_flush_func}, that is, the address of the
22620 memory range for which the cache is being flushed, the size of the
22621 memory range, and the number 3 (to flush both caches). The default
22622 depends on the target GCC was configured for, but commonly is either
22623 @code{_flush_func} or @code{__cpu_flush}.
22624
22625 @item mbranch-cost=@var{num}
22626 @opindex mbranch-cost
22627 Set the cost of branches to roughly @var{num} ``simple'' instructions.
22628 This cost is only a heuristic and is not guaranteed to produce
22629 consistent results across releases. A zero cost redundantly selects
22630 the default, which is based on the @option{-mtune} setting.
22631
22632 @item -mbranch-likely
22633 @itemx -mno-branch-likely
22634 @opindex mbranch-likely
22635 @opindex mno-branch-likely
22636 Enable or disable use of Branch Likely instructions, regardless of the
22637 default for the selected architecture. By default, Branch Likely
22638 instructions may be generated if they are supported by the selected
22639 architecture. An exception is for the MIPS32 and MIPS64 architectures
22640 and processors that implement those architectures; for those, Branch
22641 Likely instructions are not be generated by default because the MIPS32
22642 and MIPS64 architectures specifically deprecate their use.
22643
22644 @item -mcompact-branches=never
22645 @itemx -mcompact-branches=optimal
22646 @itemx -mcompact-branches=always
22647 @opindex mcompact-branches=never
22648 @opindex mcompact-branches=optimal
22649 @opindex mcompact-branches=always
22650 These options control which form of branches will be generated. The
22651 default is @option{-mcompact-branches=optimal}.
22652
22653 The @option{-mcompact-branches=never} option ensures that compact branch
22654 instructions will never be generated.
22655
22656 The @option{-mcompact-branches=always} option ensures that a compact
22657 branch instruction will be generated if available. If a compact branch
22658 instruction is not available, a delay slot form of the branch will be
22659 used instead.
22660
22661 This option is supported from MIPS Release 6 onwards.
22662
22663 The @option{-mcompact-branches=optimal} option will cause a delay slot
22664 branch to be used if one is available in the current ISA and the delay
22665 slot is successfully filled. If the delay slot is not filled, a compact
22666 branch will be chosen if one is available.
22667
22668 @item -mfp-exceptions
22669 @itemx -mno-fp-exceptions
22670 @opindex mfp-exceptions
22671 Specifies whether FP exceptions are enabled. This affects how
22672 FP instructions are scheduled for some processors.
22673 The default is that FP exceptions are
22674 enabled.
22675
22676 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
22677 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
22678 FP pipe.
22679
22680 @item -mvr4130-align
22681 @itemx -mno-vr4130-align
22682 @opindex mvr4130-align
22683 The VR4130 pipeline is two-way superscalar, but can only issue two
22684 instructions together if the first one is 8-byte aligned. When this
22685 option is enabled, GCC aligns pairs of instructions that it
22686 thinks should execute in parallel.
22687
22688 This option only has an effect when optimizing for the VR4130.
22689 It normally makes code faster, but at the expense of making it bigger.
22690 It is enabled by default at optimization level @option{-O3}.
22691
22692 @item -msynci
22693 @itemx -mno-synci
22694 @opindex msynci
22695 Enable (disable) generation of @code{synci} instructions on
22696 architectures that support it. The @code{synci} instructions (if
22697 enabled) are generated when @code{__builtin___clear_cache} is
22698 compiled.
22699
22700 This option defaults to @option{-mno-synci}, but the default can be
22701 overridden by configuring GCC with @option{--with-synci}.
22702
22703 When compiling code for single processor systems, it is generally safe
22704 to use @code{synci}. However, on many multi-core (SMP) systems, it
22705 does not invalidate the instruction caches on all cores and may lead
22706 to undefined behavior.
22707
22708 @item -mrelax-pic-calls
22709 @itemx -mno-relax-pic-calls
22710 @opindex mrelax-pic-calls
22711 Try to turn PIC calls that are normally dispatched via register
22712 @code{$25} into direct calls. This is only possible if the linker can
22713 resolve the destination at link time and if the destination is within
22714 range for a direct call.
22715
22716 @option{-mrelax-pic-calls} is the default if GCC was configured to use
22717 an assembler and a linker that support the @code{.reloc} assembly
22718 directive and @option{-mexplicit-relocs} is in effect. With
22719 @option{-mno-explicit-relocs}, this optimization can be performed by the
22720 assembler and the linker alone without help from the compiler.
22721
22722 @item -mmcount-ra-address
22723 @itemx -mno-mcount-ra-address
22724 @opindex mmcount-ra-address
22725 @opindex mno-mcount-ra-address
22726 Emit (do not emit) code that allows @code{_mcount} to modify the
22727 calling function's return address. When enabled, this option extends
22728 the usual @code{_mcount} interface with a new @var{ra-address}
22729 parameter, which has type @code{intptr_t *} and is passed in register
22730 @code{$12}. @code{_mcount} can then modify the return address by
22731 doing both of the following:
22732 @itemize
22733 @item
22734 Returning the new address in register @code{$31}.
22735 @item
22736 Storing the new address in @code{*@var{ra-address}},
22737 if @var{ra-address} is nonnull.
22738 @end itemize
22739
22740 The default is @option{-mno-mcount-ra-address}.
22741
22742 @item -mframe-header-opt
22743 @itemx -mno-frame-header-opt
22744 @opindex mframe-header-opt
22745 Enable (disable) frame header optimization in the o32 ABI. When using the
22746 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
22747 function to write out register arguments. When enabled, this optimization
22748 will suppress the allocation of the frame header if it can be determined that
22749 it is unused.
22750
22751 This optimization is off by default at all optimization levels.
22752
22753 @item -mlxc1-sxc1
22754 @itemx -mno-lxc1-sxc1
22755 @opindex mlxc1-sxc1
22756 When applicable, enable (disable) the generation of @code{lwxc1},
22757 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions. Enabled by default.
22758
22759 @item -mmadd4
22760 @itemx -mno-madd4
22761 @opindex mmadd4
22762 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
22763 @code{madd.d} and related instructions. Enabled by default.
22764
22765 @end table
22766
22767 @node MMIX Options
22768 @subsection MMIX Options
22769 @cindex MMIX Options
22770
22771 These options are defined for the MMIX:
22772
22773 @table @gcctabopt
22774 @item -mlibfuncs
22775 @itemx -mno-libfuncs
22776 @opindex mlibfuncs
22777 @opindex mno-libfuncs
22778 Specify that intrinsic library functions are being compiled, passing all
22779 values in registers, no matter the size.
22780
22781 @item -mepsilon
22782 @itemx -mno-epsilon
22783 @opindex mepsilon
22784 @opindex mno-epsilon
22785 Generate floating-point comparison instructions that compare with respect
22786 to the @code{rE} epsilon register.
22787
22788 @item -mabi=mmixware
22789 @itemx -mabi=gnu
22790 @opindex mabi=mmixware
22791 @opindex mabi=gnu
22792 Generate code that passes function parameters and return values that (in
22793 the called function) are seen as registers @code{$0} and up, as opposed to
22794 the GNU ABI which uses global registers @code{$231} and up.
22795
22796 @item -mzero-extend
22797 @itemx -mno-zero-extend
22798 @opindex mzero-extend
22799 @opindex mno-zero-extend
22800 When reading data from memory in sizes shorter than 64 bits, use (do not
22801 use) zero-extending load instructions by default, rather than
22802 sign-extending ones.
22803
22804 @item -mknuthdiv
22805 @itemx -mno-knuthdiv
22806 @opindex mknuthdiv
22807 @opindex mno-knuthdiv
22808 Make the result of a division yielding a remainder have the same sign as
22809 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
22810 remainder follows the sign of the dividend. Both methods are
22811 arithmetically valid, the latter being almost exclusively used.
22812
22813 @item -mtoplevel-symbols
22814 @itemx -mno-toplevel-symbols
22815 @opindex mtoplevel-symbols
22816 @opindex mno-toplevel-symbols
22817 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
22818 code can be used with the @code{PREFIX} assembly directive.
22819
22820 @item -melf
22821 @opindex melf
22822 Generate an executable in the ELF format, rather than the default
22823 @samp{mmo} format used by the @command{mmix} simulator.
22824
22825 @item -mbranch-predict
22826 @itemx -mno-branch-predict
22827 @opindex mbranch-predict
22828 @opindex mno-branch-predict
22829 Use (do not use) the probable-branch instructions, when static branch
22830 prediction indicates a probable branch.
22831
22832 @item -mbase-addresses
22833 @itemx -mno-base-addresses
22834 @opindex mbase-addresses
22835 @opindex mno-base-addresses
22836 Generate (do not generate) code that uses @emph{base addresses}. Using a
22837 base address automatically generates a request (handled by the assembler
22838 and the linker) for a constant to be set up in a global register. The
22839 register is used for one or more base address requests within the range 0
22840 to 255 from the value held in the register. The generally leads to short
22841 and fast code, but the number of different data items that can be
22842 addressed is limited. This means that a program that uses lots of static
22843 data may require @option{-mno-base-addresses}.
22844
22845 @item -msingle-exit
22846 @itemx -mno-single-exit
22847 @opindex msingle-exit
22848 @opindex mno-single-exit
22849 Force (do not force) generated code to have a single exit point in each
22850 function.
22851 @end table
22852
22853 @node MN10300 Options
22854 @subsection MN10300 Options
22855 @cindex MN10300 options
22856
22857 These @option{-m} options are defined for Matsushita MN10300 architectures:
22858
22859 @table @gcctabopt
22860 @item -mmult-bug
22861 @opindex mmult-bug
22862 Generate code to avoid bugs in the multiply instructions for the MN10300
22863 processors. This is the default.
22864
22865 @item -mno-mult-bug
22866 @opindex mno-mult-bug
22867 Do not generate code to avoid bugs in the multiply instructions for the
22868 MN10300 processors.
22869
22870 @item -mam33
22871 @opindex mam33
22872 Generate code using features specific to the AM33 processor.
22873
22874 @item -mno-am33
22875 @opindex mno-am33
22876 Do not generate code using features specific to the AM33 processor. This
22877 is the default.
22878
22879 @item -mam33-2
22880 @opindex mam33-2
22881 Generate code using features specific to the AM33/2.0 processor.
22882
22883 @item -mam34
22884 @opindex mam34
22885 Generate code using features specific to the AM34 processor.
22886
22887 @item -mtune=@var{cpu-type}
22888 @opindex mtune
22889 Use the timing characteristics of the indicated CPU type when
22890 scheduling instructions. This does not change the targeted processor
22891 type. The CPU type must be one of @samp{mn10300}, @samp{am33},
22892 @samp{am33-2} or @samp{am34}.
22893
22894 @item -mreturn-pointer-on-d0
22895 @opindex mreturn-pointer-on-d0
22896 When generating a function that returns a pointer, return the pointer
22897 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
22898 only in @code{a0}, and attempts to call such functions without a prototype
22899 result in errors. Note that this option is on by default; use
22900 @option{-mno-return-pointer-on-d0} to disable it.
22901
22902 @item -mno-crt0
22903 @opindex mno-crt0
22904 Do not link in the C run-time initialization object file.
22905
22906 @item -mrelax
22907 @opindex mrelax
22908 Indicate to the linker that it should perform a relaxation optimization pass
22909 to shorten branches, calls and absolute memory addresses. This option only
22910 has an effect when used on the command line for the final link step.
22911
22912 This option makes symbolic debugging impossible.
22913
22914 @item -mliw
22915 @opindex mliw
22916 Allow the compiler to generate @emph{Long Instruction Word}
22917 instructions if the target is the @samp{AM33} or later. This is the
22918 default. This option defines the preprocessor macro @code{__LIW__}.
22919
22920 @item -mno-liw
22921 @opindex mno-liw
22922 Do not allow the compiler to generate @emph{Long Instruction Word}
22923 instructions. This option defines the preprocessor macro
22924 @code{__NO_LIW__}.
22925
22926 @item -msetlb
22927 @opindex msetlb
22928 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
22929 instructions if the target is the @samp{AM33} or later. This is the
22930 default. This option defines the preprocessor macro @code{__SETLB__}.
22931
22932 @item -mno-setlb
22933 @opindex mno-setlb
22934 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
22935 instructions. This option defines the preprocessor macro
22936 @code{__NO_SETLB__}.
22937
22938 @end table
22939
22940 @node Moxie Options
22941 @subsection Moxie Options
22942 @cindex Moxie Options
22943
22944 @table @gcctabopt
22945
22946 @item -meb
22947 @opindex meb
22948 Generate big-endian code. This is the default for @samp{moxie-*-*}
22949 configurations.
22950
22951 @item -mel
22952 @opindex mel
22953 Generate little-endian code.
22954
22955 @item -mmul.x
22956 @opindex mmul.x
22957 Generate mul.x and umul.x instructions. This is the default for
22958 @samp{moxiebox-*-*} configurations.
22959
22960 @item -mno-crt0
22961 @opindex mno-crt0
22962 Do not link in the C run-time initialization object file.
22963
22964 @end table
22965
22966 @node MSP430 Options
22967 @subsection MSP430 Options
22968 @cindex MSP430 Options
22969
22970 These options are defined for the MSP430:
22971
22972 @table @gcctabopt
22973
22974 @item -masm-hex
22975 @opindex masm-hex
22976 Force assembly output to always use hex constants. Normally such
22977 constants are signed decimals, but this option is available for
22978 testsuite and/or aesthetic purposes.
22979
22980 @item -mmcu=
22981 @opindex mmcu=
22982 Select the MCU to target. This is used to create a C preprocessor
22983 symbol based upon the MCU name, converted to upper case and pre- and
22984 post-fixed with @samp{__}. This in turn is used by the
22985 @file{msp430.h} header file to select an MCU-specific supplementary
22986 header file.
22987
22988 The option also sets the ISA to use. If the MCU name is one that is
22989 known to only support the 430 ISA then that is selected, otherwise the
22990 430X ISA is selected. A generic MCU name of @samp{msp430} can also be
22991 used to select the 430 ISA. Similarly the generic @samp{msp430x} MCU
22992 name selects the 430X ISA.
22993
22994 In addition an MCU-specific linker script is added to the linker
22995 command line. The script's name is the name of the MCU with
22996 @file{.ld} appended. Thus specifying @option{-mmcu=xxx} on the @command{gcc}
22997 command line defines the C preprocessor symbol @code{__XXX__} and
22998 cause the linker to search for a script called @file{xxx.ld}.
22999
23000 This option is also passed on to the assembler.
23001
23002 @item -mwarn-mcu
23003 @itemx -mno-warn-mcu
23004 @opindex mwarn-mcu
23005 @opindex mno-warn-mcu
23006 This option enables or disables warnings about conflicts between the
23007 MCU name specified by the @option{-mmcu} option and the ISA set by the
23008 @option{-mcpu} option and/or the hardware multiply support set by the
23009 @option{-mhwmult} option. It also toggles warnings about unrecognized
23010 MCU names. This option is on by default.
23011
23012 @item -mcpu=
23013 @opindex mcpu=
23014 Specifies the ISA to use. Accepted values are @samp{msp430},
23015 @samp{msp430x} and @samp{msp430xv2}. This option is deprecated. The
23016 @option{-mmcu=} option should be used to select the ISA.
23017
23018 @item -msim
23019 @opindex msim
23020 Link to the simulator runtime libraries and linker script. Overrides
23021 any scripts that would be selected by the @option{-mmcu=} option.
23022
23023 @item -mlarge
23024 @opindex mlarge
23025 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
23026
23027 @item -msmall
23028 @opindex msmall
23029 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
23030
23031 @item -mrelax
23032 @opindex mrelax
23033 This option is passed to the assembler and linker, and allows the
23034 linker to perform certain optimizations that cannot be done until
23035 the final link.
23036
23037 @item mhwmult=
23038 @opindex mhwmult=
23039 Describes the type of hardware multiply supported by the target.
23040 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
23041 for the original 16-bit-only multiply supported by early MCUs.
23042 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
23043 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
23044 A value of @samp{auto} can also be given. This tells GCC to deduce
23045 the hardware multiply support based upon the MCU name provided by the
23046 @option{-mmcu} option. If no @option{-mmcu} option is specified or if
23047 the MCU name is not recognized then no hardware multiply support is
23048 assumed. @code{auto} is the default setting.
23049
23050 Hardware multiplies are normally performed by calling a library
23051 routine. This saves space in the generated code. When compiling at
23052 @option{-O3} or higher however the hardware multiplier is invoked
23053 inline. This makes for bigger, but faster code.
23054
23055 The hardware multiply routines disable interrupts whilst running and
23056 restore the previous interrupt state when they finish. This makes
23057 them safe to use inside interrupt handlers as well as in normal code.
23058
23059 @item -minrt
23060 @opindex minrt
23061 Enable the use of a minimum runtime environment - no static
23062 initializers or constructors. This is intended for memory-constrained
23063 devices. The compiler includes special symbols in some objects
23064 that tell the linker and runtime which code fragments are required.
23065
23066 @item -mcode-region=
23067 @itemx -mdata-region=
23068 @opindex mcode-region
23069 @opindex mdata-region
23070 These options tell the compiler where to place functions and data that
23071 do not have one of the @code{lower}, @code{upper}, @code{either} or
23072 @code{section} attributes. Possible values are @code{lower},
23073 @code{upper}, @code{either} or @code{any}. The first three behave
23074 like the corresponding attribute. The fourth possible value -
23075 @code{any} - is the default. It leaves placement entirely up to the
23076 linker script and how it assigns the standard sections
23077 (@code{.text}, @code{.data}, etc) to the memory regions.
23078
23079 @item -msilicon-errata=
23080 @opindex msilicon-errata
23081 This option passes on a request to assembler to enable the fixes for
23082 the named silicon errata.
23083
23084 @item -msilicon-errata-warn=
23085 @opindex msilicon-errata-warn
23086 This option passes on a request to the assembler to enable warning
23087 messages when a silicon errata might need to be applied.
23088
23089 @end table
23090
23091 @node NDS32 Options
23092 @subsection NDS32 Options
23093 @cindex NDS32 Options
23094
23095 These options are defined for NDS32 implementations:
23096
23097 @table @gcctabopt
23098
23099 @item -mbig-endian
23100 @opindex mbig-endian
23101 Generate code in big-endian mode.
23102
23103 @item -mlittle-endian
23104 @opindex mlittle-endian
23105 Generate code in little-endian mode.
23106
23107 @item -mreduced-regs
23108 @opindex mreduced-regs
23109 Use reduced-set registers for register allocation.
23110
23111 @item -mfull-regs
23112 @opindex mfull-regs
23113 Use full-set registers for register allocation.
23114
23115 @item -mcmov
23116 @opindex mcmov
23117 Generate conditional move instructions.
23118
23119 @item -mno-cmov
23120 @opindex mno-cmov
23121 Do not generate conditional move instructions.
23122
23123 @item -mext-perf
23124 @opindex mext-perf
23125 Generate performance extension instructions.
23126
23127 @item -mno-ext-perf
23128 @opindex mno-ext-perf
23129 Do not generate performance extension instructions.
23130
23131 @item -mext-perf2
23132 @opindex mext-perf2
23133 Generate performance extension 2 instructions.
23134
23135 @item -mno-ext-perf2
23136 @opindex mno-ext-perf2
23137 Do not generate performance extension 2 instructions.
23138
23139 @item -mext-string
23140 @opindex mext-string
23141 Generate string extension instructions.
23142
23143 @item -mno-ext-string
23144 @opindex mno-ext-string
23145 Do not generate string extension instructions.
23146
23147 @item -mv3push
23148 @opindex mv3push
23149 Generate v3 push25/pop25 instructions.
23150
23151 @item -mno-v3push
23152 @opindex mno-v3push
23153 Do not generate v3 push25/pop25 instructions.
23154
23155 @item -m16-bit
23156 @opindex m16-bit
23157 Generate 16-bit instructions.
23158
23159 @item -mno-16-bit
23160 @opindex mno-16-bit
23161 Do not generate 16-bit instructions.
23162
23163 @item -misr-vector-size=@var{num}
23164 @opindex misr-vector-size
23165 Specify the size of each interrupt vector, which must be 4 or 16.
23166
23167 @item -mcache-block-size=@var{num}
23168 @opindex mcache-block-size
23169 Specify the size of each cache block,
23170 which must be a power of 2 between 4 and 512.
23171
23172 @item -march=@var{arch}
23173 @opindex march
23174 Specify the name of the target architecture.
23175
23176 @item -mcmodel=@var{code-model}
23177 @opindex mcmodel
23178 Set the code model to one of
23179 @table @asis
23180 @item @samp{small}
23181 All the data and read-only data segments must be within 512KB addressing space.
23182 The text segment must be within 16MB addressing space.
23183 @item @samp{medium}
23184 The data segment must be within 512KB while the read-only data segment can be
23185 within 4GB addressing space. The text segment should be still within 16MB
23186 addressing space.
23187 @item @samp{large}
23188 All the text and data segments can be within 4GB addressing space.
23189 @end table
23190
23191 @item -mctor-dtor
23192 @opindex mctor-dtor
23193 Enable constructor/destructor feature.
23194
23195 @item -mrelax
23196 @opindex mrelax
23197 Guide linker to relax instructions.
23198
23199 @end table
23200
23201 @node Nios II Options
23202 @subsection Nios II Options
23203 @cindex Nios II options
23204 @cindex Altera Nios II options
23205
23206 These are the options defined for the Altera Nios II processor.
23207
23208 @table @gcctabopt
23209
23210 @item -G @var{num}
23211 @opindex G
23212 @cindex smaller data references
23213 Put global and static objects less than or equal to @var{num} bytes
23214 into the small data or BSS sections instead of the normal data or BSS
23215 sections. The default value of @var{num} is 8.
23216
23217 @item -mgpopt=@var{option}
23218 @itemx -mgpopt
23219 @itemx -mno-gpopt
23220 @opindex mgpopt
23221 @opindex mno-gpopt
23222 Generate (do not generate) GP-relative accesses. The following
23223 @var{option} names are recognized:
23224
23225 @table @samp
23226
23227 @item none
23228 Do not generate GP-relative accesses.
23229
23230 @item local
23231 Generate GP-relative accesses for small data objects that are not
23232 external, weak, or uninitialized common symbols.
23233 Also use GP-relative addressing for objects that
23234 have been explicitly placed in a small data section via a @code{section}
23235 attribute.
23236
23237 @item global
23238 As for @samp{local}, but also generate GP-relative accesses for
23239 small data objects that are external, weak, or common. If you use this option,
23240 you must ensure that all parts of your program (including libraries) are
23241 compiled with the same @option{-G} setting.
23242
23243 @item data
23244 Generate GP-relative accesses for all data objects in the program. If you
23245 use this option, the entire data and BSS segments
23246 of your program must fit in 64K of memory and you must use an appropriate
23247 linker script to allocate them within the addressable range of the
23248 global pointer.
23249
23250 @item all
23251 Generate GP-relative addresses for function pointers as well as data
23252 pointers. If you use this option, the entire text, data, and BSS segments
23253 of your program must fit in 64K of memory and you must use an appropriate
23254 linker script to allocate them within the addressable range of the
23255 global pointer.
23256
23257 @end table
23258
23259 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
23260 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
23261
23262 The default is @option{-mgpopt} except when @option{-fpic} or
23263 @option{-fPIC} is specified to generate position-independent code.
23264 Note that the Nios II ABI does not permit GP-relative accesses from
23265 shared libraries.
23266
23267 You may need to specify @option{-mno-gpopt} explicitly when building
23268 programs that include large amounts of small data, including large
23269 GOT data sections. In this case, the 16-bit offset for GP-relative
23270 addressing may not be large enough to allow access to the entire
23271 small data section.
23272
23273 @item -mgprel-sec=@var{regexp}
23274 @opindex mgprel-sec
23275 This option specifies additional section names that can be accessed via
23276 GP-relative addressing. It is most useful in conjunction with
23277 @code{section} attributes on variable declarations
23278 (@pxref{Common Variable Attributes}) and a custom linker script.
23279 The @var{regexp} is a POSIX Extended Regular Expression.
23280
23281 This option does not affect the behavior of the @option{-G} option, and
23282 the specified sections are in addition to the standard @code{.sdata}
23283 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
23284
23285 @item -mr0rel-sec=@var{regexp}
23286 @opindex mr0rel-sec
23287 This option specifies names of sections that can be accessed via a
23288 16-bit offset from @code{r0}; that is, in the low 32K or high 32K
23289 of the 32-bit address space. It is most useful in conjunction with
23290 @code{section} attributes on variable declarations
23291 (@pxref{Common Variable Attributes}) and a custom linker script.
23292 The @var{regexp} is a POSIX Extended Regular Expression.
23293
23294 In contrast to the use of GP-relative addressing for small data,
23295 zero-based addressing is never generated by default and there are no
23296 conventional section names used in standard linker scripts for sections
23297 in the low or high areas of memory.
23298
23299 @item -mel
23300 @itemx -meb
23301 @opindex mel
23302 @opindex meb
23303 Generate little-endian (default) or big-endian (experimental) code,
23304 respectively.
23305
23306 @item -march=@var{arch}
23307 @opindex march
23308 This specifies the name of the target Nios II architecture. GCC uses this
23309 name to determine what kind of instructions it can emit when generating
23310 assembly code. Permissible names are: @samp{r1}, @samp{r2}.
23311
23312 The preprocessor macro @code{__nios2_arch__} is available to programs,
23313 with value 1 or 2, indicating the targeted ISA level.
23314
23315 @item -mbypass-cache
23316 @itemx -mno-bypass-cache
23317 @opindex mno-bypass-cache
23318 @opindex mbypass-cache
23319 Force all load and store instructions to always bypass cache by
23320 using I/O variants of the instructions. The default is not to
23321 bypass the cache.
23322
23323 @item -mno-cache-volatile
23324 @itemx -mcache-volatile
23325 @opindex mcache-volatile
23326 @opindex mno-cache-volatile
23327 Volatile memory access bypass the cache using the I/O variants of
23328 the load and store instructions. The default is not to bypass the cache.
23329
23330 @item -mno-fast-sw-div
23331 @itemx -mfast-sw-div
23332 @opindex mno-fast-sw-div
23333 @opindex mfast-sw-div
23334 Do not use table-based fast divide for small numbers. The default
23335 is to use the fast divide at @option{-O3} and above.
23336
23337 @item -mno-hw-mul
23338 @itemx -mhw-mul
23339 @itemx -mno-hw-mulx
23340 @itemx -mhw-mulx
23341 @itemx -mno-hw-div
23342 @itemx -mhw-div
23343 @opindex mno-hw-mul
23344 @opindex mhw-mul
23345 @opindex mno-hw-mulx
23346 @opindex mhw-mulx
23347 @opindex mno-hw-div
23348 @opindex mhw-div
23349 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of
23350 instructions by the compiler. The default is to emit @code{mul}
23351 and not emit @code{div} and @code{mulx}.
23352
23353 @item -mbmx
23354 @itemx -mno-bmx
23355 @itemx -mcdx
23356 @itemx -mno-cdx
23357 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
23358 CDX (code density) instructions. Enabling these instructions also
23359 requires @option{-march=r2}. Since these instructions are optional
23360 extensions to the R2 architecture, the default is not to emit them.
23361
23362 @item -mcustom-@var{insn}=@var{N}
23363 @itemx -mno-custom-@var{insn}
23364 @opindex mcustom-@var{insn}
23365 @opindex mno-custom-@var{insn}
23366 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
23367 custom instruction with encoding @var{N} when generating code that uses
23368 @var{insn}. For example, @option{-mcustom-fadds=253} generates custom
23369 instruction 253 for single-precision floating-point add operations instead
23370 of the default behavior of using a library call.
23371
23372 The following values of @var{insn} are supported. Except as otherwise
23373 noted, floating-point operations are expected to be implemented with
23374 normal IEEE 754 semantics and correspond directly to the C operators or the
23375 equivalent GCC built-in functions (@pxref{Other Builtins}).
23376
23377 Single-precision floating point:
23378 @table @asis
23379
23380 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
23381 Binary arithmetic operations.
23382
23383 @item @samp{fnegs}
23384 Unary negation.
23385
23386 @item @samp{fabss}
23387 Unary absolute value.
23388
23389 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
23390 Comparison operations.
23391
23392 @item @samp{fmins}, @samp{fmaxs}
23393 Floating-point minimum and maximum. These instructions are only
23394 generated if @option{-ffinite-math-only} is specified.
23395
23396 @item @samp{fsqrts}
23397 Unary square root operation.
23398
23399 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
23400 Floating-point trigonometric and exponential functions. These instructions
23401 are only generated if @option{-funsafe-math-optimizations} is also specified.
23402
23403 @end table
23404
23405 Double-precision floating point:
23406 @table @asis
23407
23408 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
23409 Binary arithmetic operations.
23410
23411 @item @samp{fnegd}
23412 Unary negation.
23413
23414 @item @samp{fabsd}
23415 Unary absolute value.
23416
23417 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
23418 Comparison operations.
23419
23420 @item @samp{fmind}, @samp{fmaxd}
23421 Double-precision minimum and maximum. These instructions are only
23422 generated if @option{-ffinite-math-only} is specified.
23423
23424 @item @samp{fsqrtd}
23425 Unary square root operation.
23426
23427 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
23428 Double-precision trigonometric and exponential functions. These instructions
23429 are only generated if @option{-funsafe-math-optimizations} is also specified.
23430
23431 @end table
23432
23433 Conversions:
23434 @table @asis
23435 @item @samp{fextsd}
23436 Conversion from single precision to double precision.
23437
23438 @item @samp{ftruncds}
23439 Conversion from double precision to single precision.
23440
23441 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
23442 Conversion from floating point to signed or unsigned integer types, with
23443 truncation towards zero.
23444
23445 @item @samp{round}
23446 Conversion from single-precision floating point to signed integer,
23447 rounding to the nearest integer and ties away from zero.
23448 This corresponds to the @code{__builtin_lroundf} function when
23449 @option{-fno-math-errno} is used.
23450
23451 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
23452 Conversion from signed or unsigned integer types to floating-point types.
23453
23454 @end table
23455
23456 In addition, all of the following transfer instructions for internal
23457 registers X and Y must be provided to use any of the double-precision
23458 floating-point instructions. Custom instructions taking two
23459 double-precision source operands expect the first operand in the
23460 64-bit register X. The other operand (or only operand of a unary
23461 operation) is given to the custom arithmetic instruction with the
23462 least significant half in source register @var{src1} and the most
23463 significant half in @var{src2}. A custom instruction that returns a
23464 double-precision result returns the most significant 32 bits in the
23465 destination register and the other half in 32-bit register Y.
23466 GCC automatically generates the necessary code sequences to write
23467 register X and/or read register Y when double-precision floating-point
23468 instructions are used.
23469
23470 @table @asis
23471
23472 @item @samp{fwrx}
23473 Write @var{src1} into the least significant half of X and @var{src2} into
23474 the most significant half of X.
23475
23476 @item @samp{fwry}
23477 Write @var{src1} into Y.
23478
23479 @item @samp{frdxhi}, @samp{frdxlo}
23480 Read the most or least (respectively) significant half of X and store it in
23481 @var{dest}.
23482
23483 @item @samp{frdy}
23484 Read the value of Y and store it into @var{dest}.
23485 @end table
23486
23487 Note that you can gain more local control over generation of Nios II custom
23488 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
23489 and @code{target("no-custom-@var{insn}")} function attributes
23490 (@pxref{Function Attributes})
23491 or pragmas (@pxref{Function Specific Option Pragmas}).
23492
23493 @item -mcustom-fpu-cfg=@var{name}
23494 @opindex mcustom-fpu-cfg
23495
23496 This option enables a predefined, named set of custom instruction encodings
23497 (see @option{-mcustom-@var{insn}} above).
23498 Currently, the following sets are defined:
23499
23500 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
23501 @gccoptlist{-mcustom-fmuls=252 @gol
23502 -mcustom-fadds=253 @gol
23503 -mcustom-fsubs=254 @gol
23504 -fsingle-precision-constant}
23505
23506 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
23507 @gccoptlist{-mcustom-fmuls=252 @gol
23508 -mcustom-fadds=253 @gol
23509 -mcustom-fsubs=254 @gol
23510 -mcustom-fdivs=255 @gol
23511 -fsingle-precision-constant}
23512
23513 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
23514 @gccoptlist{-mcustom-floatus=243 @gol
23515 -mcustom-fixsi=244 @gol
23516 -mcustom-floatis=245 @gol
23517 -mcustom-fcmpgts=246 @gol
23518 -mcustom-fcmples=249 @gol
23519 -mcustom-fcmpeqs=250 @gol
23520 -mcustom-fcmpnes=251 @gol
23521 -mcustom-fmuls=252 @gol
23522 -mcustom-fadds=253 @gol
23523 -mcustom-fsubs=254 @gol
23524 -mcustom-fdivs=255 @gol
23525 -fsingle-precision-constant}
23526
23527 Custom instruction assignments given by individual
23528 @option{-mcustom-@var{insn}=} options override those given by
23529 @option{-mcustom-fpu-cfg=}, regardless of the
23530 order of the options on the command line.
23531
23532 Note that you can gain more local control over selection of a FPU
23533 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
23534 function attribute (@pxref{Function Attributes})
23535 or pragma (@pxref{Function Specific Option Pragmas}).
23536
23537 @end table
23538
23539 These additional @samp{-m} options are available for the Altera Nios II
23540 ELF (bare-metal) target:
23541
23542 @table @gcctabopt
23543
23544 @item -mhal
23545 @opindex mhal
23546 Link with HAL BSP. This suppresses linking with the GCC-provided C runtime
23547 startup and termination code, and is typically used in conjunction with
23548 @option{-msys-crt0=} to specify the location of the alternate startup code
23549 provided by the HAL BSP.
23550
23551 @item -msmallc
23552 @opindex msmallc
23553 Link with a limited version of the C library, @option{-lsmallc}, rather than
23554 Newlib.
23555
23556 @item -msys-crt0=@var{startfile}
23557 @opindex msys-crt0
23558 @var{startfile} is the file name of the startfile (crt0) to use
23559 when linking. This option is only useful in conjunction with @option{-mhal}.
23560
23561 @item -msys-lib=@var{systemlib}
23562 @opindex msys-lib
23563 @var{systemlib} is the library name of the library that provides
23564 low-level system calls required by the C library,
23565 e.g.@: @code{read} and @code{write}.
23566 This option is typically used to link with a library provided by a HAL BSP.
23567
23568 @end table
23569
23570 @node Nvidia PTX Options
23571 @subsection Nvidia PTX Options
23572 @cindex Nvidia PTX options
23573 @cindex nvptx options
23574
23575 These options are defined for Nvidia PTX:
23576
23577 @table @gcctabopt
23578
23579 @item -m32
23580 @itemx -m64
23581 @opindex m32
23582 @opindex m64
23583 Generate code for 32-bit or 64-bit ABI.
23584
23585 @item -misa=@var{ISA-string}
23586 @opindex march
23587 Generate code for given the specified PTX ISA (e.g.@: @samp{sm_35}). ISA
23588 strings must be lower-case. Valid ISA strings include @samp{sm_30} and
23589 @samp{sm_35}. The default ISA is sm_30.
23590
23591 @item -mmainkernel
23592 @opindex mmainkernel
23593 Link in code for a __main kernel. This is for stand-alone instead of
23594 offloading execution.
23595
23596 @item -moptimize
23597 @opindex moptimize
23598 Apply partitioned execution optimizations. This is the default when any
23599 level of optimization is selected.
23600
23601 @item -msoft-stack
23602 @opindex msoft-stack
23603 Generate code that does not use @code{.local} memory
23604 directly for stack storage. Instead, a per-warp stack pointer is
23605 maintained explicitly. This enables variable-length stack allocation (with
23606 variable-length arrays or @code{alloca}), and when global memory is used for
23607 underlying storage, makes it possible to access automatic variables from other
23608 threads, or with atomic instructions. This code generation variant is used
23609 for OpenMP offloading, but the option is exposed on its own for the purpose
23610 of testing the compiler; to generate code suitable for linking into programs
23611 using OpenMP offloading, use option @option{-mgomp}.
23612
23613 @item -muniform-simt
23614 @opindex muniform-simt
23615 Switch to code generation variant that allows to execute all threads in each
23616 warp, while maintaining memory state and side effects as if only one thread
23617 in each warp was active outside of OpenMP SIMD regions. All atomic operations
23618 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
23619 current lane index equals the master lane index), and the register being
23620 assigned is copied via a shuffle instruction from the master lane. Outside of
23621 SIMD regions lane 0 is the master; inside, each thread sees itself as the
23622 master. Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
23623 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
23624 regions). Each thread can bitwise-and the bitmask at position @code{tid.y}
23625 with current lane index to compute the master lane index.
23626
23627 @item -mgomp
23628 @opindex mgomp
23629 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
23630 @option{-muniform-simt} options, and selects corresponding multilib variant.
23631
23632 @end table
23633
23634 @node OpenRISC Options
23635 @subsection OpenRISC Options
23636 @cindex OpenRISC Options
23637
23638 These options are defined for OpenRISC:
23639
23640 @table @gcctabopt
23641
23642 @item -mboard=@var{name}
23643 @opindex mboard
23644 Configure a board specific runtime. This will be passed to the linker for
23645 newlib board library linking. The default is @code{or1ksim}.
23646
23647 @item -mnewlib
23648 @opindex mnewlib
23649 For compatibility, it's always newlib for elf now.
23650
23651 @item -mhard-div
23652 @opindex mhard-div
23653 Generate code for hardware which supports divide instructions. This is the
23654 default.
23655
23656 @item -mhard-mul
23657 @opindex mhard-mul
23658 Generate code for hardware which supports multiply instructions. This is the
23659 default.
23660
23661 @item -mcmov
23662 @opindex mcmov
23663 Generate code for hardware which supports the conditional move (@code{l.cmov})
23664 instruction.
23665
23666 @item -mror
23667 @opindex mror
23668 Generate code for hardware which supports rotate right instructions.
23669
23670 @item -msext
23671 @opindex msext
23672 Generate code for hardware which supports sign-extension instructions.
23673
23674 @item -msfimm
23675 @opindex msfimm
23676 Generate code for hardware which supports set flag immediate (@code{l.sf*i})
23677 instructions.
23678
23679 @item -mshftimm
23680 @opindex mshftimm
23681 Generate code for hardware which supports shift immediate related instructions
23682 (i.e. @code{l.srai}, @code{l.srli}, @code{l.slli}, @code{1.rori}). Note, to
23683 enable generation of the @code{l.rori} instruction the @option{-mror} flag must
23684 also be specified.
23685
23686 @item -msoft-div
23687 @opindex msoft-div
23688 Generate code for hardware which requires divide instruction emulation.
23689
23690 @item -msoft-mul
23691 @opindex msoft-mul
23692 Generate code for hardware which requires multiply instruction emulation.
23693
23694 @end table
23695
23696 @node PDP-11 Options
23697 @subsection PDP-11 Options
23698 @cindex PDP-11 Options
23699
23700 These options are defined for the PDP-11:
23701
23702 @table @gcctabopt
23703 @item -mfpu
23704 @opindex mfpu
23705 Use hardware FPP floating point. This is the default. (FIS floating
23706 point on the PDP-11/40 is not supported.) Implies -m45.
23707
23708 @item -msoft-float
23709 @opindex msoft-float
23710 Do not use hardware floating point.
23711
23712 @item -mac0
23713 @opindex mac0
23714 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
23715
23716 @item -mno-ac0
23717 @opindex mno-ac0
23718 Return floating-point results in memory. This is the default.
23719
23720 @item -m40
23721 @opindex m40
23722 Generate code for a PDP-11/40. Implies -msoft-float -mno-split.
23723
23724 @item -m45
23725 @opindex m45
23726 Generate code for a PDP-11/45. This is the default.
23727
23728 @item -m10
23729 @opindex m10
23730 Generate code for a PDP-11/10. Implies -msoft-float -mno-split.
23731
23732 @item -mint16
23733 @itemx -mno-int32
23734 @opindex mint16
23735 @opindex mno-int32
23736 Use 16-bit @code{int}. This is the default.
23737
23738 @item -mint32
23739 @itemx -mno-int16
23740 @opindex mint32
23741 @opindex mno-int16
23742 Use 32-bit @code{int}.
23743
23744 @item -msplit
23745 @opindex msplit
23746 Target has split instruction and data space. Implies -m45.
23747
23748 @item -munix-asm
23749 @opindex munix-asm
23750 Use Unix assembler syntax.
23751
23752 @item -mdec-asm
23753 @opindex mdec-asm
23754 Use DEC assembler syntax.
23755
23756 @item -mgnu-asm
23757 @opindex mgnu-asm
23758 Use GNU assembler syntax. This is the default.
23759
23760 @item -mlra
23761 @opindex mlra
23762 Use the new LRA register allocator. By default, the old ``reload''
23763 allocator is used.
23764 @end table
23765
23766 @node picoChip Options
23767 @subsection picoChip Options
23768 @cindex picoChip options
23769
23770 These @samp{-m} options are defined for picoChip implementations:
23771
23772 @table @gcctabopt
23773
23774 @item -mae=@var{ae_type}
23775 @opindex mcpu
23776 Set the instruction set, register set, and instruction scheduling
23777 parameters for array element type @var{ae_type}. Supported values
23778 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
23779
23780 @option{-mae=ANY} selects a completely generic AE type. Code
23781 generated with this option runs on any of the other AE types. The
23782 code is not as efficient as it would be if compiled for a specific
23783 AE type, and some types of operation (e.g., multiplication) do not
23784 work properly on all types of AE.
23785
23786 @option{-mae=MUL} selects a MUL AE type. This is the most useful AE type
23787 for compiled code, and is the default.
23788
23789 @option{-mae=MAC} selects a DSP-style MAC AE. Code compiled with this
23790 option may suffer from poor performance of byte (char) manipulation,
23791 since the DSP AE does not provide hardware support for byte load/stores.
23792
23793 @item -msymbol-as-address
23794 Enable the compiler to directly use a symbol name as an address in a
23795 load/store instruction, without first loading it into a
23796 register. Typically, the use of this option generates larger
23797 programs, which run faster than when the option isn't used. However, the
23798 results vary from program to program, so it is left as a user option,
23799 rather than being permanently enabled.
23800
23801 @item -mno-inefficient-warnings
23802 Disables warnings about the generation of inefficient code. These
23803 warnings can be generated, for example, when compiling code that
23804 performs byte-level memory operations on the MAC AE type. The MAC AE has
23805 no hardware support for byte-level memory operations, so all byte
23806 load/stores must be synthesized from word load/store operations. This is
23807 inefficient and a warning is generated to indicate
23808 that you should rewrite the code to avoid byte operations, or to target
23809 an AE type that has the necessary hardware support. This option disables
23810 these warnings.
23811
23812 @end table
23813
23814 @node PowerPC Options
23815 @subsection PowerPC Options
23816 @cindex PowerPC options
23817
23818 These are listed under @xref{RS/6000 and PowerPC Options}.
23819
23820 @node PRU Options
23821 @subsection PRU Options
23822 @cindex PRU Options
23823
23824 These command-line options are defined for PRU target:
23825
23826 @table @gcctabopt
23827 @item -minrt
23828 @opindex minrt
23829 Link with a minimum runtime environment, with no support for static
23830 initializers and constructors. Using this option can significantly reduce
23831 the size of the final ELF binary. Beware that the compiler could still
23832 generate code with static initializers and constructors. It is up to the
23833 programmer to ensure that the source program will not use those features.
23834
23835 @item -mmcu=@var{mcu}
23836 @opindex mmcu
23837 Specify the PRU MCU variant to use. Check Newlib for the exact list of
23838 supported MCUs.
23839
23840 @item -mno-relax
23841 @opindex mno-relax
23842 Make GCC pass the @option{--no-relax} command-line option to the linker
23843 instead of the @option{--relax} option.
23844
23845 @item -mloop
23846 @opindex mloop
23847 Allow (or do not allow) GCC to use the LOOP instruction.
23848
23849 @item -mabi=@var{variant}
23850 @opindex mabi
23851 Specify the ABI variant to output code for. @option{-mabi=ti} selects the
23852 unmodified TI ABI while @option{-mabi=gnu} selects a GNU variant that copes
23853 more naturally with certain GCC assumptions. These are the differences:
23854
23855 @table @samp
23856 @item Function Pointer Size
23857 TI ABI specifies that function (code) pointers are 16-bit, whereas GNU
23858 supports only 32-bit data and code pointers.
23859
23860 @item Optional Return Value Pointer
23861 Function return values larger than 64 bits are passed by using a hidden
23862 pointer as the first argument of the function. TI ABI, though, mandates that
23863 the pointer can be NULL in case the caller is not using the returned value.
23864 GNU always passes and expects a valid return value pointer.
23865
23866 @end table
23867
23868 The current @option{-mabi=ti} implementation simply raises a compile error
23869 when any of the above code constructs is detected. As a consequence
23870 the standard C library cannot be built and it is omitted when linking with
23871 @option{-mabi=ti}.
23872
23873 Relaxation is a GNU feature and for safety reasons is disabled when using
23874 @option{-mabi=ti}. The TI toolchain does not emit relocations for QBBx
23875 instructions, so the GNU linker cannot adjust them when shortening adjacent
23876 LDI32 pseudo instructions.
23877
23878 @end table
23879
23880 @node RISC-V Options
23881 @subsection RISC-V Options
23882 @cindex RISC-V Options
23883
23884 These command-line options are defined for RISC-V targets:
23885
23886 @table @gcctabopt
23887 @item -mbranch-cost=@var{n}
23888 @opindex mbranch-cost
23889 Set the cost of branches to roughly @var{n} instructions.
23890
23891 @item -mplt
23892 @itemx -mno-plt
23893 @opindex plt
23894 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23895 non-PIC. The default is @option{-mplt}.
23896
23897 @item -mabi=@var{ABI-string}
23898 @opindex mabi
23899 Specify integer and floating-point calling convention. @var{ABI-string}
23900 contains two parts: the size of integer types and the registers used for
23901 floating-point types. For example @samp{-march=rv64ifd -mabi=lp64d} means that
23902 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23903 32-bit), and that floating-point values up to 64 bits wide are passed in F
23904 registers. Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23905 allows the compiler to generate code that uses the F and D extensions but only
23906 allows floating-point values up to 32 bits long to be passed in registers; or
23907 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23908 passed in registers.
23909
23910 The default for this argument is system dependent, users who want a specific
23911 calling convention should specify one explicitly. The valid calling
23912 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23913 @samp{lp64f}, and @samp{lp64d}. Some calling conventions are impossible to
23914 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23915 invalid because the ABI requires 64-bit values be passed in F registers, but F
23916 registers are only 32 bits wide. There is also the @samp{ilp32e} ABI that can
23917 only be used with the @samp{rv32e} architecture. This ABI is not well
23918 specified at present, and is subject to change.
23919
23920 @item -mfdiv
23921 @itemx -mno-fdiv
23922 @opindex mfdiv
23923 Do or don't use hardware floating-point divide and square root instructions.
23924 This requires the F or D extensions for floating-point registers. The default
23925 is to use them if the specified architecture has these instructions.
23926
23927 @item -mdiv
23928 @itemx -mno-div
23929 @opindex mdiv
23930 Do or don't use hardware instructions for integer division. This requires the
23931 M extension. The default is to use them if the specified architecture has
23932 these instructions.
23933
23934 @item -march=@var{ISA-string}
23935 @opindex march
23936 Generate code for given RISC-V ISA (e.g.@: @samp{rv64im}). ISA strings must be
23937 lower-case. Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
23938 @samp{rv32imaf}.
23939
23940 @item -mtune=@var{processor-string}
23941 @opindex mtune
23942 Optimize the output for the given processor, specified by microarchitecture
23943 name. Permissible values for this option are: @samp{rocket},
23944 @samp{sifive-3-series}, @samp{sifive-5-series}, @samp{sifive-7-series},
23945 and @samp{size}.
23946
23947 When @option{-mtune=} is not specified, the default is @samp{rocket}.
23948
23949 The @samp{size} choice is not intended for use by end-users. This is used
23950 when @option{-Os} is specified. It overrides the instruction cost info
23951 provided by @option{-mtune=}, but does not override the pipeline info. This
23952 helps reduce code size while still giving good performance.
23953
23954 @item -mpreferred-stack-boundary=@var{num}
23955 @opindex mpreferred-stack-boundary
23956 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23957 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
23958 the default is 4 (16 bytes or 128-bits).
23959
23960 @strong{Warning:} If you use this switch, then you must build all modules with
23961 the same value, including any libraries. This includes the system libraries
23962 and startup modules.
23963
23964 @item -msmall-data-limit=@var{n}
23965 @opindex msmall-data-limit
23966 Put global and static data smaller than @var{n} bytes into a special section
23967 (on some targets).
23968
23969 @item -msave-restore
23970 @itemx -mno-save-restore
23971 @opindex msave-restore
23972 Do or don't use smaller but slower prologue and epilogue code that uses
23973 library function calls. The default is to use fast inline prologues and
23974 epilogues.
23975
23976 @item -mstrict-align
23977 @itemx -mno-strict-align
23978 @opindex mstrict-align
23979 Do not or do generate unaligned memory accesses. The default is set depending
23980 on whether the processor we are optimizing for supports fast unaligned access
23981 or not.
23982
23983 @item -mcmodel=medlow
23984 @opindex mcmodel=medlow
23985 Generate code for the medium-low code model. The program and its statically
23986 defined symbols must lie within a single 2 GiB address range and must lie
23987 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23988 statically or dynamically linked. This is the default code model.
23989
23990 @item -mcmodel=medany
23991 @opindex mcmodel=medany
23992 Generate code for the medium-any code model. The program and its statically
23993 defined symbols must be within any single 2 GiB address range. Programs can be
23994 statically or dynamically linked.
23995
23996 @item -mexplicit-relocs
23997 @itemx -mno-exlicit-relocs
23998 Use or do not use assembler relocation operators when dealing with symbolic
23999 addresses. The alternative is to use assembler macros instead, which may
24000 limit optimization.
24001
24002 @item -mrelax
24003 @itemx -mno-relax
24004 Take advantage of linker relaxations to reduce the number of instructions
24005 required to materialize symbol addresses. The default is to take advantage of
24006 linker relaxations.
24007
24008 @item -memit-attribute
24009 @itemx -mno-emit-attribute
24010 Emit (do not emit) RISC-V attribute to record extra information into ELF
24011 objects. This feature requires at least binutils 2.32.
24012 @end table
24013
24014 @node RL78 Options
24015 @subsection RL78 Options
24016 @cindex RL78 Options
24017
24018 @table @gcctabopt
24019
24020 @item -msim
24021 @opindex msim
24022 Links in additional target libraries to support operation within a
24023 simulator.
24024
24025 @item -mmul=none
24026 @itemx -mmul=g10
24027 @itemx -mmul=g13
24028 @itemx -mmul=g14
24029 @itemx -mmul=rl78
24030 @opindex mmul
24031 Specifies the type of hardware multiplication and division support to
24032 be used. The simplest is @code{none}, which uses software for both
24033 multiplication and division. This is the default. The @code{g13}
24034 value is for the hardware multiply/divide peripheral found on the
24035 RL78/G13 (S2 core) targets. The @code{g14} value selects the use of
24036 the multiplication and division instructions supported by the RL78/G14
24037 (S3 core) parts. The value @code{rl78} is an alias for @code{g14} and
24038 the value @code{mg10} is an alias for @code{none}.
24039
24040 In addition a C preprocessor macro is defined, based upon the setting
24041 of this option. Possible values are: @code{__RL78_MUL_NONE__},
24042 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
24043
24044 @item -mcpu=g10
24045 @itemx -mcpu=g13
24046 @itemx -mcpu=g14
24047 @itemx -mcpu=rl78
24048 @opindex mcpu
24049 Specifies the RL78 core to target. The default is the G14 core, also
24050 known as an S3 core or just RL78. The G13 or S2 core does not have
24051 multiply or divide instructions, instead it uses a hardware peripheral
24052 for these operations. The G10 or S1 core does not have register
24053 banks, so it uses a different calling convention.
24054
24055 If this option is set it also selects the type of hardware multiply
24056 support to use, unless this is overridden by an explicit
24057 @option{-mmul=none} option on the command line. Thus specifying
24058 @option{-mcpu=g13} enables the use of the G13 hardware multiply
24059 peripheral and specifying @option{-mcpu=g10} disables the use of
24060 hardware multiplications altogether.
24061
24062 Note, although the RL78/G14 core is the default target, specifying
24063 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
24064 change the behavior of the toolchain since it also enables G14
24065 hardware multiply support. If these options are not specified on the
24066 command line then software multiplication routines will be used even
24067 though the code targets the RL78 core. This is for backwards
24068 compatibility with older toolchains which did not have hardware
24069 multiply and divide support.
24070
24071 In addition a C preprocessor macro is defined, based upon the setting
24072 of this option. Possible values are: @code{__RL78_G10__},
24073 @code{__RL78_G13__} or @code{__RL78_G14__}.
24074
24075 @item -mg10
24076 @itemx -mg13
24077 @itemx -mg14
24078 @itemx -mrl78
24079 @opindex mg10
24080 @opindex mg13
24081 @opindex mg14
24082 @opindex mrl78
24083 These are aliases for the corresponding @option{-mcpu=} option. They
24084 are provided for backwards compatibility.
24085
24086 @item -mallregs
24087 @opindex mallregs
24088 Allow the compiler to use all of the available registers. By default
24089 registers @code{r24..r31} are reserved for use in interrupt handlers.
24090 With this option enabled these registers can be used in ordinary
24091 functions as well.
24092
24093 @item -m64bit-doubles
24094 @itemx -m32bit-doubles
24095 @opindex m64bit-doubles
24096 @opindex m32bit-doubles
24097 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24098 or 32 bits (@option{-m32bit-doubles}) in size. The default is
24099 @option{-m32bit-doubles}.
24100
24101 @item -msave-mduc-in-interrupts
24102 @itemx -mno-save-mduc-in-interrupts
24103 @opindex msave-mduc-in-interrupts
24104 @opindex mno-save-mduc-in-interrupts
24105 Specifies that interrupt handler functions should preserve the
24106 MDUC registers. This is only necessary if normal code might use
24107 the MDUC registers, for example because it performs multiplication
24108 and division operations. The default is to ignore the MDUC registers
24109 as this makes the interrupt handlers faster. The target option -mg13
24110 needs to be passed for this to work as this feature is only available
24111 on the G13 target (S2 core). The MDUC registers will only be saved
24112 if the interrupt handler performs a multiplication or division
24113 operation or it calls another function.
24114
24115 @end table
24116
24117 @node RS/6000 and PowerPC Options
24118 @subsection IBM RS/6000 and PowerPC Options
24119 @cindex RS/6000 and PowerPC Options
24120 @cindex IBM RS/6000 and PowerPC Options
24121
24122 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
24123 @table @gcctabopt
24124 @item -mpowerpc-gpopt
24125 @itemx -mno-powerpc-gpopt
24126 @itemx -mpowerpc-gfxopt
24127 @itemx -mno-powerpc-gfxopt
24128 @need 800
24129 @itemx -mpowerpc64
24130 @itemx -mno-powerpc64
24131 @itemx -mmfcrf
24132 @itemx -mno-mfcrf
24133 @itemx -mpopcntb
24134 @itemx -mno-popcntb
24135 @itemx -mpopcntd
24136 @itemx -mno-popcntd
24137 @itemx -mfprnd
24138 @itemx -mno-fprnd
24139 @need 800
24140 @itemx -mcmpb
24141 @itemx -mno-cmpb
24142 @itemx -mhard-dfp
24143 @itemx -mno-hard-dfp
24144 @opindex mpowerpc-gpopt
24145 @opindex mno-powerpc-gpopt
24146 @opindex mpowerpc-gfxopt
24147 @opindex mno-powerpc-gfxopt
24148 @opindex mpowerpc64
24149 @opindex mno-powerpc64
24150 @opindex mmfcrf
24151 @opindex mno-mfcrf
24152 @opindex mpopcntb
24153 @opindex mno-popcntb
24154 @opindex mpopcntd
24155 @opindex mno-popcntd
24156 @opindex mfprnd
24157 @opindex mno-fprnd
24158 @opindex mcmpb
24159 @opindex mno-cmpb
24160 @opindex mhard-dfp
24161 @opindex mno-hard-dfp
24162 You use these options to specify which instructions are available on the
24163 processor you are using. The default value of these options is
24164 determined when configuring GCC@. Specifying the
24165 @option{-mcpu=@var{cpu_type}} overrides the specification of these
24166 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
24167 rather than the options listed above.
24168
24169 Specifying @option{-mpowerpc-gpopt} allows
24170 GCC to use the optional PowerPC architecture instructions in the
24171 General Purpose group, including floating-point square root. Specifying
24172 @option{-mpowerpc-gfxopt} allows GCC to
24173 use the optional PowerPC architecture instructions in the Graphics
24174 group, including floating-point select.
24175
24176 The @option{-mmfcrf} option allows GCC to generate the move from
24177 condition register field instruction implemented on the POWER4
24178 processor and other processors that support the PowerPC V2.01
24179 architecture.
24180 The @option{-mpopcntb} option allows GCC to generate the popcount and
24181 double-precision FP reciprocal estimate instruction implemented on the
24182 POWER5 processor and other processors that support the PowerPC V2.02
24183 architecture.
24184 The @option{-mpopcntd} option allows GCC to generate the popcount
24185 instruction implemented on the POWER7 processor and other processors
24186 that support the PowerPC V2.06 architecture.
24187 The @option{-mfprnd} option allows GCC to generate the FP round to
24188 integer instructions implemented on the POWER5+ processor and other
24189 processors that support the PowerPC V2.03 architecture.
24190 The @option{-mcmpb} option allows GCC to generate the compare bytes
24191 instruction implemented on the POWER6 processor and other processors
24192 that support the PowerPC V2.05 architecture.
24193 The @option{-mhard-dfp} option allows GCC to generate the decimal
24194 floating-point instructions implemented on some POWER processors.
24195
24196 The @option{-mpowerpc64} option allows GCC to generate the additional
24197 64-bit instructions that are found in the full PowerPC64 architecture
24198 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
24199 @option{-mno-powerpc64}.
24200
24201 @item -mcpu=@var{cpu_type}
24202 @opindex mcpu
24203 Set architecture type, register usage, and
24204 instruction scheduling parameters for machine type @var{cpu_type}.
24205 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
24206 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
24207 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
24208 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
24209 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
24210 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
24211 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
24212 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
24213 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
24214 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
24215 @samp{power9}, @samp{future}, @samp{powerpc}, @samp{powerpc64},
24216 @samp{powerpc64le}, @samp{rs64}, and @samp{native}.
24217
24218 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
24219 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
24220 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
24221 architecture machine types, with an appropriate, generic processor
24222 model assumed for scheduling purposes.
24223
24224 Specifying @samp{native} as cpu type detects and selects the
24225 architecture option that corresponds to the host processor of the
24226 system performing the compilation.
24227 @option{-mcpu=native} has no effect if GCC does not recognize the
24228 processor.
24229
24230 The other options specify a specific processor. Code generated under
24231 those options runs best on that processor, and may not run at all on
24232 others.
24233
24234 The @option{-mcpu} options automatically enable or disable the
24235 following options:
24236
24237 @gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple @gol
24238 -mpopcntb -mpopcntd -mpowerpc64 @gol
24239 -mpowerpc-gpopt -mpowerpc-gfxopt @gol
24240 -mmulhw -mdlmzb -mmfpgpr -mvsx @gol
24241 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
24242 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
24243
24244 The particular options set for any particular CPU varies between
24245 compiler versions, depending on what setting seems to produce optimal
24246 code for that CPU; it doesn't necessarily reflect the actual hardware's
24247 capabilities. If you wish to set an individual option to a particular
24248 value, you may specify it after the @option{-mcpu} option, like
24249 @option{-mcpu=970 -mno-altivec}.
24250
24251 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
24252 not enabled or disabled by the @option{-mcpu} option at present because
24253 AIX does not have full support for these options. You may still
24254 enable or disable them individually if you're sure it'll work in your
24255 environment.
24256
24257 @item -mtune=@var{cpu_type}
24258 @opindex mtune
24259 Set the instruction scheduling parameters for machine type
24260 @var{cpu_type}, but do not set the architecture type or register usage,
24261 as @option{-mcpu=@var{cpu_type}} does. The same
24262 values for @var{cpu_type} are used for @option{-mtune} as for
24263 @option{-mcpu}. If both are specified, the code generated uses the
24264 architecture and registers set by @option{-mcpu}, but the
24265 scheduling parameters set by @option{-mtune}.
24266
24267 @item -mcmodel=small
24268 @opindex mcmodel=small
24269 Generate PowerPC64 code for the small model: The TOC is limited to
24270 64k.
24271
24272 @item -mcmodel=medium
24273 @opindex mcmodel=medium
24274 Generate PowerPC64 code for the medium model: The TOC and other static
24275 data may be up to a total of 4G in size. This is the default for 64-bit
24276 Linux.
24277
24278 @item -mcmodel=large
24279 @opindex mcmodel=large
24280 Generate PowerPC64 code for the large model: The TOC may be up to 4G
24281 in size. Other data and code is only limited by the 64-bit address
24282 space.
24283
24284 @item -maltivec
24285 @itemx -mno-altivec
24286 @opindex maltivec
24287 @opindex mno-altivec
24288 Generate code that uses (does not use) AltiVec instructions, and also
24289 enable the use of built-in functions that allow more direct access to
24290 the AltiVec instruction set. You may also need to set
24291 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
24292 enhancements.
24293
24294 When @option{-maltivec} is used, the element order for AltiVec intrinsics
24295 such as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert}
24296 match array element order corresponding to the endianness of the
24297 target. That is, element zero identifies the leftmost element in a
24298 vector register when targeting a big-endian platform, and identifies
24299 the rightmost element in a vector register when targeting a
24300 little-endian platform.
24301
24302 @item -mvrsave
24303 @itemx -mno-vrsave
24304 @opindex mvrsave
24305 @opindex mno-vrsave
24306 Generate VRSAVE instructions when generating AltiVec code.
24307
24308 @item -msecure-plt
24309 @opindex msecure-plt
24310 Generate code that allows @command{ld} and @command{ld.so}
24311 to build executables and shared
24312 libraries with non-executable @code{.plt} and @code{.got} sections.
24313 This is a PowerPC
24314 32-bit SYSV ABI option.
24315
24316 @item -mbss-plt
24317 @opindex mbss-plt
24318 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
24319 fills in, and
24320 requires @code{.plt} and @code{.got}
24321 sections that are both writable and executable.
24322 This is a PowerPC 32-bit SYSV ABI option.
24323
24324 @item -misel
24325 @itemx -mno-isel
24326 @opindex misel
24327 @opindex mno-isel
24328 This switch enables or disables the generation of ISEL instructions.
24329
24330 @item -mvsx
24331 @itemx -mno-vsx
24332 @opindex mvsx
24333 @opindex mno-vsx
24334 Generate code that uses (does not use) vector/scalar (VSX)
24335 instructions, and also enable the use of built-in functions that allow
24336 more direct access to the VSX instruction set.
24337
24338 @item -mcrypto
24339 @itemx -mno-crypto
24340 @opindex mcrypto
24341 @opindex mno-crypto
24342 Enable the use (disable) of the built-in functions that allow direct
24343 access to the cryptographic instructions that were added in version
24344 2.07 of the PowerPC ISA.
24345
24346 @item -mhtm
24347 @itemx -mno-htm
24348 @opindex mhtm
24349 @opindex mno-htm
24350 Enable (disable) the use of the built-in functions that allow direct
24351 access to the Hardware Transactional Memory (HTM) instructions that
24352 were added in version 2.07 of the PowerPC ISA.
24353
24354 @item -mpower8-fusion
24355 @itemx -mno-power8-fusion
24356 @opindex mpower8-fusion
24357 @opindex mno-power8-fusion
24358 Generate code that keeps (does not keeps) some integer operations
24359 adjacent so that the instructions can be fused together on power8 and
24360 later processors.
24361
24362 @item -mpower8-vector
24363 @itemx -mno-power8-vector
24364 @opindex mpower8-vector
24365 @opindex mno-power8-vector
24366 Generate code that uses (does not use) the vector and scalar
24367 instructions that were added in version 2.07 of the PowerPC ISA. Also
24368 enable the use of built-in functions that allow more direct access to
24369 the vector instructions.
24370
24371 @item -mquad-memory
24372 @itemx -mno-quad-memory
24373 @opindex mquad-memory
24374 @opindex mno-quad-memory
24375 Generate code that uses (does not use) the non-atomic quad word memory
24376 instructions. The @option{-mquad-memory} option requires use of
24377 64-bit mode.
24378
24379 @item -mquad-memory-atomic
24380 @itemx -mno-quad-memory-atomic
24381 @opindex mquad-memory-atomic
24382 @opindex mno-quad-memory-atomic
24383 Generate code that uses (does not use) the atomic quad word memory
24384 instructions. The @option{-mquad-memory-atomic} option requires use of
24385 64-bit mode.
24386
24387 @item -mfloat128
24388 @itemx -mno-float128
24389 @opindex mfloat128
24390 @opindex mno-float128
24391 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
24392 and use either software emulation for IEEE 128-bit floating point or
24393 hardware instructions.
24394
24395 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
24396 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
24397 use the IEEE 128-bit floating point support. The IEEE 128-bit
24398 floating point support only works on PowerPC Linux systems.
24399
24400 The default for @option{-mfloat128} is enabled on PowerPC Linux
24401 systems using the VSX instruction set, and disabled on other systems.
24402
24403 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
24404 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
24405 point support will also enable the generation of ISA 3.0 IEEE 128-bit
24406 floating point instructions. Otherwise, if you do not specify to
24407 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
24408 system, IEEE 128-bit floating point will be done with software
24409 emulation.
24410
24411 @item -mfloat128-hardware
24412 @itemx -mno-float128-hardware
24413 @opindex mfloat128-hardware
24414 @opindex mno-float128-hardware
24415 Enable/disable using ISA 3.0 hardware instructions to support the
24416 @var{__float128} data type.
24417
24418 The default for @option{-mfloat128-hardware} is enabled on PowerPC
24419 Linux systems using the ISA 3.0 instruction set, and disabled on other
24420 systems.
24421
24422 @item -m32
24423 @itemx -m64
24424 @opindex m32
24425 @opindex m64
24426 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
24427 targets (including GNU/Linux). The 32-bit environment sets int, long
24428 and pointer to 32 bits and generates code that runs on any PowerPC
24429 variant. The 64-bit environment sets int to 32 bits and long and
24430 pointer to 64 bits, and generates code for PowerPC64, as for
24431 @option{-mpowerpc64}.
24432
24433 @item -mfull-toc
24434 @itemx -mno-fp-in-toc
24435 @itemx -mno-sum-in-toc
24436 @itemx -mminimal-toc
24437 @opindex mfull-toc
24438 @opindex mno-fp-in-toc
24439 @opindex mno-sum-in-toc
24440 @opindex mminimal-toc
24441 Modify generation of the TOC (Table Of Contents), which is created for
24442 every executable file. The @option{-mfull-toc} option is selected by
24443 default. In that case, GCC allocates at least one TOC entry for
24444 each unique non-automatic variable reference in your program. GCC
24445 also places floating-point constants in the TOC@. However, only
24446 16,384 entries are available in the TOC@.
24447
24448 If you receive a linker error message that saying you have overflowed
24449 the available TOC space, you can reduce the amount of TOC space used
24450 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
24451 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
24452 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
24453 generate code to calculate the sum of an address and a constant at
24454 run time instead of putting that sum into the TOC@. You may specify one
24455 or both of these options. Each causes GCC to produce very slightly
24456 slower and larger code at the expense of conserving TOC space.
24457
24458 If you still run out of space in the TOC even when you specify both of
24459 these options, specify @option{-mminimal-toc} instead. This option causes
24460 GCC to make only one TOC entry for every file. When you specify this
24461 option, GCC produces code that is slower and larger but which
24462 uses extremely little TOC space. You may wish to use this option
24463 only on files that contain less frequently-executed code.
24464
24465 @item -maix64
24466 @itemx -maix32
24467 @opindex maix64
24468 @opindex maix32
24469 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
24470 @code{long} type, and the infrastructure needed to support them.
24471 Specifying @option{-maix64} implies @option{-mpowerpc64},
24472 while @option{-maix32} disables the 64-bit ABI and
24473 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
24474
24475 @item -mxl-compat
24476 @itemx -mno-xl-compat
24477 @opindex mxl-compat
24478 @opindex mno-xl-compat
24479 Produce code that conforms more closely to IBM XL compiler semantics
24480 when using AIX-compatible ABI@. Pass floating-point arguments to
24481 prototyped functions beyond the register save area (RSA) on the stack
24482 in addition to argument FPRs. Do not assume that most significant
24483 double in 128-bit long double value is properly rounded when comparing
24484 values and converting to double. Use XL symbol names for long double
24485 support routines.
24486
24487 The AIX calling convention was extended but not initially documented to
24488 handle an obscure K&R C case of calling a function that takes the
24489 address of its arguments with fewer arguments than declared. IBM XL
24490 compilers access floating-point arguments that do not fit in the
24491 RSA from the stack when a subroutine is compiled without
24492 optimization. Because always storing floating-point arguments on the
24493 stack is inefficient and rarely needed, this option is not enabled by
24494 default and only is necessary when calling subroutines compiled by IBM
24495 XL compilers without optimization.
24496
24497 @item -mpe
24498 @opindex mpe
24499 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
24500 application written to use message passing with special startup code to
24501 enable the application to run. The system must have PE installed in the
24502 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
24503 must be overridden with the @option{-specs=} option to specify the
24504 appropriate directory location. The Parallel Environment does not
24505 support threads, so the @option{-mpe} option and the @option{-pthread}
24506 option are incompatible.
24507
24508 @item -malign-natural
24509 @itemx -malign-power
24510 @opindex malign-natural
24511 @opindex malign-power
24512 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
24513 @option{-malign-natural} overrides the ABI-defined alignment of larger
24514 types, such as floating-point doubles, on their natural size-based boundary.
24515 The option @option{-malign-power} instructs GCC to follow the ABI-specified
24516 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
24517
24518 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
24519 is not supported.
24520
24521 @item -msoft-float
24522 @itemx -mhard-float
24523 @opindex msoft-float
24524 @opindex mhard-float
24525 Generate code that does not use (uses) the floating-point register set.
24526 Software floating-point emulation is provided if you use the
24527 @option{-msoft-float} option, and pass the option to GCC when linking.
24528
24529 @item -mmultiple
24530 @itemx -mno-multiple
24531 @opindex mmultiple
24532 @opindex mno-multiple
24533 Generate code that uses (does not use) the load multiple word
24534 instructions and the store multiple word instructions. These
24535 instructions are generated by default on POWER systems, and not
24536 generated on PowerPC systems. Do not use @option{-mmultiple} on little-endian
24537 PowerPC systems, since those instructions do not work when the
24538 processor is in little-endian mode. The exceptions are PPC740 and
24539 PPC750 which permit these instructions in little-endian mode.
24540
24541 @item -mupdate
24542 @itemx -mno-update
24543 @opindex mupdate
24544 @opindex mno-update
24545 Generate code that uses (does not use) the load or store instructions
24546 that update the base register to the address of the calculated memory
24547 location. These instructions are generated by default. If you use
24548 @option{-mno-update}, there is a small window between the time that the
24549 stack pointer is updated and the address of the previous frame is
24550 stored, which means code that walks the stack frame across interrupts or
24551 signals may get corrupted data.
24552
24553 @item -mavoid-indexed-addresses
24554 @itemx -mno-avoid-indexed-addresses
24555 @opindex mavoid-indexed-addresses
24556 @opindex mno-avoid-indexed-addresses
24557 Generate code that tries to avoid (not avoid) the use of indexed load
24558 or store instructions. These instructions can incur a performance
24559 penalty on Power6 processors in certain situations, such as when
24560 stepping through large arrays that cross a 16M boundary. This option
24561 is enabled by default when targeting Power6 and disabled otherwise.
24562
24563 @item -mfused-madd
24564 @itemx -mno-fused-madd
24565 @opindex mfused-madd
24566 @opindex mno-fused-madd
24567 Generate code that uses (does not use) the floating-point multiply and
24568 accumulate instructions. These instructions are generated by default
24569 if hardware floating point is used. The machine-dependent
24570 @option{-mfused-madd} option is now mapped to the machine-independent
24571 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24572 mapped to @option{-ffp-contract=off}.
24573
24574 @item -mmulhw
24575 @itemx -mno-mulhw
24576 @opindex mmulhw
24577 @opindex mno-mulhw
24578 Generate code that uses (does not use) the half-word multiply and
24579 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
24580 These instructions are generated by default when targeting those
24581 processors.
24582
24583 @item -mdlmzb
24584 @itemx -mno-dlmzb
24585 @opindex mdlmzb
24586 @opindex mno-dlmzb
24587 Generate code that uses (does not use) the string-search @samp{dlmzb}
24588 instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
24589 generated by default when targeting those processors.
24590
24591 @item -mno-bit-align
24592 @itemx -mbit-align
24593 @opindex mno-bit-align
24594 @opindex mbit-align
24595 On System V.4 and embedded PowerPC systems do not (do) force structures
24596 and unions that contain bit-fields to be aligned to the base type of the
24597 bit-field.
24598
24599 For example, by default a structure containing nothing but 8
24600 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
24601 boundary and has a size of 4 bytes. By using @option{-mno-bit-align},
24602 the structure is aligned to a 1-byte boundary and is 1 byte in
24603 size.
24604
24605 @item -mno-strict-align
24606 @itemx -mstrict-align
24607 @opindex mno-strict-align
24608 @opindex mstrict-align
24609 On System V.4 and embedded PowerPC systems do not (do) assume that
24610 unaligned memory references are handled by the system.
24611
24612 @item -mrelocatable
24613 @itemx -mno-relocatable
24614 @opindex mrelocatable
24615 @opindex mno-relocatable
24616 Generate code that allows (does not allow) a static executable to be
24617 relocated to a different address at run time. A simple embedded
24618 PowerPC system loader should relocate the entire contents of
24619 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
24620 a table of 32-bit addresses generated by this option. For this to
24621 work, all objects linked together must be compiled with
24622 @option{-mrelocatable} or @option{-mrelocatable-lib}.
24623 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
24624
24625 @item -mrelocatable-lib
24626 @itemx -mno-relocatable-lib
24627 @opindex mrelocatable-lib
24628 @opindex mno-relocatable-lib
24629 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
24630 @code{.fixup} section to allow static executables to be relocated at
24631 run time, but @option{-mrelocatable-lib} does not use the smaller stack
24632 alignment of @option{-mrelocatable}. Objects compiled with
24633 @option{-mrelocatable-lib} may be linked with objects compiled with
24634 any combination of the @option{-mrelocatable} options.
24635
24636 @item -mno-toc
24637 @itemx -mtoc
24638 @opindex mno-toc
24639 @opindex mtoc
24640 On System V.4 and embedded PowerPC systems do not (do) assume that
24641 register 2 contains a pointer to a global area pointing to the addresses
24642 used in the program.
24643
24644 @item -mlittle
24645 @itemx -mlittle-endian
24646 @opindex mlittle
24647 @opindex mlittle-endian
24648 On System V.4 and embedded PowerPC systems compile code for the
24649 processor in little-endian mode. The @option{-mlittle-endian} option is
24650 the same as @option{-mlittle}.
24651
24652 @item -mbig
24653 @itemx -mbig-endian
24654 @opindex mbig
24655 @opindex mbig-endian
24656 On System V.4 and embedded PowerPC systems compile code for the
24657 processor in big-endian mode. The @option{-mbig-endian} option is
24658 the same as @option{-mbig}.
24659
24660 @item -mdynamic-no-pic
24661 @opindex mdynamic-no-pic
24662 On Darwin and Mac OS X systems, compile code so that it is not
24663 relocatable, but that its external references are relocatable. The
24664 resulting code is suitable for applications, but not shared
24665 libraries.
24666
24667 @item -msingle-pic-base
24668 @opindex msingle-pic-base
24669 Treat the register used for PIC addressing as read-only, rather than
24670 loading it in the prologue for each function. The runtime system is
24671 responsible for initializing this register with an appropriate value
24672 before execution begins.
24673
24674 @item -mprioritize-restricted-insns=@var{priority}
24675 @opindex mprioritize-restricted-insns
24676 This option controls the priority that is assigned to
24677 dispatch-slot restricted instructions during the second scheduling
24678 pass. The argument @var{priority} takes the value @samp{0}, @samp{1},
24679 or @samp{2} to assign no, highest, or second-highest (respectively)
24680 priority to dispatch-slot restricted
24681 instructions.
24682
24683 @item -msched-costly-dep=@var{dependence_type}
24684 @opindex msched-costly-dep
24685 This option controls which dependences are considered costly
24686 by the target during instruction scheduling. The argument
24687 @var{dependence_type} takes one of the following values:
24688
24689 @table @asis
24690 @item @samp{no}
24691 No dependence is costly.
24692
24693 @item @samp{all}
24694 All dependences are costly.
24695
24696 @item @samp{true_store_to_load}
24697 A true dependence from store to load is costly.
24698
24699 @item @samp{store_to_load}
24700 Any dependence from store to load is costly.
24701
24702 @item @var{number}
24703 Any dependence for which the latency is greater than or equal to
24704 @var{number} is costly.
24705 @end table
24706
24707 @item -minsert-sched-nops=@var{scheme}
24708 @opindex minsert-sched-nops
24709 This option controls which NOP insertion scheme is used during
24710 the second scheduling pass. The argument @var{scheme} takes one of the
24711 following values:
24712
24713 @table @asis
24714 @item @samp{no}
24715 Don't insert NOPs.
24716
24717 @item @samp{pad}
24718 Pad with NOPs any dispatch group that has vacant issue slots,
24719 according to the scheduler's grouping.
24720
24721 @item @samp{regroup_exact}
24722 Insert NOPs to force costly dependent insns into
24723 separate groups. Insert exactly as many NOPs as needed to force an insn
24724 to a new group, according to the estimated processor grouping.
24725
24726 @item @var{number}
24727 Insert NOPs to force costly dependent insns into
24728 separate groups. Insert @var{number} NOPs to force an insn to a new group.
24729 @end table
24730
24731 @item -mcall-sysv
24732 @opindex mcall-sysv
24733 On System V.4 and embedded PowerPC systems compile code using calling
24734 conventions that adhere to the March 1995 draft of the System V
24735 Application Binary Interface, PowerPC processor supplement. This is the
24736 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
24737
24738 @item -mcall-sysv-eabi
24739 @itemx -mcall-eabi
24740 @opindex mcall-sysv-eabi
24741 @opindex mcall-eabi
24742 Specify both @option{-mcall-sysv} and @option{-meabi} options.
24743
24744 @item -mcall-sysv-noeabi
24745 @opindex mcall-sysv-noeabi
24746 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
24747
24748 @item -mcall-aixdesc
24749 @opindex m
24750 On System V.4 and embedded PowerPC systems compile code for the AIX
24751 operating system.
24752
24753 @item -mcall-linux
24754 @opindex mcall-linux
24755 On System V.4 and embedded PowerPC systems compile code for the
24756 Linux-based GNU system.
24757
24758 @item -mcall-freebsd
24759 @opindex mcall-freebsd
24760 On System V.4 and embedded PowerPC systems compile code for the
24761 FreeBSD operating system.
24762
24763 @item -mcall-netbsd
24764 @opindex mcall-netbsd
24765 On System V.4 and embedded PowerPC systems compile code for the
24766 NetBSD operating system.
24767
24768 @item -mcall-openbsd
24769 @opindex mcall-netbsd
24770 On System V.4 and embedded PowerPC systems compile code for the
24771 OpenBSD operating system.
24772
24773 @item -mtraceback=@var{traceback_type}
24774 @opindex mtraceback
24775 Select the type of traceback table. Valid values for @var{traceback_type}
24776 are @samp{full}, @samp{part}, and @samp{no}.
24777
24778 @item -maix-struct-return
24779 @opindex maix-struct-return
24780 Return all structures in memory (as specified by the AIX ABI)@.
24781
24782 @item -msvr4-struct-return
24783 @opindex msvr4-struct-return
24784 Return structures smaller than 8 bytes in registers (as specified by the
24785 SVR4 ABI)@.
24786
24787 @item -mabi=@var{abi-type}
24788 @opindex mabi
24789 Extend the current ABI with a particular extension, or remove such extension.
24790 Valid values are @samp{altivec}, @samp{no-altivec},
24791 @samp{ibmlongdouble}, @samp{ieeelongdouble},
24792 @samp{elfv1}, @samp{elfv2}@.
24793
24794 @item -mabi=ibmlongdouble
24795 @opindex mabi=ibmlongdouble
24796 Change the current ABI to use IBM extended-precision long double.
24797 This is not likely to work if your system defaults to using IEEE
24798 extended-precision long double. If you change the long double type
24799 from IEEE extended-precision, the compiler will issue a warning unless
24800 you use the @option{-Wno-psabi} option. Requires @option{-mlong-double-128}
24801 to be enabled.
24802
24803 @item -mabi=ieeelongdouble
24804 @opindex mabi=ieeelongdouble
24805 Change the current ABI to use IEEE extended-precision long double.
24806 This is not likely to work if your system defaults to using IBM
24807 extended-precision long double. If you change the long double type
24808 from IBM extended-precision, the compiler will issue a warning unless
24809 you use the @option{-Wno-psabi} option. Requires @option{-mlong-double-128}
24810 to be enabled.
24811
24812 @item -mabi=elfv1
24813 @opindex mabi=elfv1
24814 Change the current ABI to use the ELFv1 ABI.
24815 This is the default ABI for big-endian PowerPC 64-bit Linux.
24816 Overriding the default ABI requires special system support and is
24817 likely to fail in spectacular ways.
24818
24819 @item -mabi=elfv2
24820 @opindex mabi=elfv2
24821 Change the current ABI to use the ELFv2 ABI.
24822 This is the default ABI for little-endian PowerPC 64-bit Linux.
24823 Overriding the default ABI requires special system support and is
24824 likely to fail in spectacular ways.
24825
24826 @item -mgnu-attribute
24827 @itemx -mno-gnu-attribute
24828 @opindex mgnu-attribute
24829 @opindex mno-gnu-attribute
24830 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24831 .gnu.attributes section that specify ABI variations in function
24832 parameters or return values.
24833
24834 @item -mprototype
24835 @itemx -mno-prototype
24836 @opindex mprototype
24837 @opindex mno-prototype
24838 On System V.4 and embedded PowerPC systems assume that all calls to
24839 variable argument functions are properly prototyped. Otherwise, the
24840 compiler must insert an instruction before every non-prototyped call to
24841 set or clear bit 6 of the condition code register (@code{CR}) to
24842 indicate whether floating-point values are passed in the floating-point
24843 registers in case the function takes variable arguments. With
24844 @option{-mprototype}, only calls to prototyped variable argument functions
24845 set or clear the bit.
24846
24847 @item -msim
24848 @opindex msim
24849 On embedded PowerPC systems, assume that the startup module is called
24850 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24851 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}
24852 configurations.
24853
24854 @item -mmvme
24855 @opindex mmvme
24856 On embedded PowerPC systems, assume that the startup module is called
24857 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24858 @file{libc.a}.
24859
24860 @item -mads
24861 @opindex mads
24862 On embedded PowerPC systems, assume that the startup module is called
24863 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24864 @file{libc.a}.
24865
24866 @item -myellowknife
24867 @opindex myellowknife
24868 On embedded PowerPC systems, assume that the startup module is called
24869 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24870 @file{libc.a}.
24871
24872 @item -mvxworks
24873 @opindex mvxworks
24874 On System V.4 and embedded PowerPC systems, specify that you are
24875 compiling for a VxWorks system.
24876
24877 @item -memb
24878 @opindex memb
24879 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24880 header to indicate that @samp{eabi} extended relocations are used.
24881
24882 @item -meabi
24883 @itemx -mno-eabi
24884 @opindex meabi
24885 @opindex mno-eabi
24886 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24887 Embedded Applications Binary Interface (EABI), which is a set of
24888 modifications to the System V.4 specifications. Selecting @option{-meabi}
24889 means that the stack is aligned to an 8-byte boundary, a function
24890 @code{__eabi} is called from @code{main} to set up the EABI
24891 environment, and the @option{-msdata} option can use both @code{r2} and
24892 @code{r13} to point to two separate small data areas. Selecting
24893 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24894 no EABI initialization function is called from @code{main}, and the
24895 @option{-msdata} option only uses @code{r13} to point to a single
24896 small data area. The @option{-meabi} option is on by default if you
24897 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24898
24899 @item -msdata=eabi
24900 @opindex msdata=eabi
24901 On System V.4 and embedded PowerPC systems, put small initialized
24902 @code{const} global and static data in the @code{.sdata2} section, which
24903 is pointed to by register @code{r2}. Put small initialized
24904 non-@code{const} global and static data in the @code{.sdata} section,
24905 which is pointed to by register @code{r13}. Put small uninitialized
24906 global and static data in the @code{.sbss} section, which is adjacent to
24907 the @code{.sdata} section. The @option{-msdata=eabi} option is
24908 incompatible with the @option{-mrelocatable} option. The
24909 @option{-msdata=eabi} option also sets the @option{-memb} option.
24910
24911 @item -msdata=sysv
24912 @opindex msdata=sysv
24913 On System V.4 and embedded PowerPC systems, put small global and static
24914 data in the @code{.sdata} section, which is pointed to by register
24915 @code{r13}. Put small uninitialized global and static data in the
24916 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24917 The @option{-msdata=sysv} option is incompatible with the
24918 @option{-mrelocatable} option.
24919
24920 @item -msdata=default
24921 @itemx -msdata
24922 @opindex msdata=default
24923 @opindex msdata
24924 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24925 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24926 same as @option{-msdata=sysv}.
24927
24928 @item -msdata=data
24929 @opindex msdata=data
24930 On System V.4 and embedded PowerPC systems, put small global
24931 data in the @code{.sdata} section. Put small uninitialized global
24932 data in the @code{.sbss} section. Do not use register @code{r13}
24933 to address small data however. This is the default behavior unless
24934 other @option{-msdata} options are used.
24935
24936 @item -msdata=none
24937 @itemx -mno-sdata
24938 @opindex msdata=none
24939 @opindex mno-sdata
24940 On embedded PowerPC systems, put all initialized global and static data
24941 in the @code{.data} section, and all uninitialized data in the
24942 @code{.bss} section.
24943
24944 @item -mreadonly-in-sdata
24945 @opindex mreadonly-in-sdata
24946 @opindex mno-readonly-in-sdata
24947 Put read-only objects in the @code{.sdata} section as well. This is the
24948 default.
24949
24950 @item -mblock-move-inline-limit=@var{num}
24951 @opindex mblock-move-inline-limit
24952 Inline all block moves (such as calls to @code{memcpy} or structure
24953 copies) less than or equal to @var{num} bytes. The minimum value for
24954 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24955 targets. The default value is target-specific.
24956
24957 @item -mblock-compare-inline-limit=@var{num}
24958 @opindex mblock-compare-inline-limit
24959 Generate non-looping inline code for all block compares (such as calls
24960 to @code{memcmp} or structure compares) less than or equal to @var{num}
24961 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24962 block compare is disabled. The default value is target-specific.
24963
24964 @item -mblock-compare-inline-loop-limit=@var{num}
24965 @opindex mblock-compare-inline-loop-limit
24966 Generate an inline expansion using loop code for all block compares that
24967 are less than or equal to @var{num} bytes, but greater than the limit
24968 for non-loop inline block compare expansion. If the block length is not
24969 constant, at most @var{num} bytes will be compared before @code{memcmp}
24970 is called to compare the remainder of the block. The default value is
24971 target-specific.
24972
24973 @item -mstring-compare-inline-limit=@var{num}
24974 @opindex mstring-compare-inline-limit
24975 Compare at most @var{num} string bytes with inline code.
24976 If the difference or end of string is not found at the
24977 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24978 take care of the rest of the comparison. The default is 64 bytes.
24979
24980 @item -G @var{num}
24981 @opindex G
24982 @cindex smaller data references (PowerPC)
24983 @cindex .sdata/.sdata2 references (PowerPC)
24984 On embedded PowerPC systems, put global and static items less than or
24985 equal to @var{num} bytes into the small data or BSS sections instead of
24986 the normal data or BSS section. By default, @var{num} is 8. The
24987 @option{-G @var{num}} switch is also passed to the linker.
24988 All modules should be compiled with the same @option{-G @var{num}} value.
24989
24990 @item -mregnames
24991 @itemx -mno-regnames
24992 @opindex mregnames
24993 @opindex mno-regnames
24994 On System V.4 and embedded PowerPC systems do (do not) emit register
24995 names in the assembly language output using symbolic forms.
24996
24997 @item -mlongcall
24998 @itemx -mno-longcall
24999 @opindex mlongcall
25000 @opindex mno-longcall
25001 By default assume that all calls are far away so that a longer and more
25002 expensive calling sequence is required. This is required for calls
25003 farther than 32 megabytes (33,554,432 bytes) from the current location.
25004 A short call is generated if the compiler knows
25005 the call cannot be that far away. This setting can be overridden by
25006 the @code{shortcall} function attribute, or by @code{#pragma
25007 longcall(0)}.
25008
25009 Some linkers are capable of detecting out-of-range calls and generating
25010 glue code on the fly. On these systems, long calls are unnecessary and
25011 generate slower code. As of this writing, the AIX linker can do this,
25012 as can the GNU linker for PowerPC/64. It is planned to add this feature
25013 to the GNU linker for 32-bit PowerPC systems as well.
25014
25015 On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers,
25016 GCC can generate long calls using an inline PLT call sequence (see
25017 @option{-mpltseq}). PowerPC with @option{-mbss-plt} and PowerPC64
25018 ELFv1 (big-endian) do not support inline PLT calls.
25019
25020 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
25021 callee, L42}, plus a @dfn{branch island} (glue code). The two target
25022 addresses represent the callee and the branch island. The
25023 Darwin/PPC linker prefers the first address and generates a @code{bl
25024 callee} if the PPC @code{bl} instruction reaches the callee directly;
25025 otherwise, the linker generates @code{bl L42} to call the branch
25026 island. The branch island is appended to the body of the
25027 calling function; it computes the full 32-bit address of the callee
25028 and jumps to it.
25029
25030 On Mach-O (Darwin) systems, this option directs the compiler emit to
25031 the glue for every direct call, and the Darwin linker decides whether
25032 to use or discard it.
25033
25034 In the future, GCC may ignore all longcall specifications
25035 when the linker is known to generate glue.
25036
25037 @item -mpltseq
25038 @itemx -mno-pltseq
25039 @opindex mpltseq
25040 @opindex mno-pltseq
25041 Implement (do not implement) -fno-plt and long calls using an inline
25042 PLT call sequence that supports lazy linking and long calls to
25043 functions in dlopen'd shared libraries. Inline PLT calls are only
25044 supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU
25045 linkers, and are enabled by default if the support is detected when
25046 configuring GCC, and, in the case of 32-bit PowerPC, if GCC is
25047 configured with @option{--enable-secureplt}. @option{-mpltseq} code
25048 and @option{-mbss-plt} 32-bit PowerPC relocatable objects may not be
25049 linked together.
25050
25051 @item -mtls-markers
25052 @itemx -mno-tls-markers
25053 @opindex mtls-markers
25054 @opindex mno-tls-markers
25055 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
25056 specifying the function argument. The relocation allows the linker to
25057 reliably associate function call with argument setup instructions for
25058 TLS optimization, which in turn allows GCC to better schedule the
25059 sequence.
25060
25061 @item -mrecip
25062 @itemx -mno-recip
25063 @opindex mrecip
25064 This option enables use of the reciprocal estimate and
25065 reciprocal square root estimate instructions with additional
25066 Newton-Raphson steps to increase precision instead of doing a divide or
25067 square root and divide for floating-point arguments. You should use
25068 the @option{-ffast-math} option when using @option{-mrecip} (or at
25069 least @option{-funsafe-math-optimizations},
25070 @option{-ffinite-math-only}, @option{-freciprocal-math} and
25071 @option{-fno-trapping-math}). Note that while the throughput of the
25072 sequence is generally higher than the throughput of the non-reciprocal
25073 instruction, the precision of the sequence can be decreased by up to 2
25074 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
25075 roots.
25076
25077 @item -mrecip=@var{opt}
25078 @opindex mrecip=opt
25079 This option controls which reciprocal estimate instructions
25080 may be used. @var{opt} is a comma-separated list of options, which may
25081 be preceded by a @code{!} to invert the option:
25082
25083 @table @samp
25084
25085 @item all
25086 Enable all estimate instructions.
25087
25088 @item default
25089 Enable the default instructions, equivalent to @option{-mrecip}.
25090
25091 @item none
25092 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25093
25094 @item div
25095 Enable the reciprocal approximation instructions for both
25096 single and double precision.
25097
25098 @item divf
25099 Enable the single-precision reciprocal approximation instructions.
25100
25101 @item divd
25102 Enable the double-precision reciprocal approximation instructions.
25103
25104 @item rsqrt
25105 Enable the reciprocal square root approximation instructions for both
25106 single and double precision.
25107
25108 @item rsqrtf
25109 Enable the single-precision reciprocal square root approximation instructions.
25110
25111 @item rsqrtd
25112 Enable the double-precision reciprocal square root approximation instructions.
25113
25114 @end table
25115
25116 So, for example, @option{-mrecip=all,!rsqrtd} enables
25117 all of the reciprocal estimate instructions, except for the
25118 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
25119 which handle the double-precision reciprocal square root calculations.
25120
25121 @item -mrecip-precision
25122 @itemx -mno-recip-precision
25123 @opindex mrecip-precision
25124 Assume (do not assume) that the reciprocal estimate instructions
25125 provide higher-precision estimates than is mandated by the PowerPC
25126 ABI. Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
25127 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
25128 The double-precision square root estimate instructions are not generated by
25129 default on low-precision machines, since they do not provide an
25130 estimate that converges after three steps.
25131
25132 @item -mveclibabi=@var{type}
25133 @opindex mveclibabi
25134 Specifies the ABI type to use for vectorizing intrinsics using an
25135 external library. The only type supported at present is @samp{mass},
25136 which specifies to use IBM's Mathematical Acceleration Subsystem
25137 (MASS) libraries for vectorizing intrinsics using external libraries.
25138 GCC currently emits calls to @code{acosd2}, @code{acosf4},
25139 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
25140 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
25141 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
25142 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
25143 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
25144 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
25145 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
25146 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
25147 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
25148 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
25149 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
25150 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
25151 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
25152 for power7. Both @option{-ftree-vectorize} and
25153 @option{-funsafe-math-optimizations} must also be enabled. The MASS
25154 libraries must be specified at link time.
25155
25156 @item -mfriz
25157 @itemx -mno-friz
25158 @opindex mfriz
25159 Generate (do not generate) the @code{friz} instruction when the
25160 @option{-funsafe-math-optimizations} option is used to optimize
25161 rounding of floating-point values to 64-bit integer and back to floating
25162 point. The @code{friz} instruction does not return the same value if
25163 the floating-point number is too large to fit in an integer.
25164
25165 @item -mpointers-to-nested-functions
25166 @itemx -mno-pointers-to-nested-functions
25167 @opindex mpointers-to-nested-functions
25168 Generate (do not generate) code to load up the static chain register
25169 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
25170 systems where a function pointer points to a 3-word descriptor giving
25171 the function address, TOC value to be loaded in register @code{r2}, and
25172 static chain value to be loaded in register @code{r11}. The
25173 @option{-mpointers-to-nested-functions} is on by default. You cannot
25174 call through pointers to nested functions or pointers
25175 to functions compiled in other languages that use the static chain if
25176 you use @option{-mno-pointers-to-nested-functions}.
25177
25178 @item -msave-toc-indirect
25179 @itemx -mno-save-toc-indirect
25180 @opindex msave-toc-indirect
25181 Generate (do not generate) code to save the TOC value in the reserved
25182 stack location in the function prologue if the function calls through
25183 a pointer on AIX and 64-bit Linux systems. If the TOC value is not
25184 saved in the prologue, it is saved just before the call through the
25185 pointer. The @option{-mno-save-toc-indirect} option is the default.
25186
25187 @item -mcompat-align-parm
25188 @itemx -mno-compat-align-parm
25189 @opindex mcompat-align-parm
25190 Generate (do not generate) code to pass structure parameters with a
25191 maximum alignment of 64 bits, for compatibility with older versions
25192 of GCC.
25193
25194 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
25195 structure parameter on a 128-bit boundary when that structure contained
25196 a member requiring 128-bit alignment. This is corrected in more
25197 recent versions of GCC. This option may be used to generate code
25198 that is compatible with functions compiled with older versions of
25199 GCC.
25200
25201 The @option{-mno-compat-align-parm} option is the default.
25202
25203 @item -mstack-protector-guard=@var{guard}
25204 @itemx -mstack-protector-guard-reg=@var{reg}
25205 @itemx -mstack-protector-guard-offset=@var{offset}
25206 @itemx -mstack-protector-guard-symbol=@var{symbol}
25207 @opindex mstack-protector-guard
25208 @opindex mstack-protector-guard-reg
25209 @opindex mstack-protector-guard-offset
25210 @opindex mstack-protector-guard-symbol
25211 Generate stack protection code using canary at @var{guard}. Supported
25212 locations are @samp{global} for global canary or @samp{tls} for per-thread
25213 canary in the TLS block (the default with GNU libc version 2.4 or later).
25214
25215 With the latter choice the options
25216 @option{-mstack-protector-guard-reg=@var{reg}} and
25217 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
25218 which register to use as base register for reading the canary, and from what
25219 offset from that base register. The default for those is as specified in the
25220 relevant ABI. @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
25221 the offset with a symbol reference to a canary in the TLS block.
25222
25223 @item -mpcrel
25224 @itemx -mno-pcrel
25225 @opindex mpcrel
25226 @opindex mno-pcrel
25227 Generate (do not generate) pc-relative addressing when the option
25228 @option{-mcpu=future} is used.
25229 @end table
25230
25231 @node RX Options
25232 @subsection RX Options
25233 @cindex RX Options
25234
25235 These command-line options are defined for RX targets:
25236
25237 @table @gcctabopt
25238 @item -m64bit-doubles
25239 @itemx -m32bit-doubles
25240 @opindex m64bit-doubles
25241 @opindex m32bit-doubles
25242 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
25243 or 32 bits (@option{-m32bit-doubles}) in size. The default is
25244 @option{-m32bit-doubles}. @emph{Note} RX floating-point hardware only
25245 works on 32-bit values, which is why the default is
25246 @option{-m32bit-doubles}.
25247
25248 @item -fpu
25249 @itemx -nofpu
25250 @opindex fpu
25251 @opindex nofpu
25252 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
25253 floating-point hardware. The default is enabled for the RX600
25254 series and disabled for the RX200 series.
25255
25256 Floating-point instructions are only generated for 32-bit floating-point
25257 values, however, so the FPU hardware is not used for doubles if the
25258 @option{-m64bit-doubles} option is used.
25259
25260 @emph{Note} If the @option{-fpu} option is enabled then
25261 @option{-funsafe-math-optimizations} is also enabled automatically.
25262 This is because the RX FPU instructions are themselves unsafe.
25263
25264 @item -mcpu=@var{name}
25265 @opindex mcpu
25266 Selects the type of RX CPU to be targeted. Currently three types are
25267 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
25268 the specific @samp{RX610} CPU. The default is @samp{RX600}.
25269
25270 The only difference between @samp{RX600} and @samp{RX610} is that the
25271 @samp{RX610} does not support the @code{MVTIPL} instruction.
25272
25273 The @samp{RX200} series does not have a hardware floating-point unit
25274 and so @option{-nofpu} is enabled by default when this type is
25275 selected.
25276
25277 @item -mbig-endian-data
25278 @itemx -mlittle-endian-data
25279 @opindex mbig-endian-data
25280 @opindex mlittle-endian-data
25281 Store data (but not code) in the big-endian format. The default is
25282 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
25283 format.
25284
25285 @item -msmall-data-limit=@var{N}
25286 @opindex msmall-data-limit
25287 Specifies the maximum size in bytes of global and static variables
25288 which can be placed into the small data area. Using the small data
25289 area can lead to smaller and faster code, but the size of area is
25290 limited and it is up to the programmer to ensure that the area does
25291 not overflow. Also when the small data area is used one of the RX's
25292 registers (usually @code{r13}) is reserved for use pointing to this
25293 area, so it is no longer available for use by the compiler. This
25294 could result in slower and/or larger code if variables are pushed onto
25295 the stack instead of being held in this register.
25296
25297 Note, common variables (variables that have not been initialized) and
25298 constants are not placed into the small data area as they are assigned
25299 to other sections in the output executable.
25300
25301 The default value is zero, which disables this feature. Note, this
25302 feature is not enabled by default with higher optimization levels
25303 (@option{-O2} etc) because of the potentially detrimental effects of
25304 reserving a register. It is up to the programmer to experiment and
25305 discover whether this feature is of benefit to their program. See the
25306 description of the @option{-mpid} option for a description of how the
25307 actual register to hold the small data area pointer is chosen.
25308
25309 @item -msim
25310 @itemx -mno-sim
25311 @opindex msim
25312 @opindex mno-sim
25313 Use the simulator runtime. The default is to use the libgloss
25314 board-specific runtime.
25315
25316 @item -mas100-syntax
25317 @itemx -mno-as100-syntax
25318 @opindex mas100-syntax
25319 @opindex mno-as100-syntax
25320 When generating assembler output use a syntax that is compatible with
25321 Renesas's AS100 assembler. This syntax can also be handled by the GAS
25322 assembler, but it has some restrictions so it is not generated by default.
25323
25324 @item -mmax-constant-size=@var{N}
25325 @opindex mmax-constant-size
25326 Specifies the maximum size, in bytes, of a constant that can be used as
25327 an operand in a RX instruction. Although the RX instruction set does
25328 allow constants of up to 4 bytes in length to be used in instructions,
25329 a longer value equates to a longer instruction. Thus in some
25330 circumstances it can be beneficial to restrict the size of constants
25331 that are used in instructions. Constants that are too big are instead
25332 placed into a constant pool and referenced via register indirection.
25333
25334 The value @var{N} can be between 0 and 4. A value of 0 (the default)
25335 or 4 means that constants of any size are allowed.
25336
25337 @item -mrelax
25338 @opindex mrelax
25339 Enable linker relaxation. Linker relaxation is a process whereby the
25340 linker attempts to reduce the size of a program by finding shorter
25341 versions of various instructions. Disabled by default.
25342
25343 @item -mint-register=@var{N}
25344 @opindex mint-register
25345 Specify the number of registers to reserve for fast interrupt handler
25346 functions. The value @var{N} can be between 0 and 4. A value of 1
25347 means that register @code{r13} is reserved for the exclusive use
25348 of fast interrupt handlers. A value of 2 reserves @code{r13} and
25349 @code{r12}. A value of 3 reserves @code{r13}, @code{r12} and
25350 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
25351 A value of 0, the default, does not reserve any registers.
25352
25353 @item -msave-acc-in-interrupts
25354 @opindex msave-acc-in-interrupts
25355 Specifies that interrupt handler functions should preserve the
25356 accumulator register. This is only necessary if normal code might use
25357 the accumulator register, for example because it performs 64-bit
25358 multiplications. The default is to ignore the accumulator as this
25359 makes the interrupt handlers faster.
25360
25361 @item -mpid
25362 @itemx -mno-pid
25363 @opindex mpid
25364 @opindex mno-pid
25365 Enables the generation of position independent data. When enabled any
25366 access to constant data is done via an offset from a base address
25367 held in a register. This allows the location of constant data to be
25368 determined at run time without requiring the executable to be
25369 relocated, which is a benefit to embedded applications with tight
25370 memory constraints. Data that can be modified is not affected by this
25371 option.
25372
25373 Note, using this feature reserves a register, usually @code{r13}, for
25374 the constant data base address. This can result in slower and/or
25375 larger code, especially in complicated functions.
25376
25377 The actual register chosen to hold the constant data base address
25378 depends upon whether the @option{-msmall-data-limit} and/or the
25379 @option{-mint-register} command-line options are enabled. Starting
25380 with register @code{r13} and proceeding downwards, registers are
25381 allocated first to satisfy the requirements of @option{-mint-register},
25382 then @option{-mpid} and finally @option{-msmall-data-limit}. Thus it
25383 is possible for the small data area register to be @code{r8} if both
25384 @option{-mint-register=4} and @option{-mpid} are specified on the
25385 command line.
25386
25387 By default this feature is not enabled. The default can be restored
25388 via the @option{-mno-pid} command-line option.
25389
25390 @item -mno-warn-multiple-fast-interrupts
25391 @itemx -mwarn-multiple-fast-interrupts
25392 @opindex mno-warn-multiple-fast-interrupts
25393 @opindex mwarn-multiple-fast-interrupts
25394 Prevents GCC from issuing a warning message if it finds more than one
25395 fast interrupt handler when it is compiling a file. The default is to
25396 issue a warning for each extra fast interrupt handler found, as the RX
25397 only supports one such interrupt.
25398
25399 @item -mallow-string-insns
25400 @itemx -mno-allow-string-insns
25401 @opindex mallow-string-insns
25402 @opindex mno-allow-string-insns
25403 Enables or disables the use of the string manipulation instructions
25404 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
25405 @code{SWHILE} and also the @code{RMPA} instruction. These
25406 instructions may prefetch data, which is not safe to do if accessing
25407 an I/O register. (See section 12.2.7 of the RX62N Group User's Manual
25408 for more information).
25409
25410 The default is to allow these instructions, but it is not possible for
25411 GCC to reliably detect all circumstances where a string instruction
25412 might be used to access an I/O register, so their use cannot be
25413 disabled automatically. Instead it is reliant upon the programmer to
25414 use the @option{-mno-allow-string-insns} option if their program
25415 accesses I/O space.
25416
25417 When the instructions are enabled GCC defines the C preprocessor
25418 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
25419 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
25420
25421 @item -mjsr
25422 @itemx -mno-jsr
25423 @opindex mjsr
25424 @opindex mno-jsr
25425 Use only (or not only) @code{JSR} instructions to access functions.
25426 This option can be used when code size exceeds the range of @code{BSR}
25427 instructions. Note that @option{-mno-jsr} does not mean to not use
25428 @code{JSR} but instead means that any type of branch may be used.
25429 @end table
25430
25431 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
25432 has special significance to the RX port when used with the
25433 @code{interrupt} function attribute. This attribute indicates a
25434 function intended to process fast interrupts. GCC ensures
25435 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
25436 and/or @code{r13} and only provided that the normal use of the
25437 corresponding registers have been restricted via the
25438 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
25439 options.
25440
25441 @node S/390 and zSeries Options
25442 @subsection S/390 and zSeries Options
25443 @cindex S/390 and zSeries Options
25444
25445 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
25446
25447 @table @gcctabopt
25448 @item -mhard-float
25449 @itemx -msoft-float
25450 @opindex mhard-float
25451 @opindex msoft-float
25452 Use (do not use) the hardware floating-point instructions and registers
25453 for floating-point operations. When @option{-msoft-float} is specified,
25454 functions in @file{libgcc.a} are used to perform floating-point
25455 operations. When @option{-mhard-float} is specified, the compiler
25456 generates IEEE floating-point instructions. This is the default.
25457
25458 @item -mhard-dfp
25459 @itemx -mno-hard-dfp
25460 @opindex mhard-dfp
25461 @opindex mno-hard-dfp
25462 Use (do not use) the hardware decimal-floating-point instructions for
25463 decimal-floating-point operations. When @option{-mno-hard-dfp} is
25464 specified, functions in @file{libgcc.a} are used to perform
25465 decimal-floating-point operations. When @option{-mhard-dfp} is
25466 specified, the compiler generates decimal-floating-point hardware
25467 instructions. This is the default for @option{-march=z9-ec} or higher.
25468
25469 @item -mlong-double-64
25470 @itemx -mlong-double-128
25471 @opindex mlong-double-64
25472 @opindex mlong-double-128
25473 These switches control the size of @code{long double} type. A size
25474 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25475 type. This is the default.
25476
25477 @item -mbackchain
25478 @itemx -mno-backchain
25479 @opindex mbackchain
25480 @opindex mno-backchain
25481 Store (do not store) the address of the caller's frame as backchain pointer
25482 into the callee's stack frame.
25483 A backchain may be needed to allow debugging using tools that do not understand
25484 DWARF call frame information.
25485 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
25486 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
25487 the backchain is placed into the topmost word of the 96/160 byte register
25488 save area.
25489
25490 In general, code compiled with @option{-mbackchain} is call-compatible with
25491 code compiled with @option{-mmo-backchain}; however, use of the backchain
25492 for debugging purposes usually requires that the whole binary is built with
25493 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
25494 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
25495 to build a linux kernel use @option{-msoft-float}.
25496
25497 The default is to not maintain the backchain.
25498
25499 @item -mpacked-stack
25500 @itemx -mno-packed-stack
25501 @opindex mpacked-stack
25502 @opindex mno-packed-stack
25503 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
25504 specified, the compiler uses the all fields of the 96/160 byte register save
25505 area only for their default purpose; unused fields still take up stack space.
25506 When @option{-mpacked-stack} is specified, register save slots are densely
25507 packed at the top of the register save area; unused space is reused for other
25508 purposes, allowing for more efficient use of the available stack space.
25509 However, when @option{-mbackchain} is also in effect, the topmost word of
25510 the save area is always used to store the backchain, and the return address
25511 register is always saved two words below the backchain.
25512
25513 As long as the stack frame backchain is not used, code generated with
25514 @option{-mpacked-stack} is call-compatible with code generated with
25515 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
25516 S/390 or zSeries generated code that uses the stack frame backchain at run
25517 time, not just for debugging purposes. Such code is not call-compatible
25518 with code compiled with @option{-mpacked-stack}. Also, note that the
25519 combination of @option{-mbackchain},
25520 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
25521 to build a linux kernel use @option{-msoft-float}.
25522
25523 The default is to not use the packed stack layout.
25524
25525 @item -msmall-exec
25526 @itemx -mno-small-exec
25527 @opindex msmall-exec
25528 @opindex mno-small-exec
25529 Generate (or do not generate) code using the @code{bras} instruction
25530 to do subroutine calls.
25531 This only works reliably if the total executable size does not
25532 exceed 64k. The default is to use the @code{basr} instruction instead,
25533 which does not have this limitation.
25534
25535 @item -m64
25536 @itemx -m31
25537 @opindex m64
25538 @opindex m31
25539 When @option{-m31} is specified, generate code compliant to the
25540 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
25541 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
25542 particular to generate 64-bit instructions. For the @samp{s390}
25543 targets, the default is @option{-m31}, while the @samp{s390x}
25544 targets default to @option{-m64}.
25545
25546 @item -mzarch
25547 @itemx -mesa
25548 @opindex mzarch
25549 @opindex mesa
25550 When @option{-mzarch} is specified, generate code using the
25551 instructions available on z/Architecture.
25552 When @option{-mesa} is specified, generate code using the
25553 instructions available on ESA/390. Note that @option{-mesa} is
25554 not possible with @option{-m64}.
25555 When generating code compliant to the GNU/Linux for S/390 ABI,
25556 the default is @option{-mesa}. When generating code compliant
25557 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
25558
25559 @item -mhtm
25560 @itemx -mno-htm
25561 @opindex mhtm
25562 @opindex mno-htm
25563 The @option{-mhtm} option enables a set of builtins making use of
25564 instructions available with the transactional execution facility
25565 introduced with the IBM zEnterprise EC12 machine generation
25566 @ref{S/390 System z Built-in Functions}.
25567 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
25568
25569 @item -mvx
25570 @itemx -mno-vx
25571 @opindex mvx
25572 @opindex mno-vx
25573 When @option{-mvx} is specified, generate code using the instructions
25574 available with the vector extension facility introduced with the IBM
25575 z13 machine generation.
25576 This option changes the ABI for some vector type values with regard to
25577 alignment and calling conventions. In case vector type values are
25578 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
25579 command will be added to mark the resulting binary with the ABI used.
25580 @option{-mvx} is enabled by default when using @option{-march=z13}.
25581
25582 @item -mzvector
25583 @itemx -mno-zvector
25584 @opindex mzvector
25585 @opindex mno-zvector
25586 The @option{-mzvector} option enables vector language extensions and
25587 builtins using instructions available with the vector extension
25588 facility introduced with the IBM z13 machine generation.
25589 This option adds support for @samp{vector} to be used as a keyword to
25590 define vector type variables and arguments. @samp{vector} is only
25591 available when GNU extensions are enabled. It will not be expanded
25592 when requesting strict standard compliance e.g.@: with @option{-std=c99}.
25593 In addition to the GCC low-level builtins @option{-mzvector} enables
25594 a set of builtins added for compatibility with AltiVec-style
25595 implementations like Power and Cell. In order to make use of these
25596 builtins the header file @file{vecintrin.h} needs to be included.
25597 @option{-mzvector} is disabled by default.
25598
25599 @item -mmvcle
25600 @itemx -mno-mvcle
25601 @opindex mmvcle
25602 @opindex mno-mvcle
25603 Generate (or do not generate) code using the @code{mvcle} instruction
25604 to perform block moves. When @option{-mno-mvcle} is specified,
25605 use a @code{mvc} loop instead. This is the default unless optimizing for
25606 size.
25607
25608 @item -mdebug
25609 @itemx -mno-debug
25610 @opindex mdebug
25611 @opindex mno-debug
25612 Print (or do not print) additional debug information when compiling.
25613 The default is to not print debug information.
25614
25615 @item -march=@var{cpu-type}
25616 @opindex march
25617 Generate code that runs on @var{cpu-type}, which is the name of a
25618 system representing a certain processor type. Possible values for
25619 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
25620 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
25621 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11},
25622 @samp{z14}/@samp{arch12}, and @samp{native}.
25623
25624 The default is @option{-march=z900}.
25625
25626 Specifying @samp{native} as cpu type can be used to select the best
25627 architecture option for the host processor.
25628 @option{-march=native} has no effect if GCC does not recognize the
25629 processor.
25630
25631 @item -mtune=@var{cpu-type}
25632 @opindex mtune
25633 Tune to @var{cpu-type} everything applicable about the generated code,
25634 except for the ABI and the set of available instructions.
25635 The list of @var{cpu-type} values is the same as for @option{-march}.
25636 The default is the value used for @option{-march}.
25637
25638 @item -mtpf-trace
25639 @itemx -mno-tpf-trace
25640 @opindex mtpf-trace
25641 @opindex mno-tpf-trace
25642 Generate code that adds (does not add) in TPF OS specific branches to trace
25643 routines in the operating system. This option is off by default, even
25644 when compiling for the TPF OS@.
25645
25646 @item -mfused-madd
25647 @itemx -mno-fused-madd
25648 @opindex mfused-madd
25649 @opindex mno-fused-madd
25650 Generate code that uses (does not use) the floating-point multiply and
25651 accumulate instructions. These instructions are generated by default if
25652 hardware floating point is used.
25653
25654 @item -mwarn-framesize=@var{framesize}
25655 @opindex mwarn-framesize
25656 Emit a warning if the current function exceeds the given frame size. Because
25657 this is a compile-time check it doesn't need to be a real problem when the program
25658 runs. It is intended to identify functions that most probably cause
25659 a stack overflow. It is useful to be used in an environment with limited stack
25660 size e.g.@: the linux kernel.
25661
25662 @item -mwarn-dynamicstack
25663 @opindex mwarn-dynamicstack
25664 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
25665 arrays. This is generally a bad idea with a limited stack size.
25666
25667 @item -mstack-guard=@var{stack-guard}
25668 @itemx -mstack-size=@var{stack-size}
25669 @opindex mstack-guard
25670 @opindex mstack-size
25671 If these options are provided the S/390 back end emits additional instructions in
25672 the function prologue that trigger a trap if the stack size is @var{stack-guard}
25673 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
25674 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
25675 the frame size of the compiled function is chosen.
25676 These options are intended to be used to help debugging stack overflow problems.
25677 The additionally emitted code causes only little overhead and hence can also be
25678 used in production-like systems without greater performance degradation. The given
25679 values have to be exact powers of 2 and @var{stack-size} has to be greater than
25680 @var{stack-guard} without exceeding 64k.
25681 In order to be efficient the extra code makes the assumption that the stack starts
25682 at an address aligned to the value given by @var{stack-size}.
25683 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
25684
25685 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
25686 @opindex mhotpatch
25687 If the hotpatch option is enabled, a ``hot-patching'' function
25688 prologue is generated for all functions in the compilation unit.
25689 The funtion label is prepended with the given number of two-byte
25690 NOP instructions (@var{pre-halfwords}, maximum 1000000). After
25691 the label, 2 * @var{post-halfwords} bytes are appended, using the
25692 largest NOP like instructions the architecture allows (maximum
25693 1000000).
25694
25695 If both arguments are zero, hotpatching is disabled.
25696
25697 This option can be overridden for individual functions with the
25698 @code{hotpatch} attribute.
25699 @end table
25700
25701 @node Score Options
25702 @subsection Score Options
25703 @cindex Score Options
25704
25705 These options are defined for Score implementations:
25706
25707 @table @gcctabopt
25708 @item -meb
25709 @opindex meb
25710 Compile code for big-endian mode. This is the default.
25711
25712 @item -mel
25713 @opindex mel
25714 Compile code for little-endian mode.
25715
25716 @item -mnhwloop
25717 @opindex mnhwloop
25718 Disable generation of @code{bcnz} instructions.
25719
25720 @item -muls
25721 @opindex muls
25722 Enable generation of unaligned load and store instructions.
25723
25724 @item -mmac
25725 @opindex mmac
25726 Enable the use of multiply-accumulate instructions. Disabled by default.
25727
25728 @item -mscore5
25729 @opindex mscore5
25730 Specify the SCORE5 as the target architecture.
25731
25732 @item -mscore5u
25733 @opindex mscore5u
25734 Specify the SCORE5U of the target architecture.
25735
25736 @item -mscore7
25737 @opindex mscore7
25738 Specify the SCORE7 as the target architecture. This is the default.
25739
25740 @item -mscore7d
25741 @opindex mscore7d
25742 Specify the SCORE7D as the target architecture.
25743 @end table
25744
25745 @node SH Options
25746 @subsection SH Options
25747
25748 These @samp{-m} options are defined for the SH implementations:
25749
25750 @table @gcctabopt
25751 @item -m1
25752 @opindex m1
25753 Generate code for the SH1.
25754
25755 @item -m2
25756 @opindex m2
25757 Generate code for the SH2.
25758
25759 @item -m2e
25760 Generate code for the SH2e.
25761
25762 @item -m2a-nofpu
25763 @opindex m2a-nofpu
25764 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
25765 that the floating-point unit is not used.
25766
25767 @item -m2a-single-only
25768 @opindex m2a-single-only
25769 Generate code for the SH2a-FPU, in such a way that no double-precision
25770 floating-point operations are used.
25771
25772 @item -m2a-single
25773 @opindex m2a-single
25774 Generate code for the SH2a-FPU assuming the floating-point unit is in
25775 single-precision mode by default.
25776
25777 @item -m2a
25778 @opindex m2a
25779 Generate code for the SH2a-FPU assuming the floating-point unit is in
25780 double-precision mode by default.
25781
25782 @item -m3
25783 @opindex m3
25784 Generate code for the SH3.
25785
25786 @item -m3e
25787 @opindex m3e
25788 Generate code for the SH3e.
25789
25790 @item -m4-nofpu
25791 @opindex m4-nofpu
25792 Generate code for the SH4 without a floating-point unit.
25793
25794 @item -m4-single-only
25795 @opindex m4-single-only
25796 Generate code for the SH4 with a floating-point unit that only
25797 supports single-precision arithmetic.
25798
25799 @item -m4-single
25800 @opindex m4-single
25801 Generate code for the SH4 assuming the floating-point unit is in
25802 single-precision mode by default.
25803
25804 @item -m4
25805 @opindex m4
25806 Generate code for the SH4.
25807
25808 @item -m4-100
25809 @opindex m4-100
25810 Generate code for SH4-100.
25811
25812 @item -m4-100-nofpu
25813 @opindex m4-100-nofpu
25814 Generate code for SH4-100 in such a way that the
25815 floating-point unit is not used.
25816
25817 @item -m4-100-single
25818 @opindex m4-100-single
25819 Generate code for SH4-100 assuming the floating-point unit is in
25820 single-precision mode by default.
25821
25822 @item -m4-100-single-only
25823 @opindex m4-100-single-only
25824 Generate code for SH4-100 in such a way that no double-precision
25825 floating-point operations are used.
25826
25827 @item -m4-200
25828 @opindex m4-200
25829 Generate code for SH4-200.
25830
25831 @item -m4-200-nofpu
25832 @opindex m4-200-nofpu
25833 Generate code for SH4-200 without in such a way that the
25834 floating-point unit is not used.
25835
25836 @item -m4-200-single
25837 @opindex m4-200-single
25838 Generate code for SH4-200 assuming the floating-point unit is in
25839 single-precision mode by default.
25840
25841 @item -m4-200-single-only
25842 @opindex m4-200-single-only
25843 Generate code for SH4-200 in such a way that no double-precision
25844 floating-point operations are used.
25845
25846 @item -m4-300
25847 @opindex m4-300
25848 Generate code for SH4-300.
25849
25850 @item -m4-300-nofpu
25851 @opindex m4-300-nofpu
25852 Generate code for SH4-300 without in such a way that the
25853 floating-point unit is not used.
25854
25855 @item -m4-300-single
25856 @opindex m4-300-single
25857 Generate code for SH4-300 in such a way that no double-precision
25858 floating-point operations are used.
25859
25860 @item -m4-300-single-only
25861 @opindex m4-300-single-only
25862 Generate code for SH4-300 in such a way that no double-precision
25863 floating-point operations are used.
25864
25865 @item -m4-340
25866 @opindex m4-340
25867 Generate code for SH4-340 (no MMU, no FPU).
25868
25869 @item -m4-500
25870 @opindex m4-500
25871 Generate code for SH4-500 (no FPU). Passes @option{-isa=sh4-nofpu} to the
25872 assembler.
25873
25874 @item -m4a-nofpu
25875 @opindex m4a-nofpu
25876 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25877 floating-point unit is not used.
25878
25879 @item -m4a-single-only
25880 @opindex m4a-single-only
25881 Generate code for the SH4a, in such a way that no double-precision
25882 floating-point operations are used.
25883
25884 @item -m4a-single
25885 @opindex m4a-single
25886 Generate code for the SH4a assuming the floating-point unit is in
25887 single-precision mode by default.
25888
25889 @item -m4a
25890 @opindex m4a
25891 Generate code for the SH4a.
25892
25893 @item -m4al
25894 @opindex m4al
25895 Same as @option{-m4a-nofpu}, except that it implicitly passes
25896 @option{-dsp} to the assembler. GCC doesn't generate any DSP
25897 instructions at the moment.
25898
25899 @item -mb
25900 @opindex mb
25901 Compile code for the processor in big-endian mode.
25902
25903 @item -ml
25904 @opindex ml
25905 Compile code for the processor in little-endian mode.
25906
25907 @item -mdalign
25908 @opindex mdalign
25909 Align doubles at 64-bit boundaries. Note that this changes the calling
25910 conventions, and thus some functions from the standard C library do
25911 not work unless you recompile it first with @option{-mdalign}.
25912
25913 @item -mrelax
25914 @opindex mrelax
25915 Shorten some address references at link time, when possible; uses the
25916 linker option @option{-relax}.
25917
25918 @item -mbigtable
25919 @opindex mbigtable
25920 Use 32-bit offsets in @code{switch} tables. The default is to use
25921 16-bit offsets.
25922
25923 @item -mbitops
25924 @opindex mbitops
25925 Enable the use of bit manipulation instructions on SH2A.
25926
25927 @item -mfmovd
25928 @opindex mfmovd
25929 Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for
25930 alignment constraints.
25931
25932 @item -mrenesas
25933 @opindex mrenesas
25934 Comply with the calling conventions defined by Renesas.
25935
25936 @item -mno-renesas
25937 @opindex mno-renesas
25938 Comply with the calling conventions defined for GCC before the Renesas
25939 conventions were available. This option is the default for all
25940 targets of the SH toolchain.
25941
25942 @item -mnomacsave
25943 @opindex mnomacsave
25944 Mark the @code{MAC} register as call-clobbered, even if
25945 @option{-mrenesas} is given.
25946
25947 @item -mieee
25948 @itemx -mno-ieee
25949 @opindex mieee
25950 @opindex mno-ieee
25951 Control the IEEE compliance of floating-point comparisons, which affects the
25952 handling of cases where the result of a comparison is unordered. By default
25953 @option{-mieee} is implicitly enabled. If @option{-ffinite-math-only} is
25954 enabled @option{-mno-ieee} is implicitly set, which results in faster
25955 floating-point greater-equal and less-equal comparisons. The implicit settings
25956 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25957
25958 @item -minline-ic_invalidate
25959 @opindex minline-ic_invalidate
25960 Inline code to invalidate instruction cache entries after setting up
25961 nested function trampolines.
25962 This option has no effect if @option{-musermode} is in effect and the selected
25963 code generation option (e.g.@: @option{-m4}) does not allow the use of the @code{icbi}
25964 instruction.
25965 If the selected code generation option does not allow the use of the @code{icbi}
25966 instruction, and @option{-musermode} is not in effect, the inlined code
25967 manipulates the instruction cache address array directly with an associative
25968 write. This not only requires privileged mode at run time, but it also
25969 fails if the cache line had been mapped via the TLB and has become unmapped.
25970
25971 @item -misize
25972 @opindex misize
25973 Dump instruction size and location in the assembly code.
25974
25975 @item -mpadstruct
25976 @opindex mpadstruct
25977 This option is deprecated. It pads structures to multiple of 4 bytes,
25978 which is incompatible with the SH ABI@.
25979
25980 @item -matomic-model=@var{model}
25981 @opindex matomic-model=@var{model}
25982 Sets the model of atomic operations and additional parameters as a comma
25983 separated list. For details on the atomic built-in functions see
25984 @ref{__atomic Builtins}. The following models and parameters are supported:
25985
25986 @table @samp
25987
25988 @item none
25989 Disable compiler generated atomic sequences and emit library calls for atomic
25990 operations. This is the default if the target is not @code{sh*-*-linux*}.
25991
25992 @item soft-gusa
25993 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25994 built-in functions. The generated atomic sequences require additional support
25995 from the interrupt/exception handling code of the system and are only suitable
25996 for SH3* and SH4* single-core systems. This option is enabled by default when
25997 the target is @code{sh*-*-linux*} and SH3* or SH4*. When the target is SH4A,
25998 this option also partially utilizes the hardware atomic instructions
25999 @code{movli.l} and @code{movco.l} to create more efficient code, unless
26000 @samp{strict} is specified.
26001
26002 @item soft-tcb
26003 Generate software atomic sequences that use a variable in the thread control
26004 block. This is a variation of the gUSA sequences which can also be used on
26005 SH1* and SH2* targets. The generated atomic sequences require additional
26006 support from the interrupt/exception handling code of the system and are only
26007 suitable for single-core systems. When using this model, the @samp{gbr-offset=}
26008 parameter has to be specified as well.
26009
26010 @item soft-imask
26011 Generate software atomic sequences that temporarily disable interrupts by
26012 setting @code{SR.IMASK = 1111}. This model works only when the program runs
26013 in privileged mode and is only suitable for single-core systems. Additional
26014 support from the interrupt/exception handling code of the system is not
26015 required. This model is enabled by default when the target is
26016 @code{sh*-*-linux*} and SH1* or SH2*.
26017
26018 @item hard-llcs
26019 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
26020 instructions only. This is only available on SH4A and is suitable for
26021 multi-core systems. Since the hardware instructions support only 32 bit atomic
26022 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
26023 Code compiled with this option is also compatible with other software
26024 atomic model interrupt/exception handling systems if executed on an SH4A
26025 system. Additional support from the interrupt/exception handling code of the
26026 system is not required for this model.
26027
26028 @item gbr-offset=
26029 This parameter specifies the offset in bytes of the variable in the thread
26030 control block structure that should be used by the generated atomic sequences
26031 when the @samp{soft-tcb} model has been selected. For other models this
26032 parameter is ignored. The specified value must be an integer multiple of four
26033 and in the range 0-1020.
26034
26035 @item strict
26036 This parameter prevents mixed usage of multiple atomic models, even if they
26037 are compatible, and makes the compiler generate atomic sequences of the
26038 specified model only.
26039
26040 @end table
26041
26042 @item -mtas
26043 @opindex mtas
26044 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
26045 Notice that depending on the particular hardware and software configuration
26046 this can degrade overall performance due to the operand cache line flushes
26047 that are implied by the @code{tas.b} instruction. On multi-core SH4A
26048 processors the @code{tas.b} instruction must be used with caution since it
26049 can result in data corruption for certain cache configurations.
26050
26051 @item -mprefergot
26052 @opindex mprefergot
26053 When generating position-independent code, emit function calls using
26054 the Global Offset Table instead of the Procedure Linkage Table.
26055
26056 @item -musermode
26057 @itemx -mno-usermode
26058 @opindex musermode
26059 @opindex mno-usermode
26060 Don't allow (allow) the compiler generating privileged mode code. Specifying
26061 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
26062 inlined code would not work in user mode. @option{-musermode} is the default
26063 when the target is @code{sh*-*-linux*}. If the target is SH1* or SH2*
26064 @option{-musermode} has no effect, since there is no user mode.
26065
26066 @item -multcost=@var{number}
26067 @opindex multcost=@var{number}
26068 Set the cost to assume for a multiply insn.
26069
26070 @item -mdiv=@var{strategy}
26071 @opindex mdiv=@var{strategy}
26072 Set the division strategy to be used for integer division operations.
26073 @var{strategy} can be one of:
26074
26075 @table @samp
26076
26077 @item call-div1
26078 Calls a library function that uses the single-step division instruction
26079 @code{div1} to perform the operation. Division by zero calculates an
26080 unspecified result and does not trap. This is the default except for SH4,
26081 SH2A and SHcompact.
26082
26083 @item call-fp
26084 Calls a library function that performs the operation in double precision
26085 floating point. Division by zero causes a floating-point exception. This is
26086 the default for SHcompact with FPU. Specifying this for targets that do not
26087 have a double precision FPU defaults to @code{call-div1}.
26088
26089 @item call-table
26090 Calls a library function that uses a lookup table for small divisors and
26091 the @code{div1} instruction with case distinction for larger divisors. Division
26092 by zero calculates an unspecified result and does not trap. This is the default
26093 for SH4. Specifying this for targets that do not have dynamic shift
26094 instructions defaults to @code{call-div1}.
26095
26096 @end table
26097
26098 When a division strategy has not been specified the default strategy is
26099 selected based on the current target. For SH2A the default strategy is to
26100 use the @code{divs} and @code{divu} instructions instead of library function
26101 calls.
26102
26103 @item -maccumulate-outgoing-args
26104 @opindex maccumulate-outgoing-args
26105 Reserve space once for outgoing arguments in the function prologue rather
26106 than around each call. Generally beneficial for performance and size. Also
26107 needed for unwinding to avoid changing the stack frame around conditional code.
26108
26109 @item -mdivsi3_libfunc=@var{name}
26110 @opindex mdivsi3_libfunc=@var{name}
26111 Set the name of the library function used for 32-bit signed division to
26112 @var{name}.
26113 This only affects the name used in the @samp{call} division strategies, and
26114 the compiler still expects the same sets of input/output/clobbered registers as
26115 if this option were not present.
26116
26117 @item -mfixed-range=@var{register-range}
26118 @opindex mfixed-range
26119 Generate code treating the given register range as fixed registers.
26120 A fixed register is one that the register allocator cannot use. This is
26121 useful when compiling kernel code. A register range is specified as
26122 two registers separated by a dash. Multiple register ranges can be
26123 specified separated by a comma.
26124
26125 @item -mbranch-cost=@var{num}
26126 @opindex mbranch-cost=@var{num}
26127 Assume @var{num} to be the cost for a branch instruction. Higher numbers
26128 make the compiler try to generate more branch-free code if possible.
26129 If not specified the value is selected depending on the processor type that
26130 is being compiled for.
26131
26132 @item -mzdcbranch
26133 @itemx -mno-zdcbranch
26134 @opindex mzdcbranch
26135 @opindex mno-zdcbranch
26136 Assume (do not assume) that zero displacement conditional branch instructions
26137 @code{bt} and @code{bf} are fast. If @option{-mzdcbranch} is specified, the
26138 compiler prefers zero displacement branch code sequences. This is
26139 enabled by default when generating code for SH4 and SH4A. It can be explicitly
26140 disabled by specifying @option{-mno-zdcbranch}.
26141
26142 @item -mcbranch-force-delay-slot
26143 @opindex mcbranch-force-delay-slot
26144 Force the usage of delay slots for conditional branches, which stuffs the delay
26145 slot with a @code{nop} if a suitable instruction cannot be found. By default
26146 this option is disabled. It can be enabled to work around hardware bugs as
26147 found in the original SH7055.
26148
26149 @item -mfused-madd
26150 @itemx -mno-fused-madd
26151 @opindex mfused-madd
26152 @opindex mno-fused-madd
26153 Generate code that uses (does not use) the floating-point multiply and
26154 accumulate instructions. These instructions are generated by default
26155 if hardware floating point is used. The machine-dependent
26156 @option{-mfused-madd} option is now mapped to the machine-independent
26157 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
26158 mapped to @option{-ffp-contract=off}.
26159
26160 @item -mfsca
26161 @itemx -mno-fsca
26162 @opindex mfsca
26163 @opindex mno-fsca
26164 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
26165 and cosine approximations. The option @option{-mfsca} must be used in
26166 combination with @option{-funsafe-math-optimizations}. It is enabled by default
26167 when generating code for SH4A. Using @option{-mno-fsca} disables sine and cosine
26168 approximations even if @option{-funsafe-math-optimizations} is in effect.
26169
26170 @item -mfsrra
26171 @itemx -mno-fsrra
26172 @opindex mfsrra
26173 @opindex mno-fsrra
26174 Allow or disallow the compiler to emit the @code{fsrra} instruction for
26175 reciprocal square root approximations. The option @option{-mfsrra} must be used
26176 in combination with @option{-funsafe-math-optimizations} and
26177 @option{-ffinite-math-only}. It is enabled by default when generating code for
26178 SH4A. Using @option{-mno-fsrra} disables reciprocal square root approximations
26179 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
26180 in effect.
26181
26182 @item -mpretend-cmove
26183 @opindex mpretend-cmove
26184 Prefer zero-displacement conditional branches for conditional move instruction
26185 patterns. This can result in faster code on the SH4 processor.
26186
26187 @item -mfdpic
26188 @opindex fdpic
26189 Generate code using the FDPIC ABI.
26190
26191 @end table
26192
26193 @node Solaris 2 Options
26194 @subsection Solaris 2 Options
26195 @cindex Solaris 2 options
26196
26197 These @samp{-m} options are supported on Solaris 2:
26198
26199 @table @gcctabopt
26200 @item -mclear-hwcap
26201 @opindex mclear-hwcap
26202 @option{-mclear-hwcap} tells the compiler to remove the hardware
26203 capabilities generated by the Solaris assembler. This is only necessary
26204 when object files use ISA extensions not supported by the current
26205 machine, but check at runtime whether or not to use them.
26206
26207 @item -mimpure-text
26208 @opindex mimpure-text
26209 @option{-mimpure-text}, used in addition to @option{-shared}, tells
26210 the compiler to not pass @option{-z text} to the linker when linking a
26211 shared object. Using this option, you can link position-dependent
26212 code into a shared object.
26213
26214 @option{-mimpure-text} suppresses the ``relocations remain against
26215 allocatable but non-writable sections'' linker error message.
26216 However, the necessary relocations trigger copy-on-write, and the
26217 shared object is not actually shared across processes. Instead of
26218 using @option{-mimpure-text}, you should compile all source code with
26219 @option{-fpic} or @option{-fPIC}.
26220
26221 @end table
26222
26223 These switches are supported in addition to the above on Solaris 2:
26224
26225 @table @gcctabopt
26226 @item -pthreads
26227 @opindex pthreads
26228 This is a synonym for @option{-pthread}.
26229 @end table
26230
26231 @node SPARC Options
26232 @subsection SPARC Options
26233 @cindex SPARC options
26234
26235 These @samp{-m} options are supported on the SPARC:
26236
26237 @table @gcctabopt
26238 @item -mno-app-regs
26239 @itemx -mapp-regs
26240 @opindex mno-app-regs
26241 @opindex mapp-regs
26242 Specify @option{-mapp-regs} to generate output using the global registers
26243 2 through 4, which the SPARC SVR4 ABI reserves for applications. Like the
26244 global register 1, each global register 2 through 4 is then treated as an
26245 allocable register that is clobbered by function calls. This is the default.
26246
26247 To be fully SVR4 ABI-compliant at the cost of some performance loss,
26248 specify @option{-mno-app-regs}. You should compile libraries and system
26249 software with this option.
26250
26251 @item -mflat
26252 @itemx -mno-flat
26253 @opindex mflat
26254 @opindex mno-flat
26255 With @option{-mflat}, the compiler does not generate save/restore instructions
26256 and uses a ``flat'' or single register window model. This model is compatible
26257 with the regular register window model. The local registers and the input
26258 registers (0--5) are still treated as ``call-saved'' registers and are
26259 saved on the stack as needed.
26260
26261 With @option{-mno-flat} (the default), the compiler generates save/restore
26262 instructions (except for leaf functions). This is the normal operating mode.
26263
26264 @item -mfpu
26265 @itemx -mhard-float
26266 @opindex mfpu
26267 @opindex mhard-float
26268 Generate output containing floating-point instructions. This is the
26269 default.
26270
26271 @item -mno-fpu
26272 @itemx -msoft-float
26273 @opindex mno-fpu
26274 @opindex msoft-float
26275 Generate output containing library calls for floating point.
26276 @strong{Warning:} the requisite libraries are not available for all SPARC
26277 targets. Normally the facilities of the machine's usual C compiler are
26278 used, but this cannot be done directly in cross-compilation. You must make
26279 your own arrangements to provide suitable library functions for
26280 cross-compilation. The embedded targets @samp{sparc-*-aout} and
26281 @samp{sparclite-*-*} do provide software floating-point support.
26282
26283 @option{-msoft-float} changes the calling convention in the output file;
26284 therefore, it is only useful if you compile @emph{all} of a program with
26285 this option. In particular, you need to compile @file{libgcc.a}, the
26286 library that comes with GCC, with @option{-msoft-float} in order for
26287 this to work.
26288
26289 @item -mhard-quad-float
26290 @opindex mhard-quad-float
26291 Generate output containing quad-word (long double) floating-point
26292 instructions.
26293
26294 @item -msoft-quad-float
26295 @opindex msoft-quad-float
26296 Generate output containing library calls for quad-word (long double)
26297 floating-point instructions. The functions called are those specified
26298 in the SPARC ABI@. This is the default.
26299
26300 As of this writing, there are no SPARC implementations that have hardware
26301 support for the quad-word floating-point instructions. They all invoke
26302 a trap handler for one of these instructions, and then the trap handler
26303 emulates the effect of the instruction. Because of the trap handler overhead,
26304 this is much slower than calling the ABI library routines. Thus the
26305 @option{-msoft-quad-float} option is the default.
26306
26307 @item -mno-unaligned-doubles
26308 @itemx -munaligned-doubles
26309 @opindex mno-unaligned-doubles
26310 @opindex munaligned-doubles
26311 Assume that doubles have 8-byte alignment. This is the default.
26312
26313 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
26314 alignment only if they are contained in another type, or if they have an
26315 absolute address. Otherwise, it assumes they have 4-byte alignment.
26316 Specifying this option avoids some rare compatibility problems with code
26317 generated by other compilers. It is not the default because it results
26318 in a performance loss, especially for floating-point code.
26319
26320 @item -muser-mode
26321 @itemx -mno-user-mode
26322 @opindex muser-mode
26323 @opindex mno-user-mode
26324 Do not generate code that can only run in supervisor mode. This is relevant
26325 only for the @code{casa} instruction emitted for the LEON3 processor. This
26326 is the default.
26327
26328 @item -mfaster-structs
26329 @itemx -mno-faster-structs
26330 @opindex mfaster-structs
26331 @opindex mno-faster-structs
26332 With @option{-mfaster-structs}, the compiler assumes that structures
26333 should have 8-byte alignment. This enables the use of pairs of
26334 @code{ldd} and @code{std} instructions for copies in structure
26335 assignment, in place of twice as many @code{ld} and @code{st} pairs.
26336 However, the use of this changed alignment directly violates the SPARC
26337 ABI@. Thus, it's intended only for use on targets where the developer
26338 acknowledges that their resulting code is not directly in line with
26339 the rules of the ABI@.
26340
26341 @item -mstd-struct-return
26342 @itemx -mno-std-struct-return
26343 @opindex mstd-struct-return
26344 @opindex mno-std-struct-return
26345 With @option{-mstd-struct-return}, the compiler generates checking code
26346 in functions returning structures or unions to detect size mismatches
26347 between the two sides of function calls, as per the 32-bit ABI@.
26348
26349 The default is @option{-mno-std-struct-return}. This option has no effect
26350 in 64-bit mode.
26351
26352 @item -mlra
26353 @itemx -mno-lra
26354 @opindex mlra
26355 @opindex mno-lra
26356 Enable Local Register Allocation. This is the default for SPARC since GCC 7
26357 so @option{-mno-lra} needs to be passed to get old Reload.
26358
26359 @item -mcpu=@var{cpu_type}
26360 @opindex mcpu
26361 Set the instruction set, register set, and instruction scheduling parameters
26362 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
26363 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
26364 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
26365 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
26366 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
26367 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
26368
26369 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
26370 which selects the best architecture option for the host processor.
26371 @option{-mcpu=native} has no effect if GCC does not recognize
26372 the processor.
26373
26374 Default instruction scheduling parameters are used for values that select
26375 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
26376 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
26377
26378 Here is a list of each supported architecture and their supported
26379 implementations.
26380
26381 @table @asis
26382 @item v7
26383 cypress, leon3v7
26384
26385 @item v8
26386 supersparc, hypersparc, leon, leon3
26387
26388 @item sparclite
26389 f930, f934, sparclite86x
26390
26391 @item sparclet
26392 tsc701
26393
26394 @item v9
26395 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
26396 niagara7, m8
26397 @end table
26398
26399 By default (unless configured otherwise), GCC generates code for the V7
26400 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
26401 additionally optimizes it for the Cypress CY7C602 chip, as used in the
26402 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
26403 SPARCStation 1, 2, IPX etc.
26404
26405 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
26406 architecture. The only difference from V7 code is that the compiler emits
26407 the integer multiply and integer divide instructions which exist in SPARC-V8
26408 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
26409 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
26410 2000 series.
26411
26412 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
26413 the SPARC architecture. This adds the integer multiply, integer divide step
26414 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
26415 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
26416 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
26417 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
26418 MB86934 chip, which is the more recent SPARClite with FPU@.
26419
26420 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
26421 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
26422 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
26423 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
26424 optimizes it for the TEMIC SPARClet chip.
26425
26426 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
26427 architecture. This adds 64-bit integer and floating-point move instructions,
26428 3 additional floating-point condition code registers and conditional move
26429 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
26430 optimizes it for the Sun UltraSPARC I/II/IIi chips. With
26431 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
26432 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With
26433 @option{-mcpu=niagara}, the compiler additionally optimizes it for
26434 Sun UltraSPARC T1 chips. With @option{-mcpu=niagara2}, the compiler
26435 additionally optimizes it for Sun UltraSPARC T2 chips. With
26436 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
26437 UltraSPARC T3 chips. With @option{-mcpu=niagara4}, the compiler
26438 additionally optimizes it for Sun UltraSPARC T4 chips. With
26439 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
26440 Oracle SPARC M7 chips. With @option{-mcpu=m8}, the compiler
26441 additionally optimizes it for Oracle M8 chips.
26442
26443 @item -mtune=@var{cpu_type}
26444 @opindex mtune
26445 Set the instruction scheduling parameters for machine type
26446 @var{cpu_type}, but do not set the instruction set or register set that the
26447 option @option{-mcpu=@var{cpu_type}} does.
26448
26449 The same values for @option{-mcpu=@var{cpu_type}} can be used for
26450 @option{-mtune=@var{cpu_type}}, but the only useful values are those
26451 that select a particular CPU implementation. Those are
26452 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
26453 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
26454 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
26455 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
26456 @samp{niagara4}, @samp{niagara7} and @samp{m8}. With native Solaris
26457 and GNU/Linux toolchains, @samp{native} can also be used.
26458
26459 @item -mv8plus
26460 @itemx -mno-v8plus
26461 @opindex mv8plus
26462 @opindex mno-v8plus
26463 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
26464 difference from the V8 ABI is that the global and out registers are
26465 considered 64 bits wide. This is enabled by default on Solaris in 32-bit
26466 mode for all SPARC-V9 processors.
26467
26468 @item -mvis
26469 @itemx -mno-vis
26470 @opindex mvis
26471 @opindex mno-vis
26472 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
26473 Visual Instruction Set extensions. The default is @option{-mno-vis}.
26474
26475 @item -mvis2
26476 @itemx -mno-vis2
26477 @opindex mvis2
26478 @opindex mno-vis2
26479 With @option{-mvis2}, GCC generates code that takes advantage of
26480 version 2.0 of the UltraSPARC Visual Instruction Set extensions. The
26481 default is @option{-mvis2} when targeting a cpu that supports such
26482 instructions, such as UltraSPARC-III and later. Setting @option{-mvis2}
26483 also sets @option{-mvis}.
26484
26485 @item -mvis3
26486 @itemx -mno-vis3
26487 @opindex mvis3
26488 @opindex mno-vis3
26489 With @option{-mvis3}, GCC generates code that takes advantage of
26490 version 3.0 of the UltraSPARC Visual Instruction Set extensions. The
26491 default is @option{-mvis3} when targeting a cpu that supports such
26492 instructions, such as niagara-3 and later. Setting @option{-mvis3}
26493 also sets @option{-mvis2} and @option{-mvis}.
26494
26495 @item -mvis4
26496 @itemx -mno-vis4
26497 @opindex mvis4
26498 @opindex mno-vis4
26499 With @option{-mvis4}, GCC generates code that takes advantage of
26500 version 4.0 of the UltraSPARC Visual Instruction Set extensions. The
26501 default is @option{-mvis4} when targeting a cpu that supports such
26502 instructions, such as niagara-7 and later. Setting @option{-mvis4}
26503 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
26504
26505 @item -mvis4b
26506 @itemx -mno-vis4b
26507 @opindex mvis4b
26508 @opindex mno-vis4b
26509 With @option{-mvis4b}, GCC generates code that takes advantage of
26510 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
26511 the additional VIS instructions introduced in the Oracle SPARC
26512 Architecture 2017. The default is @option{-mvis4b} when targeting a
26513 cpu that supports such instructions, such as m8 and later. Setting
26514 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
26515 @option{-mvis2} and @option{-mvis}.
26516
26517 @item -mcbcond
26518 @itemx -mno-cbcond
26519 @opindex mcbcond
26520 @opindex mno-cbcond
26521 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
26522 Compare-and-Branch-on-Condition instructions. The default is @option{-mcbcond}
26523 when targeting a CPU that supports such instructions, such as Niagara-4 and
26524 later.
26525
26526 @item -mfmaf
26527 @itemx -mno-fmaf
26528 @opindex mfmaf
26529 @opindex mno-fmaf
26530 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
26531 Fused Multiply-Add Floating-point instructions. The default is @option{-mfmaf}
26532 when targeting a CPU that supports such instructions, such as Niagara-3 and
26533 later.
26534
26535 @item -mfsmuld
26536 @itemx -mno-fsmuld
26537 @opindex mfsmuld
26538 @opindex mno-fsmuld
26539 With @option{-mfsmuld}, GCC generates code that takes advantage of the
26540 Floating-point Multiply Single to Double (FsMULd) instruction. The default is
26541 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
26542 or V9 with FPU except @option{-mcpu=leon}.
26543
26544 @item -mpopc
26545 @itemx -mno-popc
26546 @opindex mpopc
26547 @opindex mno-popc
26548 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
26549 Population Count instruction. The default is @option{-mpopc}
26550 when targeting a CPU that supports such an instruction, such as Niagara-2 and
26551 later.
26552
26553 @item -msubxc
26554 @itemx -mno-subxc
26555 @opindex msubxc
26556 @opindex mno-subxc
26557 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
26558 Subtract-Extended-with-Carry instruction. The default is @option{-msubxc}
26559 when targeting a CPU that supports such an instruction, such as Niagara-7 and
26560 later.
26561
26562 @item -mfix-at697f
26563 @opindex mfix-at697f
26564 Enable the documented workaround for the single erratum of the Atmel AT697F
26565 processor (which corresponds to erratum #13 of the AT697E processor).
26566
26567 @item -mfix-ut699
26568 @opindex mfix-ut699
26569 Enable the documented workarounds for the floating-point errata and the data
26570 cache nullify errata of the UT699 processor.
26571
26572 @item -mfix-ut700
26573 @opindex mfix-ut700
26574 Enable the documented workaround for the back-to-back store errata of
26575 the UT699E/UT700 processor.
26576
26577 @item -mfix-gr712rc
26578 @opindex mfix-gr712rc
26579 Enable the documented workaround for the back-to-back store errata of
26580 the GR712RC processor.
26581 @end table
26582
26583 These @samp{-m} options are supported in addition to the above
26584 on SPARC-V9 processors in 64-bit environments:
26585
26586 @table @gcctabopt
26587 @item -m32
26588 @itemx -m64
26589 @opindex m32
26590 @opindex m64
26591 Generate code for a 32-bit or 64-bit environment.
26592 The 32-bit environment sets int, long and pointer to 32 bits.
26593 The 64-bit environment sets int to 32 bits and long and pointer
26594 to 64 bits.
26595
26596 @item -mcmodel=@var{which}
26597 @opindex mcmodel
26598 Set the code model to one of
26599
26600 @table @samp
26601 @item medlow
26602 The Medium/Low code model: 64-bit addresses, programs
26603 must be linked in the low 32 bits of memory. Programs can be statically
26604 or dynamically linked.
26605
26606 @item medmid
26607 The Medium/Middle code model: 64-bit addresses, programs
26608 must be linked in the low 44 bits of memory, the text and data segments must
26609 be less than 2GB in size and the data segment must be located within 2GB of
26610 the text segment.
26611
26612 @item medany
26613 The Medium/Anywhere code model: 64-bit addresses, programs
26614 may be linked anywhere in memory, the text and data segments must be less
26615 than 2GB in size and the data segment must be located within 2GB of the
26616 text segment.
26617
26618 @item embmedany
26619 The Medium/Anywhere code model for embedded systems:
26620 64-bit addresses, the text and data segments must be less than 2GB in
26621 size, both starting anywhere in memory (determined at link time). The
26622 global register %g4 points to the base of the data segment. Programs
26623 are statically linked and PIC is not supported.
26624 @end table
26625
26626 @item -mmemory-model=@var{mem-model}
26627 @opindex mmemory-model
26628 Set the memory model in force on the processor to one of
26629
26630 @table @samp
26631 @item default
26632 The default memory model for the processor and operating system.
26633
26634 @item rmo
26635 Relaxed Memory Order
26636
26637 @item pso
26638 Partial Store Order
26639
26640 @item tso
26641 Total Store Order
26642
26643 @item sc
26644 Sequential Consistency
26645 @end table
26646
26647 These memory models are formally defined in Appendix D of the SPARC-V9
26648 architecture manual, as set in the processor's @code{PSTATE.MM} field.
26649
26650 @item -mstack-bias
26651 @itemx -mno-stack-bias
26652 @opindex mstack-bias
26653 @opindex mno-stack-bias
26654 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
26655 frame pointer if present, are offset by @minus{}2047 which must be added back
26656 when making stack frame references. This is the default in 64-bit mode.
26657 Otherwise, assume no such offset is present.
26658 @end table
26659
26660 @node SPU Options
26661 @subsection SPU Options
26662 @cindex SPU options
26663
26664 These @samp{-m} options are supported on the SPU:
26665
26666 @table @gcctabopt
26667 @item -mwarn-reloc
26668 @itemx -merror-reloc
26669 @opindex mwarn-reloc
26670 @opindex merror-reloc
26671
26672 The loader for SPU does not handle dynamic relocations. By default, GCC
26673 gives an error when it generates code that requires a dynamic
26674 relocation. @option{-mno-error-reloc} disables the error,
26675 @option{-mwarn-reloc} generates a warning instead.
26676
26677 @item -msafe-dma
26678 @itemx -munsafe-dma
26679 @opindex msafe-dma
26680 @opindex munsafe-dma
26681
26682 Instructions that initiate or test completion of DMA must not be
26683 reordered with respect to loads and stores of the memory that is being
26684 accessed.
26685 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
26686 memory accesses, but that can lead to inefficient code in places where the
26687 memory is known to not change. Rather than mark the memory as volatile,
26688 you can use @option{-msafe-dma} to tell the compiler to treat
26689 the DMA instructions as potentially affecting all memory.
26690
26691 @item -mbranch-hints
26692 @opindex mbranch-hints
26693
26694 By default, GCC generates a branch hint instruction to avoid
26695 pipeline stalls for always-taken or probably-taken branches. A hint
26696 is not generated closer than 8 instructions away from its branch.
26697 There is little reason to disable them, except for debugging purposes,
26698 or to make an object a little bit smaller.
26699
26700 @item -msmall-mem
26701 @itemx -mlarge-mem
26702 @opindex msmall-mem
26703 @opindex mlarge-mem
26704
26705 By default, GCC generates code assuming that addresses are never larger
26706 than 18 bits. With @option{-mlarge-mem} code is generated that assumes
26707 a full 32-bit address.
26708
26709 @item -mstdmain
26710 @opindex mstdmain
26711
26712 By default, GCC links against startup code that assumes the SPU-style
26713 main function interface (which has an unconventional parameter list).
26714 With @option{-mstdmain}, GCC links your program against startup
26715 code that assumes a C99-style interface to @code{main}, including a
26716 local copy of @code{argv} strings.
26717
26718 @item -mfixed-range=@var{register-range}
26719 @opindex mfixed-range
26720 Generate code treating the given register range as fixed registers.
26721 A fixed register is one that the register allocator cannot use. This is
26722 useful when compiling kernel code. A register range is specified as
26723 two registers separated by a dash. Multiple register ranges can be
26724 specified separated by a comma.
26725
26726 @item -mea32
26727 @itemx -mea64
26728 @opindex mea32
26729 @opindex mea64
26730 Compile code assuming that pointers to the PPU address space accessed
26731 via the @code{__ea} named address space qualifier are either 32 or 64
26732 bits wide. The default is 32 bits. As this is an ABI-changing option,
26733 all object code in an executable must be compiled with the same setting.
26734
26735 @item -maddress-space-conversion
26736 @itemx -mno-address-space-conversion
26737 @opindex maddress-space-conversion
26738 @opindex mno-address-space-conversion
26739 Allow/disallow treating the @code{__ea} address space as superset
26740 of the generic address space. This enables explicit type casts
26741 between @code{__ea} and generic pointer as well as implicit
26742 conversions of generic pointers to @code{__ea} pointers. The
26743 default is to allow address space pointer conversions.
26744
26745 @item -mcache-size=@var{cache-size}
26746 @opindex mcache-size
26747 This option controls the version of libgcc that the compiler links to an
26748 executable and selects a software-managed cache for accessing variables
26749 in the @code{__ea} address space with a particular cache size. Possible
26750 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
26751 and @samp{128}. The default cache size is 64KB.
26752
26753 @item -matomic-updates
26754 @itemx -mno-atomic-updates
26755 @opindex matomic-updates
26756 @opindex mno-atomic-updates
26757 This option controls the version of libgcc that the compiler links to an
26758 executable and selects whether atomic updates to the software-managed
26759 cache of PPU-side variables are used. If you use atomic updates, changes
26760 to a PPU variable from SPU code using the @code{__ea} named address space
26761 qualifier do not interfere with changes to other PPU variables residing
26762 in the same cache line from PPU code. If you do not use atomic updates,
26763 such interference may occur; however, writing back cache lines is
26764 more efficient. The default behavior is to use atomic updates.
26765
26766 @item -mdual-nops
26767 @itemx -mdual-nops=@var{n}
26768 @opindex mdual-nops
26769 By default, GCC inserts NOPs to increase dual issue when it expects
26770 it to increase performance. @var{n} can be a value from 0 to 10. A
26771 smaller @var{n} inserts fewer NOPs. 10 is the default, 0 is the
26772 same as @option{-mno-dual-nops}. Disabled with @option{-Os}.
26773
26774 @item -mhint-max-nops=@var{n}
26775 @opindex mhint-max-nops
26776 Maximum number of NOPs to insert for a branch hint. A branch hint must
26777 be at least 8 instructions away from the branch it is affecting. GCC
26778 inserts up to @var{n} NOPs to enforce this, otherwise it does not
26779 generate the branch hint.
26780
26781 @item -mhint-max-distance=@var{n}
26782 @opindex mhint-max-distance
26783 The encoding of the branch hint instruction limits the hint to be within
26784 256 instructions of the branch it is affecting. By default, GCC makes
26785 sure it is within 125.
26786
26787 @item -msafe-hints
26788 @opindex msafe-hints
26789 Work around a hardware bug that causes the SPU to stall indefinitely.
26790 By default, GCC inserts the @code{hbrp} instruction to make sure
26791 this stall won't happen.
26792
26793 @end table
26794
26795 @node System V Options
26796 @subsection Options for System V
26797
26798 These additional options are available on System V Release 4 for
26799 compatibility with other compilers on those systems:
26800
26801 @table @gcctabopt
26802 @item -G
26803 @opindex G
26804 Create a shared object.
26805 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
26806
26807 @item -Qy
26808 @opindex Qy
26809 Identify the versions of each tool used by the compiler, in a
26810 @code{.ident} assembler directive in the output.
26811
26812 @item -Qn
26813 @opindex Qn
26814 Refrain from adding @code{.ident} directives to the output file (this is
26815 the default).
26816
26817 @item -YP,@var{dirs}
26818 @opindex YP
26819 Search the directories @var{dirs}, and no others, for libraries
26820 specified with @option{-l}.
26821
26822 @item -Ym,@var{dir}
26823 @opindex Ym
26824 Look in the directory @var{dir} to find the M4 preprocessor.
26825 The assembler uses this option.
26826 @c This is supposed to go with a -Yd for predefined M4 macro files, but
26827 @c the generic assembler that comes with Solaris takes just -Ym.
26828 @end table
26829
26830 @node TILE-Gx Options
26831 @subsection TILE-Gx Options
26832 @cindex TILE-Gx options
26833
26834 These @samp{-m} options are supported on the TILE-Gx:
26835
26836 @table @gcctabopt
26837 @item -mcmodel=small
26838 @opindex mcmodel=small
26839 Generate code for the small model. The distance for direct calls is
26840 limited to 500M in either direction. PC-relative addresses are 32
26841 bits. Absolute addresses support the full address range.
26842
26843 @item -mcmodel=large
26844 @opindex mcmodel=large
26845 Generate code for the large model. There is no limitation on call
26846 distance, pc-relative addresses, or absolute addresses.
26847
26848 @item -mcpu=@var{name}
26849 @opindex mcpu
26850 Selects the type of CPU to be targeted. Currently the only supported
26851 type is @samp{tilegx}.
26852
26853 @item -m32
26854 @itemx -m64
26855 @opindex m32
26856 @opindex m64
26857 Generate code for a 32-bit or 64-bit environment. The 32-bit
26858 environment sets int, long, and pointer to 32 bits. The 64-bit
26859 environment sets int to 32 bits and long and pointer to 64 bits.
26860
26861 @item -mbig-endian
26862 @itemx -mlittle-endian
26863 @opindex mbig-endian
26864 @opindex mlittle-endian
26865 Generate code in big/little endian mode, respectively.
26866 @end table
26867
26868 @node TILEPro Options
26869 @subsection TILEPro Options
26870 @cindex TILEPro options
26871
26872 These @samp{-m} options are supported on the TILEPro:
26873
26874 @table @gcctabopt
26875 @item -mcpu=@var{name}
26876 @opindex mcpu
26877 Selects the type of CPU to be targeted. Currently the only supported
26878 type is @samp{tilepro}.
26879
26880 @item -m32
26881 @opindex m32
26882 Generate code for a 32-bit environment, which sets int, long, and
26883 pointer to 32 bits. This is the only supported behavior so the flag
26884 is essentially ignored.
26885 @end table
26886
26887 @node V850 Options
26888 @subsection V850 Options
26889 @cindex V850 Options
26890
26891 These @samp{-m} options are defined for V850 implementations:
26892
26893 @table @gcctabopt
26894 @item -mlong-calls
26895 @itemx -mno-long-calls
26896 @opindex mlong-calls
26897 @opindex mno-long-calls
26898 Treat all calls as being far away (near). If calls are assumed to be
26899 far away, the compiler always loads the function's address into a
26900 register, and calls indirect through the pointer.
26901
26902 @item -mno-ep
26903 @itemx -mep
26904 @opindex mno-ep
26905 @opindex mep
26906 Do not optimize (do optimize) basic blocks that use the same index
26907 pointer 4 or more times to copy pointer into the @code{ep} register, and
26908 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
26909 option is on by default if you optimize.
26910
26911 @item -mno-prolog-function
26912 @itemx -mprolog-function
26913 @opindex mno-prolog-function
26914 @opindex mprolog-function
26915 Do not use (do use) external functions to save and restore registers
26916 at the prologue and epilogue of a function. The external functions
26917 are slower, but use less code space if more than one function saves
26918 the same number of registers. The @option{-mprolog-function} option
26919 is on by default if you optimize.
26920
26921 @item -mspace
26922 @opindex mspace
26923 Try to make the code as small as possible. At present, this just turns
26924 on the @option{-mep} and @option{-mprolog-function} options.
26925
26926 @item -mtda=@var{n}
26927 @opindex mtda
26928 Put static or global variables whose size is @var{n} bytes or less into
26929 the tiny data area that register @code{ep} points to. The tiny data
26930 area can hold up to 256 bytes in total (128 bytes for byte references).
26931
26932 @item -msda=@var{n}
26933 @opindex msda
26934 Put static or global variables whose size is @var{n} bytes or less into
26935 the small data area that register @code{gp} points to. The small data
26936 area can hold up to 64 kilobytes.
26937
26938 @item -mzda=@var{n}
26939 @opindex mzda
26940 Put static or global variables whose size is @var{n} bytes or less into
26941 the first 32 kilobytes of memory.
26942
26943 @item -mv850
26944 @opindex mv850
26945 Specify that the target processor is the V850.
26946
26947 @item -mv850e3v5
26948 @opindex mv850e3v5
26949 Specify that the target processor is the V850E3V5. The preprocessor
26950 constant @code{__v850e3v5__} is defined if this option is used.
26951
26952 @item -mv850e2v4
26953 @opindex mv850e2v4
26954 Specify that the target processor is the V850E3V5. This is an alias for
26955 the @option{-mv850e3v5} option.
26956
26957 @item -mv850e2v3
26958 @opindex mv850e2v3
26959 Specify that the target processor is the V850E2V3. The preprocessor
26960 constant @code{__v850e2v3__} is defined if this option is used.
26961
26962 @item -mv850e2
26963 @opindex mv850e2
26964 Specify that the target processor is the V850E2. The preprocessor
26965 constant @code{__v850e2__} is defined if this option is used.
26966
26967 @item -mv850e1
26968 @opindex mv850e1
26969 Specify that the target processor is the V850E1. The preprocessor
26970 constants @code{__v850e1__} and @code{__v850e__} are defined if
26971 this option is used.
26972
26973 @item -mv850es
26974 @opindex mv850es
26975 Specify that the target processor is the V850ES. This is an alias for
26976 the @option{-mv850e1} option.
26977
26978 @item -mv850e
26979 @opindex mv850e
26980 Specify that the target processor is the V850E@. The preprocessor
26981 constant @code{__v850e__} is defined if this option is used.
26982
26983 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26984 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26985 are defined then a default target processor is chosen and the
26986 relevant @samp{__v850*__} preprocessor constant is defined.
26987
26988 The preprocessor constants @code{__v850} and @code{__v851__} are always
26989 defined, regardless of which processor variant is the target.
26990
26991 @item -mdisable-callt
26992 @itemx -mno-disable-callt
26993 @opindex mdisable-callt
26994 @opindex mno-disable-callt
26995 This option suppresses generation of the @code{CALLT} instruction for the
26996 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26997 architecture.
26998
26999 This option is enabled by default when the RH850 ABI is
27000 in use (see @option{-mrh850-abi}), and disabled by default when the
27001 GCC ABI is in use. If @code{CALLT} instructions are being generated
27002 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
27003
27004 @item -mrelax
27005 @itemx -mno-relax
27006 @opindex mrelax
27007 @opindex mno-relax
27008 Pass on (or do not pass on) the @option{-mrelax} command-line option
27009 to the assembler.
27010
27011 @item -mlong-jumps
27012 @itemx -mno-long-jumps
27013 @opindex mlong-jumps
27014 @opindex mno-long-jumps
27015 Disable (or re-enable) the generation of PC-relative jump instructions.
27016
27017 @item -msoft-float
27018 @itemx -mhard-float
27019 @opindex msoft-float
27020 @opindex mhard-float
27021 Disable (or re-enable) the generation of hardware floating point
27022 instructions. This option is only significant when the target
27023 architecture is @samp{V850E2V3} or higher. If hardware floating point
27024 instructions are being generated then the C preprocessor symbol
27025 @code{__FPU_OK__} is defined, otherwise the symbol
27026 @code{__NO_FPU__} is defined.
27027
27028 @item -mloop
27029 @opindex mloop
27030 Enables the use of the e3v5 LOOP instruction. The use of this
27031 instruction is not enabled by default when the e3v5 architecture is
27032 selected because its use is still experimental.
27033
27034 @item -mrh850-abi
27035 @itemx -mghs
27036 @opindex mrh850-abi
27037 @opindex mghs
27038 Enables support for the RH850 version of the V850 ABI. This is the
27039 default. With this version of the ABI the following rules apply:
27040
27041 @itemize
27042 @item
27043 Integer sized structures and unions are returned via a memory pointer
27044 rather than a register.
27045
27046 @item
27047 Large structures and unions (more than 8 bytes in size) are passed by
27048 value.
27049
27050 @item
27051 Functions are aligned to 16-bit boundaries.
27052
27053 @item
27054 The @option{-m8byte-align} command-line option is supported.
27055
27056 @item
27057 The @option{-mdisable-callt} command-line option is enabled by
27058 default. The @option{-mno-disable-callt} command-line option is not
27059 supported.
27060 @end itemize
27061
27062 When this version of the ABI is enabled the C preprocessor symbol
27063 @code{__V850_RH850_ABI__} is defined.
27064
27065 @item -mgcc-abi
27066 @opindex mgcc-abi
27067 Enables support for the old GCC version of the V850 ABI. With this
27068 version of the ABI the following rules apply:
27069
27070 @itemize
27071 @item
27072 Integer sized structures and unions are returned in register @code{r10}.
27073
27074 @item
27075 Large structures and unions (more than 8 bytes in size) are passed by
27076 reference.
27077
27078 @item
27079 Functions are aligned to 32-bit boundaries, unless optimizing for
27080 size.
27081
27082 @item
27083 The @option{-m8byte-align} command-line option is not supported.
27084
27085 @item
27086 The @option{-mdisable-callt} command-line option is supported but not
27087 enabled by default.
27088 @end itemize
27089
27090 When this version of the ABI is enabled the C preprocessor symbol
27091 @code{__V850_GCC_ABI__} is defined.
27092
27093 @item -m8byte-align
27094 @itemx -mno-8byte-align
27095 @opindex m8byte-align
27096 @opindex mno-8byte-align
27097 Enables support for @code{double} and @code{long long} types to be
27098 aligned on 8-byte boundaries. The default is to restrict the
27099 alignment of all objects to at most 4-bytes. When
27100 @option{-m8byte-align} is in effect the C preprocessor symbol
27101 @code{__V850_8BYTE_ALIGN__} is defined.
27102
27103 @item -mbig-switch
27104 @opindex mbig-switch
27105 Generate code suitable for big switch tables. Use this option only if
27106 the assembler/linker complain about out of range branches within a switch
27107 table.
27108
27109 @item -mapp-regs
27110 @opindex mapp-regs
27111 This option causes r2 and r5 to be used in the code generated by
27112 the compiler. This setting is the default.
27113
27114 @item -mno-app-regs
27115 @opindex mno-app-regs
27116 This option causes r2 and r5 to be treated as fixed registers.
27117
27118 @end table
27119
27120 @node VAX Options
27121 @subsection VAX Options
27122 @cindex VAX options
27123
27124 These @samp{-m} options are defined for the VAX:
27125
27126 @table @gcctabopt
27127 @item -munix
27128 @opindex munix
27129 Do not output certain jump instructions (@code{aobleq} and so on)
27130 that the Unix assembler for the VAX cannot handle across long
27131 ranges.
27132
27133 @item -mgnu
27134 @opindex mgnu
27135 Do output those jump instructions, on the assumption that the
27136 GNU assembler is being used.
27137
27138 @item -mg
27139 @opindex mg
27140 Output code for G-format floating-point numbers instead of D-format.
27141 @end table
27142
27143 @node Visium Options
27144 @subsection Visium Options
27145 @cindex Visium options
27146
27147 @table @gcctabopt
27148
27149 @item -mdebug
27150 @opindex mdebug
27151 A program which performs file I/O and is destined to run on an MCM target
27152 should be linked with this option. It causes the libraries libc.a and
27153 libdebug.a to be linked. The program should be run on the target under
27154 the control of the GDB remote debugging stub.
27155
27156 @item -msim
27157 @opindex msim
27158 A program which performs file I/O and is destined to run on the simulator
27159 should be linked with option. This causes libraries libc.a and libsim.a to
27160 be linked.
27161
27162 @item -mfpu
27163 @itemx -mhard-float
27164 @opindex mfpu
27165 @opindex mhard-float
27166 Generate code containing floating-point instructions. This is the
27167 default.
27168
27169 @item -mno-fpu
27170 @itemx -msoft-float
27171 @opindex mno-fpu
27172 @opindex msoft-float
27173 Generate code containing library calls for floating-point.
27174
27175 @option{-msoft-float} changes the calling convention in the output file;
27176 therefore, it is only useful if you compile @emph{all} of a program with
27177 this option. In particular, you need to compile @file{libgcc.a}, the
27178 library that comes with GCC, with @option{-msoft-float} in order for
27179 this to work.
27180
27181 @item -mcpu=@var{cpu_type}
27182 @opindex mcpu
27183 Set the instruction set, register set, and instruction scheduling parameters
27184 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
27185 @samp{mcm}, @samp{gr5} and @samp{gr6}.
27186
27187 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
27188
27189 By default (unless configured otherwise), GCC generates code for the GR5
27190 variant of the Visium architecture.
27191
27192 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
27193 architecture. The only difference from GR5 code is that the compiler will
27194 generate block move instructions.
27195
27196 @item -mtune=@var{cpu_type}
27197 @opindex mtune
27198 Set the instruction scheduling parameters for machine type @var{cpu_type},
27199 but do not set the instruction set or register set that the option
27200 @option{-mcpu=@var{cpu_type}} would.
27201
27202 @item -msv-mode
27203 @opindex msv-mode
27204 Generate code for the supervisor mode, where there are no restrictions on
27205 the access to general registers. This is the default.
27206
27207 @item -muser-mode
27208 @opindex muser-mode
27209 Generate code for the user mode, where the access to some general registers
27210 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
27211 mode; on the GR6, only registers r29 to r31 are affected.
27212 @end table
27213
27214 @node VMS Options
27215 @subsection VMS Options
27216
27217 These @samp{-m} options are defined for the VMS implementations:
27218
27219 @table @gcctabopt
27220 @item -mvms-return-codes
27221 @opindex mvms-return-codes
27222 Return VMS condition codes from @code{main}. The default is to return POSIX-style
27223 condition (e.g.@: error) codes.
27224
27225 @item -mdebug-main=@var{prefix}
27226 @opindex mdebug-main=@var{prefix}
27227 Flag the first routine whose name starts with @var{prefix} as the main
27228 routine for the debugger.
27229
27230 @item -mmalloc64
27231 @opindex mmalloc64
27232 Default to 64-bit memory allocation routines.
27233
27234 @item -mpointer-size=@var{size}
27235 @opindex mpointer-size=@var{size}
27236 Set the default size of pointers. Possible options for @var{size} are
27237 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
27238 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
27239 The later option disables @code{pragma pointer_size}.
27240 @end table
27241
27242 @node VxWorks Options
27243 @subsection VxWorks Options
27244 @cindex VxWorks Options
27245
27246 The options in this section are defined for all VxWorks targets.
27247 Options specific to the target hardware are listed with the other
27248 options for that target.
27249
27250 @table @gcctabopt
27251 @item -mrtp
27252 @opindex mrtp
27253 GCC can generate code for both VxWorks kernels and real time processes
27254 (RTPs). This option switches from the former to the latter. It also
27255 defines the preprocessor macro @code{__RTP__}.
27256
27257 @item -non-static
27258 @opindex non-static
27259 Link an RTP executable against shared libraries rather than static
27260 libraries. The options @option{-static} and @option{-shared} can
27261 also be used for RTPs (@pxref{Link Options}); @option{-static}
27262 is the default.
27263
27264 @item -Bstatic
27265 @itemx -Bdynamic
27266 @opindex Bstatic
27267 @opindex Bdynamic
27268 These options are passed down to the linker. They are defined for
27269 compatibility with Diab.
27270
27271 @item -Xbind-lazy
27272 @opindex Xbind-lazy
27273 Enable lazy binding of function calls. This option is equivalent to
27274 @option{-Wl,-z,now} and is defined for compatibility with Diab.
27275
27276 @item -Xbind-now
27277 @opindex Xbind-now
27278 Disable lazy binding of function calls. This option is the default and
27279 is defined for compatibility with Diab.
27280 @end table
27281
27282 @node x86 Options
27283 @subsection x86 Options
27284 @cindex x86 Options
27285
27286 These @samp{-m} options are defined for the x86 family of computers.
27287
27288 @table @gcctabopt
27289
27290 @item -march=@var{cpu-type}
27291 @opindex march
27292 Generate instructions for the machine type @var{cpu-type}. In contrast to
27293 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code
27294 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
27295 to generate code that may not run at all on processors other than the one
27296 indicated. Specifying @option{-march=@var{cpu-type}} implies
27297 @option{-mtune=@var{cpu-type}}.
27298
27299 The choices for @var{cpu-type} are:
27300
27301 @table @samp
27302 @item native
27303 This selects the CPU to generate code for at compilation time by determining
27304 the processor type of the compiling machine. Using @option{-march=native}
27305 enables all instruction subsets supported by the local machine (hence
27306 the result might not run on different machines). Using @option{-mtune=native}
27307 produces code optimized for the local machine under the constraints
27308 of the selected instruction set.
27309
27310 @item x86-64
27311 A generic CPU with 64-bit extensions.
27312
27313 @item i386
27314 Original Intel i386 CPU@.
27315
27316 @item i486
27317 Intel i486 CPU@. (No scheduling is implemented for this chip.)
27318
27319 @item i586
27320 @itemx pentium
27321 Intel Pentium CPU with no MMX support.
27322
27323 @item lakemont
27324 Intel Lakemont MCU, based on Intel Pentium CPU.
27325
27326 @item pentium-mmx
27327 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
27328
27329 @item pentiumpro
27330 Intel Pentium Pro CPU@.
27331
27332 @item i686
27333 When used with @option{-march}, the Pentium Pro
27334 instruction set is used, so the code runs on all i686 family chips.
27335 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
27336
27337 @item pentium2
27338 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
27339 support.
27340
27341 @item pentium3
27342 @itemx pentium3m
27343 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
27344 set support.
27345
27346 @item pentium-m
27347 Intel Pentium M; low-power version of Intel Pentium III CPU
27348 with MMX, SSE and SSE2 instruction set support. Used by Centrino notebooks.
27349
27350 @item pentium4
27351 @itemx pentium4m
27352 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
27353
27354 @item prescott
27355 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
27356 set support.
27357
27358 @item nocona
27359 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
27360 SSE2 and SSE3 instruction set support.
27361
27362 @item core2
27363 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
27364 instruction set support.
27365
27366 @item nehalem
27367 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27368 SSE4.1, SSE4.2 and POPCNT instruction set support.
27369
27370 @item westmere
27371 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27372 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
27373
27374 @item sandybridge
27375 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27376 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
27377
27378 @item ivybridge
27379 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
27380 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
27381 instruction set support.
27382
27383 @item haswell
27384 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27385 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27386 BMI, BMI2 and F16C instruction set support.
27387
27388 @item broadwell
27389 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27390 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27391 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
27392
27393 @item skylake
27394 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27395 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27396 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
27397 XSAVES instruction set support.
27398
27399 @item bonnell
27400 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
27401 instruction set support.
27402
27403 @item silvermont
27404 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27405 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
27406
27407 @item goldmont
27408 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27409 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
27410 instruction set support.
27411
27412 @item goldmont-plus
27413 Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27414 SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE,
27415 PTWRITE, RDPID, SGX and UMIP instruction set support.
27416
27417 @item tremont
27418 Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27419 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, PTWRITE,
27420 RDPID, SGX, UMIP, GFNI-SSE, CLWB and ENCLV instruction set support.
27421
27422 @item knl
27423 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27424 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27425 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
27426 AVX512CD instruction set support.
27427
27428 @item knm
27429 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27430 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27431 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27432 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
27433
27434 @item skylake-avx512
27435 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
27436 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
27437 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
27438 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
27439
27440 @item cannonlake
27441 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27442 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27443 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27444 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27445 AVX512IFMA, SHA and UMIP instruction set support.
27446
27447 @item icelake-client
27448 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27449 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27450 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27451 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27452 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
27453 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
27454
27455 @item icelake-server
27456 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
27457 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
27458 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
27459 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
27460 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
27461 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
27462 set support.
27463
27464 @item cascadelake
27465 Intel Cascadelake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
27466 SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA, BMI,
27467 BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, CLWB,
27468 AVX512VL, AVX512BW, AVX512DQ, AVX512CD and AVX512VNNI instruction set support.
27469
27470 @item k6
27471 AMD K6 CPU with MMX instruction set support.
27472
27473 @item k6-2
27474 @itemx k6-3
27475 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
27476
27477 @item athlon
27478 @itemx athlon-tbird
27479 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
27480 support.
27481
27482 @item athlon-4
27483 @itemx athlon-xp
27484 @itemx athlon-mp
27485 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
27486 instruction set support.
27487
27488 @item k8
27489 @itemx opteron
27490 @itemx athlon64
27491 @itemx athlon-fx
27492 Processors based on the AMD K8 core with x86-64 instruction set support,
27493 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
27494 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
27495 instruction set extensions.)
27496
27497 @item k8-sse3
27498 @itemx opteron-sse3
27499 @itemx athlon64-sse3
27500 Improved versions of AMD K8 cores with SSE3 instruction set support.
27501
27502 @item amdfam10
27503 @itemx barcelona
27504 CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This
27505 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
27506 instruction set extensions.)
27507
27508 @item bdver1
27509 CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This
27510 supersets FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
27511 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
27512 @item bdver2
27513 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
27514 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX,
27515 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set
27516 extensions.)
27517 @item bdver3
27518 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
27519 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES,
27520 PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and
27521 64-bit instruction set extensions.
27522 @item bdver4
27523 AMD Family 15h core based CPUs with x86-64 instruction set support. (This
27524 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP,
27525 AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1,
27526 SSE4.2, ABM and 64-bit instruction set extensions.
27527
27528 @item znver1
27529 AMD Family 17h core based CPUs with x86-64 instruction set support. (This
27530 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
27531 SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
27532 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
27533 instruction set extensions.
27534 @item znver2
27535 AMD Family 17h core based CPUs with x86-64 instruction set support. (This
27536 supersets BMI, BMI2, ,CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED,
27537 MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A,
27538 SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
27539 instruction set extensions.)
27540
27541
27542 @item btver1
27543 CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This
27544 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
27545 instruction set extensions.)
27546
27547 @item btver2
27548 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
27549 includes MOVBE, F16C, BMI, AVX, PCLMUL, AES, SSE4.2, SSE4.1, CX16, ABM,
27550 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
27551
27552 @item winchip-c6
27553 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
27554 set support.
27555
27556 @item winchip2
27557 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
27558 instruction set support.
27559
27560 @item c3
27561 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
27562 (No scheduling is implemented for this chip.)
27563
27564 @item c3-2
27565 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
27566 (No scheduling is implemented for this chip.)
27567
27568 @item c7
27569 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
27570 (No scheduling is implemented for this chip.)
27571
27572 @item samuel-2
27573 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
27574 (No scheduling is implemented for this chip.)
27575
27576 @item nehemiah
27577 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
27578 (No scheduling is implemented for this chip.)
27579
27580 @item esther
27581 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
27582 (No scheduling is implemented for this chip.)
27583
27584 @item eden-x2
27585 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
27586 (No scheduling is implemented for this chip.)
27587
27588 @item eden-x4
27589 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
27590 AVX and AVX2 instruction set support.
27591 (No scheduling is implemented for this chip.)
27592
27593 @item nano
27594 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27595 instruction set support.
27596 (No scheduling is implemented for this chip.)
27597
27598 @item nano-1000
27599 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27600 instruction set support.
27601 (No scheduling is implemented for this chip.)
27602
27603 @item nano-2000
27604 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
27605 instruction set support.
27606 (No scheduling is implemented for this chip.)
27607
27608 @item nano-3000
27609 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27610 instruction set support.
27611 (No scheduling is implemented for this chip.)
27612
27613 @item nano-x2
27614 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27615 instruction set support.
27616 (No scheduling is implemented for this chip.)
27617
27618 @item nano-x4
27619 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
27620 instruction set support.
27621 (No scheduling is implemented for this chip.)
27622
27623 @item geode
27624 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
27625 @end table
27626
27627 @item -mtune=@var{cpu-type}
27628 @opindex mtune
27629 Tune to @var{cpu-type} everything applicable about the generated code, except
27630 for the ABI and the set of available instructions.
27631 While picking a specific @var{cpu-type} schedules things appropriately
27632 for that particular chip, the compiler does not generate any code that
27633 cannot run on the default machine type unless you use a
27634 @option{-march=@var{cpu-type}} option.
27635 For example, if GCC is configured for i686-pc-linux-gnu
27636 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
27637 but still runs on i686 machines.
27638
27639 The choices for @var{cpu-type} are the same as for @option{-march}.
27640 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
27641
27642 @table @samp
27643 @item generic
27644 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
27645 If you know the CPU on which your code will run, then you should use
27646 the corresponding @option{-mtune} or @option{-march} option instead of
27647 @option{-mtune=generic}. But, if you do not know exactly what CPU users
27648 of your application will have, then you should use this option.
27649
27650 As new processors are deployed in the marketplace, the behavior of this
27651 option will change. Therefore, if you upgrade to a newer version of
27652 GCC, code generation controlled by this option will change to reflect
27653 the processors
27654 that are most common at the time that version of GCC is released.
27655
27656 There is no @option{-march=generic} option because @option{-march}
27657 indicates the instruction set the compiler can use, and there is no
27658 generic instruction set applicable to all processors. In contrast,
27659 @option{-mtune} indicates the processor (or, in this case, collection of
27660 processors) for which the code is optimized.
27661
27662 @item intel
27663 Produce code optimized for the most current Intel processors, which are
27664 Haswell and Silvermont for this version of GCC. If you know the CPU
27665 on which your code will run, then you should use the corresponding
27666 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
27667 But, if you want your application performs better on both Haswell and
27668 Silvermont, then you should use this option.
27669
27670 As new Intel processors are deployed in the marketplace, the behavior of
27671 this option will change. Therefore, if you upgrade to a newer version of
27672 GCC, code generation controlled by this option will change to reflect
27673 the most current Intel processors at the time that version of GCC is
27674 released.
27675
27676 There is no @option{-march=intel} option because @option{-march} indicates
27677 the instruction set the compiler can use, and there is no common
27678 instruction set applicable to all processors. In contrast,
27679 @option{-mtune} indicates the processor (or, in this case, collection of
27680 processors) for which the code is optimized.
27681 @end table
27682
27683 @item -mcpu=@var{cpu-type}
27684 @opindex mcpu
27685 A deprecated synonym for @option{-mtune}.
27686
27687 @item -mfpmath=@var{unit}
27688 @opindex mfpmath
27689 Generate floating-point arithmetic for selected unit @var{unit}. The choices
27690 for @var{unit} are:
27691
27692 @table @samp
27693 @item 387
27694 Use the standard 387 floating-point coprocessor present on the majority of chips and
27695 emulated otherwise. Code compiled with this option runs almost everywhere.
27696 The temporary results are computed in 80-bit precision instead of the precision
27697 specified by the type, resulting in slightly different results compared to most
27698 of other chips. See @option{-ffloat-store} for more detailed description.
27699
27700 This is the default choice for non-Darwin x86-32 targets.
27701
27702 @item sse
27703 Use scalar floating-point instructions present in the SSE instruction set.
27704 This instruction set is supported by Pentium III and newer chips,
27705 and in the AMD line
27706 by Athlon-4, Athlon XP and Athlon MP chips. The earlier version of the SSE
27707 instruction set supports only single-precision arithmetic, thus the double and
27708 extended-precision arithmetic are still done using 387. A later version, present
27709 only in Pentium 4 and AMD x86-64 chips, supports double-precision
27710 arithmetic too.
27711
27712 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
27713 or @option{-msse2} switches to enable SSE extensions and make this option
27714 effective. For the x86-64 compiler, these extensions are enabled by default.
27715
27716 The resulting code should be considerably faster in the majority of cases and avoid
27717 the numerical instability problems of 387 code, but may break some existing
27718 code that expects temporaries to be 80 bits.
27719
27720 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
27721 and the default choice for x86-32 targets with the SSE2 instruction set
27722 when @option{-ffast-math} is enabled.
27723
27724 @item sse,387
27725 @itemx sse+387
27726 @itemx both
27727 Attempt to utilize both instruction sets at once. This effectively doubles the
27728 amount of available registers, and on chips with separate execution units for
27729 387 and SSE the execution resources too. Use this option with care, as it is
27730 still experimental, because the GCC register allocator does not model separate
27731 functional units well, resulting in unstable performance.
27732 @end table
27733
27734 @item -masm=@var{dialect}
27735 @opindex masm=@var{dialect}
27736 Output assembly instructions using selected @var{dialect}. Also affects
27737 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
27738 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
27739 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
27740 not support @samp{intel}.
27741
27742 @item -mieee-fp
27743 @itemx -mno-ieee-fp
27744 @opindex mieee-fp
27745 @opindex mno-ieee-fp
27746 Control whether or not the compiler uses IEEE floating-point
27747 comparisons. These correctly handle the case where the result of a
27748 comparison is unordered.
27749
27750 @item -m80387
27751 @itemx -mhard-float
27752 @opindex 80387
27753 @opindex mhard-float
27754 Generate output containing 80387 instructions for floating point.
27755
27756 @item -mno-80387
27757 @itemx -msoft-float
27758 @opindex no-80387
27759 @opindex msoft-float
27760 Generate output containing library calls for floating point.
27761
27762 @strong{Warning:} the requisite libraries are not part of GCC@.
27763 Normally the facilities of the machine's usual C compiler are used, but
27764 this cannot be done directly in cross-compilation. You must make your
27765 own arrangements to provide suitable library functions for
27766 cross-compilation.
27767
27768 On machines where a function returns floating-point results in the 80387
27769 register stack, some floating-point opcodes may be emitted even if
27770 @option{-msoft-float} is used.
27771
27772 @item -mno-fp-ret-in-387
27773 @opindex mno-fp-ret-in-387
27774 @opindex mfp-ret-in-387
27775 Do not use the FPU registers for return values of functions.
27776
27777 The usual calling convention has functions return values of types
27778 @code{float} and @code{double} in an FPU register, even if there
27779 is no FPU@. The idea is that the operating system should emulate
27780 an FPU@.
27781
27782 The option @option{-mno-fp-ret-in-387} causes such values to be returned
27783 in ordinary CPU registers instead.
27784
27785 @item -mno-fancy-math-387
27786 @opindex mno-fancy-math-387
27787 @opindex mfancy-math-387
27788 Some 387 emulators do not support the @code{sin}, @code{cos} and
27789 @code{sqrt} instructions for the 387. Specify this option to avoid
27790 generating those instructions.
27791 This option is overridden when @option{-march}
27792 indicates that the target CPU always has an FPU and so the
27793 instruction does not need emulation. These
27794 instructions are not generated unless you also use the
27795 @option{-funsafe-math-optimizations} switch.
27796
27797 @item -malign-double
27798 @itemx -mno-align-double
27799 @opindex malign-double
27800 @opindex mno-align-double
27801 Control whether GCC aligns @code{double}, @code{long double}, and
27802 @code{long long} variables on a two-word boundary or a one-word
27803 boundary. Aligning @code{double} variables on a two-word boundary
27804 produces code that runs somewhat faster on a Pentium at the
27805 expense of more memory.
27806
27807 On x86-64, @option{-malign-double} is enabled by default.
27808
27809 @strong{Warning:} if you use the @option{-malign-double} switch,
27810 structures containing the above types are aligned differently than
27811 the published application binary interface specifications for the x86-32
27812 and are not binary compatible with structures in code compiled
27813 without that switch.
27814
27815 @item -m96bit-long-double
27816 @itemx -m128bit-long-double
27817 @opindex m96bit-long-double
27818 @opindex m128bit-long-double
27819 These switches control the size of @code{long double} type. The x86-32
27820 application binary interface specifies the size to be 96 bits,
27821 so @option{-m96bit-long-double} is the default in 32-bit mode.
27822
27823 Modern architectures (Pentium and newer) prefer @code{long double}
27824 to be aligned to an 8- or 16-byte boundary. In arrays or structures
27825 conforming to the ABI, this is not possible. So specifying
27826 @option{-m128bit-long-double} aligns @code{long double}
27827 to a 16-byte boundary by padding the @code{long double} with an additional
27828 32-bit zero.
27829
27830 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
27831 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
27832
27833 Notice that neither of these options enable any extra precision over the x87
27834 standard of 80 bits for a @code{long double}.
27835
27836 @strong{Warning:} if you override the default value for your target ABI, this
27837 changes the size of
27838 structures and arrays containing @code{long double} variables,
27839 as well as modifying the function calling convention for functions taking
27840 @code{long double}. Hence they are not binary-compatible
27841 with code compiled without that switch.
27842
27843 @item -mlong-double-64
27844 @itemx -mlong-double-80
27845 @itemx -mlong-double-128
27846 @opindex mlong-double-64
27847 @opindex mlong-double-80
27848 @opindex mlong-double-128
27849 These switches control the size of @code{long double} type. A size
27850 of 64 bits makes the @code{long double} type equivalent to the @code{double}
27851 type. This is the default for 32-bit Bionic C library. A size
27852 of 128 bits makes the @code{long double} type equivalent to the
27853 @code{__float128} type. This is the default for 64-bit Bionic C library.
27854
27855 @strong{Warning:} if you override the default value for your target ABI, this
27856 changes the size of
27857 structures and arrays containing @code{long double} variables,
27858 as well as modifying the function calling convention for functions taking
27859 @code{long double}. Hence they are not binary-compatible
27860 with code compiled without that switch.
27861
27862 @item -malign-data=@var{type}
27863 @opindex malign-data
27864 Control how GCC aligns variables. Supported values for @var{type} are
27865 @samp{compat} uses increased alignment value compatible uses GCC 4.8
27866 and earlier, @samp{abi} uses alignment value as specified by the
27867 psABI, and @samp{cacheline} uses increased alignment value to match
27868 the cache line size. @samp{compat} is the default.
27869
27870 @item -mlarge-data-threshold=@var{threshold}
27871 @opindex mlarge-data-threshold
27872 When @option{-mcmodel=medium} is specified, data objects larger than
27873 @var{threshold} are placed in the large data section. This value must be the
27874 same across all objects linked into the binary, and defaults to 65535.
27875
27876 @item -mrtd
27877 @opindex mrtd
27878 Use a different function-calling convention, in which functions that
27879 take a fixed number of arguments return with the @code{ret @var{num}}
27880 instruction, which pops their arguments while returning. This saves one
27881 instruction in the caller since there is no need to pop the arguments
27882 there.
27883
27884 You can specify that an individual function is called with this calling
27885 sequence with the function attribute @code{stdcall}. You can also
27886 override the @option{-mrtd} option by using the function attribute
27887 @code{cdecl}. @xref{Function Attributes}.
27888
27889 @strong{Warning:} this calling convention is incompatible with the one
27890 normally used on Unix, so you cannot use it if you need to call
27891 libraries compiled with the Unix compiler.
27892
27893 Also, you must provide function prototypes for all functions that
27894 take variable numbers of arguments (including @code{printf});
27895 otherwise incorrect code is generated for calls to those
27896 functions.
27897
27898 In addition, seriously incorrect code results if you call a
27899 function with too many arguments. (Normally, extra arguments are
27900 harmlessly ignored.)
27901
27902 @item -mregparm=@var{num}
27903 @opindex mregparm
27904 Control how many registers are used to pass integer arguments. By
27905 default, no registers are used to pass arguments, and at most 3
27906 registers can be used. You can control this behavior for a specific
27907 function by using the function attribute @code{regparm}.
27908 @xref{Function Attributes}.
27909
27910 @strong{Warning:} if you use this switch, and
27911 @var{num} is nonzero, then you must build all modules with the same
27912 value, including any libraries. This includes the system libraries and
27913 startup modules.
27914
27915 @item -msseregparm
27916 @opindex msseregparm
27917 Use SSE register passing conventions for float and double arguments
27918 and return values. You can control this behavior for a specific
27919 function by using the function attribute @code{sseregparm}.
27920 @xref{Function Attributes}.
27921
27922 @strong{Warning:} if you use this switch then you must build all
27923 modules with the same value, including any libraries. This includes
27924 the system libraries and startup modules.
27925
27926 @item -mvect8-ret-in-mem
27927 @opindex mvect8-ret-in-mem
27928 Return 8-byte vectors in memory instead of MMX registers. This is the
27929 default on VxWorks to match the ABI of the Sun Studio compilers until
27930 version 12. @emph{Only} use this option if you need to remain
27931 compatible with existing code produced by those previous compiler
27932 versions or older versions of GCC@.
27933
27934 @item -mpc32
27935 @itemx -mpc64
27936 @itemx -mpc80
27937 @opindex mpc32
27938 @opindex mpc64
27939 @opindex mpc80
27940
27941 Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32}
27942 is specified, the significands of results of floating-point operations are
27943 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27944 significands of results of floating-point operations to 53 bits (double
27945 precision) and @option{-mpc80} rounds the significands of results of
27946 floating-point operations to 64 bits (extended double precision), which is
27947 the default. When this option is used, floating-point operations in higher
27948 precisions are not available to the programmer without setting the FPU
27949 control word explicitly.
27950
27951 Setting the rounding of floating-point operations to less than the default
27952 80 bits can speed some programs by 2% or more. Note that some mathematical
27953 libraries assume that extended-precision (80-bit) floating-point operations
27954 are enabled by default; routines in such libraries could suffer significant
27955 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27956 when this option is used to set the precision to less than extended precision.
27957
27958 @item -mstackrealign
27959 @opindex mstackrealign
27960 Realign the stack at entry. On the x86, the @option{-mstackrealign}
27961 option generates an alternate prologue and epilogue that realigns the
27962 run-time stack if necessary. This supports mixing legacy codes that keep
27963 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27964 SSE compatibility. See also the attribute @code{force_align_arg_pointer},
27965 applicable to individual functions.
27966
27967 @item -mpreferred-stack-boundary=@var{num}
27968 @opindex mpreferred-stack-boundary
27969 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27970 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
27971 the default is 4 (16 bytes or 128 bits).
27972
27973 @strong{Warning:} When generating code for the x86-64 architecture with
27974 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27975 used to keep the stack boundary aligned to 8 byte boundary. Since
27976 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27977 intended to be used in controlled environment where stack space is
27978 important limitation. This option leads to wrong code when functions
27979 compiled with 16 byte stack alignment (such as functions from a standard
27980 library) are called with misaligned stack. In this case, SSE
27981 instructions may lead to misaligned memory access traps. In addition,
27982 variable arguments are handled incorrectly for 16 byte aligned
27983 objects (including x87 long double and __int128), leading to wrong
27984 results. You must build all modules with
27985 @option{-mpreferred-stack-boundary=3}, including any libraries. This
27986 includes the system libraries and startup modules.
27987
27988 @item -mincoming-stack-boundary=@var{num}
27989 @opindex mincoming-stack-boundary
27990 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27991 boundary. If @option{-mincoming-stack-boundary} is not specified,
27992 the one specified by @option{-mpreferred-stack-boundary} is used.
27993
27994 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27995 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27996 suffer significant run time performance penalties. On Pentium III, the
27997 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27998 properly if it is not 16-byte aligned.
27999
28000 To ensure proper alignment of this values on the stack, the stack boundary
28001 must be as aligned as that required by any value stored on the stack.
28002 Further, every function must be generated such that it keeps the stack
28003 aligned. Thus calling a function compiled with a higher preferred
28004 stack boundary from a function compiled with a lower preferred stack
28005 boundary most likely misaligns the stack. It is recommended that
28006 libraries that use callbacks always use the default setting.
28007
28008 This extra alignment does consume extra stack space, and generally
28009 increases code size. Code that is sensitive to stack space usage, such
28010 as embedded systems and operating system kernels, may want to reduce the
28011 preferred alignment to @option{-mpreferred-stack-boundary=2}.
28012
28013 @need 200
28014 @item -mmmx
28015 @opindex mmmx
28016 @need 200
28017 @itemx -msse
28018 @opindex msse
28019 @need 200
28020 @itemx -msse2
28021 @opindex msse2
28022 @need 200
28023 @itemx -msse3
28024 @opindex msse3
28025 @need 200
28026 @itemx -mssse3
28027 @opindex mssse3
28028 @need 200
28029 @itemx -msse4
28030 @opindex msse4
28031 @need 200
28032 @itemx -msse4a
28033 @opindex msse4a
28034 @need 200
28035 @itemx -msse4.1
28036 @opindex msse4.1
28037 @need 200
28038 @itemx -msse4.2
28039 @opindex msse4.2
28040 @need 200
28041 @itemx -mavx
28042 @opindex mavx
28043 @need 200
28044 @itemx -mavx2
28045 @opindex mavx2
28046 @need 200
28047 @itemx -mavx512f
28048 @opindex mavx512f
28049 @need 200
28050 @itemx -mavx512pf
28051 @opindex mavx512pf
28052 @need 200
28053 @itemx -mavx512er
28054 @opindex mavx512er
28055 @need 200
28056 @itemx -mavx512cd
28057 @opindex mavx512cd
28058 @need 200
28059 @itemx -mavx512vl
28060 @opindex mavx512vl
28061 @need 200
28062 @itemx -mavx512bw
28063 @opindex mavx512bw
28064 @need 200
28065 @itemx -mavx512dq
28066 @opindex mavx512dq
28067 @need 200
28068 @itemx -mavx512ifma
28069 @opindex mavx512ifma
28070 @need 200
28071 @itemx -mavx512vbmi
28072 @opindex mavx512vbmi
28073 @need 200
28074 @itemx -msha
28075 @opindex msha
28076 @need 200
28077 @itemx -maes
28078 @opindex maes
28079 @need 200
28080 @itemx -mpclmul
28081 @opindex mpclmul
28082 @need 200
28083 @itemx -mclflushopt
28084 @opindex mclflushopt
28085 @need 200
28086 @itemx -mclwb
28087 @opindex mclwb
28088 @need 200
28089 @itemx -mfsgsbase
28090 @opindex mfsgsbase
28091 @need 200
28092 @itemx -mptwrite
28093 @opindex mptwrite
28094 @need 200
28095 @itemx -mrdrnd
28096 @opindex mrdrnd
28097 @need 200
28098 @itemx -mf16c
28099 @opindex mf16c
28100 @need 200
28101 @itemx -mfma
28102 @opindex mfma
28103 @need 200
28104 @itemx -mpconfig
28105 @opindex mpconfig
28106 @need 200
28107 @itemx -mwbnoinvd
28108 @opindex mwbnoinvd
28109 @need 200
28110 @itemx -mfma4
28111 @opindex mfma4
28112 @need 200
28113 @itemx -mprfchw
28114 @opindex mprfchw
28115 @need 200
28116 @itemx -mrdpid
28117 @opindex mrdpid
28118 @need 200
28119 @itemx -mprefetchwt1
28120 @opindex mprefetchwt1
28121 @need 200
28122 @itemx -mrdseed
28123 @opindex mrdseed
28124 @need 200
28125 @itemx -msgx
28126 @opindex msgx
28127 @need 200
28128 @itemx -mxop
28129 @opindex mxop
28130 @need 200
28131 @itemx -mlwp
28132 @opindex mlwp
28133 @need 200
28134 @itemx -m3dnow
28135 @opindex m3dnow
28136 @need 200
28137 @itemx -m3dnowa
28138 @opindex m3dnowa
28139 @need 200
28140 @itemx -mpopcnt
28141 @opindex mpopcnt
28142 @need 200
28143 @itemx -mabm
28144 @opindex mabm
28145 @need 200
28146 @itemx -madx
28147 @opindex madx
28148 @need 200
28149 @itemx -mbmi
28150 @opindex mbmi
28151 @need 200
28152 @itemx -mbmi2
28153 @opindex mbmi2
28154 @need 200
28155 @itemx -mlzcnt
28156 @opindex mlzcnt
28157 @need 200
28158 @itemx -mfxsr
28159 @opindex mfxsr
28160 @need 200
28161 @itemx -mxsave
28162 @opindex mxsave
28163 @need 200
28164 @itemx -mxsaveopt
28165 @opindex mxsaveopt
28166 @need 200
28167 @itemx -mxsavec
28168 @opindex mxsavec
28169 @need 200
28170 @itemx -mxsaves
28171 @opindex mxsaves
28172 @need 200
28173 @itemx -mrtm
28174 @opindex mrtm
28175 @need 200
28176 @itemx -mhle
28177 @opindex mhle
28178 @need 200
28179 @itemx -mtbm
28180 @opindex mtbm
28181 @need 200
28182 @itemx -mmwaitx
28183 @opindex mmwaitx
28184 @need 200
28185 @itemx -mclzero
28186 @opindex mclzero
28187 @need 200
28188 @itemx -mpku
28189 @opindex mpku
28190 @need 200
28191 @itemx -mavx512vbmi2
28192 @opindex mavx512vbmi2
28193 @need 200
28194 @itemx -mavx512bf16
28195 @opindex mavx512bf16
28196 @need 200
28197 @itemx -mgfni
28198 @opindex mgfni
28199 @need 200
28200 @itemx -mvaes
28201 @opindex mvaes
28202 @need 200
28203 @itemx -mwaitpkg
28204 @opindex mwaitpkg
28205 @need 200
28206 @itemx -mvpclmulqdq
28207 @opindex mvpclmulqdq
28208 @need 200
28209 @itemx -mavx512bitalg
28210 @opindex mavx512bitalg
28211 @need 200
28212 @itemx -mmovdiri
28213 @opindex mmovdiri
28214 @need 200
28215 @itemx -mmovdir64b
28216 @opindex mmovdir64b
28217 @need 200
28218 @itemx -menqcmd
28219 @opindex menqcmd
28220 @need 200
28221 @itemx -mavx512vpopcntdq
28222 @opindex mavx512vpopcntdq
28223 @need 200
28224 @itemx -mavx512vp2intersect
28225 @opindex mavx512vp2intersect
28226 @need 200
28227 @itemx -mavx5124fmaps
28228 @opindex mavx5124fmaps
28229 @need 200
28230 @itemx -mavx512vnni
28231 @opindex mavx512vnni
28232 @need 200
28233 @itemx -mavx5124vnniw
28234 @opindex mavx5124vnniw
28235 @need 200
28236 @itemx -mcldemote
28237 @opindex mcldemote
28238 These switches enable the use of instructions in the MMX, SSE,
28239 SSE2, SSE3, SSSE3, SSE4, SSE4A, SSE4.1, SSE4.2, AVX, AVX2, AVX512F, AVX512PF,
28240 AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, SHA,
28241 AES, PCLMUL, CLFLUSHOPT, CLWB, FSGSBASE, PTWRITE, RDRND, F16C, FMA, PCONFIG,
28242 WBNOINVD, FMA4, PREFETCHW, RDPID, PREFETCHWT1, RDSEED, SGX, XOP, LWP,
28243 3DNow!@:, enhanced 3DNow!@:, POPCNT, ABM, ADX, BMI, BMI2, LZCNT, FXSR, XSAVE,
28244 XSAVEOPT, XSAVEC, XSAVES, RTM, HLE, TBM, MWAITX, CLZERO, PKU, AVX512VBMI2,
28245 GFNI, VAES, WAITPKG, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B, AVX512BF16,
28246 ENQCMD, AVX512VPOPCNTDQ, AVX5124FMAPS, AVX512VNNI, AVX5124VNNIW, or CLDEMOTE
28247 extended instruction sets. Each has a corresponding @option{-mno-} option to
28248 disable use of these instructions.
28249
28250 These extensions are also available as built-in functions: see
28251 @ref{x86 Built-in Functions}, for details of the functions enabled and
28252 disabled by these switches.
28253
28254 To generate SSE/SSE2 instructions automatically from floating-point
28255 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
28256
28257 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
28258 generates new AVX instructions or AVX equivalence for all SSEx instructions
28259 when needed.
28260
28261 These options enable GCC to use these extended instructions in
28262 generated code, even without @option{-mfpmath=sse}. Applications that
28263 perform run-time CPU detection must compile separate files for each
28264 supported architecture, using the appropriate flags. In particular,
28265 the file containing the CPU detection code should be compiled without
28266 these options.
28267
28268 @item -mdump-tune-features
28269 @opindex mdump-tune-features
28270 This option instructs GCC to dump the names of the x86 performance
28271 tuning features and default settings. The names can be used in
28272 @option{-mtune-ctrl=@var{feature-list}}.
28273
28274 @item -mtune-ctrl=@var{feature-list}
28275 @opindex mtune-ctrl=@var{feature-list}
28276 This option is used to do fine grain control of x86 code generation features.
28277 @var{feature-list} is a comma separated list of @var{feature} names. See also
28278 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
28279 on if it is not preceded with @samp{^}, otherwise, it is turned off.
28280 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
28281 developers. Using it may lead to code paths not covered by testing and can
28282 potentially result in compiler ICEs or runtime errors.
28283
28284 @item -mno-default
28285 @opindex mno-default
28286 This option instructs GCC to turn off all tunable features. See also
28287 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
28288
28289 @item -mcld
28290 @opindex mcld
28291 This option instructs GCC to emit a @code{cld} instruction in the prologue
28292 of functions that use string instructions. String instructions depend on
28293 the DF flag to select between autoincrement or autodecrement mode. While the
28294 ABI specifies the DF flag to be cleared on function entry, some operating
28295 systems violate this specification by not clearing the DF flag in their
28296 exception dispatchers. The exception handler can be invoked with the DF flag
28297 set, which leads to wrong direction mode when string instructions are used.
28298 This option can be enabled by default on 32-bit x86 targets by configuring
28299 GCC with the @option{--enable-cld} configure option. Generation of @code{cld}
28300 instructions can be suppressed with the @option{-mno-cld} compiler option
28301 in this case.
28302
28303 @item -mvzeroupper
28304 @opindex mvzeroupper
28305 This option instructs GCC to emit a @code{vzeroupper} instruction
28306 before a transfer of control flow out of the function to minimize
28307 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
28308 intrinsics.
28309
28310 @item -mprefer-avx128
28311 @opindex mprefer-avx128
28312 This option instructs GCC to use 128-bit AVX instructions instead of
28313 256-bit AVX instructions in the auto-vectorizer.
28314
28315 @item -mprefer-vector-width=@var{opt}
28316 @opindex mprefer-vector-width
28317 This option instructs GCC to use @var{opt}-bit vector width in instructions
28318 instead of default on the selected platform.
28319
28320 @table @samp
28321 @item none
28322 No extra limitations applied to GCC other than defined by the selected platform.
28323
28324 @item 128
28325 Prefer 128-bit vector width for instructions.
28326
28327 @item 256
28328 Prefer 256-bit vector width for instructions.
28329
28330 @item 512
28331 Prefer 512-bit vector width for instructions.
28332 @end table
28333
28334 @item -mcx16
28335 @opindex mcx16
28336 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
28337 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
28338 objects. This is useful for atomic updates of data structures exceeding one
28339 machine word in size. The compiler uses this instruction to implement
28340 @ref{__sync Builtins}. However, for @ref{__atomic Builtins} operating on
28341 128-bit integers, a library call is always used.
28342
28343 @item -msahf
28344 @opindex msahf
28345 This option enables generation of @code{SAHF} instructions in 64-bit code.
28346 Early Intel Pentium 4 CPUs with Intel 64 support,
28347 prior to the introduction of Pentium 4 G1 step in December 2005,
28348 lacked the @code{LAHF} and @code{SAHF} instructions
28349 which are supported by AMD64.
28350 These are load and store instructions, respectively, for certain status flags.
28351 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
28352 @code{drem}, and @code{remainder} built-in functions;
28353 see @ref{Other Builtins} for details.
28354
28355 @item -mmovbe
28356 @opindex mmovbe
28357 This option enables use of the @code{movbe} instruction to implement
28358 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
28359
28360 @item -mshstk
28361 @opindex mshstk
28362 The @option{-mshstk} option enables shadow stack built-in functions
28363 from x86 Control-flow Enforcement Technology (CET).
28364
28365 @item -mcrc32
28366 @opindex mcrc32
28367 This option enables built-in functions @code{__builtin_ia32_crc32qi},
28368 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
28369 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
28370
28371 @item -mrecip
28372 @opindex mrecip
28373 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
28374 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
28375 with an additional Newton-Raphson step
28376 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
28377 (and their vectorized
28378 variants) for single-precision floating-point arguments. These instructions
28379 are generated only when @option{-funsafe-math-optimizations} is enabled
28380 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
28381 Note that while the throughput of the sequence is higher than the throughput
28382 of the non-reciprocal instruction, the precision of the sequence can be
28383 decreased by up to 2 ulp (i.e.@: the inverse of 1.0 equals 0.99999994).
28384
28385 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
28386 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
28387 combination), and doesn't need @option{-mrecip}.
28388
28389 Also note that GCC emits the above sequence with additional Newton-Raphson step
28390 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
28391 already with @option{-ffast-math} (or the above option combination), and
28392 doesn't need @option{-mrecip}.
28393
28394 @item -mrecip=@var{opt}
28395 @opindex mrecip=opt
28396 This option controls which reciprocal estimate instructions
28397 may be used. @var{opt} is a comma-separated list of options, which may
28398 be preceded by a @samp{!} to invert the option:
28399
28400 @table @samp
28401 @item all
28402 Enable all estimate instructions.
28403
28404 @item default
28405 Enable the default instructions, equivalent to @option{-mrecip}.
28406
28407 @item none
28408 Disable all estimate instructions, equivalent to @option{-mno-recip}.
28409
28410 @item div
28411 Enable the approximation for scalar division.
28412
28413 @item vec-div
28414 Enable the approximation for vectorized division.
28415
28416 @item sqrt
28417 Enable the approximation for scalar square root.
28418
28419 @item vec-sqrt
28420 Enable the approximation for vectorized square root.
28421 @end table
28422
28423 So, for example, @option{-mrecip=all,!sqrt} enables
28424 all of the reciprocal approximations, except for square root.
28425
28426 @item -mveclibabi=@var{type}
28427 @opindex mveclibabi
28428 Specifies the ABI type to use for vectorizing intrinsics using an
28429 external library. Supported values for @var{type} are @samp{svml}
28430 for the Intel short
28431 vector math library and @samp{acml} for the AMD math core library.
28432 To use this option, both @option{-ftree-vectorize} and
28433 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML
28434 ABI-compatible library must be specified at link time.
28435
28436 GCC currently emits calls to @code{vmldExp2},
28437 @code{vmldLn2}, @code{vmldLog102}, @code{vmldPow2},
28438 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
28439 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
28440 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
28441 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4},
28442 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
28443 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
28444 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
28445 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
28446 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
28447 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
28448 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
28449 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
28450 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
28451 when @option{-mveclibabi=acml} is used.
28452
28453 @item -mabi=@var{name}
28454 @opindex mabi
28455 Generate code for the specified calling convention. Permissible values
28456 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
28457 @samp{ms} for the Microsoft ABI. The default is to use the Microsoft
28458 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
28459 You can control this behavior for specific functions by
28460 using the function attributes @code{ms_abi} and @code{sysv_abi}.
28461 @xref{Function Attributes}.
28462
28463 @item -mforce-indirect-call
28464 @opindex mforce-indirect-call
28465 Force all calls to functions to be indirect. This is useful
28466 when using Intel Processor Trace where it generates more precise timing
28467 information for function calls.
28468
28469 @item -mmanual-endbr
28470 @opindex mmanual-endbr
28471 Insert ENDBR instruction at function entry only via the @code{cf_check}
28472 function attribute. This is useful when used with the option
28473 @option{-fcf-protection=branch} to control ENDBR insertion at the
28474 function entry.
28475
28476 @item -mcall-ms2sysv-xlogues
28477 @opindex mcall-ms2sysv-xlogues
28478 @opindex mno-call-ms2sysv-xlogues
28479 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
28480 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered. By
28481 default, the code for saving and restoring these registers is emitted inline,
28482 resulting in fairly lengthy prologues and epilogues. Using
28483 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
28484 use stubs in the static portion of libgcc to perform these saves and restores,
28485 thus reducing function size at the cost of a few extra instructions.
28486
28487 @item -mtls-dialect=@var{type}
28488 @opindex mtls-dialect
28489 Generate code to access thread-local storage using the @samp{gnu} or
28490 @samp{gnu2} conventions. @samp{gnu} is the conservative default;
28491 @samp{gnu2} is more efficient, but it may add compile- and run-time
28492 requirements that cannot be satisfied on all systems.
28493
28494 @item -mpush-args
28495 @itemx -mno-push-args
28496 @opindex mpush-args
28497 @opindex mno-push-args
28498 Use PUSH operations to store outgoing parameters. This method is shorter
28499 and usually equally fast as method using SUB/MOV operations and is enabled
28500 by default. In some cases disabling it may improve performance because of
28501 improved scheduling and reduced dependencies.
28502
28503 @item -maccumulate-outgoing-args
28504 @opindex maccumulate-outgoing-args
28505 If enabled, the maximum amount of space required for outgoing arguments is
28506 computed in the function prologue. This is faster on most modern CPUs
28507 because of reduced dependencies, improved scheduling and reduced stack usage
28508 when the preferred stack boundary is not equal to 2. The drawback is a notable
28509 increase in code size. This switch implies @option{-mno-push-args}.
28510
28511 @item -mthreads
28512 @opindex mthreads
28513 Support thread-safe exception handling on MinGW. Programs that rely
28514 on thread-safe exception handling must compile and link all code with the
28515 @option{-mthreads} option. When compiling, @option{-mthreads} defines
28516 @option{-D_MT}; when linking, it links in a special thread helper library
28517 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
28518
28519 @item -mms-bitfields
28520 @itemx -mno-ms-bitfields
28521 @opindex mms-bitfields
28522 @opindex mno-ms-bitfields
28523
28524 Enable/disable bit-field layout compatible with the native Microsoft
28525 Windows compiler.
28526
28527 If @code{packed} is used on a structure, or if bit-fields are used,
28528 it may be that the Microsoft ABI lays out the structure differently
28529 than the way GCC normally does. Particularly when moving packed
28530 data between functions compiled with GCC and the native Microsoft compiler
28531 (either via function call or as data in a file), it may be necessary to access
28532 either format.
28533
28534 This option is enabled by default for Microsoft Windows
28535 targets. This behavior can also be controlled locally by use of variable
28536 or type attributes. For more information, see @ref{x86 Variable Attributes}
28537 and @ref{x86 Type Attributes}.
28538
28539 The Microsoft structure layout algorithm is fairly simple with the exception
28540 of the bit-field packing.
28541 The padding and alignment of members of structures and whether a bit-field
28542 can straddle a storage-unit boundary are determine by these rules:
28543
28544 @enumerate
28545 @item Structure members are stored sequentially in the order in which they are
28546 declared: the first member has the lowest memory address and the last member
28547 the highest.
28548
28549 @item Every data object has an alignment requirement. The alignment requirement
28550 for all data except structures, unions, and arrays is either the size of the
28551 object or the current packing size (specified with either the
28552 @code{aligned} attribute or the @code{pack} pragma),
28553 whichever is less. For structures, unions, and arrays,
28554 the alignment requirement is the largest alignment requirement of its members.
28555 Every object is allocated an offset so that:
28556
28557 @smallexample
28558 offset % alignment_requirement == 0
28559 @end smallexample
28560
28561 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
28562 unit if the integral types are the same size and if the next bit-field fits
28563 into the current allocation unit without crossing the boundary imposed by the
28564 common alignment requirements of the bit-fields.
28565 @end enumerate
28566
28567 MSVC interprets zero-length bit-fields in the following ways:
28568
28569 @enumerate
28570 @item If a zero-length bit-field is inserted between two bit-fields that
28571 are normally coalesced, the bit-fields are not coalesced.
28572
28573 For example:
28574
28575 @smallexample
28576 struct
28577 @{
28578 unsigned long bf_1 : 12;
28579 unsigned long : 0;
28580 unsigned long bf_2 : 12;
28581 @} t1;
28582 @end smallexample
28583
28584 @noindent
28585 The size of @code{t1} is 8 bytes with the zero-length bit-field. If the
28586 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
28587
28588 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
28589 alignment of the zero-length bit-field is greater than the member that follows it,
28590 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
28591
28592 For example:
28593
28594 @smallexample
28595 struct
28596 @{
28597 char foo : 4;
28598 short : 0;
28599 char bar;
28600 @} t2;
28601
28602 struct
28603 @{
28604 char foo : 4;
28605 short : 0;
28606 double bar;
28607 @} t3;
28608 @end smallexample
28609
28610 @noindent
28611 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
28612 Accordingly, the size of @code{t2} is 4. For @code{t3}, the zero-length
28613 bit-field does not affect the alignment of @code{bar} or, as a result, the size
28614 of the structure.
28615
28616 Taking this into account, it is important to note the following:
28617
28618 @enumerate
28619 @item If a zero-length bit-field follows a normal bit-field, the type of the
28620 zero-length bit-field may affect the alignment of the structure as whole. For
28621 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
28622 normal bit-field, and is of type short.
28623
28624 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
28625 still affect the alignment of the structure:
28626
28627 @smallexample
28628 struct
28629 @{
28630 char foo : 6;
28631 long : 0;
28632 @} t4;
28633 @end smallexample
28634
28635 @noindent
28636 Here, @code{t4} takes up 4 bytes.
28637 @end enumerate
28638
28639 @item Zero-length bit-fields following non-bit-field members are ignored:
28640
28641 @smallexample
28642 struct
28643 @{
28644 char foo;
28645 long : 0;
28646 char bar;
28647 @} t5;
28648 @end smallexample
28649
28650 @noindent
28651 Here, @code{t5} takes up 2 bytes.
28652 @end enumerate
28653
28654
28655 @item -mno-align-stringops
28656 @opindex mno-align-stringops
28657 @opindex malign-stringops
28658 Do not align the destination of inlined string operations. This switch reduces
28659 code size and improves performance in case the destination is already aligned,
28660 but GCC doesn't know about it.
28661
28662 @item -minline-all-stringops
28663 @opindex minline-all-stringops
28664 By default GCC inlines string operations only when the destination is
28665 known to be aligned to least a 4-byte boundary.
28666 This enables more inlining and increases code
28667 size, but may improve performance of code that depends on fast
28668 @code{memcpy} and @code{memset} for short lengths.
28669 The option enables inline expansion of @code{strlen} for all
28670 pointer alignments.
28671
28672 @item -minline-stringops-dynamically
28673 @opindex minline-stringops-dynamically
28674 For string operations of unknown size, use run-time checks with
28675 inline code for small blocks and a library call for large blocks.
28676
28677 @item -mstringop-strategy=@var{alg}
28678 @opindex mstringop-strategy=@var{alg}
28679 Override the internal decision heuristic for the particular algorithm to use
28680 for inlining string operations. The allowed values for @var{alg} are:
28681
28682 @table @samp
28683 @item rep_byte
28684 @itemx rep_4byte
28685 @itemx rep_8byte
28686 Expand using i386 @code{rep} prefix of the specified size.
28687
28688 @item byte_loop
28689 @itemx loop
28690 @itemx unrolled_loop
28691 Expand into an inline loop.
28692
28693 @item libcall
28694 Always use a library call.
28695 @end table
28696
28697 @item -mmemcpy-strategy=@var{strategy}
28698 @opindex mmemcpy-strategy=@var{strategy}
28699 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
28700 should be inlined and what inline algorithm to use when the expected size
28701 of the copy operation is known. @var{strategy}
28702 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets.
28703 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
28704 the max byte size with which inline algorithm @var{alg} is allowed. For the last
28705 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
28706 in the list must be specified in increasing order. The minimal byte size for
28707 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the
28708 preceding range.
28709
28710 @item -mmemset-strategy=@var{strategy}
28711 @opindex mmemset-strategy=@var{strategy}
28712 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
28713 @code{__builtin_memset} expansion.
28714
28715 @item -momit-leaf-frame-pointer
28716 @opindex momit-leaf-frame-pointer
28717 Don't keep the frame pointer in a register for leaf functions. This
28718 avoids the instructions to save, set up, and restore frame pointers and
28719 makes an extra register available in leaf functions. The option
28720 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
28721 which might make debugging harder.
28722
28723 @item -mtls-direct-seg-refs
28724 @itemx -mno-tls-direct-seg-refs
28725 @opindex mtls-direct-seg-refs
28726 Controls whether TLS variables may be accessed with offsets from the
28727 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
28728 or whether the thread base pointer must be added. Whether or not this
28729 is valid depends on the operating system, and whether it maps the
28730 segment to cover the entire TLS area.
28731
28732 For systems that use the GNU C Library, the default is on.
28733
28734 @item -msse2avx
28735 @itemx -mno-sse2avx
28736 @opindex msse2avx
28737 Specify that the assembler should encode SSE instructions with VEX
28738 prefix. The option @option{-mavx} turns this on by default.
28739
28740 @item -mfentry
28741 @itemx -mno-fentry
28742 @opindex mfentry
28743 If profiling is active (@option{-pg}), put the profiling
28744 counter call before the prologue.
28745 Note: On x86 architectures the attribute @code{ms_hook_prologue}
28746 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
28747
28748 @item -mrecord-mcount
28749 @itemx -mno-record-mcount
28750 @opindex mrecord-mcount
28751 If profiling is active (@option{-pg}), generate a __mcount_loc section
28752 that contains pointers to each profiling call. This is useful for
28753 automatically patching and out calls.
28754
28755 @item -mnop-mcount
28756 @itemx -mno-nop-mcount
28757 @opindex mnop-mcount
28758 If profiling is active (@option{-pg}), generate the calls to
28759 the profiling functions as NOPs. This is useful when they
28760 should be patched in later dynamically. This is likely only
28761 useful together with @option{-mrecord-mcount}.
28762
28763 @item -minstrument-return=@var{type}
28764 @opindex minstrument-return
28765 Instrument function exit in -pg -mfentry instrumented functions with
28766 call to specified function. This only instruments true returns ending
28767 with ret, but not sibling calls ending with jump. Valid types
28768 are @var{none} to not instrument, @var{call} to generate a call to __return__,
28769 or @var{nop5} to generate a 5 byte nop.
28770
28771 @item -mrecord-return
28772 @itemx -mno-record-return
28773 @opindex mrecord-return
28774 Generate a __return_loc section pointing to all return instrumentation code.
28775
28776 @item -mfentry-name=@var{name}
28777 @opindex mfentry-name
28778 Set name of __fentry__ symbol called at function entry for -pg -mfentry functions.
28779
28780 @item -mfentry-section=@var{name}
28781 @opindex mfentry-section
28782 Set name of section to record -mrecord-mcount calls (default __mcount_loc).
28783
28784 @item -mskip-rax-setup
28785 @itemx -mno-skip-rax-setup
28786 @opindex mskip-rax-setup
28787 When generating code for the x86-64 architecture with SSE extensions
28788 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
28789 register when there are no variable arguments passed in vector registers.
28790
28791 @strong{Warning:} Since RAX register is used to avoid unnecessarily
28792 saving vector registers on stack when passing variable arguments, the
28793 impacts of this option are callees may waste some stack space,
28794 misbehave or jump to a random location. GCC 4.4 or newer don't have
28795 those issues, regardless the RAX register value.
28796
28797 @item -m8bit-idiv
28798 @itemx -mno-8bit-idiv
28799 @opindex m8bit-idiv
28800 On some processors, like Intel Atom, 8-bit unsigned integer divide is
28801 much faster than 32-bit/64-bit integer divide. This option generates a
28802 run-time check. If both dividend and divisor are within range of 0
28803 to 255, 8-bit unsigned integer divide is used instead of
28804 32-bit/64-bit integer divide.
28805
28806 @item -mavx256-split-unaligned-load
28807 @itemx -mavx256-split-unaligned-store
28808 @opindex mavx256-split-unaligned-load
28809 @opindex mavx256-split-unaligned-store
28810 Split 32-byte AVX unaligned load and store.
28811
28812 @item -mstack-protector-guard=@var{guard}
28813 @itemx -mstack-protector-guard-reg=@var{reg}
28814 @itemx -mstack-protector-guard-offset=@var{offset}
28815 @opindex mstack-protector-guard
28816 @opindex mstack-protector-guard-reg
28817 @opindex mstack-protector-guard-offset
28818 Generate stack protection code using canary at @var{guard}. Supported
28819 locations are @samp{global} for global canary or @samp{tls} for per-thread
28820 canary in the TLS block (the default). This option has effect only when
28821 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
28822
28823 With the latter choice the options
28824 @option{-mstack-protector-guard-reg=@var{reg}} and
28825 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
28826 which segment register (@code{%fs} or @code{%gs}) to use as base register
28827 for reading the canary, and from what offset from that base register.
28828 The default for those is as specified in the relevant ABI.
28829
28830 @item -mgeneral-regs-only
28831 @opindex mgeneral-regs-only
28832 Generate code that uses only the general-purpose registers. This
28833 prevents the compiler from using floating-point, vector, mask and bound
28834 registers.
28835
28836 @item -mindirect-branch=@var{choice}
28837 @opindex mindirect-branch
28838 Convert indirect call and jump with @var{choice}. The default is
28839 @samp{keep}, which keeps indirect call and jump unmodified.
28840 @samp{thunk} converts indirect call and jump to call and return thunk.
28841 @samp{thunk-inline} converts indirect call and jump to inlined call
28842 and return thunk. @samp{thunk-extern} converts indirect call and jump
28843 to external call and return thunk provided in a separate object file.
28844 You can control this behavior for a specific function by using the
28845 function attribute @code{indirect_branch}. @xref{Function Attributes}.
28846
28847 Note that @option{-mcmodel=large} is incompatible with
28848 @option{-mindirect-branch=thunk} and
28849 @option{-mindirect-branch=thunk-extern} since the thunk function may
28850 not be reachable in the large code model.
28851
28852 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
28853 @option{-fcf-protection=branch} since the external thunk cannot be modified
28854 to disable control-flow check.
28855
28856 @item -mfunction-return=@var{choice}
28857 @opindex mfunction-return
28858 Convert function return with @var{choice}. The default is @samp{keep},
28859 which keeps function return unmodified. @samp{thunk} converts function
28860 return to call and return thunk. @samp{thunk-inline} converts function
28861 return to inlined call and return thunk. @samp{thunk-extern} converts
28862 function return to external call and return thunk provided in a separate
28863 object file. You can control this behavior for a specific function by
28864 using the function attribute @code{function_return}.
28865 @xref{Function Attributes}.
28866
28867 Note that @option{-mcmodel=large} is incompatible with
28868 @option{-mfunction-return=thunk} and
28869 @option{-mfunction-return=thunk-extern} since the thunk function may
28870 not be reachable in the large code model.
28871
28872
28873 @item -mindirect-branch-register
28874 @opindex mindirect-branch-register
28875 Force indirect call and jump via register.
28876
28877 @end table
28878
28879 These @samp{-m} switches are supported in addition to the above
28880 on x86-64 processors in 64-bit environments.
28881
28882 @table @gcctabopt
28883 @item -m32
28884 @itemx -m64
28885 @itemx -mx32
28886 @itemx -m16
28887 @itemx -miamcu
28888 @opindex m32
28889 @opindex m64
28890 @opindex mx32
28891 @opindex m16
28892 @opindex miamcu
28893 Generate code for a 16-bit, 32-bit or 64-bit environment.
28894 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
28895 to 32 bits, and
28896 generates code that runs on any i386 system.
28897
28898 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
28899 types to 64 bits, and generates code for the x86-64 architecture.
28900 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
28901 and @option{-mdynamic-no-pic} options.
28902
28903 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
28904 to 32 bits, and
28905 generates code for the x86-64 architecture.
28906
28907 The @option{-m16} option is the same as @option{-m32}, except for that
28908 it outputs the @code{.code16gcc} assembly directive at the beginning of
28909 the assembly output so that the binary can run in 16-bit mode.
28910
28911 The @option{-miamcu} option generates code which conforms to Intel MCU
28912 psABI. It requires the @option{-m32} option to be turned on.
28913
28914 @item -mno-red-zone
28915 @opindex mno-red-zone
28916 @opindex mred-zone
28917 Do not use a so-called ``red zone'' for x86-64 code. The red zone is mandated
28918 by the x86-64 ABI; it is a 128-byte area beyond the location of the
28919 stack pointer that is not modified by signal or interrupt handlers
28920 and therefore can be used for temporary data without adjusting the stack
28921 pointer. The flag @option{-mno-red-zone} disables this red zone.
28922
28923 @item -mcmodel=small
28924 @opindex mcmodel=small
28925 Generate code for the small code model: the program and its symbols must
28926 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
28927 Programs can be statically or dynamically linked. This is the default
28928 code model.
28929
28930 @item -mcmodel=kernel
28931 @opindex mcmodel=kernel
28932 Generate code for the kernel code model. The kernel runs in the
28933 negative 2 GB of the address space.
28934 This model has to be used for Linux kernel code.
28935
28936 @item -mcmodel=medium
28937 @opindex mcmodel=medium
28938 Generate code for the medium model: the program is linked in the lower 2
28939 GB of the address space. Small symbols are also placed there. Symbols
28940 with sizes larger than @option{-mlarge-data-threshold} are put into
28941 large data or BSS sections and can be located above 2GB. Programs can
28942 be statically or dynamically linked.
28943
28944 @item -mcmodel=large
28945 @opindex mcmodel=large
28946 Generate code for the large model. This model makes no assumptions
28947 about addresses and sizes of sections.
28948
28949 @item -maddress-mode=long
28950 @opindex maddress-mode=long
28951 Generate code for long address mode. This is only supported for 64-bit
28952 and x32 environments. It is the default address mode for 64-bit
28953 environments.
28954
28955 @item -maddress-mode=short
28956 @opindex maddress-mode=short
28957 Generate code for short address mode. This is only supported for 32-bit
28958 and x32 environments. It is the default address mode for 32-bit and
28959 x32 environments.
28960 @end table
28961
28962 @node x86 Windows Options
28963 @subsection x86 Windows Options
28964 @cindex x86 Windows Options
28965 @cindex Windows Options for x86
28966
28967 These additional options are available for Microsoft Windows targets:
28968
28969 @table @gcctabopt
28970 @item -mconsole
28971 @opindex mconsole
28972 This option
28973 specifies that a console application is to be generated, by
28974 instructing the linker to set the PE header subsystem type
28975 required for console applications.
28976 This option is available for Cygwin and MinGW targets and is
28977 enabled by default on those targets.
28978
28979 @item -mdll
28980 @opindex mdll
28981 This option is available for Cygwin and MinGW targets. It
28982 specifies that a DLL---a dynamic link library---is to be
28983 generated, enabling the selection of the required runtime
28984 startup object and entry point.
28985
28986 @item -mnop-fun-dllimport
28987 @opindex mnop-fun-dllimport
28988 This option is available for Cygwin and MinGW targets. It
28989 specifies that the @code{dllimport} attribute should be ignored.
28990
28991 @item -mthread
28992 @opindex mthread
28993 This option is available for MinGW targets. It specifies
28994 that MinGW-specific thread support is to be used.
28995
28996 @item -municode
28997 @opindex municode
28998 This option is available for MinGW-w64 targets. It causes
28999 the @code{UNICODE} preprocessor macro to be predefined, and
29000 chooses Unicode-capable runtime startup code.
29001
29002 @item -mwin32
29003 @opindex mwin32
29004 This option is available for Cygwin and MinGW targets. It
29005 specifies that the typical Microsoft Windows predefined macros are to
29006 be set in the pre-processor, but does not influence the choice
29007 of runtime library/startup code.
29008
29009 @item -mwindows
29010 @opindex mwindows
29011 This option is available for Cygwin and MinGW targets. It
29012 specifies that a GUI application is to be generated by
29013 instructing the linker to set the PE header subsystem type
29014 appropriately.
29015
29016 @item -fno-set-stack-executable
29017 @opindex fno-set-stack-executable
29018 @opindex fset-stack-executable
29019 This option is available for MinGW targets. It specifies that
29020 the executable flag for the stack used by nested functions isn't
29021 set. This is necessary for binaries running in kernel mode of
29022 Microsoft Windows, as there the User32 API, which is used to set executable
29023 privileges, isn't available.
29024
29025 @item -fwritable-relocated-rdata
29026 @opindex fno-writable-relocated-rdata
29027 @opindex fwritable-relocated-rdata
29028 This option is available for MinGW and Cygwin targets. It specifies
29029 that relocated-data in read-only section is put into the @code{.data}
29030 section. This is a necessary for older runtimes not supporting
29031 modification of @code{.rdata} sections for pseudo-relocation.
29032
29033 @item -mpe-aligned-commons
29034 @opindex mpe-aligned-commons
29035 This option is available for Cygwin and MinGW targets. It
29036 specifies that the GNU extension to the PE file format that
29037 permits the correct alignment of COMMON variables should be
29038 used when generating code. It is enabled by default if
29039 GCC detects that the target assembler found during configuration
29040 supports the feature.
29041 @end table
29042
29043 See also under @ref{x86 Options} for standard options.
29044
29045 @node Xstormy16 Options
29046 @subsection Xstormy16 Options
29047 @cindex Xstormy16 Options
29048
29049 These options are defined for Xstormy16:
29050
29051 @table @gcctabopt
29052 @item -msim
29053 @opindex msim
29054 Choose startup files and linker script suitable for the simulator.
29055 @end table
29056
29057 @node Xtensa Options
29058 @subsection Xtensa Options
29059 @cindex Xtensa Options
29060
29061 These options are supported for Xtensa targets:
29062
29063 @table @gcctabopt
29064 @item -mconst16
29065 @itemx -mno-const16
29066 @opindex mconst16
29067 @opindex mno-const16
29068 Enable or disable use of @code{CONST16} instructions for loading
29069 constant values. The @code{CONST16} instruction is currently not a
29070 standard option from Tensilica. When enabled, @code{CONST16}
29071 instructions are always used in place of the standard @code{L32R}
29072 instructions. The use of @code{CONST16} is enabled by default only if
29073 the @code{L32R} instruction is not available.
29074
29075 @item -mfused-madd
29076 @itemx -mno-fused-madd
29077 @opindex mfused-madd
29078 @opindex mno-fused-madd
29079 Enable or disable use of fused multiply/add and multiply/subtract
29080 instructions in the floating-point option. This has no effect if the
29081 floating-point option is not also enabled. Disabling fused multiply/add
29082 and multiply/subtract instructions forces the compiler to use separate
29083 instructions for the multiply and add/subtract operations. This may be
29084 desirable in some cases where strict IEEE 754-compliant results are
29085 required: the fused multiply add/subtract instructions do not round the
29086 intermediate result, thereby producing results with @emph{more} bits of
29087 precision than specified by the IEEE standard. Disabling fused multiply
29088 add/subtract instructions also ensures that the program output is not
29089 sensitive to the compiler's ability to combine multiply and add/subtract
29090 operations.
29091
29092 @item -mserialize-volatile
29093 @itemx -mno-serialize-volatile
29094 @opindex mserialize-volatile
29095 @opindex mno-serialize-volatile
29096 When this option is enabled, GCC inserts @code{MEMW} instructions before
29097 @code{volatile} memory references to guarantee sequential consistency.
29098 The default is @option{-mserialize-volatile}. Use
29099 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
29100
29101 @item -mforce-no-pic
29102 @opindex mforce-no-pic
29103 For targets, like GNU/Linux, where all user-mode Xtensa code must be
29104 position-independent code (PIC), this option disables PIC for compiling
29105 kernel code.
29106
29107 @item -mtext-section-literals
29108 @itemx -mno-text-section-literals
29109 @opindex mtext-section-literals
29110 @opindex mno-text-section-literals
29111 These options control the treatment of literal pools. The default is
29112 @option{-mno-text-section-literals}, which places literals in a separate
29113 section in the output file. This allows the literal pool to be placed
29114 in a data RAM/ROM, and it also allows the linker to combine literal
29115 pools from separate object files to remove redundant literals and
29116 improve code size. With @option{-mtext-section-literals}, the literals
29117 are interspersed in the text section in order to keep them as close as
29118 possible to their references. This may be necessary for large assembly
29119 files. Literals for each function are placed right before that function.
29120
29121 @item -mauto-litpools
29122 @itemx -mno-auto-litpools
29123 @opindex mauto-litpools
29124 @opindex mno-auto-litpools
29125 These options control the treatment of literal pools. The default is
29126 @option{-mno-auto-litpools}, which places literals in a separate
29127 section in the output file unless @option{-mtext-section-literals} is
29128 used. With @option{-mauto-litpools} the literals are interspersed in
29129 the text section by the assembler. Compiler does not produce explicit
29130 @code{.literal} directives and loads literals into registers with
29131 @code{MOVI} instructions instead of @code{L32R} to let the assembler
29132 do relaxation and place literals as necessary. This option allows
29133 assembler to create several literal pools per function and assemble
29134 very big functions, which may not be possible with
29135 @option{-mtext-section-literals}.
29136
29137 @item -mtarget-align
29138 @itemx -mno-target-align
29139 @opindex mtarget-align
29140 @opindex mno-target-align
29141 When this option is enabled, GCC instructs the assembler to
29142 automatically align instructions to reduce branch penalties at the
29143 expense of some code density. The assembler attempts to widen density
29144 instructions to align branch targets and the instructions following call
29145 instructions. If there are not enough preceding safe density
29146 instructions to align a target, no widening is performed. The
29147 default is @option{-mtarget-align}. These options do not affect the
29148 treatment of auto-aligned instructions like @code{LOOP}, which the
29149 assembler always aligns, either by widening density instructions or
29150 by inserting NOP instructions.
29151
29152 @item -mlongcalls
29153 @itemx -mno-longcalls
29154 @opindex mlongcalls
29155 @opindex mno-longcalls
29156 When this option is enabled, GCC instructs the assembler to translate
29157 direct calls to indirect calls unless it can determine that the target
29158 of a direct call is in the range allowed by the call instruction. This
29159 translation typically occurs for calls to functions in other source
29160 files. Specifically, the assembler translates a direct @code{CALL}
29161 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
29162 The default is @option{-mno-longcalls}. This option should be used in
29163 programs where the call target can potentially be out of range. This
29164 option is implemented in the assembler, not the compiler, so the
29165 assembly code generated by GCC still shows direct call
29166 instructions---look at the disassembled object code to see the actual
29167 instructions. Note that the assembler uses an indirect call for
29168 every cross-file call, not just those that really are out of range.
29169 @end table
29170
29171 @node zSeries Options
29172 @subsection zSeries Options
29173 @cindex zSeries options
29174
29175 These are listed under @xref{S/390 and zSeries Options}.
29176
29177
29178 @c man end
29179
29180 @node Spec Files
29181 @section Specifying Subprocesses and the Switches to Pass to Them
29182 @cindex Spec Files
29183
29184 @command{gcc} is a driver program. It performs its job by invoking a
29185 sequence of other programs to do the work of compiling, assembling and
29186 linking. GCC interprets its command-line parameters and uses these to
29187 deduce which programs it should invoke, and which command-line options
29188 it ought to place on their command lines. This behavior is controlled
29189 by @dfn{spec strings}. In most cases there is one spec string for each
29190 program that GCC can invoke, but a few programs have multiple spec
29191 strings to control their behavior. The spec strings built into GCC can
29192 be overridden by using the @option{-specs=} command-line switch to specify
29193 a spec file.
29194
29195 @dfn{Spec files} are plain-text files that are used to construct spec
29196 strings. They consist of a sequence of directives separated by blank
29197 lines. The type of directive is determined by the first non-whitespace
29198 character on the line, which can be one of the following:
29199
29200 @table @code
29201 @item %@var{command}
29202 Issues a @var{command} to the spec file processor. The commands that can
29203 appear here are:
29204
29205 @table @code
29206 @item %include <@var{file}>
29207 @cindex @code{%include}
29208 Search for @var{file} and insert its text at the current point in the
29209 specs file.
29210
29211 @item %include_noerr <@var{file}>
29212 @cindex @code{%include_noerr}
29213 Just like @samp{%include}, but do not generate an error message if the include
29214 file cannot be found.
29215
29216 @item %rename @var{old_name} @var{new_name}
29217 @cindex @code{%rename}
29218 Rename the spec string @var{old_name} to @var{new_name}.
29219
29220 @end table
29221
29222 @item *[@var{spec_name}]:
29223 This tells the compiler to create, override or delete the named spec
29224 string. All lines after this directive up to the next directive or
29225 blank line are considered to be the text for the spec string. If this
29226 results in an empty string then the spec is deleted. (Or, if the
29227 spec did not exist, then nothing happens.) Otherwise, if the spec
29228 does not currently exist a new spec is created. If the spec does
29229 exist then its contents are overridden by the text of this
29230 directive, unless the first character of that text is the @samp{+}
29231 character, in which case the text is appended to the spec.
29232
29233 @item [@var{suffix}]:
29234 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
29235 and up to the next directive or blank line are considered to make up the
29236 spec string for the indicated suffix. When the compiler encounters an
29237 input file with the named suffix, it processes the spec string in
29238 order to work out how to compile that file. For example:
29239
29240 @smallexample
29241 .ZZ:
29242 z-compile -input %i
29243 @end smallexample
29244
29245 This says that any input file whose name ends in @samp{.ZZ} should be
29246 passed to the program @samp{z-compile}, which should be invoked with the
29247 command-line switch @option{-input} and with the result of performing the
29248 @samp{%i} substitution. (See below.)
29249
29250 As an alternative to providing a spec string, the text following a
29251 suffix directive can be one of the following:
29252
29253 @table @code
29254 @item @@@var{language}
29255 This says that the suffix is an alias for a known @var{language}. This is
29256 similar to using the @option{-x} command-line switch to GCC to specify a
29257 language explicitly. For example:
29258
29259 @smallexample
29260 .ZZ:
29261 @@c++
29262 @end smallexample
29263
29264 Says that .ZZ files are, in fact, C++ source files.
29265
29266 @item #@var{name}
29267 This causes an error messages saying:
29268
29269 @smallexample
29270 @var{name} compiler not installed on this system.
29271 @end smallexample
29272 @end table
29273
29274 GCC already has an extensive list of suffixes built into it.
29275 This directive adds an entry to the end of the list of suffixes, but
29276 since the list is searched from the end backwards, it is effectively
29277 possible to override earlier entries using this technique.
29278
29279 @end table
29280
29281 GCC has the following spec strings built into it. Spec files can
29282 override these strings or create their own. Note that individual
29283 targets can also add their own spec strings to this list.
29284
29285 @smallexample
29286 asm Options to pass to the assembler
29287 asm_final Options to pass to the assembler post-processor
29288 cpp Options to pass to the C preprocessor
29289 cc1 Options to pass to the C compiler
29290 cc1plus Options to pass to the C++ compiler
29291 endfile Object files to include at the end of the link
29292 link Options to pass to the linker
29293 lib Libraries to include on the command line to the linker
29294 libgcc Decides which GCC support library to pass to the linker
29295 linker Sets the name of the linker
29296 predefines Defines to be passed to the C preprocessor
29297 signed_char Defines to pass to CPP to say whether @code{char} is signed
29298 by default
29299 startfile Object files to include at the start of the link
29300 @end smallexample
29301
29302 Here is a small example of a spec file:
29303
29304 @smallexample
29305 %rename lib old_lib
29306
29307 *lib:
29308 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
29309 @end smallexample
29310
29311 This example renames the spec called @samp{lib} to @samp{old_lib} and
29312 then overrides the previous definition of @samp{lib} with a new one.
29313 The new definition adds in some extra command-line options before
29314 including the text of the old definition.
29315
29316 @dfn{Spec strings} are a list of command-line options to be passed to their
29317 corresponding program. In addition, the spec strings can contain
29318 @samp{%}-prefixed sequences to substitute variable text or to
29319 conditionally insert text into the command line. Using these constructs
29320 it is possible to generate quite complex command lines.
29321
29322 Here is a table of all defined @samp{%}-sequences for spec
29323 strings. Note that spaces are not generated automatically around the
29324 results of expanding these sequences. Therefore you can concatenate them
29325 together or combine them with constant text in a single argument.
29326
29327 @table @code
29328 @item %%
29329 Substitute one @samp{%} into the program name or argument.
29330
29331 @item %i
29332 Substitute the name of the input file being processed.
29333
29334 @item %b
29335 Substitute the basename of the input file being processed.
29336 This is the substring up to (and not including) the last period
29337 and not including the directory.
29338
29339 @item %B
29340 This is the same as @samp{%b}, but include the file suffix (text after
29341 the last period).
29342
29343 @item %d
29344 Marks the argument containing or following the @samp{%d} as a
29345 temporary file name, so that that file is deleted if GCC exits
29346 successfully. Unlike @samp{%g}, this contributes no text to the
29347 argument.
29348
29349 @item %g@var{suffix}
29350 Substitute a file name that has suffix @var{suffix} and is chosen
29351 once per compilation, and mark the argument in the same way as
29352 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
29353 name is now chosen in a way that is hard to predict even when previously
29354 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
29355 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
29356 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
29357 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
29358 was simply substituted with a file name chosen once per compilation,
29359 without regard to any appended suffix (which was therefore treated
29360 just like ordinary text), making such attacks more likely to succeed.
29361
29362 @item %u@var{suffix}
29363 Like @samp{%g}, but generates a new temporary file name
29364 each time it appears instead of once per compilation.
29365
29366 @item %U@var{suffix}
29367 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
29368 new one if there is no such last file name. In the absence of any
29369 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
29370 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
29371 involves the generation of two distinct file names, one
29372 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
29373 simply substituted with a file name chosen for the previous @samp{%u},
29374 without regard to any appended suffix.
29375
29376 @item %j@var{suffix}
29377 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
29378 writable, and if @option{-save-temps} is not used;
29379 otherwise, substitute the name
29380 of a temporary file, just like @samp{%u}. This temporary file is not
29381 meant for communication between processes, but rather as a junk
29382 disposal mechanism.
29383
29384 @item %|@var{suffix}
29385 @itemx %m@var{suffix}
29386 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
29387 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
29388 all. These are the two most common ways to instruct a program that it
29389 should read from standard input or write to standard output. If you
29390 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
29391 construct: see for example @file{gcc/fortran/lang-specs.h}.
29392
29393 @item %.@var{SUFFIX}
29394 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
29395 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
29396 terminated by the next space or %.
29397
29398 @item %w
29399 Marks the argument containing or following the @samp{%w} as the
29400 designated output file of this compilation. This puts the argument
29401 into the sequence of arguments that @samp{%o} substitutes.
29402
29403 @item %o
29404 Substitutes the names of all the output files, with spaces
29405 automatically placed around them. You should write spaces
29406 around the @samp{%o} as well or the results are undefined.
29407 @samp{%o} is for use in the specs for running the linker.
29408 Input files whose names have no recognized suffix are not compiled
29409 at all, but they are included among the output files, so they are
29410 linked.
29411
29412 @item %O
29413 Substitutes the suffix for object files. Note that this is
29414 handled specially when it immediately follows @samp{%g, %u, or %U},
29415 because of the need for those to form complete file names. The
29416 handling is such that @samp{%O} is treated exactly as if it had already
29417 been substituted, except that @samp{%g, %u, and %U} do not currently
29418 support additional @var{suffix} characters following @samp{%O} as they do
29419 following, for example, @samp{.o}.
29420
29421 @item %p
29422 Substitutes the standard macro predefinitions for the
29423 current target machine. Use this when running @command{cpp}.
29424
29425 @item %P
29426 Like @samp{%p}, but puts @samp{__} before and after the name of each
29427 predefined macro, except for macros that start with @samp{__} or with
29428 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
29429 C@.
29430
29431 @item %I
29432 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
29433 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
29434 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
29435 and @option{-imultilib} as necessary.
29436
29437 @item %s
29438 Current argument is the name of a library or startup file of some sort.
29439 Search for that file in a standard list of directories and substitute
29440 the full name found. The current working directory is included in the
29441 list of directories scanned.
29442
29443 @item %T
29444 Current argument is the name of a linker script. Search for that file
29445 in the current list of directories to scan for libraries. If the file
29446 is located insert a @option{--script} option into the command line
29447 followed by the full path name found. If the file is not found then
29448 generate an error message. Note: the current working directory is not
29449 searched.
29450
29451 @item %e@var{str}
29452 Print @var{str} as an error message. @var{str} is terminated by a newline.
29453 Use this when inconsistent options are detected.
29454
29455 @item %(@var{name})
29456 Substitute the contents of spec string @var{name} at this point.
29457
29458 @item %x@{@var{option}@}
29459 Accumulate an option for @samp{%X}.
29460
29461 @item %X
29462 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
29463 spec string.
29464
29465 @item %Y
29466 Output the accumulated assembler options specified by @option{-Wa}.
29467
29468 @item %Z
29469 Output the accumulated preprocessor options specified by @option{-Wp}.
29470
29471 @item %a
29472 Process the @code{asm} spec. This is used to compute the
29473 switches to be passed to the assembler.
29474
29475 @item %A
29476 Process the @code{asm_final} spec. This is a spec string for
29477 passing switches to an assembler post-processor, if such a program is
29478 needed.
29479
29480 @item %l
29481 Process the @code{link} spec. This is the spec for computing the
29482 command line passed to the linker. Typically it makes use of the
29483 @samp{%L %G %S %D and %E} sequences.
29484
29485 @item %D
29486 Dump out a @option{-L} option for each directory that GCC believes might
29487 contain startup files. If the target supports multilibs then the
29488 current multilib directory is prepended to each of these paths.
29489
29490 @item %L
29491 Process the @code{lib} spec. This is a spec string for deciding which
29492 libraries are included on the command line to the linker.
29493
29494 @item %G
29495 Process the @code{libgcc} spec. This is a spec string for deciding
29496 which GCC support library is included on the command line to the linker.
29497
29498 @item %S
29499 Process the @code{startfile} spec. This is a spec for deciding which
29500 object files are the first ones passed to the linker. Typically
29501 this might be a file named @file{crt0.o}.
29502
29503 @item %E
29504 Process the @code{endfile} spec. This is a spec string that specifies
29505 the last object files that are passed to the linker.
29506
29507 @item %C
29508 Process the @code{cpp} spec. This is used to construct the arguments
29509 to be passed to the C preprocessor.
29510
29511 @item %1
29512 Process the @code{cc1} spec. This is used to construct the options to be
29513 passed to the actual C compiler (@command{cc1}).
29514
29515 @item %2
29516 Process the @code{cc1plus} spec. This is used to construct the options to be
29517 passed to the actual C++ compiler (@command{cc1plus}).
29518
29519 @item %*
29520 Substitute the variable part of a matched option. See below.
29521 Note that each comma in the substituted string is replaced by
29522 a single space.
29523
29524 @item %<S
29525 Remove all occurrences of @code{-S} from the command line. Note---this
29526 command is position dependent. @samp{%} commands in the spec string
29527 before this one see @code{-S}, @samp{%} commands in the spec string
29528 after this one do not.
29529
29530 @item %:@var{function}(@var{args})
29531 Call the named function @var{function}, passing it @var{args}.
29532 @var{args} is first processed as a nested spec string, then split
29533 into an argument vector in the usual fashion. The function returns
29534 a string which is processed as if it had appeared literally as part
29535 of the current spec.
29536
29537 The following built-in spec functions are provided:
29538
29539 @table @code
29540 @item @code{getenv}
29541 The @code{getenv} spec function takes two arguments: an environment
29542 variable name and a string. If the environment variable is not
29543 defined, a fatal error is issued. Otherwise, the return value is the
29544 value of the environment variable concatenated with the string. For
29545 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
29546
29547 @smallexample
29548 %:getenv(TOPDIR /include)
29549 @end smallexample
29550
29551 expands to @file{/path/to/top/include}.
29552
29553 @item @code{if-exists}
29554 The @code{if-exists} spec function takes one argument, an absolute
29555 pathname to a file. If the file exists, @code{if-exists} returns the
29556 pathname. Here is a small example of its usage:
29557
29558 @smallexample
29559 *startfile:
29560 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
29561 @end smallexample
29562
29563 @item @code{if-exists-else}
29564 The @code{if-exists-else} spec function is similar to the @code{if-exists}
29565 spec function, except that it takes two arguments. The first argument is
29566 an absolute pathname to a file. If the file exists, @code{if-exists-else}
29567 returns the pathname. If it does not exist, it returns the second argument.
29568 This way, @code{if-exists-else} can be used to select one file or another,
29569 based on the existence of the first. Here is a small example of its usage:
29570
29571 @smallexample
29572 *startfile:
29573 crt0%O%s %:if-exists(crti%O%s) \
29574 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
29575 @end smallexample
29576
29577 @item @code{replace-outfile}
29578 The @code{replace-outfile} spec function takes two arguments. It looks for the
29579 first argument in the outfiles array and replaces it with the second argument. Here
29580 is a small example of its usage:
29581
29582 @smallexample
29583 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
29584 @end smallexample
29585
29586 @item @code{remove-outfile}
29587 The @code{remove-outfile} spec function takes one argument. It looks for the
29588 first argument in the outfiles array and removes it. Here is a small example
29589 its usage:
29590
29591 @smallexample
29592 %:remove-outfile(-lm)
29593 @end smallexample
29594
29595 @item @code{pass-through-libs}
29596 The @code{pass-through-libs} spec function takes any number of arguments. It
29597 finds any @option{-l} options and any non-options ending in @file{.a} (which it
29598 assumes are the names of linker input library archive files) and returns a
29599 result containing all the found arguments each prepended by
29600 @option{-plugin-opt=-pass-through=} and joined by spaces. This list is
29601 intended to be passed to the LTO linker plugin.
29602
29603 @smallexample
29604 %:pass-through-libs(%G %L %G)
29605 @end smallexample
29606
29607 @item @code{print-asm-header}
29608 The @code{print-asm-header} function takes no arguments and simply
29609 prints a banner like:
29610
29611 @smallexample
29612 Assembler options
29613 =================
29614
29615 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
29616 @end smallexample
29617
29618 It is used to separate compiler options from assembler options
29619 in the @option{--target-help} output.
29620 @end table
29621
29622 @item %@{S@}
29623 Substitutes the @code{-S} switch, if that switch is given to GCC@.
29624 If that switch is not specified, this substitutes nothing. Note that
29625 the leading dash is omitted when specifying this option, and it is
29626 automatically inserted if the substitution is performed. Thus the spec
29627 string @samp{%@{foo@}} matches the command-line option @option{-foo}
29628 and outputs the command-line option @option{-foo}.
29629
29630 @item %W@{S@}
29631 Like %@{@code{S}@} but mark last argument supplied within as a file to be
29632 deleted on failure.
29633
29634 @item %@{S*@}
29635 Substitutes all the switches specified to GCC whose names start
29636 with @code{-S}, but which also take an argument. This is used for
29637 switches like @option{-o}, @option{-D}, @option{-I}, etc.
29638 GCC considers @option{-o foo} as being
29639 one switch whose name starts with @samp{o}. %@{o*@} substitutes this
29640 text, including the space. Thus two arguments are generated.
29641
29642 @item %@{S*&T*@}
29643 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
29644 (the order of @code{S} and @code{T} in the spec is not significant).
29645 There can be any number of ampersand-separated variables; for each the
29646 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
29647
29648 @item %@{S:X@}
29649 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
29650
29651 @item %@{!S:X@}
29652 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
29653
29654 @item %@{S*:X@}
29655 Substitutes @code{X} if one or more switches whose names start with
29656 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
29657 once, no matter how many such switches appeared. However, if @code{%*}
29658 appears somewhere in @code{X}, then @code{X} is substituted once
29659 for each matching switch, with the @code{%*} replaced by the part of
29660 that switch matching the @code{*}.
29661
29662 If @code{%*} appears as the last part of a spec sequence then a space
29663 is added after the end of the last substitution. If there is more
29664 text in the sequence, however, then a space is not generated. This
29665 allows the @code{%*} substitution to be used as part of a larger
29666 string. For example, a spec string like this:
29667
29668 @smallexample
29669 %@{mcu=*:--script=%*/memory.ld@}
29670 @end smallexample
29671
29672 @noindent
29673 when matching an option like @option{-mcu=newchip} produces:
29674
29675 @smallexample
29676 --script=newchip/memory.ld
29677 @end smallexample
29678
29679 @item %@{.S:X@}
29680 Substitutes @code{X}, if processing a file with suffix @code{S}.
29681
29682 @item %@{!.S:X@}
29683 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
29684
29685 @item %@{,S:X@}
29686 Substitutes @code{X}, if processing a file for language @code{S}.
29687
29688 @item %@{!,S:X@}
29689 Substitutes @code{X}, if not processing a file for language @code{S}.
29690
29691 @item %@{S|P:X@}
29692 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
29693 GCC@. This may be combined with @samp{!}, @samp{.}, @samp{,}, and
29694 @code{*} sequences as well, although they have a stronger binding than
29695 the @samp{|}. If @code{%*} appears in @code{X}, all of the
29696 alternatives must be starred, and only the first matching alternative
29697 is substituted.
29698
29699 For example, a spec string like this:
29700
29701 @smallexample
29702 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
29703 @end smallexample
29704
29705 @noindent
29706 outputs the following command-line options from the following input
29707 command-line options:
29708
29709 @smallexample
29710 fred.c -foo -baz
29711 jim.d -bar -boggle
29712 -d fred.c -foo -baz -boggle
29713 -d jim.d -bar -baz -boggle
29714 @end smallexample
29715
29716 @item %@{S:X; T:Y; :D@}
29717
29718 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
29719 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
29720 be as many clauses as you need. This may be combined with @code{.},
29721 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
29722
29723
29724 @end table
29725
29726 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
29727 or similar construct can use a backslash to ignore the special meaning
29728 of the character following it, thus allowing literal matching of a
29729 character that is otherwise specially treated. For example,
29730 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
29731 @option{-std=iso9899:1999} option is given.
29732
29733 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
29734 construct may contain other nested @samp{%} constructs or spaces, or
29735 even newlines. They are processed as usual, as described above.
29736 Trailing white space in @code{X} is ignored. White space may also
29737 appear anywhere on the left side of the colon in these constructs,
29738 except between @code{.} or @code{*} and the corresponding word.
29739
29740 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
29741 handled specifically in these constructs. If another value of
29742 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
29743 @option{-W} switch is found later in the command line, the earlier
29744 switch value is ignored, except with @{@code{S}*@} where @code{S} is
29745 just one letter, which passes all matching options.
29746
29747 The character @samp{|} at the beginning of the predicate text is used to
29748 indicate that a command should be piped to the following command, but
29749 only if @option{-pipe} is specified.
29750
29751 It is built into GCC which switches take arguments and which do not.
29752 (You might think it would be useful to generalize this to allow each
29753 compiler's spec to say which switches take arguments. But this cannot
29754 be done in a consistent fashion. GCC cannot even decide which input
29755 files have been specified without knowing which switches take arguments,
29756 and it must know which input files to compile in order to tell which
29757 compilers to run).
29758
29759 GCC also knows implicitly that arguments starting in @option{-l} are to be
29760 treated as compiler output files, and passed to the linker in their
29761 proper position among the other output files.
29762
29763 @node Environment Variables
29764 @section Environment Variables Affecting GCC
29765 @cindex environment variables
29766
29767 @c man begin ENVIRONMENT
29768 This section describes several environment variables that affect how GCC
29769 operates. Some of them work by specifying directories or prefixes to use
29770 when searching for various kinds of files. Some are used to specify other
29771 aspects of the compilation environment.
29772
29773 Note that you can also specify places to search using options such as
29774 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
29775 take precedence over places specified using environment variables, which
29776 in turn take precedence over those specified by the configuration of GCC@.
29777 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
29778 GNU Compiler Collection (GCC) Internals}.
29779
29780 @table @env
29781 @item LANG
29782 @itemx LC_CTYPE
29783 @c @itemx LC_COLLATE
29784 @itemx LC_MESSAGES
29785 @c @itemx LC_MONETARY
29786 @c @itemx LC_NUMERIC
29787 @c @itemx LC_TIME
29788 @itemx LC_ALL
29789 @findex LANG
29790 @findex LC_CTYPE
29791 @c @findex LC_COLLATE
29792 @findex LC_MESSAGES
29793 @c @findex LC_MONETARY
29794 @c @findex LC_NUMERIC
29795 @c @findex LC_TIME
29796 @findex LC_ALL
29797 @cindex locale
29798 These environment variables control the way that GCC uses
29799 localization information which allows GCC to work with different
29800 national conventions. GCC inspects the locale categories
29801 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
29802 so. These locale categories can be set to any value supported by your
29803 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
29804 Kingdom encoded in UTF-8.
29805
29806 The @env{LC_CTYPE} environment variable specifies character
29807 classification. GCC uses it to determine the character boundaries in
29808 a string; this is needed for some multibyte encodings that contain quote
29809 and escape characters that are otherwise interpreted as a string
29810 end or escape.
29811
29812 The @env{LC_MESSAGES} environment variable specifies the language to
29813 use in diagnostic messages.
29814
29815 If the @env{LC_ALL} environment variable is set, it overrides the value
29816 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
29817 and @env{LC_MESSAGES} default to the value of the @env{LANG}
29818 environment variable. If none of these variables are set, GCC
29819 defaults to traditional C English behavior.
29820
29821 @item TMPDIR
29822 @findex TMPDIR
29823 If @env{TMPDIR} is set, it specifies the directory to use for temporary
29824 files. GCC uses temporary files to hold the output of one stage of
29825 compilation which is to be used as input to the next stage: for example,
29826 the output of the preprocessor, which is the input to the compiler
29827 proper.
29828
29829 @item GCC_COMPARE_DEBUG
29830 @findex GCC_COMPARE_DEBUG
29831 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
29832 @option{-fcompare-debug} to the compiler driver. See the documentation
29833 of this option for more details.
29834
29835 @item GCC_EXEC_PREFIX
29836 @findex GCC_EXEC_PREFIX
29837 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
29838 names of the subprograms executed by the compiler. No slash is added
29839 when this prefix is combined with the name of a subprogram, but you can
29840 specify a prefix that ends with a slash if you wish.
29841
29842 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
29843 an appropriate prefix to use based on the pathname it is invoked with.
29844
29845 If GCC cannot find the subprogram using the specified prefix, it
29846 tries looking in the usual places for the subprogram.
29847
29848 The default value of @env{GCC_EXEC_PREFIX} is
29849 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
29850 the installed compiler. In many cases @var{prefix} is the value
29851 of @code{prefix} when you ran the @file{configure} script.
29852
29853 Other prefixes specified with @option{-B} take precedence over this prefix.
29854
29855 This prefix is also used for finding files such as @file{crt0.o} that are
29856 used for linking.
29857
29858 In addition, the prefix is used in an unusual way in finding the
29859 directories to search for header files. For each of the standard
29860 directories whose name normally begins with @samp{/usr/local/lib/gcc}
29861 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
29862 replacing that beginning with the specified prefix to produce an
29863 alternate directory name. Thus, with @option{-Bfoo/}, GCC searches
29864 @file{foo/bar} just before it searches the standard directory
29865 @file{/usr/local/lib/bar}.
29866 If a standard directory begins with the configured
29867 @var{prefix} then the value of @var{prefix} is replaced by
29868 @env{GCC_EXEC_PREFIX} when looking for header files.
29869
29870 @item COMPILER_PATH
29871 @findex COMPILER_PATH
29872 The value of @env{COMPILER_PATH} is a colon-separated list of
29873 directories, much like @env{PATH}. GCC tries the directories thus
29874 specified when searching for subprograms, if it cannot find the
29875 subprograms using @env{GCC_EXEC_PREFIX}.
29876
29877 @item LIBRARY_PATH
29878 @findex LIBRARY_PATH
29879 The value of @env{LIBRARY_PATH} is a colon-separated list of
29880 directories, much like @env{PATH}. When configured as a native compiler,
29881 GCC tries the directories thus specified when searching for special
29882 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}. Linking
29883 using GCC also uses these directories when searching for ordinary
29884 libraries for the @option{-l} option (but directories specified with
29885 @option{-L} come first).
29886
29887 @item LANG
29888 @findex LANG
29889 @cindex locale definition
29890 This variable is used to pass locale information to the compiler. One way in
29891 which this information is used is to determine the character set to be used
29892 when character literals, string literals and comments are parsed in C and C++.
29893 When the compiler is configured to allow multibyte characters,
29894 the following values for @env{LANG} are recognized:
29895
29896 @table @samp
29897 @item C-JIS
29898 Recognize JIS characters.
29899 @item C-SJIS
29900 Recognize SJIS characters.
29901 @item C-EUCJP
29902 Recognize EUCJP characters.
29903 @end table
29904
29905 If @env{LANG} is not defined, or if it has some other value, then the
29906 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
29907 recognize and translate multibyte characters.
29908 @end table
29909
29910 @noindent
29911 Some additional environment variables affect the behavior of the
29912 preprocessor.
29913
29914 @include cppenv.texi
29915
29916 @c man end
29917
29918 @node Precompiled Headers
29919 @section Using Precompiled Headers
29920 @cindex precompiled headers
29921 @cindex speed of compilation
29922
29923 Often large projects have many header files that are included in every
29924 source file. The time the compiler takes to process these header files
29925 over and over again can account for nearly all of the time required to
29926 build the project. To make builds faster, GCC allows you to
29927 @dfn{precompile} a header file.
29928
29929 To create a precompiled header file, simply compile it as you would any
29930 other file, if necessary using the @option{-x} option to make the driver
29931 treat it as a C or C++ header file. You may want to use a
29932 tool like @command{make} to keep the precompiled header up-to-date when
29933 the headers it contains change.
29934
29935 A precompiled header file is searched for when @code{#include} is
29936 seen in the compilation. As it searches for the included file
29937 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
29938 compiler looks for a precompiled header in each directory just before it
29939 looks for the include file in that directory. The name searched for is
29940 the name specified in the @code{#include} with @samp{.gch} appended. If
29941 the precompiled header file cannot be used, it is ignored.
29942
29943 For instance, if you have @code{#include "all.h"}, and you have
29944 @file{all.h.gch} in the same directory as @file{all.h}, then the
29945 precompiled header file is used if possible, and the original
29946 header is used otherwise.
29947
29948 Alternatively, you might decide to put the precompiled header file in a
29949 directory and use @option{-I} to ensure that directory is searched
29950 before (or instead of) the directory containing the original header.
29951 Then, if you want to check that the precompiled header file is always
29952 used, you can put a file of the same name as the original header in this
29953 directory containing an @code{#error} command.
29954
29955 This also works with @option{-include}. So yet another way to use
29956 precompiled headers, good for projects not designed with precompiled
29957 header files in mind, is to simply take most of the header files used by
29958 a project, include them from another header file, precompile that header
29959 file, and @option{-include} the precompiled header. If the header files
29960 have guards against multiple inclusion, they are skipped because
29961 they've already been included (in the precompiled header).
29962
29963 If you need to precompile the same header file for different
29964 languages, targets, or compiler options, you can instead make a
29965 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29966 header in the directory, perhaps using @option{-o}. It doesn't matter
29967 what you call the files in the directory; every precompiled header in
29968 the directory is considered. The first precompiled header
29969 encountered in the directory that is valid for this compilation is
29970 used; they're searched in no particular order.
29971
29972 There are many other possibilities, limited only by your imagination,
29973 good sense, and the constraints of your build system.
29974
29975 A precompiled header file can be used only when these conditions apply:
29976
29977 @itemize
29978 @item
29979 Only one precompiled header can be used in a particular compilation.
29980
29981 @item
29982 A precompiled header cannot be used once the first C token is seen. You
29983 can have preprocessor directives before a precompiled header; you cannot
29984 include a precompiled header from inside another header.
29985
29986 @item
29987 The precompiled header file must be produced for the same language as
29988 the current compilation. You cannot use a C precompiled header for a C++
29989 compilation.
29990
29991 @item
29992 The precompiled header file must have been produced by the same compiler
29993 binary as the current compilation is using.
29994
29995 @item
29996 Any macros defined before the precompiled header is included must
29997 either be defined in the same way as when the precompiled header was
29998 generated, or must not affect the precompiled header, which usually
29999 means that they don't appear in the precompiled header at all.
30000
30001 The @option{-D} option is one way to define a macro before a
30002 precompiled header is included; using a @code{#define} can also do it.
30003 There are also some options that define macros implicitly, like
30004 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
30005 defined this way.
30006
30007 @item If debugging information is output when using the precompiled
30008 header, using @option{-g} or similar, the same kind of debugging information
30009 must have been output when building the precompiled header. However,
30010 a precompiled header built using @option{-g} can be used in a compilation
30011 when no debugging information is being output.
30012
30013 @item The same @option{-m} options must generally be used when building
30014 and using the precompiled header. @xref{Submodel Options},
30015 for any cases where this rule is relaxed.
30016
30017 @item Each of the following options must be the same when building and using
30018 the precompiled header:
30019
30020 @gccoptlist{-fexceptions}
30021
30022 @item
30023 Some other command-line options starting with @option{-f},
30024 @option{-p}, or @option{-O} must be defined in the same way as when
30025 the precompiled header was generated. At present, it's not clear
30026 which options are safe to change and which are not; the safest choice
30027 is to use exactly the same options when generating and using the
30028 precompiled header. The following are known to be safe:
30029
30030 @gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock @gol
30031 -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous @gol
30032 -fsched-verbose=@var{number} -fschedule-insns -fvisibility= @gol
30033 -pedantic-errors}
30034
30035 @end itemize
30036
30037 For all of these except the last, the compiler automatically
30038 ignores the precompiled header if the conditions aren't met. If you
30039 find an option combination that doesn't work and doesn't cause the
30040 precompiled header to be ignored, please consider filing a bug report,
30041 see @ref{Bugs}.
30042
30043 If you do use differing options when generating and using the
30044 precompiled header, the actual behavior is a mixture of the
30045 behavior for the options. For instance, if you use @option{-g} to
30046 generate the precompiled header but not when using it, you may or may
30047 not get debugging information for routines in the precompiled header.